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

1.75      rillig      1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
                      2: <html>
1.1       grant       3: <head>
1.75      rillig      4: <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
                      5: <title>The pkgsrc guide</title>
1.132     spz         6: <link rel="stylesheet" type="text/css" href="/global.css">
1.75      rillig      7: <meta name="generator" content="DocBook XSL Stylesheets VX.X.X">
1.91      rillig      8: <meta name="description" content="pkgsrc is a centralized package management system for Unix-like operating systems. This guide provides information for users and developers of pkgsrc. It covers installation of binary and source packages, creation of binary and source packages and a high-level overview about the infrastructure.">
1.75      rillig      9: </head>
1.148     asau       10: <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book">
1.75      rillig     11: <div class="titlepage">
                     12: <div>
                     13: <div><h1 class="title">
                     14: <a name="the-pkgsrc-guide"></a>The pkgsrc guide</h1></div>
                     15: <div><h2 class="subtitle">Documentation on the NetBSD packages system</h2></div>
                     16: <div><div class="authorgroup">
                     17: <div class="author">
                     18: <h3 class="author">
                     19: <span class="firstname">Alistair</span> <span class="surname">Crooks</span>
                     20: </h3>
1.110     hubertf    21: <div class="affiliation"><div class="address"><p><code class="email">&lt;<a class="email" href="mailto:agc@NetBSD.org">agc@NetBSD.org</a>&gt;</code></p></div></div>
1.75      rillig     22: </div>
                     23: <div class="author">
                     24: <h3 class="author">
                     25: <span class="firstname">Hubert</span> <span class="surname">Feyrer</span>
                     26: </h3>
1.110     hubertf    27: <div class="affiliation"><div class="address"><p><code class="email">&lt;<a class="email" href="mailto:hubertf@NetBSD.org">hubertf@NetBSD.org</a>&gt;</code></p></div></div>
1.75      rillig     28: </div>
                     29: <h3 class="corpauthor">
                     30:         The pkgsrc Developers
                     31:       </h3>
                     32: </div></div>
1.310     jnemeth    33: <div><p class="copyright">Copyright © 1994-2021 The NetBSD Foundation, Inc</p></div>
                     34: <div><p class="pubdate">$NetBSD: pkgsrc.xml,v 1.39 2021/01/02 08:32:15 jnemeth Exp $</p></div>
1.148     asau       35: <div><div class="abstract">
1.75      rillig     36: <p class="title"><b>Abstract</b></p>
                     37: <p>pkgsrc is a centralized package management system for
                     38:        Unix-like operating systems. This guide provides information for
                     39:        users and developers of pkgsrc. It covers installation of binary
                     40:        and source packages, creation of binary and source packages and
                     41:        a high-level overview about the infrastructure.</p>
                     42: </div></div>
                     43: </div>
                     44: <hr>
                     45: </div>
                     46: <div class="toc">
                     47: <p><b>Table of Contents</b></p>
1.210     leot       48: <dl class="toc">
1.75      rillig     49: <dt><span class="chapter"><a href="#introduction">1. What is pkgsrc?</a></span></dt>
                     50: <dd><dl>
                     51: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82      rillig     52: <dd><dl>
                     53: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
                     54: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
                     55: </dl></dd>
1.75      rillig     56: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
                     57: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88      wiz        58: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
1.75      rillig     59: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
                     60: </dl></dd>
                     61: <dt><span class="part"><a href="#users-guide">I. The pkgsrc user's guide</a></span></dt>
                     62: <dd><dl>
1.267     rillig     63: <dt><span class="chapter"><a href="#help-user">2. Getting help</a></span></dt>
                     64: <dt><span class="chapter"><a href="#getting">3. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
1.75      rillig     65: <dd><dl>
1.267     rillig     66: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.75      rillig     67: <dd><dl>
1.267     rillig     68: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
                     69: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.75      rillig     70: </dl></dd>
1.267     rillig     71: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.75      rillig     72: <dd><dl>
1.267     rillig     73: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
                     74: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.75      rillig     75: </dl></dd>
                     76: </dl></dd>
1.267     rillig     77: <dt><span class="chapter"><a href="#platforms">4. Using pkgsrc on systems other than NetBSD</a></span></dt>
1.75      rillig     78: <dd><dl>
1.267     rillig     79: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
                     80: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.75      rillig     81: </dl></dd>
1.267     rillig     82: <dt><span class="chapter"><a href="#using">5. Using pkgsrc</a></span></dt>
1.75      rillig     83: <dd><dl>
1.267     rillig     84: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.75      rillig     85: <dd><dl>
1.267     rillig     86: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
                     87: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
1.317   ! nia        88: <dt><span class="sect2"><a href="#using.pkgin_update">5.1.3. Updating packages</a></span></dt>
        !            89: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.4. Deinstalling packages</a></span></dt>
        !            90: <dt><span class="sect2"><a href="#using.pkg_info">5.1.5. Getting information about installed packages</a></span></dt>
        !            91: <dt><span class="sect2"><a href="#vulnerabilities">5.1.6. Checking for security vulnerabilities in installed packages</a></span></dt>
        !            92: <dt><span class="sect2"><a href="#pkg_versions">5.1.7. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
        !            93: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.8. Other administrative functions</a></span></dt>
1.75      rillig     94: </dl></dd>
1.267     rillig     95: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1.75      rillig     96: <dd><dl>
1.267     rillig     97: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
                     98: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
                     99: <dt><span class="sect2"><a href="#how-to-build-and-install">5.2.3. How to build and install</a></span></dt>
1.75      rillig    100: </dl></dd>
                    101: </dl></dd>
1.267     rillig    102: <dt><span class="chapter"><a href="#configuring">6. Configuring pkgsrc</a></span></dt>
1.75      rillig    103: <dd><dl>
1.267     rillig    104: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
                    105: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
                    106: <dt><span class="sect1"><a href="#variables-affecting-installation">6.3. Variables affecting the installation process</a></span></dt>
                    107: <dt><span class="sect1"><a href="#conf.compiler">6.4. Selecting and configuring the compiler</a></span></dt>
1.88      wiz       108: <dd><dl>
1.267     rillig    109: <dt><span class="sect2"><a href="#selecting-the-compiler">6.4.1. Selecting the compiler</a></span></dt>
                    110: <dt><span class="sect2"><a href="#conf.cflags">6.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                    111: <dt><span class="sect2"><a href="#conf.ldflags">6.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.88      wiz       112: </dl></dd>
1.267     rillig    113: <dt><span class="sect1"><a href="#developer-advanced-settings">6.5. Developer/advanced settings</a></span></dt>
                    114: <dt><span class="sect1"><a href="#selecting-build-options">6.6. Selecting Build Options</a></span></dt>
1.75      rillig    115: </dl></dd>
1.267     rillig    116: <dt><span class="chapter"><a href="#binary">7. Creating binary packages</a></span></dt>
1.75      rillig    117: <dd><dl>
1.267     rillig    118: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
                    119: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">7.2. Settings for creation of binary packages</a></span></dt>
1.106     rillig    120: </dl></dd>
1.267     rillig    121: <dt><span class="chapter"><a href="#bulk">8. Creating binary packages for everything in pkgsrc (bulk
1.106     rillig    122: builds)</a></span></dt>
1.75      rillig    123: <dd><dl>
1.267     rillig    124: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
1.295     rillig    125: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a bulk build</a></span></dt>
1.267     rillig    126: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
                    127: <dt><span class="sect1"><a href="#bulk.req">8.3. Requirements of a full bulk build</a></span></dt>
1.293     rillig    128: <dt><span class="sect1"><a href="#bulk.var">8.4. Bulk build variants</a></span></dt>
                    129: <dd><dl>
1.294     rillig    130: <dt><span class="sect2"><a href="#bulk.var.confopt">8.4.1. Detect unknown configure options</a></span></dt>
                    131: <dt><span class="sect2"><a href="#bulk.var.comperr">8.4.2. Detect classes of bugs by forcing compiler warnings</a></span></dt>
1.296     rillig    132: <dt><span class="sect2"><a href="#bulk.var.builderr">8.4.3. Force compiler options only in the build phase</a></span></dt>
                    133: <dt><span class="sect2"><a href="#bulk.var.dirs">8.4.4. Use custom directories</a></span></dt>
                    134: <dt><span class="sect2"><a href="#bulk.var.warn">8.4.5. Turn warnings into errors</a></span></dt>
                    135: <dt><span class="sect2"><a href="#bulk.var.pkglint">8.4.6. Reject packages for which pkglint reports errors</a></span></dt>
                    136: <dt><span class="sect2"><a href="#bulk.var.strings">8.4.7. Reject packages that contain forbidden strings</a></span></dt>
                    137: <dt><span class="sect2"><a href="#bulk.var.test">8.4.8. Reject packages whose self-test fails</a></span></dt>
                    138: <dt><span class="sect2"><a href="#bulk.var.shvar">8.4.9. Reject packages that use undefined shell variables</a></span></dt>
                    139: <dt><span class="sect2"><a href="#bulk.var.quiet">8.4.10. Turn off verbose logging</a></span></dt>
1.293     rillig    140: </dl></dd>
                    141: <dt><span class="sect1"><a href="#creating-cdroms">8.5. Creating a multiple CD-ROM packages collection</a></span></dt>
                    142: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.5.1. Example of cdpack</a></span></dt></dl></dd>
1.267     rillig    143: </dl></dd>
                    144: <dt><span class="chapter"><a href="#files">9. Directory layout of the installed files</a></span></dt>
                    145: <dd><dl>
                    146: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
                    147: <dt><span class="sect1"><a href="#files.varbase">9.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
                    148: </dl></dd>
                    149: <dt><span class="chapter"><a href="#faq">10. Frequently Asked Questions</a></span></dt>
                    150: <dd><dl>
                    151: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                    152: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
                    153: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
                    154: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
                    155: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">10.5. How can I install/use modular X.org from pkgsrc?</a></span></dt>
                    156: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
                    157: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
                    158: <dt><span class="sect1"><a href="#passive-ftp">10.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
                    159: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
                    160: <dt><span class="sect1"><a href="#tmac.andoc-missing">10.10. What does <span class="quote">&#8220;<span class="quote">Don't know how to make
1.128     wiz       161: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</a></span></dt>
1.267     rillig    162: <dt><span class="sect1"><a href="#bsd.own.mk-missing">10.11. What does <span class="quote">&#8220;<span class="quote">Could not find bsd.own.mk</span>&#8221;</span> mean?</a></span></dt>
                    163: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' with pkgsrc</a></span></dt>
                    164: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
                    165: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
                    166: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
                    167: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build.  What shall I do?</a></span></dt>
                    168: <dt><span class="sect1"><a href="#faq.rcs-conflicts">10.17. What does <span class="quote">&#8220;<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>&#8221;</span> mean?</a></span></dt>
1.75      rillig    169: </dl></dd>
                    170: </dl></dd>
                    171: <dt><span class="part"><a href="#developers-guide">II. The pkgsrc developer's guide</a></span></dt>
                    172: <dd><dl>
1.267     rillig    173: <dt><span class="chapter"><a href="#help-devel">11. Getting help</a></span></dt>
1.299     rillig    174: <dt><span class="chapter"><a href="#components">12. Package components - files, directories and contents</a></span></dt>
1.91      rillig    175: <dd><dl>
1.299     rillig    176: <dt><span class="sect1"><a href="#components.Makefile">12.1. <code class="filename">Makefile</code></a></span></dt>
                    177: <dt><span class="sect1"><a href="#components.distinfo">12.2. <code class="filename">distinfo</code></a></span></dt>
                    178: <dt><span class="sect1"><a href="#components.patches">12.3. <code class="filename">patches/*</code></a></span></dt>
1.91      rillig    179: <dd><dl>
1.299     rillig    180: <dt><span class="sect2"><a href="#components.patch.structure">12.3.1. Structure of a single patch file</a></span></dt>
                    181: <dt><span class="sect2"><a href="#components.patches.caveats">12.3.2. Creating patch files</a></span></dt>
                    182: <dt><span class="sect2"><a href="#components.patches.sources">12.3.3. Sources where the patch files come from</a></span></dt>
                    183: <dt><span class="sect2"><a href="#components.patches.guidelines">12.3.4. Patching guidelines</a></span></dt>
                    184: <dt><span class="sect2"><a href="#components.patches.feedback">12.3.5. Feedback to the author</a></span></dt>
1.91      rillig    185: </dl></dd>
1.299     rillig    186: <dt><span class="sect1"><a href="#other-mandatory-files">12.4. Other mandatory files</a></span></dt>
                    187: <dt><span class="sect1"><a href="#components.optional">12.5. Optional files</a></span></dt>
                    188: <dd><dl>
                    189: <dt><span class="sect2"><a href="#components.optional.bin">12.5.1. Files affecting the binary package</a></span></dt>
                    190: <dt><span class="sect2"><a href="#components.optional.build">12.5.2. Files affecting the build process</a></span></dt>
                    191: <dt><span class="sect2"><a href="#components.optional.none">12.5.3. Files affecting nothing at all</a></span></dt>
                    192: </dl></dd>
                    193: <dt><span class="sect1"><a href="#work-dir">12.6. <code class="filename">work*</code></a></span></dt>
                    194: <dt><span class="sect1"><a href="#files-dir">12.7. <code class="filename">files/*</code></a></span></dt>
1.106     rillig    195: </dl></dd>
1.299     rillig    196: <dt><span class="chapter"><a href="#build">13. The build process</a></span></dt>
1.106     rillig    197: <dd><dl>
1.299     rillig    198: <dt><span class="sect1"><a href="#build.intro">13.1. Introduction</a></span></dt>
                    199: <dt><span class="sect1"><a href="#build.prefix">13.2. Program location</a></span></dt>
                    200: <dt><span class="sect1"><a href="#build.builddirs">13.3. Directories used during the build process</a></span></dt>
                    201: <dt><span class="sect1"><a href="#build.running">13.4. Running a phase</a></span></dt>
                    202: <dt><span class="sect1"><a href="#build.fetch">13.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.106     rillig    203: <dd><dl>
1.299     rillig    204: <dt><span class="sect2"><a href="#build.fetch.what">13.5.1. What to fetch and where to get it from</a></span></dt>
                    205: <dt><span class="sect2"><a href="#build.fetch.how">13.5.2. How are the files fetched?</a></span></dt>
1.106     rillig    206: </dl></dd>
1.299     rillig    207: <dt><span class="sect1"><a href="#build.checksum">13.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                    208: <dt><span class="sect1"><a href="#build.extract">13.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                    209: <dt><span class="sect1"><a href="#build.patch">13.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                    210: <dt><span class="sect1"><a href="#build.tools">13.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                    211: <dt><span class="sect1"><a href="#build.wrapper">13.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                    212: <dt><span class="sect1"><a href="#build.configure">13.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                    213: <dt><span class="sect1"><a href="#build.build">13.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                    214: <dt><span class="sect1"><a href="#build.test">13.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                    215: <dt><span class="sect1"><a href="#build.install">13.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                    216: <dt><span class="sect1"><a href="#build.package">13.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
                    217: <dt><span class="sect1"><a href="#build.clean">13.16. Cleaning up</a></span></dt>
                    218: <dt><span class="sect1"><a href="#build.helpful-targets">13.17. Other helpful targets</a></span></dt>
                    219: </dl></dd>
                    220: <dt><span class="chapter"><a href="#creating">14. Creating a new pkgsrc package from scratch</a></span></dt>
                    221: <dd><dl>
                    222: <dt><span class="sect1"><a href="#creating.common">14.1. Common types of packages</a></span></dt>
1.106     rillig    223: <dd><dl>
1.299     rillig    224: <dt><span class="sect2"><a href="#creating.perl-module">14.1.1. Perl modules</a></span></dt>
                    225: <dt><span class="sect2"><a href="#creating.python-module">14.1.2. Python modules and programs</a></span></dt>
                    226: <dt><span class="sect2"><a href="#creating.R-package">14.1.3. R packages</a></span></dt>
                    227: <dt><span class="sect2"><a href="#creating.TeX-package">14.1.4. TeXlive packages</a></span></dt>
1.106     rillig    228: </dl></dd>
1.299     rillig    229: <dt><span class="sect1"><a href="#creating.examples">14.2. Examples</a></span></dt>
                    230: <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    231: </dl></dd>
1.299     rillig    232: <dt><span class="chapter"><a href="#makefile">15. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.106     rillig    233: <dd><dl>
1.299     rillig    234: <dt><span class="sect1"><a href="#makefile.style">15.1. Caveats</a></span></dt>
                    235: <dt><span class="sect1"><a href="#makefile.variables">15.2. <code class="filename">Makefile</code> variables</a></span></dt>
                    236: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">15.2.1. Naming conventions</a></span></dt></dl></dd>
                    237: <dt><span class="sect1"><a href="#makefile.code">15.3. Code snippets</a></span></dt>
1.106     rillig    238: <dd><dl>
1.299     rillig    239: <dt><span class="sect2"><a href="#adding-to-list">15.3.1. Adding things to a list</a></span></dt>
                    240: <dt><span class="sect2"><a href="#echo-literal">15.3.2. Echoing a string exactly as-is</a></span></dt>
                    241: <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>
                    242: <dt><span class="sect2"><a href="#empty-variables">15.3.4. Handling possibly empty variables</a></span></dt>
1.106     rillig    243: </dl></dd>
                    244: </dl></dd>
1.299     rillig    245: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
1.106     rillig    246: <dd><dl>
1.299     rillig    247: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
                    248: <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>
                    249: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
                    250: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106     rillig    251: </dl></dd>
1.299     rillig    252: <dt><span class="chapter"><a href="#tools">17. Tools needed for building or running</a></span></dt>
1.106     rillig    253: <dd><dl>
1.299     rillig    254: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
                    255: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
                    256: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
                    257: </dl></dd>
                    258: <dt><span class="chapter"><a href="#buildlink">18. Buildlink methodology</a></span></dt>
                    259: <dd><dl>
                    260: <dt><span class="sect1"><a href="#converting-to-buildlink3">18.1. Converting packages to use buildlink3</a></span></dt>
                    261: <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    262: <dd><dl>
1.299     rillig    263: <dt><span class="sect2"><a href="#anatomy-of-bl3">18.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
                    264: <dt><span class="sect2"><a href="#updating-buildlink-depends">18.2.2. Updating
1.133     wiz       265:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                    266:       and
                    267:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                    268:       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106     rillig    269: </dl></dd>
1.299     rillig    270: <dt><span class="sect1"><a href="#writing-builtin.mk">18.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
                    271: <dd><dl>
                    272: <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>
                    273: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">18.3.2. Global preferences for native or pkgsrc software</a></span></dt>
                    274: </dl></dd>
                    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>
                    299: <dt><span class="sect2"><a href="#conf-files-patching">20.2.3. Patching installations</a></span></dt>
                    300: <dt><span class="sect2"><a href="#conf-files-disable">20.2.4. Disabling handling of configuration files</a></span></dt>
                    301: </dl></dd>
                    302: <dt><span class="sect1"><a href="#rcd-scripts">20.3. System startup scripts</a></span></dt>
                    303: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">20.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
                    304: <dt><span class="sect1"><a href="#users-and-groups">20.4. System users and groups</a></span></dt>
                    305: <dt><span class="sect1"><a href="#shells">20.5. System shells</a></span></dt>
                    306: <dd><dl><dt><span class="sect2"><a href="#shells-disable">20.5.1. Disabling shell registration</a></span></dt></dl></dd>
                    307: <dt><span class="sect1"><a href="#fonts">20.6. Fonts</a></span></dt>
                    308: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">20.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
1.267     rillig    309: </dl></dd>
                    310: <dt><span class="chapter"><a href="#fixes">21. Making your package work</a></span></dt>
                    311: <dd><dl>
                    312: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
                    313: <dd><dl>
                    314: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">21.1.1. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
                    315: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
                    316: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
                    317: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
                    318: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
                    319: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
                    320: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
                    321: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
                    322: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
                    323: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
                    324: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                    325: </dl></dd>
                    326: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                    327: <dd><dl>
                    328: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                    329: <dt><span class="sect2"><a href="#modified-distfiles-same-name">21.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
                    330: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
                    331: </dl></dd>
                    332: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                    333: <dd><dl>
                    334: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
                    335: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                    336: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
                    337: </dl></dd>
                    338: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
                    339: <dd><dl>
                    340: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
                    341: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
                    342: <dt><span class="sect2"><a href="#perl-scripts">21.4.3. Packages containing perl scripts</a></span></dt>
                    343: <dt><span class="sect2"><a href="#shell-scripts">21.4.4. Packages containing shell scripts</a></span></dt>
                    344: <dt><span class="sect2"><a href="#other-programming-languages">21.4.5. Other programming languages</a></span></dt>
                    345: </dl></dd>
                    346: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                    347: <dd><dl>
                    348: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
                    349: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.287     rillig    350: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
                    351: <dt><span class="sect2"><a href="#undefined-reference">21.5.4. Undefined reference to <span class="quote">&#8220;<span class="quote">...</span>&#8221;</span></a></span></dt>
                    352: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.267     rillig    353: </dl></dd>
                    354: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                    355: <dd><dl>
                    356: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
                    357: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
                    358: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
                    359: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
                    360: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
                    361: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing perl modules</a></span></dt>
                    362: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
                    363: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
                    364: <dt><span class="sect2"><a href="#gconf-data-files">21.6.9. Packages installing GConf data files</a></span></dt>
                    365: <dt><span class="sect2"><a href="#scrollkeeper-data-files">21.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
                    366: <dt><span class="sect2"><a href="#x11-fonts">21.6.11. Packages installing X11 fonts</a></span></dt>
                    367: <dt><span class="sect2"><a href="#gtk2-modules">21.6.12. Packages installing GTK2 modules</a></span></dt>
                    368: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.13. Packages installing SGML or XML data</a></span></dt>
                    369: <dt><span class="sect2"><a href="#mime-database">21.6.14. Packages installing extensions to the MIME database</a></span></dt>
                    370: <dt><span class="sect2"><a href="#intltool">21.6.15. Packages using intltool</a></span></dt>
                    371: <dt><span class="sect2"><a href="#startup-scripts">21.6.16. Packages installing startup scripts</a></span></dt>
                    372: <dt><span class="sect2"><a href="#tex-packages">21.6.17. Packages installing TeX modules</a></span></dt>
                    373: <dt><span class="sect2"><a href="#emulation-packages">21.6.18. Packages supporting running binaries in
1.87      wiz       374:     emulation</a></span></dt>
1.267     rillig    375: <dt><span class="sect2"><a href="#hicolor-theme">21.6.19. Packages installing hicolor theme icons</a></span></dt>
                    376: <dt><span class="sect2"><a href="#desktop-files">21.6.20. Packages installing desktop files</a></span></dt>
1.77      rillig    377: </dl></dd>
1.267     rillig    378: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.77      rillig    379: </dl></dd>
1.299     rillig    380: <dt><span class="chapter"><a href="#gnome">22. GNOME packaging and porting</a></span></dt>
                    381: <dd><dl>
                    382: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
                    383: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
                    384: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
                    385: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
                    386: </dl></dd>
1.267     rillig    387: <dt><span class="chapter"><a href="#submit">23. Submitting and Committing</a></span></dt>
1.77      rillig    388: <dd><dl>
1.267     rillig    389: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
                    390: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                    391: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
                    392: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
                    393: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
                    394: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
                    395: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
                    396: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
                    397: </dl></dd>
                    398: <dt><span class="chapter"><a href="#devfaq">24. Frequently Asked Questions</a></span></dt>
1.75      rillig    399: </dl></dd>
                    400: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
                    401: <dd><dl>
1.299     rillig    402: <dt><span class="chapter"><a href="#infr.design">25. Design of the pkgsrc infrastructure</a></span></dt>
1.75      rillig    403: <dd><dl>
1.299     rillig    404: <dt><span class="sect1"><a href="#infr.vardef">25.1. The meaning of variable definitions</a></span></dt>
                    405: <dt><span class="sect1"><a href="#infr.vardef.problems">25.2. Avoiding problems before they arise</a></span></dt>
                    406: <dt><span class="sect1"><a href="#infr.var">25.3. Variable evaluation</a></span></dt>
1.81      rillig    407: <dd><dl>
1.299     rillig    408: <dt><span class="sect2"><a href="#infr.var.load">25.3.1. At load time</a></span></dt>
                    409: <dt><span class="sect2"><a href="#infr.var.run">25.3.2. At runtime</a></span></dt>
1.81      rillig    410: </dl></dd>
1.299     rillig    411: <dt><span class="sect1"><a href="#infr.varspec">25.4. How can variables be specified?</a></span></dt>
                    412: <dt><span class="sect1"><a href="#infr.design.intf">25.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig    413: <dd><dl>
1.299     rillig    414: <dt><span class="sect2"><a href="#infr.design.intf.proc">25.5.1. Procedures with parameters</a></span></dt>
                    415: <dt><span class="sect2"><a href="#infr.design.intf.action">25.5.2. Actions taken on behalf of parameters</a></span></dt>
1.75      rillig    416: </dl></dd>
1.299     rillig    417: <dt><span class="sect1"><a href="#infr.order">25.6. The order in which files are loaded</a></span></dt>
1.75      rillig    418: <dd><dl>
1.299     rillig    419: <dt><span class="sect2"><a href="#infr.order.prefs">25.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
                    420: <dt><span class="sect2"><a href="#infr.order.pkg">25.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.75      rillig    421: </dl></dd>
                    422: </dl></dd>
1.299     rillig    423: <dt><span class="chapter"><a href="#regression">26. Regression tests</a></span></dt>
1.75      rillig    424: <dd><dl>
1.299     rillig    425: <dt><span class="sect1"><a href="#regression.run">26.1. Running the regression tests</a></span></dt>
                    426: <dt><span class="sect1"><a href="#regression.new">26.2. Adding a new regression test</a></span></dt>
1.75      rillig    427: <dd><dl>
1.299     rillig    428: <dt><span class="sect2"><a href="#regression.fun.override">26.2.1. Overridable functions</a></span></dt>
                    429: <dt><span class="sect2"><a href="#regression.fun.helper">26.2.2. Helper functions</a></span></dt>
1.75      rillig    430: </dl></dd>
                    431: </dl></dd>
1.299     rillig    432: <dt><span class="chapter"><a href="#porting">27. Porting pkgsrc</a></span></dt>
                    433: <dd><dl><dt><span class="sect1"><a href="#porting.opsys">27.1. Porting pkgsrc to a new operating system</a></span></dt></dl></dd>
1.75      rillig    434: </dl></dd>
                    435: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
                    436: <dd><dl>
                    437: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
                    438: <dd><dl>
                    439: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
                    440: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
                    441: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.287     rillig    442: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with pkglint</a></span></dt>
1.75      rillig    443: </dl></dd>
                    444: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
                    445: </dl></dd>
                    446: <dt><span class="appendix"><a href="#logs">B. Build logs</a></span></dt>
                    447: <dd><dl>
                    448: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
                    449: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
                    450: </dl></dd>
1.76      rillig    451: <dt><span class="appendix"><a href="#ftp-layout">C. Directory layout of the pkgsrc FTP server</a></span></dt>
                    452: <dd><dl>
1.128     wiz       453: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
                    454: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
                    455: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
                    456: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
                    457: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
1.261     leot      458: <code class="filename">stable</code>,
1.128     wiz       459: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76      rillig    460: source packages</a></span></dt>
                    461: </dl></dd>
1.267     rillig    462: <dt><span class="appendix"><a href="#help-topics">D. Help topics</a></span></dt>
                    463: <dt><span class="appendix"><a href="#editing">E. Editing guidelines for the pkgsrc guide</a></span></dt>
1.75      rillig    464: <dd><dl>
1.267     rillig    465: <dt><span class="sect1"><a href="#targets">E.1. Make targets</a></span></dt>
                    466: <dt><span class="sect1"><a href="#procedure">E.2. Procedure</a></span></dt>
1.75      rillig    467: </dl></dd>
                    468: </dl>
                    469: </div>
1.82      rillig    470: <div class="list-of-tables">
                    471: <p><b>List of Tables</b></p>
                    472: <dl>
                    473: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
                    474: </dt>
1.299     rillig    475: <dt>12.1. <a href="#patch-examples">Patching examples</a>
1.85      jmmv      476: </dt>
1.299     rillig    477: <dt>22.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.85      jmmv      478: </dt>
1.82      rillig    479: </dl>
                    480: </div>
1.148     asau      481: <div class="chapter">
                    482: <div class="titlepage"><div><div><h1 class="title">
                    483: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h1></div></div></div>
1.75      rillig    484: <div class="toc">
                    485: <p><b>Table of Contents</b></p>
1.210     leot      486: <dl class="toc">
1.75      rillig    487: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82      rillig    488: <dd><dl>
                    489: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
                    490: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
                    491: </dl></dd>
1.75      rillig    492: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
                    493: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88      wiz       494: <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    495: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
                    496: </dl>
                    497: </div>
1.148     asau      498: <div class="sect1">
1.75      rillig    499: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    500: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
1.82      rillig    501: <p>There is a lot of software freely available for Unix-based
                    502: systems, which is usually available in form of the source code. Before
                    503: such software can be used, it needs to be configured to the local
                    504: system, compiled and installed, and this is exactly what The NetBSD
                    505: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
                    506: to handle binary packages, so that not every user has to build the
                    507: packages for himself, which is a time-costly task.</p>
1.75      rillig    508: <p>pkgsrc currently contains several thousand packages,
                    509:       including:</p>
1.148     asau      510: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.250     leot      511: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache24/README.html" target="_top"><code class="filename">www/apache24</code></a> - The Apache
1.75      rillig    512:          web server</p></li>
1.250     leot      513: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a> - The Firefox
1.75      rillig    514:          web browser</p></li>
1.250     leot      515: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome/README.html" target="_top"><code class="filename">meta-pkgs/gnome</code></a> - The GNOME
1.75      rillig    516:          Desktop Environment</p></li>
1.250     leot      517: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde4/README.html" target="_top"><code class="filename">meta-pkgs/kde4</code></a> - The K
1.75      rillig    518:          Desktop Environment</p></li>
                    519: </ul></div>
1.219     rillig    520: <p>&#8230; just to name a few.</p>
1.75      rillig    521: <p>pkgsrc has built-in support for handling varying dependencies,
                    522:       such as pthreads and X11, and extended features such as IPv6 support on
                    523:       a range of platforms.</p>
1.148     asau      524: <div class="sect2">
1.82      rillig    525: <div class="titlepage"><div><div><h3 class="title">
                    526: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
                    527: <p>
                    528: pkgsrc provides the following key features:
                    529: </p>
1.148     asau      530: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz       531: <li class="listitem"><p>Easy building of software from source as well as the creation
1.82      rillig    532:   and installation of binary packages. The source and latest
                    533:   patches are retrieved from a master or mirror download site, checksum
                    534:   verified, then built on your system. Support for binary-only
                    535:   distributions is available for both native platforms and NetBSD
                    536:   emulated platforms.</p></li>
1.128     wiz       537: <li class="listitem"><p>All packages are installed in a consistent directory tree,
1.82      rillig    538:   including binaries, libraries, man pages and other
                    539:   documentation.</p></li>
1.214     sevan     540: <li class="listitem"><p>Tracking of package dependencies automatically, including when
                    541:   performing updates, to ensure required packages are installed. The
                    542:   configuration files of various packages are handled automatically during
                    543:   updates, so local changes are preserved.</p></li>
1.128     wiz       544: <li class="listitem"><p>Like NetBSD, pkgsrc is designed with portability in mind and
1.82      rillig    545:   consists of highly portable code. This allows the greatest speed of
1.132     spz       546:   development when porting to a new platform. This portability also
1.82      rillig    547:   ensures that pkgsrc is <span class="emphasis"><em>consistent across all
                    548:   platforms</em></span>.</p></li>
1.128     wiz       549: <li class="listitem"><p>The installation prefix, acceptable software licenses,
1.82      rillig    550:   international encryption requirements and build-time options for a
                    551:   large number of packages are all set in a simple, central
                    552:   configuration file.</p></li>
1.128     wiz       553: <li class="listitem"><p>The entire source (not including the distribution files) is
1.82      rillig    554:   freely available under a BSD license, so you may extend and adapt
                    555:   pkgsrc to your needs. Support for local packages and patches is
                    556:   available right out of the box, so you can configure it specifically
                    557:   for your environment.</p></li>
                    558: </ul></div>
1.91      rillig    559: <p>The following principles are basic to pkgsrc:</p>
1.148     asau      560: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz       561: <li class="listitem"><p><span class="quote">&#8220;<span class="quote">It should only work if it's right.</span>&#8221;</span>
1.126     jakllsch  562: &mdash; That means, if a package contains bugs, it's better to find
1.91      rillig    563: them and to complain about them rather than to just install the package
                    564: and hope that it works. There are numerous checks in pkgsrc that try to
1.290     gutterid  565: find such bugs: static analysis tools (<a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>), build-time checks (portability
1.91      rillig    566: of shell scripts), and post-installation checks (installed files,
                    567: references to shared libraries, script interpreters).</p></li>
1.128     wiz       568: <li class="listitem"><p><span class="quote">&#8220;<span class="quote">If it works, it should work everywhere</span>&#8221;</span>
1.126     jakllsch  569: &mdash; Like NetBSD has been ported to many hardware architectures,
1.91      rillig    570: pkgsrc has been ported to many operating systems. Care is taken that
                    571: packages behave the same on all platforms.</p></li>
                    572: </ul></div>
1.82      rillig    573: </div>
1.148     asau      574: <div class="sect2">
1.82      rillig    575: <div class="titlepage"><div><div><h3 class="title">
                    576: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
                    577: <p>pkgsrc consists of both a source distribution and a binary
                    578: distribution for these operating systems. After retrieving the required
                    579: source or binaries, you can be up and running with pkgsrc in just
                    580: minutes!</p>
1.75      rillig    581: <p>pkgsrc was derived from FreeBSD's ports system, and
                    582:       initially developed for NetBSD only. Since then, pkgsrc has
                    583:       grown a lot, and now supports the following platforms:</p>
1.82      rillig    584: <div class="table">
                    585: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.216     tnn       586: <div class="table-contents"><table class="table" summary="Platforms supported by pkgsrc" border="1">
1.82      rillig    587: <colgroup>
                    588: <col>
                    589: <col>
1.202     sevan     590: <col>
1.82      rillig    591: </colgroup>
                    592: <thead><tr>
                    593: <th>Platform</th>
                    594: <th>Date Support Added</th>
1.202     sevan     595: <th>Notes</th>
1.82      rillig    596: </tr></thead>
                    597: <tbody>
                    598: <tr>
1.289     leot      599: <td><a class="ulink" href="https://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.82      rillig    600: <td align="center">Aug 1997</td>
1.202     sevan     601: <td class="auto-generated"> </td>
1.82      rillig    602: </tr>
                    603: <tr>
1.110     hubertf   604: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.82      rillig    605: <td align="center">Mar 1999</td>
1.264     sevan     606: <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    607: </tr>
                    608: <tr>
1.289     leot      609: <td><a class="ulink" href="https://www.kernel.org/" target="_top">Linux</a></td>
1.82      rillig    610: <td align="center">Jun 1999</td>
1.264     sevan     611: <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    612: </tr>
                    613: <tr>
                    614: <td>
1.230     sevan     615:           <a class="ulink" href="https://developer.apple.com/macos/" target="_top">Darwin / Mac OS X / OS X / macOS</a>
1.82      rillig    616:         </td>
                    617: <td align="center">Oct 2001</td>
1.305     bacon     618: <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    619: </tr>
                    620: <tr>
1.289     leot      621: <td><a class="ulink" href="https://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.82      rillig    622: <td align="center">Nov 2002</td>
1.264     sevan     623: <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    624: </tr>
                    625: <tr>
1.289     leot      626: <td><a class="ulink" href="https://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.82      rillig    627: <td align="center">Nov 2002</td>
1.264     sevan     628: <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    629: </tr>
                    630: <tr>
1.289     leot      631: <td><a class="ulink" href="https://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.82      rillig    632: <td align="center">Dec 2002</td>
1.202     sevan     633: <td>
1.264     sevan     634:        <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.IRIX" target="_top">README.IRIX</a>
                    635:        <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.IRIX5.3" target="_top">README.IRIX5.3</a>
1.202     sevan     636:        </td>
1.82      rillig    637: </tr>
                    638: <tr>
                    639: <td>BSD/OS</td>
                    640: <td align="center">Dec 2003</td>
1.202     sevan     641: <td class="auto-generated"> </td>
1.82      rillig    642: </tr>
                    643: <tr>
1.289     leot      644: <td><a class="ulink" href="https://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.82      rillig    645: <td align="center">Dec 2003</td>
1.264     sevan     646: <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    647: </tr>
                    648: <tr>
                    649: <td>
1.289     leot      650:           <a class="ulink" href="https://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.82      rillig    651:           (Microsoft Windows Services for Unix)
                    652:         </td>
                    653: <td align="center">Mar 2004</td>
1.264     sevan     654: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Interix" target="_top">README.Interix</a></td>
1.82      rillig    655: </tr>
                    656: <tr>
1.289     leot      657: <td><a class="ulink" href="https://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.82      rillig    658: <td align="center">Oct 2004</td>
1.202     sevan     659: <td class="auto-generated"> </td>
1.82      rillig    660: </tr>
                    661: <tr>
1.110     hubertf   662: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.82      rillig    663: <td align="center">Nov 2004</td>
1.264     sevan     664: <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    665: </tr>
1.98      wiz       666: <tr>
1.289     leot      667: <td><a class="ulink" href="https://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.98      wiz       668: <td align="center">Apr 2007</td>
1.264     sevan     669: <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       670: </tr>
1.128     wiz       671: <tr>
1.289     leot      672: <td><a class="ulink" href="https://www.haiku-os.org/" target="_top">Haiku</a></td>
1.128     wiz       673: <td align="center">Sep 2010</td>
1.264     sevan     674: <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       675: </tr>
1.151     obache    676: <tr>
1.289     leot      677: <td><a class="ulink" href="https://www.mirbsd.org/" target="_top">MirBSD</a></td>
1.163     bsiegert  678: <td align="center">Jan 2011</td>
1.202     sevan     679: <td class="auto-generated"> </td>
1.151     obache    680: </tr>
                    681: <tr>
1.289     leot      682: <td><a class="ulink" href="https://www.minix3.org/" target="_top">Minix3</a></td>
1.151     obache    683: <td align="center">Nov 2011</td>
1.264     sevan     684: <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    685: </tr>
                    686: <tr>
1.289     leot      687: <td><a class="ulink" href="https://cygwin.com/" target="_top">Cygwin</a></td>
1.151     obache    688: <td align="center">Mar 2013</td>
1.264     sevan     689: <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    690: </tr>
1.166     jnemeth   691: <tr>
1.289     leot      692: <td><a class="ulink" href="https://www.debian.org/ports/kfreebsd-gnu/" target="_top">GNU/kFreeBSD</a></td>
1.166     jnemeth   693: <td align="center">Jul 2013</td>
1.264     sevan     694: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.GNUkFreeBSD" target="_top">README.GNUkFreeBSD</a></td>
1.166     jnemeth   695: </tr>
1.214     sevan     696: <tr>
1.289     leot      697: <td><a class="ulink" href="https://www.bitrig.org/" target="_top">Bitrig</a></td>
1.214     sevan     698: <td align="center">Jun 2014</td>
1.264     sevan     699: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Bitrig" target="_top">README.Bitrig</a></td>
1.214     sevan     700: </tr>
1.82      rillig    701: </tbody>
1.91      rillig    702: </table></div>
1.82      rillig    703: </div>
1.91      rillig    704: <br class="table-break">
1.82      rillig    705: </div>
1.75      rillig    706: </div>
1.148     asau      707: <div class="sect1">
1.75      rillig    708: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    709: <a name="overview"></a>1.2. Overview</h2></div></div></div>
                    710: <p>This document is divided into three parts. The first,
1.110     hubertf   711:        <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.75      rillig    712:        describes how one can use one of the packages in the Package
                    713:        Collection, either by installing a precompiled binary package,
1.93      rillig    714:        or by building one's own copy using the NetBSD package system.
1.110     hubertf   715:        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    716:        package so it can be easily built by other NetBSD users without
                    717:        knowing about the package's building details. The third part,
1.110     hubertf   718:        <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.75      rillig    719:        is intended for those who want to understand how pkgsrc is
                    720:        implemented.</p>
                    721: <p>This document is available in various formats:
1.110     hubertf   722:        <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    723: </div>
1.148     asau      724: <div class="sect1">
1.75      rillig    725: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    726: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
1.128     wiz       727: <p>There has been a lot of talk about <span class="quote">&#8220;<span class="quote">ports</span>&#8221;</span>,
                    728:       <span class="quote">&#8220;<span class="quote">packages</span>&#8221;</span>, etc. so far. Here is a description of all the
1.75      rillig    729:       terminology used within this document.</p>
1.148     asau      730: <div class="variablelist"><dl class="variablelist">
1.75      rillig    731: <dt><span class="term">Package</span></dt>
                    732: <dd><p>A set of files and building instructions
                    733:            that describe what's necessary
                    734:            to build a certain piece of software using
                    735:             pkgsrc. Packages are traditionally stored under
1.236     wiz       736:            <code class="filename">/usr/pkgsrc</code>,
                    737:            but may be stored in any location,
                    738:            referred to as <code class="varname">PKGSRCDIR</code>.</p></dd>
1.75      rillig    739: <dt><span class="term">The NetBSD package system</span></dt>
1.128     wiz       740: <dd><p>This is the former name of <span class="quote">&#8220;<span class="quote">pkgsrc</span>&#8221;</span>.  It
1.87      wiz       741:          is part of the NetBSD operating system and can be bootstrapped
                    742:          to run on non-NetBSD operating systems as well.  It handles
                    743:          building (compiling), installing, and removing of
                    744:          packages.</p></dd>
1.75      rillig    745: <dt><span class="term">Distfile</span></dt>
                    746: <dd><p>This term describes the file or files that are
                    747:            provided by the author of the piece of software to
                    748:            distribute his work. All the changes necessary to build on
                    749:            NetBSD are reflected in the corresponding package. Usually
                    750:            the distfile is in the form of a compressed tar-archive,
                    751:            but other types are possible, too. Distfiles are usually
                    752:            stored below
1.76      rillig    753:            <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
1.75      rillig    754: <dt><span class="term">Port</span></dt>
                    755: <dd><p>This is the term used by FreeBSD and OpenBSD people
                    756:            for what we call a package.
1.128     wiz       757:            In NetBSD terminology, <span class="quote">&#8220;<span class="quote">port</span>&#8221;</span> refers to a different
1.75      rillig    758:            architecture.</p></dd>
                    759: <dt><span class="term">Precompiled/binary package</span></dt>
                    760: <dd>
                    761: <p>A set of binaries built with pkgsrc from a distfile
1.76      rillig    762:            and stuffed together in a single <code class="filename">.tgz</code>
1.75      rillig    763:            file so it can be installed on machines of the same
                    764:            machine architecture without the need to
                    765:            recompile. Packages are usually generated in
1.76      rillig    766:            <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.132     spz       767:            an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.128     wiz       768: <p>Sometimes, this is referred to by the term <span class="quote">&#8220;<span class="quote">package</span>&#8221;</span> too,
1.75      rillig    769:            especially in the context of precompiled packages.</p>
                    770: </dd>
                    771: <dt><span class="term">Program</span></dt>
1.88      wiz       772: <dd><p>The piece of software to be installed which will be
                    773:          constructed from all the files in the distfile by the
                    774:          actions defined in the corresponding package.</p></dd>
1.75      rillig    775: </dl></div>
1.148     asau      776: <div class="sect2">
1.75      rillig    777: <div class="titlepage"><div><div><h3 class="title">
1.88      wiz       778: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.148     asau      779: <div class="variablelist"><dl class="variablelist">
1.75      rillig    780: <dt><span class="term">pkgsrc users</span></dt>
                    781: <dd>
                    782: <p>The
                    783:        pkgsrc users are people who use the packages provided by pkgsrc.
                    784:        Typically they are system administrators. The people using the
1.128     wiz       785:        software that is inside the packages (maybe called <span class="quote">&#8220;<span class="quote">end
                    786:        users</span>&#8221;</span>) are not covered by the pkgsrc guide.</p>
1.75      rillig    787: <p>There are two kinds of pkgsrc users: Some only want to
                    788:        install pre-built binary packages. Others build the pkgsrc
                    789:        packages from source, either for installing them directly or for
1.110     hubertf   790:        building binary packages themselves. For pkgsrc users <a class="xref" href="#users-guide" title="Part I. The pkgsrc user's guide">Part I, &#8220;The pkgsrc user's guide&#8221;</a> should provide all necessary
1.75      rillig    791:        documentation.</p>
                    792: </dd>
                    793: <dt><span class="term">package maintainers</span></dt>
                    794: <dd><p>A
1.110     hubertf   795:        package maintainer creates packages as described in <a class="xref" href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, &#8220;The pkgsrc developer's guide&#8221;</a>.</p></dd>
1.75      rillig    796: <dt><span class="term">infrastructure developers</span></dt>
                    797: <dd><p>These people are involved in all those files
1.76      rillig    798:        that live in the <code class="filename">mk/</code> directory and below.
1.110     hubertf   799:        Only these people should need to read through <a class="xref" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">Part III, &#8220;The pkgsrc infrastructure internals&#8221;</a>, though others might be curious,
1.75      rillig    800:        too.</p></dd>
                    801: </dl></div>
                    802: </div>
                    803: </div>
1.148     asau      804: <div class="sect1">
1.75      rillig    805: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    806: <a name="typography"></a>1.4. Typography</h2></div></div></div>
                    807: <p>When giving examples for commands, shell prompts are used to
                    808:       show if the command should/can be issued as root, or if
1.128     wiz       809:       <span class="quote">&#8220;<span class="quote">normal</span>&#8221;</span> user privileges are sufficient. We use a
1.226     sevan     810:       <code class="prompt">#</code> for root's shell prompt, a <code class="prompt">%</code> for users'
                    811:       shell prompt, assuming they use the C-shell or tcsh and a <code class="prompt">$</code> for
                    812:       bourne shell and derivatives.</p>
1.75      rillig    813: </div>
                    814: </div>
1.148     asau      815: <div class="part">
1.75      rillig    816: <div class="titlepage"><div><div><h1 class="title">
                    817: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
                    818: <div class="toc">
                    819: <p><b>Table of Contents</b></p>
1.210     leot      820: <dl class="toc">
1.267     rillig    821: <dt><span class="chapter"><a href="#help-user">2. Getting help</a></span></dt>
                    822: <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    823: <dd><dl>
1.267     rillig    824: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.75      rillig    825: <dd><dl>
1.267     rillig    826: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
                    827: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.75      rillig    828: </dl></dd>
1.267     rillig    829: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.75      rillig    830: <dd><dl>
1.267     rillig    831: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
                    832: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.75      rillig    833: </dl></dd>
                    834: </dl></dd>
1.267     rillig    835: <dt><span class="chapter"><a href="#platforms">4. Using pkgsrc on systems other than NetBSD</a></span></dt>
1.75      rillig    836: <dd><dl>
1.267     rillig    837: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
                    838: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.75      rillig    839: </dl></dd>
1.267     rillig    840: <dt><span class="chapter"><a href="#using">5. Using pkgsrc</a></span></dt>
1.75      rillig    841: <dd><dl>
1.267     rillig    842: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.75      rillig    843: <dd><dl>
1.267     rillig    844: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
                    845: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
1.317   ! nia       846: <dt><span class="sect2"><a href="#using.pkgin_update">5.1.3. Updating packages</a></span></dt>
        !           847: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.4. Deinstalling packages</a></span></dt>
        !           848: <dt><span class="sect2"><a href="#using.pkg_info">5.1.5. Getting information about installed packages</a></span></dt>
        !           849: <dt><span class="sect2"><a href="#vulnerabilities">5.1.6. Checking for security vulnerabilities in installed packages</a></span></dt>
        !           850: <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>
        !           851: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.8. Other administrative functions</a></span></dt>
1.75      rillig    852: </dl></dd>
1.267     rillig    853: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1.75      rillig    854: <dd><dl>
1.267     rillig    855: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
                    856: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
                    857: <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    858: </dl></dd>
                    859: </dl></dd>
1.267     rillig    860: <dt><span class="chapter"><a href="#configuring">6. Configuring pkgsrc</a></span></dt>
1.75      rillig    861: <dd><dl>
1.267     rillig    862: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
                    863: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
                    864: <dt><span class="sect1"><a href="#variables-affecting-installation">6.3. Variables affecting the installation process</a></span></dt>
                    865: <dt><span class="sect1"><a href="#conf.compiler">6.4. Selecting and configuring the compiler</a></span></dt>
1.88      wiz       866: <dd><dl>
1.267     rillig    867: <dt><span class="sect2"><a href="#selecting-the-compiler">6.4.1. Selecting the compiler</a></span></dt>
                    868: <dt><span class="sect2"><a href="#conf.cflags">6.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                    869: <dt><span class="sect2"><a href="#conf.ldflags">6.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.88      wiz       870: </dl></dd>
1.267     rillig    871: <dt><span class="sect1"><a href="#developer-advanced-settings">6.5. Developer/advanced settings</a></span></dt>
                    872: <dt><span class="sect1"><a href="#selecting-build-options">6.6. Selecting Build Options</a></span></dt>
1.75      rillig    873: </dl></dd>
1.267     rillig    874: <dt><span class="chapter"><a href="#binary">7. Creating binary packages</a></span></dt>
1.75      rillig    875: <dd><dl>
1.267     rillig    876: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
                    877: <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    878: </dl></dd>
1.267     rillig    879: <dt><span class="chapter"><a href="#bulk">8. Creating binary packages for everything in pkgsrc (bulk
1.106     rillig    880: builds)</a></span></dt>
1.75      rillig    881: <dd><dl>
1.267     rillig    882: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
1.295     rillig    883: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a bulk build</a></span></dt>
1.267     rillig    884: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
                    885: <dt><span class="sect1"><a href="#bulk.req">8.3. Requirements of a full bulk build</a></span></dt>
1.293     rillig    886: <dt><span class="sect1"><a href="#bulk.var">8.4. Bulk build variants</a></span></dt>
                    887: <dd><dl>
1.294     rillig    888: <dt><span class="sect2"><a href="#bulk.var.confopt">8.4.1. Detect unknown configure options</a></span></dt>
                    889: <dt><span class="sect2"><a href="#bulk.var.comperr">8.4.2. Detect classes of bugs by forcing compiler warnings</a></span></dt>
1.296     rillig    890: <dt><span class="sect2"><a href="#bulk.var.builderr">8.4.3. Force compiler options only in the build phase</a></span></dt>
                    891: <dt><span class="sect2"><a href="#bulk.var.dirs">8.4.4. Use custom directories</a></span></dt>
                    892: <dt><span class="sect2"><a href="#bulk.var.warn">8.4.5. Turn warnings into errors</a></span></dt>
                    893: <dt><span class="sect2"><a href="#bulk.var.pkglint">8.4.6. Reject packages for which pkglint reports errors</a></span></dt>
                    894: <dt><span class="sect2"><a href="#bulk.var.strings">8.4.7. Reject packages that contain forbidden strings</a></span></dt>
                    895: <dt><span class="sect2"><a href="#bulk.var.test">8.4.8. Reject packages whose self-test fails</a></span></dt>
                    896: <dt><span class="sect2"><a href="#bulk.var.shvar">8.4.9. Reject packages that use undefined shell variables</a></span></dt>
                    897: <dt><span class="sect2"><a href="#bulk.var.quiet">8.4.10. Turn off verbose logging</a></span></dt>
1.293     rillig    898: </dl></dd>
                    899: <dt><span class="sect1"><a href="#creating-cdroms">8.5. Creating a multiple CD-ROM packages collection</a></span></dt>
                    900: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.5.1. Example of cdpack</a></span></dt></dl></dd>
1.267     rillig    901: </dl></dd>
                    902: <dt><span class="chapter"><a href="#files">9. Directory layout of the installed files</a></span></dt>
                    903: <dd><dl>
                    904: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
                    905: <dt><span class="sect1"><a href="#files.varbase">9.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
                    906: </dl></dd>
                    907: <dt><span class="chapter"><a href="#faq">10. Frequently Asked Questions</a></span></dt>
                    908: <dd><dl>
                    909: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                    910: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
                    911: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
                    912: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
                    913: <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>
                    914: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
                    915: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
                    916: <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>
                    917: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
                    918: <dt><span class="sect1"><a href="#tmac.andoc-missing">10.10. What does <span class="quote">&#8220;<span class="quote">Don't know how to make
1.128     wiz       919: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</a></span></dt>
1.267     rillig    920: <dt><span class="sect1"><a href="#bsd.own.mk-missing">10.11. What does <span class="quote">&#8220;<span class="quote">Could not find bsd.own.mk</span>&#8221;</span> mean?</a></span></dt>
                    921: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' with pkgsrc</a></span></dt>
                    922: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
                    923: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
                    924: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
                    925: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build.  What shall I do?</a></span></dt>
                    926: <dt><span class="sect1"><a href="#faq.rcs-conflicts">10.17. What does <span class="quote">&#8220;<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>&#8221;</span> mean?</a></span></dt>
1.75      rillig    927: </dl></dd>
                    928: </dl>
                    929: </div>
1.148     asau      930: <div class="chapter">
1.75      rillig    931: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig    932: <a name="help-user"></a>Chapter 2. Getting help</h2></div></div></div>
                    933: <p>
                    934:        To get help when using pkgsrc, the definitive source is this
                    935:        document, the pkgsrc guide. If you don't find anything here,
                    936:        there are alternatives:
                    937: </p>
                    938: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                    939: <li class="listitem">
                    940: <p>
                    941:        The built-in pkgsrc help, which is available after bootstrapping
                    942:        pkgsrc. Run <span class="command"><strong>bmake help topic=&#8230;</strong></span> to get
                    943:        help for any topic, such as a variable name like
                    944:        <code class="varname">BUILD_DEFS</code>, a make target like
                    945:        <span class="command"><strong>do-build</strong></span>, a missing C or C++ function like
                    946:        <span class="command"><strong>strcasecmp</strong></span> or any other topic.</p>
                    947: <p>The available help topics are listed in <a class="xref" href="#help-topics" title="Appendix D. Help topics">Appendix D, <i>Help topics</i></a>.</p>
                    948: </li>
                    949: <li class="listitem"><p>
1.278     rillig    950:        To see the value of a single variable, run <span class="command"><strong>bmake
                    951:        show-var VARNAME=<em class="replaceable"><code>X</code></em></strong></span>.
                    952: </p></li>
                    953: <li class="listitem"><p>
                    954:        To see the values of the most common variables, run
                    955:        <span class="command"><strong>bmake show-all</strong></span>. These variables are grouped by
                    956:        topic. To see the variables for a single topic, run
                    957:        <span class="command"><strong>bmake
                    958:        show-all-<em class="replaceable"><code>topic</code></em></strong></span>, for example
                    959:        <span class="command"><strong>bmake show-all-fetch</strong></span>.
                    960: </p></li>
                    961: <li class="listitem"><p>
1.267     rillig    962:        The pkgsrc-users mailing list, to which
                    963:        <a class="ulink" href="https://www.NetBSD.org/mailinglists/#pkgsrc-users" target="_top">you
                    964:        can subscribe</a> and then <a class="ulink" href="mailto:pkgsrc-users@NetBSD.org" target="_top">ask your
                    965:        questions</a>.</p></li>
                    966: <li class="listitem"><p>The #pkgsrc IRC channel, which is accessible
                    967:        <a class="ulink" href="https://webchat.freenode.net/" target="_top">via a web browser</a>
                    968:        or by using a specialized chat program such as
                    969:        <a class="ulink" href="http://xchat.org/" target="_top">XChat</a>.
                    970:        Pick any user name and join the channel #pkgsrc.</p></li>
                    971: </ul></div>
                    972: </div>
                    973: <div class="chapter">
                    974: <div class="titlepage"><div><div><h2 class="title">
                    975: <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    976: <div class="toc">
                    977: <p><b>Table of Contents</b></p>
1.210     leot      978: <dl class="toc">
1.267     rillig    979: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.75      rillig    980: <dd><dl>
1.267     rillig    981: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
                    982: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.75      rillig    983: </dl></dd>
1.267     rillig    984: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.75      rillig    985: <dd><dl>
1.267     rillig    986: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
                    987: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.75      rillig    988: </dl></dd>
                    989: </dl>
                    990: </div>
1.91      rillig    991: <p>Before you download and extract the files, you need to decide
                    992: where you want to extract them. When using pkgsrc as root user, pkgsrc
                    993: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
                    994: free to install the sources and binary packages wherever you want in
                    995: your filesystem, provided that the pathname does not contain white-space
                    996: or other characters that are interpreted specially by the shell and some
                    997: other programs. A safe bet is to use only letters, digits, underscores
                    998: and dashes.</p>
1.148     asau      999: <div class="sect1">
1.75      rillig   1000: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1001: <a name="getting-first"></a>3.1. Getting pkgsrc for the first time</h2></div></div></div>
1.75      rillig   1002: <p>Before you download any pkgsrc files, you should decide
                   1003:        whether you want the <span class="emphasis"><em>current</em></span> branch or the
                   1004:        <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
                   1005:        quarterly basis from the current branch and only gets modified
                   1006:        for security updates. The names of the stable branches are built
                   1007:        from the year and the quarter, for example
1.313     leot     1008:        <code class="literal">2021Q1</code>.</p>
1.75      rillig   1009: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
1.128     wiz      1010:        want to download pkgsrc. You can get it as a tar file or via CVS.
                   1011:        Both ways are described here.</p>
1.157     asau     1012: <p>Note that tar archive contains CVS working copy.
                   1013:        Thus you can switch to using CVS at any later time.</p>
1.148     asau     1014: <div class="sect2">
1.75      rillig   1015: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1016: <a name="getting-via-tar"></a>3.1.1. As tar archive</h3></div></div></div>
1.75      rillig   1017: <p>The primary download location for all pkgsrc files is
1.264     sevan    1018:        <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/" target="_top">https://cdn.NetBSD.org/pub/pkgsrc/</a> or
1.157     asau     1019:        <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>
                   1020:        (it points to the same location).
                   1021:        There are a number of subdirectories for different purposes,
                   1022:        which are described in detail in <a class="xref" href="#ftp-layout" title="Appendix C. Directory layout of the pkgsrc FTP server">Appendix C, <i>Directory layout of the pkgsrc FTP server</i></a>.</p>
                   1023: <p>The tar archive for the current branch is in the directory
1.264     sevan    1024:        <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    1025:        It is autogenerated weekly.</p>
1.157     asau     1026: <p>To save download time we provide bzip2- and
                   1027:        xz-compressed archives which are published at
1.264     sevan    1028:        <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     1029:        and
1.264     sevan    1030:        <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     1031:        respectively.
                   1032:        </p>
                   1033: <p>You can fetch the same files using FTP.</p>
1.313     leot     1034: <p>The tar file for the stable branch 2021Q1 is in the
                   1035:        directory <code class="filename">pkgsrc-2021Q1</code> and is also called <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/pkgsrc-2021Q1/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.</p>
1.249     leot     1036: <p>To download the latest pkgsrc stable tarball, run:</p>
1.112     weinem   1037: <pre class="screen">
1.313     leot     1038: <code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2021Q1/pkgsrc.tar.gz</code></strong></pre>
1.188     snj      1039: <p>If you prefer, you can also fetch it using "wget", "curl",
1.157     asau     1040:        or your web browser.</p>
1.112     weinem   1041: <p>Then, extract it with:</p>
1.188     snj      1042: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf pkgsrc.tar.gz -C /usr</code></strong></pre>
1.112     weinem   1043: <p>This will create the directory <code class="filename">pkgsrc/</code>
                   1044:        in <code class="filename">/usr/</code> and all the package source will be 
                   1045:        stored under <code class="filename">/usr/pkgsrc/</code>.</p>
                   1046: <p>To download pkgsrc-current, run:</p>
                   1047: <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   1048: </div>
1.148     asau     1049: <div class="sect2">
1.75      rillig   1050: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1051: <a name="getting-via-cvs"></a>3.1.2. Via anonymous CVS</h3></div></div></div>
1.128     wiz      1052: <p>To fetch a specific pkgsrc stable branch, run:</p>
1.313     leot     1053: <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-2021Q1 -P pkgsrc</code></strong>
1.128     wiz      1054: </pre>
                   1055: <p>This will create the directory <code class="filename">pkgsrc/</code> 
                   1056:        in your <code class="filename">/usr/</code> directory and all the package source 
                   1057:        will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
                   1058: <p>To fetch the pkgsrc current branch, run:</p>
1.146     wiz      1059: <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    1060: </pre>
1.289     leot     1061: <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      1062: <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      1063: <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      1064: </pre>
                   1065: <p>Refer to documentation on your command shell how to set CVS_RSH=ssh permanently.
                   1066:        For Bourne shells, you can set it in your <code class="filename">.profile</code>
                   1067:        or better globally in <code class="filename">/etc/profile</code>:</p>
                   1068: <pre class="programlisting">
                   1069: # set CVS remote shell command
                   1070: CVS_RSH=ssh
                   1071: export CVS_RSH
                   1072: </pre>
                   1073: <p>By default, CVS doesn't do things like most people would expect it to do.
                   1074:        But there is a way to convince CVS, by creating a file called <code class="filename">.cvsrc</code>
                   1075:        in your home directory and saving the following lines to it.
                   1076:        This file will save you lots of headache and some bug reports, so we strongly recommend it.
                   1077:        You can find an explanation of this file in the CVS documentation.</p>
1.101     rillig   1078: <pre class="programlisting">
                   1079: # recommended CVS configuration file from the pkgsrc guide
1.268     sevan    1080: cvs -q
1.101     rillig   1081: checkout -P
1.103     wiz      1082: update -dP
                   1083: diff -upN
1.101     rillig   1084: rdiff -u
1.128     wiz      1085: release -d
1.101     rillig   1086: </pre>
1.75      rillig   1087: </div>
                   1088: </div>
1.148     asau     1089: <div class="sect1">
1.75      rillig   1090: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1091: <a name="uptodate"></a>3.2. Keeping pkgsrc up-to-date</h2></div></div></div>
1.75      rillig   1092: <p>The preferred way to keep pkgsrc up-to-date is via CVS
                   1093:        (which also works if you have first installed it via a tar
                   1094:        file). It saves bandwidth and hard disk activity, compared to
                   1095:        downloading the tar file again.</p>
1.148     asau     1096: <div class="sect2">
1.75      rillig   1097: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1098: <a name="uptodate-tar"></a>3.2.1. Via tar files</h3></div></div></div>
1.148     asau     1099: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   1100: <h3 class="title">Warning</h3>
1.77      rillig   1101: <p>When updating from a tar file, you first need to
                   1102:        completely remove the old pkgsrc directory. Otherwise those
                   1103:        files that have been removed from pkgsrc in the mean time will
                   1104:        not be removed on your local disk, resulting in inconsistencies.
                   1105:        When removing the old files, any changes that you have done to
                   1106:        the pkgsrc files will be lost after updating. Therefore updating
                   1107:        via CVS is strongly recommended.</p>
1.75      rillig   1108: </div>
1.82      rillig   1109: <p>Note that by default the distfiles and the binary packages
                   1110:        are saved in the pkgsrc tree, so don't forget to rescue them
1.188     snj      1111:        before updating. You can also configure pkgsrc to store distfiles
                   1112:         and packages in directories outside the pkgsrc tree by setting the
1.82      rillig   1113:        <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.267     rillig   1114:        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   1115: <p>To update pkgsrc from a tar file, download the tar file as
                   1116:        explained above. Then, make sure that you have not made any
                   1117:        changes to the files in the pkgsrc directory. Remove the pkgsrc
                   1118:        directory and extract the new tar file. Done.</p>
                   1119: </div>
1.148     asau     1120: <div class="sect2">
1.75      rillig   1121: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1122: <a name="uptodate-cvs"></a>3.2.2. Via CVS</h3></div></div></div>
1.132     spz      1123: <p>To update pkgsrc via CVS, change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
                   1124: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc &amp;&amp; cvs update -dP</code></strong>
                   1125: </pre>
                   1126: <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>
                   1127: <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>
                   1128: </pre>
1.148     asau     1129: <div class="sect3">
1.75      rillig   1130: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   1131: <a name="uptodate-cvs-switch"></a>3.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1.75      rillig   1132: <p>When updating pkgsrc, the CVS program keeps track of the
                   1133:        branch you selected. But if you, for whatever reason, want to
                   1134:        switch from the stable branch to the current one, you can do it
1.128     wiz      1135:        by adding the option <span class="quote">&#8220;<span class="quote">-A</span>&#8221;</span> after the
                   1136:        <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> keyword. To switch from the current branch
1.75      rillig   1137:        back to the stable branch, add the
1.313     leot     1138:        <span class="quote">&#8220;<span class="quote">-rpkgsrc-2021Q1</span>&#8221;</span> option.</p>
1.75      rillig   1139: </div>
1.148     asau     1140: <div class="sect3">
1.75      rillig   1141: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   1142: <a name="uptodate-cvs-changes"></a>3.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1.75      rillig   1143: <p>When you update pkgsrc, the CVS program will only touch
                   1144:        those files that are registered in the CVS repository. That
                   1145:        means that any packages that you created on your own will stay
                   1146:        unmodified. If you change files that are managed by CVS, later
                   1147:        updates will try to merge your changes with those that have been
                   1148:        done by others. See the CVS manual, chapter
1.128     wiz      1149:        <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> for details.</p>
1.75      rillig   1150: </div>
                   1151: </div>
                   1152: </div>
                   1153: </div>
1.148     asau     1154: <div class="chapter">
1.75      rillig   1155: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   1156: <a name="platforms"></a>Chapter 4. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1.75      rillig   1157: <div class="toc">
                   1158: <p><b>Table of Contents</b></p>
1.210     leot     1159: <dl class="toc">
1.267     rillig   1160: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
                   1161: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.75      rillig   1162: </dl>
                   1163: </div>
1.148     asau     1164: <div class="sect1">
1.75      rillig   1165: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1166: <a name="binarydist"></a>4.1. Binary distribution</h2></div></div></div>
                   1167: <p>See <a class="xref" href="#using-pkg" title="5.1. Using binary packages">Section 5.1, &#8220;Using binary packages&#8221;</a>.</p>
1.82      rillig   1168: </div>
1.148     asau     1169: <div class="sect1">
1.82      rillig   1170: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1171: <a name="bootstrapping-pkgsrc"></a>4.2. Bootstrapping pkgsrc</h2></div></div></div>
1.149     asau     1172: <p>pkgsrc can be bootstrapped for use in two different modes:
                   1173:     privileged and unprivileged one. In unprivileged mode in contrast
1.150     asau     1174:     to privileged one all programs are installed under one particular user
1.149     asau     1175:     and cannot utilise privileged operations (packages don't create
                   1176:     special users and all special file permissions like setuid are ignored).
                   1177:     </p>
1.82      rillig   1178: <p>Installing the bootstrap kit from source should be as simple as:</p>
1.75      rillig   1179: <pre class="screen">
1.167     asau     1180: <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   1181: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.87      wiz      1182: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
                   1183:     </pre>
1.149     asau     1184: <p>To bootstrap in unprivileged mode pass <span class="quote">&#8220;<span class="quote">--unprivileged</span>&#8221;</span> flag to <span class="command"><strong>bootstrap</strong></span></p>
                   1185: <p>By default, in privileged mode pkgsrc uses
                   1186:     <code class="filename">/usr/pkg</code> for <span class="emphasis"><em>prefix</em></span>
                   1187:     where programs will be installed in,
1.230     sevan    1188:     and <code class="filename">/usr/pkg/pkgdb</code> for the package database
1.149     asau     1189:     directory where pkgsrc will do its internal bookkeeping,
                   1190:     <code class="filename">/var</code> is used as <span class="emphasis"><em>varbase</em></span>,
                   1191:     where packages install their persistent data.
                   1192:     In unprivileged mode pkgsrc uses
                   1193:     <code class="filename">~/pkg</code> for <span class="emphasis"><em>prefix</em></span>,
1.230     sevan    1194:     <code class="filename">~/pkg/pkgdb</code> for the package database,
1.149     asau     1195:     and <code class="filename">~/pkg/var</code> for <span class="emphasis"><em>varbase</em></span>.
                   1196:     </p>
                   1197: <p>You can change default layout using command-line arguments.
                   1198:     Run <span class="quote">&#8220;<span class="quote">./bootstrap --help</span>&#8221;</span> to get details.
                   1199:     </p>
1.148     asau     1200: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   1201: <h3 class="title">Note</h3>
1.110     hubertf  1202: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
                   1203:       Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
                   1204:       For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.128     wiz      1205:       instead of <span class="quote">&#8220;<span class="quote">make</span>&#8221;</span>.</p>
1.75      rillig   1206: </div>
1.149     asau     1207: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1208: <h3 class="title">Note</h3>
                   1209: <p>It is possible to bootstrap multiple instances of pkgsrc
                   1210:       using non-intersecting directories. Use <span class="command"><strong>bmake</strong></span>
                   1211:       corresponding to the installation you're working with to build
                   1212:       and install packages.
                   1213:       </p>
                   1214: </div>
1.75      rillig   1215: </div>
                   1216: </div>
1.148     asau     1217: <div class="chapter">
1.75      rillig   1218: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   1219: <a name="using"></a>Chapter 5. Using pkgsrc</h2></div></div></div>
1.75      rillig   1220: <div class="toc">
                   1221: <p><b>Table of Contents</b></p>
1.210     leot     1222: <dl class="toc">
1.267     rillig   1223: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.75      rillig   1224: <dd><dl>
1.267     rillig   1225: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
                   1226: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
1.317   ! nia      1227: <dt><span class="sect2"><a href="#using.pkgin_update">5.1.3. Updating packages</a></span></dt>
        !          1228: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.4. Deinstalling packages</a></span></dt>
        !          1229: <dt><span class="sect2"><a href="#using.pkg_info">5.1.5. Getting information about installed packages</a></span></dt>
        !          1230: <dt><span class="sect2"><a href="#vulnerabilities">5.1.6. Checking for security vulnerabilities in installed packages</a></span></dt>
        !          1231: <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>
        !          1232: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.8. Other administrative functions</a></span></dt>
1.267     rillig   1233: </dl></dd>
                   1234: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
                   1235: <dd><dl>
                   1236: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
                   1237: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
                   1238: <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   1239: </dl></dd>
                   1240: </dl>
                   1241: </div>
                   1242: <p>Basically, there are two ways of using pkgsrc. The first
1.88      wiz      1243: is to only install the package tools and to use binary packages
1.128     wiz      1244: that someone else has prepared. This is the <span class="quote">&#8220;<span class="quote">pkg</span>&#8221;</span>
                   1245: in pkgsrc. The second way is to install the <span class="quote">&#8220;<span class="quote">src</span>&#8221;</span>
1.88      wiz      1246: of pkgsrc, too. Then you are able to build your own packages,
                   1247: and you can still use binary packages from someone else.</p>
1.148     asau     1248: <div class="sect1">
1.75      rillig   1249: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1250: <a name="using-pkg"></a>5.1. Using binary packages</h2></div></div></div>
1.317   ! nia      1251: <p>On the <a class="ulink" href="https://cdn.NetBSD.org/" target="_top">cdn.NetBSD.org</a>
1.264     sevan    1252:   site and mirrors, there are collections of binary packages,
1.109     rillig   1253:   ready to be installed. These binary packages have been built using the
                   1254:   default settings for the directories, that is:</p>
1.148     asau     1255: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1256: <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>
                   1257: <li class="listitem"><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
                   1258: <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   1259: </ul></div>
                   1260: <p>If you cannot use these directories for whatever reasons (maybe
                   1261:   because you're not root), you cannot use these binary packages, but
1.267     rillig   1262:   have to build the packages yourself, which is explained in <a class="xref" href="#bootstrapping-pkgsrc" title="4.2. Bootstrapping pkgsrc">Section 4.2, &#8220;Bootstrapping pkgsrc&#8221;</a>.</p>
1.148     asau     1263: <div class="sect2">
1.75      rillig   1264: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1265: <a name="finding-binary-packages"></a>5.1.1. Finding binary packages</h3></div></div></div>
1.105     weinem   1266: <p>To install binary packages, you first need to know from where
                   1267:     to get them. The first place where you should look is on the main
1.317   ! nia      1268:     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   1269: <p>This directory contains binary packages for multiple
                   1270:     platforms. First, select your operating system. (Ignore the
                   1271:     directories with version numbers attached to it, they just exist for
                   1272:     legacy reasons.) Then, select your hardware architecture, and in the
1.128     wiz      1273:     third step, the OS version and the <span class="quote">&#8220;<span class="quote">version</span>&#8221;</span> of pkgsrc.</p>
1.109     rillig   1274: <p>In this directory, you often find a file called
                   1275:     <code class="filename">bootstrap.tar.gz</code> which contains the package
                   1276:     management tools. If the file is missing, it is likely that your
                   1277:     operating system already provides those tools. Download the file and
                   1278:     extract it in the <code class="filename">/</code> directory. It will create
                   1279:     the directories <code class="filename">/usr/pkg</code> (containing the tools
1.230     sevan    1280:     for managing binary packages and the database of installed packages).</p>
1.75      rillig   1281: </div>
1.148     asau     1282: <div class="sect2">
1.75      rillig   1283: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1284: <a name="installing-binary-packages"></a>5.1.2. Installing binary packages</h3></div></div></div>
1.109     rillig   1285: <p>In the directory from the last section, there is a
1.196     wiz      1286:     subdirectory called <code class="filename">All/</code>, which contains all the
1.109     rillig   1287:     binary packages that are available for the platform, excluding those
1.317   ! nia      1288:     that may not be distributed via HTTP or FTP.</p>
1.109     rillig   1289: <p>To install packages directly from an FTP or HTTP server, run
                   1290:     the following commands in a Bourne-compatible shell (be sure to
1.110     hubertf  1291:     <span class="command"><strong>su</strong></span> to root first):</p>
1.109     rillig   1292: <pre class="screen">
1.317   ! nia      1293: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:/usr/pkg/bin:$PATH"</code></strong>
        !          1294: <code class="prompt">#</code> <strong class="userinput"><code>PKG_PATH="https://cdn.NetBSD.org/pub/pkgsrc/packages"</code></strong>
1.284     rillig   1295: <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   1296: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
1.317   ! nia      1297: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add pkgin</code></strong>
1.109     rillig   1298: </pre>
                   1299: <p>Instead of URLs, you can also use local paths, for example if
                   1300:     you are installing from a set of CDROMs, DVDs or an NFS-mounted
                   1301:     repository. If you want to install packages from multiple sources,
                   1302:     you can separate them by a semicolon in
                   1303:     <code class="varname">PKG_PATH</code>.</p>
                   1304: <p>After these preparations, installing a package is very
                   1305:     easy:</p>
                   1306: <pre class="screen">
1.317   ! nia      1307: <code class="prompt">#</code> <strong class="userinput"><code>pkgin search nginx</code></strong>
        !          1308: nginx-1.19.6         Lightweight HTTP server and mail proxy server
        !          1309: nginx-1.18.0nb8      Lightweight HTTP server and mail proxy server
        !          1310: <code class="prompt">#</code> <strong class="userinput"><code>pkgin install zsh nginx-1.19.6 vim</code></strong>
        !          1311: </pre>
        !          1312: <p>Note that <span class="command"><strong>pkgin</strong></span> is a user-friendly frontend
        !          1313:     to the <span class="command"><strong>pkg_*</strong></span> tools.</p>
        !          1314: <p>Any prerequisite packages needed to run the
1.88      wiz      1315:     package in question will be installed, too, assuming they are
1.317   ! nia      1316:     present in the repository.</p>
1.75      rillig   1317: <p>After you've installed packages, be sure to have
1.88      wiz      1318:     <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
                   1319:     <code class="varname">PATH</code> so you can actually start the just
                   1320:     installed program.</p>
1.75      rillig   1321: </div>
1.148     asau     1322: <div class="sect2">
1.75      rillig   1323: <div class="titlepage"><div><div><h3 class="title">
1.317   ! nia      1324: <a name="using.pkgin_update"></a>5.1.3. Updating packages</h3></div></div></div>
        !          1325: <p>To update binary packages, it is recommended that you use
        !          1326:     <span class="command"><strong>pkgin upgrade</strong></span>.  This will compare the remote
        !          1327:     package repository to your locally installed packages and safely
        !          1328:     replace any older packages.</p>
        !          1329: <p>Note that pkgsrc is released as quarterly branches.
        !          1330:     If you are updating to a newer quarterly branch of pkgsrc, you may
        !          1331:     need to adjust the repository in
        !          1332:     <code class="filename">/usr/pkg/etc/pkgin/repositories.conf</code>.</p>
        !          1333: </div>
        !          1334: <div class="sect2">
        !          1335: <div class="titlepage"><div><div><h3 class="title">
        !          1336: <a name="using.pkg_delete"></a>5.1.4. Deinstalling packages</h3></div></div></div>
1.82      rillig   1337: <p>To deinstall a package, it does not matter whether it was
1.317   ! nia      1338:     installed from source code or from a binary package. Neither the
        !          1339:     <span class="command"><strong>pkgin</strong></span> or the <span class="command"><strong>pkg_delete</strong></span>
        !          1340:     command need to know.</p>
        !          1341: <p>To delete a package, you can just run <span class="command"><strong>pkgin remove
1.88      wiz      1342:     <em class="replaceable"><code>package-name</code></em></strong></span>. The package
1.317   ! nia      1343:     name can be given with or without version number.</p>
1.82      rillig   1344: </div>
1.148     asau     1345: <div class="sect2">
1.82      rillig   1346: <div class="titlepage"><div><div><h3 class="title">
1.317   ! nia      1347: <a name="using.pkg_info"></a>5.1.5. Getting information about installed packages</h3></div></div></div>
1.110     hubertf  1348: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.317   ! nia      1349:     installed packages or binary package files.
        !          1350:     As with other management tools, it works with packages installed
        !          1351:     from source or binaries.</p>
1.82      rillig   1352: </div>
1.148     asau     1353: <div class="sect2">
1.82      rillig   1354: <div class="titlepage"><div><div><h3 class="title">
1.317   ! nia      1355: <a name="vulnerabilities"></a>5.1.6. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1.82      rillig   1356: <p>
1.279     leot     1357:       The pkgsrc Security Team and Packages Groups maintain a list of
1.317   ! nia      1358:       known vulnerabilities to packages which are (or have been)
1.88      wiz      1359:       included in pkgsrc.  The list is available from the NetBSD
1.317   ! nia      1360:       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>.
        !          1361:     </p>
        !          1362: <p>
        !          1363:       Please note that not every "vulnerability" with a CVE assignment is
        !          1364:       exploitable in every configuration.
        !          1365:       Some bugs are marked as active simply because an fix was not
        !          1366:       marked as such.
        !          1367:       Operating system specific hardening and mitigation features may also
        !          1368:       reduce the impact of bugs.
1.88      wiz      1369:     </p>
1.82      rillig   1370: <p>
1.125     wiz      1371:       Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.88      wiz      1372:       this list can be downloaded
                   1373:       automatically, and a security audit of all packages installed on a system
                   1374:       can take place.
                   1375:     </p>
1.82      rillig   1376: <p>
1.125     wiz      1377:       There are two components to auditing.  The first
                   1378:       step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
                   1379:       is for downloading
1.88      wiz      1380:       the list of vulnerabilities from the NetBSD FTP site.  The second
1.125     wiz      1381:       step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.88      wiz      1382:       installed packages are vulnerable.  If a package is vulnerable, you
                   1383:       will see output similar to the following:
                   1384:     </p>
1.82      rillig   1385: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1.289     leot     1386:     https://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1.82      rillig   1387: <p>
1.125     wiz      1388:       You may wish to have the
1.317   ! nia      1389:       <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.125     wiz      1390:       file downloaded daily so that
                   1391:       it remains current.  This may be done by adding an appropriate entry
1.311     leot     1392:       to the root users <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/crontab.5"><span class="citerefentry"><span class="refentrytitle">crontab</span>(5)</span></a> entry.  For example the entry
1.125     wiz      1393:       </p>
                   1394: <pre class="screen">
1.233     sevan    1395: # Download vulnerabilities file
1.230     sevan    1396: 0 3 * * * /usr/pkg/sbin/pkg_admin fetch-pkg-vulnerabilities &gt;/dev/null 2&gt;&amp;1
1.233     sevan    1397: # Audit the installed packages and email results to root
                   1398: 9 3 * * * /usr/pkg/sbin/pkg_admin audit |mail -s "Installed package audit result" \
                   1399:            root &gt;/dev/null 2&gt;&amp;1
1.125     wiz      1400:       </pre>
                   1401: <p>
1.230     sevan    1402:       will update the vulnerability list every day at 3AM, followed by an audit
                   1403:       at 3:09AM. The result of the audit are then emailed to root.
1.125     wiz      1404: 
1.230     sevan    1405:       On NetBSD this may be accomplished instead by adding the following
                   1406:       line to <code class="filename">/etc/daily.conf</code>:
                   1407:       </p>
                   1408: <pre class="screen">
                   1409: fetch_pkg_vulnerabilities=YES
                   1410:       </pre>
                   1411: <p>
                   1412:       to fetch the vulnerability list from the daily security script. The system
                   1413:       is set to audit the packages by default but can be set explicitly, if
1.235     yyamano  1414:       desired (not required), by adding the following line to
1.230     sevan    1415: <code class="filename">/etc/security.conf</code>:
1.125     wiz      1416:       </p>
                   1417: <pre class="screen">
1.230     sevan    1418: check_pkg_vulnerabilities=YES
1.125     wiz      1419:       </pre>
                   1420: <p>
1.311     leot     1421:       see <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/daily.conf.5"><span class="citerefentry"><span class="refentrytitle">daily.conf</span>(5)</span></a> and <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/security.conf.5"><span class="citerefentry"><span class="refentrytitle">security.conf</span>(5)</span></a> for more details.
1.88      wiz      1422:     </p>
1.82      rillig   1423: </div>
1.148     asau     1424: <div class="sect2">
1.82      rillig   1425: <div class="titlepage"><div><div><h3 class="title">
1.317   ! nia      1426: <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   1427: <p>
1.250     leot     1428:       Install <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/lintpkgsrc/README.html" target="_top"><code class="filename">pkgtools/lintpkgsrc</code></a> and run
1.128     wiz      1429:       <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">&#8220;<span class="quote">-i</span>&#8221;</span>
1.317   ! nia      1430:       argument to check if any packages are stale, e.g.
1.88      wiz      1431:     </p>
                   1432: <pre class="screen">
                   1433: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1.82      rillig   1434: ...
1.88      wiz      1435: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
                   1436:     </pre>
1.82      rillig   1437: </div>
1.148     asau     1438: <div class="sect2">
1.82      rillig   1439: <div class="titlepage"><div><div><h3 class="title">
1.317   ! nia      1440: <a name="using.pkg_admin"></a>5.1.8. Other administrative functions</h3></div></div></div>
1.110     hubertf  1441: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.88      wiz      1442:     administrative functions on the package system.</p>
1.82      rillig   1443: </div>
1.75      rillig   1444: </div>
1.148     asau     1445: <div class="sect1">
1.75      rillig   1446: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1447: <a name="building-packages-from-source"></a>5.2. Building packages from source</h2></div></div></div>
1.88      wiz      1448: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
                   1449:   directory now contains a set of packages, organized into
                   1450:   categories. You can browse the online index of packages, or run
1.110     hubertf  1451:   <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.88      wiz      1452:   directory to build local <code class="filename">README.html</code> files for
1.250     leot     1453:   all packages, viewable with any web browser such as <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/lynx/README.html" target="_top"><code class="filename">www/lynx</code></a> or <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a>.</p>
1.88      wiz      1454: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
                   1455:   is <code class="filename">/usr/pkg</code>. If you wish to change this, you
                   1456:   should do so by setting <code class="varname">LOCALBASE</code> in
1.110     hubertf  1457:   <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.88      wiz      1458:   different <code class="varname">LOCALBASE</code> definitions on the same
                   1459:   system (inside a chroot is an exception). </p>
                   1460: <p>The rest of this chapter assumes that the package is already
1.110     hubertf  1461:   in pkgsrc. If it is not, see <a class="xref" href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, &#8220;The pkgsrc developer's guide&#8221;</a> for
1.88      wiz      1462:   instructions how to create your own packages.</p>
1.148     asau     1463: <div class="sect2">
1.75      rillig   1464: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1465: <a name="requirements"></a>5.2.1. Requirements</h3></div></div></div>
1.82      rillig   1466: <p>To build packages from source, you need a working C
1.88      wiz      1467:     compiler. On NetBSD, you need to install the
1.128     wiz      1468:     <span class="quote">&#8220;<span class="quote">comp</span>&#8221;</span> and the <span class="quote">&#8220;<span class="quote">text</span>&#8221;</span> distribution
1.88      wiz      1469:     sets. If you want to build X11-related packages, the
1.128     wiz      1470:     <span class="quote">&#8220;<span class="quote">xbase</span>&#8221;</span> and <span class="quote">&#8220;<span class="quote">xcomp</span>&#8221;</span> distribution
1.88      wiz      1471:     sets are required, too.</p>
1.75      rillig   1472: </div>
1.148     asau     1473: <div class="sect2">
1.75      rillig   1474: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1475: <a name="fetching-distfiles"></a>5.2.2. Fetching distfiles</h3></div></div></div>
1.75      rillig   1476: <p>The first step for building a package is downloading the
1.88      wiz      1477:     distfiles (i.e. the unmodified source). If they have not yet been
                   1478:     downloaded, pkgsrc will fetch them automatically.</p>
                   1479: <p>If you have all files that you need in the
                   1480:     <code class="filename">distfiles</code> directory,
                   1481:     you don't need to connect. If the distfiles are on CD-ROM, you can
                   1482:     mount the CD-ROM on <code class="filename">/cdrom</code> and add:
                   1483:     </p>
1.82      rillig   1484: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
                   1485: <p>
1.110     hubertf  1486:     to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.91      rillig   1487: <p>By default a list of distribution sites will be randomly
                   1488:     intermixed to prevent huge load on servers which holding popular
                   1489:     packages (for example, SourceForge.net mirrors). Thus, every
                   1490:     time when you need to fetch yet another distfile all the mirrors
                   1491:     will be tried in new (random) order. You can turn this feature
                   1492:     off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
                   1493:     <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1.88      wiz      1494: <p>You can overwrite some of the major distribution sites to
                   1495:     fit to sites that are close to your own.  By setting one or two
                   1496:     variables you can modify the order in which the master sites are
                   1497:     accessed.  <code class="varname">MASTER_SORT</code> contains a whitespace
                   1498:     delimited list of domain suffixes.
                   1499:     <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
                   1500:     contains a whitespace delimited list of regular expressions.  It
                   1501:     has higher priority than <code class="varname">MASTER_SORT</code>.  Have a
                   1502:     look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
                   1503:     some examples.  This may save some of your bandwidth and
                   1504:     time.</p>
1.75      rillig   1505: <p>You can change these settings either in your shell's environment, or,
1.88      wiz      1506:     if you want to keep the settings, by editing the
1.110     hubertf  1507:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.88      wiz      1508:     and adding the definitions there.</p>
1.82      rillig   1509: <p>
1.88      wiz      1510:       If a package depends on many other packages (such as
1.250     leot     1511:       <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde4/README.html" target="_top"><code class="filename">meta-pkgs/kde4</code></a>), the build process may
1.88      wiz      1512:       alternate between periods of
                   1513:       downloading source, and compiling. To ensure you have all the source
                   1514:       downloaded initially you can run the command:
                   1515:       </p>
1.82      rillig   1516: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
                   1517: <p>
1.88      wiz      1518:       which will output and run a set of shell commands to fetch the
                   1519:       necessary files into the <code class="filename">distfiles</code> directory.  You can
                   1520:       also choose to download the files manually.
                   1521:     </p>
1.75      rillig   1522: </div>
1.148     asau     1523: <div class="sect2">
1.75      rillig   1524: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1525: <a name="how-to-build-and-install"></a>5.2.3. How to build and install</h3></div></div></div>
1.82      rillig   1526: <p>
1.88      wiz      1527:       Once the software has downloaded, any patches will be applied, then it
                   1528:       will be compiled for you. This may take some time depending on your
                   1529:       computer, and how many other packages the software depends on and their
                   1530:       compile time.
                   1531:     </p>
1.148     asau     1532: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   1533: <h3 class="title">Note</h3>
                   1534: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.110     hubertf  1535:     use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.128     wiz      1536:     <span class="quote">&#8220;<span class="quote">make</span>&#8221;</span> in the examples in this guide.</p>
1.75      rillig   1537: </div>
1.87      wiz      1538: <p>For example, type</p>
1.88      wiz      1539: <pre class="screen">
                   1540: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
                   1541: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   1542:     </pre>
1.75      rillig   1543: <p>at the shell prompt to build the various components of the
1.88      wiz      1544:     package.</p>
1.82      rillig   1545: <p>The next stage is to actually install the newly compiled
1.88      wiz      1546:     program onto your system. Do this by entering:
1.82      rillig   1547: 
1.88      wiz      1548:     </p>
1.82      rillig   1549: <pre class="screen">
1.88      wiz      1550: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
                   1551:     </pre>
1.82      rillig   1552: <p>
                   1553: 
1.88      wiz      1554:     while you are still in the directory for whatever package you
                   1555:     are installing.</p>
1.82      rillig   1556: <p>Installing the package on your system may require you to
1.88      wiz      1557:     be root.  However, pkgsrc has a
                   1558:     <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
                   1559:     to only become root for the actual installation step.</p>
1.82      rillig   1560: <p>That's it, the software should now be installed and setup for use.
1.88      wiz      1561:     You can now enter:
1.82      rillig   1562: 
1.88      wiz      1563:     </p>
1.82      rillig   1564: <pre class="screen">
1.88      wiz      1565: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
                   1566:     </pre>
1.82      rillig   1567: <p>
                   1568: 
1.88      wiz      1569:     to remove the compiled files in the work directory, as you shouldn't need
                   1570:     them any more. If other packages were also added to your system
                   1571:     (dependencies) to allow your program to compile, you can tidy these up
                   1572:     also with the command:</p>
1.82      rillig   1573: <pre class="screen">
1.88      wiz      1574: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
                   1575:     </pre>
1.75      rillig   1576: <p>Taking the figlet utility as an example, we can install it on our
1.110     hubertf  1577:     system by building as shown in <a class="xref" href="#logs" title="Appendix B. Build logs">Appendix B, <i>Build logs</i></a>.</p>
1.88      wiz      1578: <p>The program is installed under the default root of the
                   1579:     packages tree - <code class="filename">/usr/pkg</code>. Should this not
                   1580:     conform to your tastes, set the <code class="varname">LOCALBASE</code>
                   1581:     variable in your environment, and it will use that value as the
                   1582:     root of your packages tree. So, to use
                   1583:     <code class="filename">/usr/local</code>, set
                   1584:     <code class="varname">LOCALBASE=/usr/local</code> in your environment.
                   1585:     Please note that you should use a directory which is dedicated to
                   1586:     packages and not shared with other programs (i.e., do not try and
                   1587:     use <code class="varname">LOCALBASE=/usr</code>).  Also, you should not try
                   1588:     to add any of your own files or directories (such as
                   1589:     <code class="filename">src/</code>, <code class="filename">obj/</code>, or
                   1590:     <code class="filename">pkgsrc/</code>) below the
                   1591:     <code class="varname">LOCALBASE</code> tree.  This is to prevent possible
                   1592:     conflicts between programs and other files installed by the
                   1593:     package system and whatever else may have been installed
                   1594:     there.</p>
1.110     hubertf  1595: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.88      wiz      1596:     alter some configuration options at build time.  Have a look at
                   1597:     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
                   1598:     of what will be set there by default.  Environment variables such
                   1599:     as <code class="varname">LOCALBASE</code> can be set in
1.110     hubertf  1600:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.88      wiz      1601:     set them each time you want to use pkgsrc.</p>
1.128     wiz      1602: <p>Occasionally, people want to <span class="quote">&#8220;<span class="quote">look under the
                   1603:     covers</span>&#8221;</span> to see what is going on when a package is building
1.88      wiz      1604:     or being installed. This may be for debugging purposes, or out of
                   1605:     simple curiosity. A number of utility values have been added to
                   1606:     help with this.</p>
1.128     wiz      1607: <div class="orderedlist"><ol class="orderedlist" type="1">
                   1608: <li class="listitem">
1.311     leot     1609: <p>If you invoke the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> command with
1.88      wiz      1610:        <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
                   1611:        information will be displayed. For example,</p>
1.75      rillig   1612: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1.88      wiz      1613: <p>will show all the commands that are invoked, up to and
1.128     wiz      1614:        including the <span class="quote">&#8220;<span class="quote">patch</span>&#8221;</span> stage.</p>
1.75      rillig   1615: </li>
1.128     wiz      1616: <li class="listitem">
1.311     leot     1617: <p>If you want to know the value of a certain <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88      wiz      1618:        definition, then the <code class="varname">VARNAME</code> definition
                   1619:        should be used, in conjunction with the show-var
1.311     leot     1620:        target. e.g. to show the expansion of the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88      wiz      1621:        variable <code class="varname">LOCALBASE</code>:</p>
                   1622: <pre class="screen">
                   1623: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1.75      rillig   1624: /usr/pkg
                   1625: <code class="prompt">%</code>
1.88      wiz      1626:        </pre>
1.75      rillig   1627: </li>
                   1628: </ol></div>
                   1629: <p>If you want to install a binary package that you've either
1.88      wiz      1630:     created yourself (see next section), that you put into
                   1631:     pkgsrc/packages manually or that is located on a remote FTP
                   1632:     server, you can use the "bin-install" target. This target will
1.311     leot     1633:     install a binary package - if available - via <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>,
1.110     hubertf  1634:     else do a <span class="command"><strong>make package</strong></span>.  The list of remote FTP
1.88      wiz      1635:     sites searched is kept in the variable
                   1636:     <code class="varname">BINPKG_SITES</code>, which defaults to
1.311     leot     1637:     ftp.NetBSD.org. Any flags that should be added to <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>
1.88      wiz      1638:     can be put into <code class="varname">BIN_INSTALL_FLAGS</code>.  See
                   1639:     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
                   1640:     details.</p>
                   1641: <p>A final word of warning: If you set up a system that has a
                   1642:     non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
                   1643:     set that before any packages are installed, as you cannot use
                   1644:     several directories for the same purpose. Doing so will result in
                   1645:     pkgsrc not being able to properly detect your installed packages,
                   1646:     and fail miserably. Note also that precompiled binary packages are
                   1647:     usually built with the default <code class="varname">LOCALBASE</code> of
                   1648:     <code class="filename">/usr/pkg</code>, and that you should
                   1649:     <span class="emphasis"><em>not</em></span> install any if you use a non-standard
                   1650:     <code class="varname">LOCALBASE</code>.</p>
1.75      rillig   1651: </div>
                   1652: </div>
                   1653: </div>
1.148     asau     1654: <div class="chapter">
1.75      rillig   1655: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   1656: <a name="configuring"></a>Chapter 6. Configuring pkgsrc</h2></div></div></div>
1.75      rillig   1657: <div class="toc">
                   1658: <p><b>Table of Contents</b></p>
1.210     leot     1659: <dl class="toc">
1.267     rillig   1660: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
                   1661: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
                   1662: <dt><span class="sect1"><a href="#variables-affecting-installation">6.3. Variables affecting the installation process</a></span></dt>
                   1663: <dt><span class="sect1"><a href="#conf.compiler">6.4. Selecting and configuring the compiler</a></span></dt>
                   1664: <dd><dl>
                   1665: <dt><span class="sect2"><a href="#selecting-the-compiler">6.4.1. Selecting the compiler</a></span></dt>
                   1666: <dt><span class="sect2"><a href="#conf.cflags">6.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                   1667: <dt><span class="sect2"><a href="#conf.ldflags">6.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.88      wiz      1668: </dl></dd>
1.267     rillig   1669: <dt><span class="sect1"><a href="#developer-advanced-settings">6.5. Developer/advanced settings</a></span></dt>
                   1670: <dt><span class="sect1"><a href="#selecting-build-options">6.6. Selecting Build Options</a></span></dt>
1.75      rillig   1671: </dl>
                   1672: </div>
1.104     rillig   1673: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.89      rillig   1674: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
                   1675: that file depends on the installation. On NetBSD, when you use
1.311     leot     1676: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> from the base system, it is in the directory
1.89      rillig   1677: <code class="filename">/etc/</code>. In all other cases the default location is
                   1678: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
                   1679: bootstrap program to install the binary packages.</p>
                   1680: <p>The format of the configuration file is that of the usual
                   1681: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
                   1682: is done by setting variables in this file. Note that you can define all
                   1683: kinds of variables, and no special error checking (for example for
1.223     rillig   1684: spelling mistakes) takes place.</p>
1.148     asau     1685: <div class="sect1">
1.75      rillig   1686: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1687: <a name="general-configuration"></a>6.1. General configuration</h2></div></div></div>
1.223     rillig   1688: <p>The following variables apply to all
1.89      rillig   1689:     pkgsrc packages. A complete list of the variables that can be
                   1690:     configured by the user is available in
                   1691:     <code class="filename">mk/defaults/mk.conf</code>, together with some
                   1692:     comments that describe each variable's intent.</p>
1.148     asau     1693: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1694: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.75      rillig   1695:            packages will be installed. The default is
1.76      rillig   1696:            <code class="filename">/usr/pkg</code>. Do not mix binary packages
1.75      rillig   1697:            with different <code class="varname">LOCALBASE</code>s!</p></li>
1.128     wiz      1698: <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
                   1699:            <span class="quote">&#8220;<span class="quote">cross</span>&#8221;</span> category packages will be
1.75      rillig   1700:            installed. The default is
1.76      rillig   1701:            <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.128     wiz      1702: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.75      rillig   1703:            X11 is installed on the system. The default is
1.194     bsiegert 1704:            <code class="filename">/usr/X11R7</code>.</p></li>
1.128     wiz      1705: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.75      rillig   1706:            downloaded copies of the original source distributions used
                   1707:            for building pkgsrc packages. The default is
1.76      rillig   1708:            <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.128     wiz      1709: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.97      rillig   1710:            database about installed packages is stored.  The default is
1.230     sevan    1711:            <code class="filename">/usr/pkg/pkgdb</code>.</p></li>
1.128     wiz      1712: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.75      rillig   1713:            If set, override the packages'
                   1714:            <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.128     wiz      1715: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.75      rillig   1716:            Backup location(s) for distribution files and patch files
                   1717:            if not found locally or in
1.76      rillig   1718:            <code class="filename">${MASTER_SITES}</code> or
                   1719:            <code class="filename">${PATCH_SITES}</code> respectively.
1.230     sevan    1720:            The defaults is
                   1721:            <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.128     wiz      1722: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.93      rillig   1723:            List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
                   1724:            <em class="replaceable"><code>arch</code></em> are replaced with OS
1.128     wiz      1725:            release (<span class="quote">&#8220;<span class="quote">2.0</span>&#8221;</span>, etc.) and architecture
                   1726:            (<span class="quote">&#8220;<span class="quote">mipsel</span>&#8221;</span>, etc.).</p></li>
                   1727: <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.125     wiz      1728:            List of acceptable licenses. License names are case-sensitive.
                   1729:            Whenever you try to build a package whose license is not in this
                   1730:            list, you will get an error message. If the license condition is
                   1731:            simple enough, the error message will include specific
                   1732:            instructions on how to change this variable.</p></li>
1.75      rillig   1733: </ul></div>
                   1734: </div>
1.148     asau     1735: <div class="sect1">
1.75      rillig   1736: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1737: <a name="variables-affecting-build"></a>6.2. Variables affecting the build process</h2></div></div></div>
1.219     rillig   1738: <p>
1.75      rillig   1739:       </p>
1.148     asau     1740: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1741: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.75      rillig   1742:            directory for the binary packages. The default is
1.76      rillig   1743:            <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.128     wiz      1744: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.75      rillig   1745:            The top level directory where, if defined, the separate
                   1746:            working directories will get created, and symbolically
1.76      rillig   1747:            linked to from <code class="filename">${WRKDIR}</code> (see below).
1.75      rillig   1748:            This is useful for building packages on several
1.76      rillig   1749:            architectures, then <code class="filename">${PKGSRCDIR}</code>
                   1750:            can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1.75      rillig   1751:            is local to every architecture. (It should be noted that
                   1752:            <code class="varname">PKGSRCDIR</code> should not be set by the user
1.126     jakllsch 1753:            &mdash; it is an internal definition which refers to the
1.75      rillig   1754:            root of the pkgsrc tree. It is possible to have many
                   1755:            pkgsrc tree instances.)</p></li>
1.128     wiz      1756: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.75      rillig   1757:            Directory for local patches that aren't part of pkgsrc.
1.299     rillig   1758:            See <a class="xref" href="#components.patches" title="12.3. patches/*">Section 12.3, &#8220;<code class="filename">patches/*</code>&#8221;</a> for more
1.93      rillig   1759:            information.</p></li>
1.128     wiz      1760: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.110     hubertf  1761:            the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.75      rillig   1762:            BSD-style Makefile. If this is not set,
                   1763:            <code class="varname">MAKECONF</code> is set to
1.76      rillig   1764:            <code class="filename">/dev/null</code> to avoid picking up
                   1765:            settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.75      rillig   1766: </ul></div>
                   1767: </div>
1.148     asau     1768: <div class="sect1">
1.75      rillig   1769: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1770: <a name="variables-affecting-installation"></a>6.3. Variables affecting the installation process</h2></div></div></div>
1.312     gdt      1771: <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     1772:                 By default, binary packages of built packages are
1.263     leot     1773:                 preserved in <code class="filename">${PACKAGES}/All</code>. Setting
1.256     maya     1774:                this variable to "no" prevents this.</p></li></ul></div>
1.217     jnemeth  1775: <p>Packages have to support installation into a
1.103     wiz      1776:     subdirectory of <code class="varname">WRKDIR</code>. This allows a package
                   1777:     to be built, before the actual filesystem is touched. DESTDIR
                   1778:     support exists in two variations:</p>
1.148     asau     1779: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1780: <li class="listitem"><p>Basic DESTDIR support means that the package
1.131     wiz      1781:       installation and packaging is still run as root.</p></li>
                   1782: <li class="listitem"><p>Full DESTDIR support can run the complete
                   1783:       build, installation and packaging as normal user. Root
                   1784:       privileges are only needed to add packages.</p></li>
                   1785: </ul></div>
1.103     wiz      1786: <p>With basic DESTDIR support, <strong class="userinput"><code>make
                   1787:     clean</code></strong> needs to be run as root.</p>
1.118     imil     1788: <p>Considering the <code class="filename">foo/bar</code> package,
                   1789:     DESTDIR full support can be tested using the following commands
                   1790: 
                   1791: </p>
                   1792: <pre class="programlisting">
                   1793: <code class="prompt">$</code> id
                   1794: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
                   1795: <code class="prompt">$</code> mkdir $HOME/packages
                   1796: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
                   1797: </pre>
                   1798: <p>
                   1799: 
                   1800:     Verify <code class="varname">DESTDIR</code> full support, no root privileges
                   1801:     should be needed
                   1802: 
                   1803: </p>
                   1804: <pre class="programlisting">
1.174     asau     1805: <code class="prompt">$</code> make stage-install
1.118     imil     1806: </pre>
                   1807: <p>
                   1808: 
                   1809:     Create a package without root privileges
                   1810: 
                   1811: </p>
                   1812: <pre class="programlisting">
1.174     asau     1813: <code class="prompt">$</code> make PACKAGES=$HOME/packages package
1.118     imil     1814: </pre>
                   1815: <p>
                   1816: 
                   1817:     For the following command, you must be able to gain root
1.311     leot     1818:     privileges using <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/su.1"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a>
1.118     imil     1819: 
                   1820: </p>
                   1821: <pre class="programlisting">
1.174     asau     1822: <code class="prompt">$</code> make PACKAGES=$HOME/packages install
1.118     imil     1823: </pre>
                   1824: <p>
                   1825: 
                   1826:     Then, as a simple user
                   1827: 
                   1828: </p>
                   1829: <pre class="programlisting">
                   1830: <code class="prompt">$</code> make clean
                   1831: </pre>
                   1832: <p>
                   1833: 
                   1834:     </p>
1.103     wiz      1835: </div>
1.148     asau     1836: <div class="sect1">
1.103     wiz      1837: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1838: <a name="conf.compiler"></a>6.4. Selecting and configuring the compiler</h2></div></div></div>
1.148     asau     1839: <div class="sect2">
1.78      rillig   1840: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1841: <a name="selecting-the-compiler"></a>6.4.1. Selecting the compiler</h3></div></div></div>
1.89      rillig   1842: <p>By default, pkgsrc will use GCC to build packages.  This may be
                   1843:     overridden by setting the following variables in /etc/mk.conf:</p>
1.148     asau     1844: <div class="variablelist"><dl class="variablelist">
1.89      rillig   1845: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
                   1846: <dd>
                   1847: <p>This is a list of values specifying the chain of
                   1848:          compilers to invoke when building packages.  Valid values
                   1849:          are:</p>
1.148     asau     1850: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.174     asau     1851: <li class="listitem"><p><code class="varname">ccc</code>:
                   1852:            Compaq C Compilers (Tru64)</p></li>
                   1853: <li class="listitem"><p><code class="varname">ccache</code>:
                   1854:            compiler cache (chainable)</p></li>
                   1855: <li class="listitem"><p><code class="varname">clang</code>:
                   1856:            Clang C and Objective-C compiler</p></li>
1.128     wiz      1857: <li class="listitem"><p><code class="varname">distcc</code>:
1.89      rillig   1858:            distributed C/C++ (chainable)</p></li>
1.174     asau     1859: <li class="listitem"><p><code class="varname">f2c</code>:
                   1860:            Fortran 77 to C compiler (chainable)</p></li>
                   1861: <li class="listitem"><p><code class="varname">icc</code>:
                   1862:            Intel C++ Compiler (Linux)</p></li>
                   1863: <li class="listitem"><p><code class="varname">ido</code>:
                   1864:            SGI IRIS Development Option cc (IRIX 5)</p></li>
1.128     wiz      1865: <li class="listitem"><p><code class="varname">gcc</code>:
1.89      rillig   1866:            GNU C/C++ Compiler</p></li>
1.174     asau     1867: <li class="listitem"><p><code class="varname">hp</code>:
                   1868:            HP-UX C/aC++ compilers</p></li>
1.128     wiz      1869: <li class="listitem"><p><code class="varname">mipspro</code>:
1.89      rillig   1870:            Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.174     asau     1871: <li class="listitem"><p><code class="varname">mipspro-ucode</code>:
1.89      rillig   1872:            Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.128     wiz      1873: <li class="listitem"><p><code class="varname">sunpro</code>:
1.89      rillig   1874:            Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
1.174     asau     1875: <li class="listitem"><p><code class="varname">xlc</code>:
1.230     sevan    1876:            IBM's XL C/C++ compiler suite</p></li>
1.89      rillig   1877: </ul></div>
                   1878: <p>The default is
1.128     wiz      1879:          <span class="quote">&#8220;<span class="quote"><code class="varname">gcc</code></span>&#8221;</span>.  You can use
1.89      rillig   1880:          <code class="varname">ccache</code> and/or
                   1881:          <code class="varname">distcc</code> with an appropriate
                   1882:          <code class="varname">PKGSRC_COMPILER</code> setting,
1.128     wiz      1883:          e.g. <span class="quote">&#8220;<span class="quote"><code class="varname">ccache gcc</code></span>&#8221;</span>.  This
1.94      dmcmahil 1884:          variable should always be terminated with a value for
                   1885:          a real compiler.  Note that only one real compiler
1.128     wiz      1886:          should be listed (e.g. <span class="quote">&#8220;<span class="quote"><code class="varname">sunpro gcc</code></span>&#8221;</span>
1.94      dmcmahil 1887:          is not allowed).</p>
1.89      rillig   1888: </dd>
                   1889: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
                   1890: <dd><p>This specifies the minimum version of GCC to use
                   1891:          when building packages.  If the system GCC doesn't
                   1892:          satisfy this requirement, then pkgsrc will build and
                   1893:          install one of the GCC packages to use instead.</p></dd>
1.266     leot     1894: <dt><span class="term"><code class="varname">PYTHON_VERSION_DEFAULT</code>:</span></dt>
1.225     maya     1895: <dd><p>Specifies which version of python to use when several
                   1896:          options are available.</p></dd>
                   1897: <dt><span class="term"><code class="varname">PKGSRC_FORTRAN</code>:</span></dt>
1.291     gutterid 1898: <dd><p>Specifies the Fortran compiler to use.
                   1899:          The default is <code class="varname">gfortran</code>.</p></dd>
1.225     maya     1900: <dt><span class="term"><code class="varname">GFORTRAN_VERSION</code>:</span></dt>
                   1901: <dd><p>If <code class="varname">PKGSRC_FORTRAN</code><code class="literal">=</code>
                   1902:          <code class="varname">gfortran</code> is used, this option specifies which
                   1903:          version to use.</p></dd>
1.89      rillig   1904: </dl></div>
                   1905: </div>
1.148     asau     1906: <div class="sect2">
1.89      rillig   1907: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1908: <a name="conf.cflags"></a>6.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</h3></div></div></div>
1.78      rillig   1909: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
                   1910:        please make sure to use the <code class="literal">+=</code> operator
                   1911:        instead of the <code class="literal">=</code> operator:</p>
                   1912: <pre class="programlisting">
1.100     rillig   1913: CFLAGS+=        -your -flags
1.78      rillig   1914: </pre>
                   1915: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.128     wiz      1916:        <span class="quote">&#8220;<span class="quote">+</span>&#8221;</span>) may lead to problems with packages that
1.117     jnemeth  1917:        need to add their own flags.  You may want to take a look
1.250     leot     1918:        at the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/README.html" target="_top"><code class="filename">devel/cpuflags</code></a>
1.128     wiz      1919:        package if you're interested in optimization specifically
                   1920:        for the current CPU. </p>
1.78      rillig   1921: </div>
1.148     asau     1922: <div class="sect2">
1.88      wiz      1923: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1924: <a name="conf.ldflags"></a>6.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</h3></div></div></div>
1.88      wiz      1925: <p>If you want to pass flags to the linker, both in the configure
                   1926: step and the build step, you can do this in two ways.  Either set
                   1927: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>.  The difference
                   1928: between the two is that <code class="varname">LIBS</code> will be appended to
                   1929: the command line, while <code class="varname">LDFLAGS</code> come earlier.
                   1930: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
                   1931: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
                   1932: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>.  As with
                   1933: <code class="varname">CFLAGS</code>, if you do not wish to override these
                   1934: settings, use the <code class="literal">+=</code> operator:</p>
                   1935: <pre class="programlisting">
1.100     rillig   1936: LDFLAGS+=        -your -linkerflags
1.88      wiz      1937: </pre>
                   1938: </div>
1.78      rillig   1939: </div>
1.148     asau     1940: <div class="sect1">
1.78      rillig   1941: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1942: <a name="developer-advanced-settings"></a>6.5. Developer/advanced settings</h2></div></div></div>
1.194     bsiegert 1943: <p>
1.75      rillig   1944:       </p>
1.148     asau     1945: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1946: <li class="listitem">
1.75      rillig   1947: <p><code class="varname">PKG_DEVELOPER</code>:
                   1948:            Run some sanity checks that package developers want:
                   1949:            </p>
1.148     asau     1950: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.128     wiz      1951: <li class="listitem"><p>make sure patches apply with zero
1.88      wiz      1952:              fuzz</p></li>
1.128     wiz      1953: <li class="listitem"><p>run check-shlibs to see that all
1.88      wiz      1954:              binaries will find their shared libs.</p></li>
1.75      rillig   1955: </ul></div>
                   1956: <p>
1.87      wiz      1957:        </p>
1.75      rillig   1958: </li>
1.128     wiz      1959: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.88      wiz      1960:        of debugging output which is displayed whilst making and
                   1961:        installing the package.  The default value for this is 0,
                   1962:        which will not display the commands as they are executed
                   1963:        (normal, default, quiet operation); the value 1 will display
                   1964:        all shell commands before their invocation, and the value 2
                   1965:        will display both the shell commands before their invocation,
1.223     rillig   1966:        as well as their actual execution progress with <span class="command"><strong>set
                   1967:        -x</strong></span>.</p></li>
1.75      rillig   1968: </ul></div>
                   1969: <p>
                   1970:     </p>
                   1971: </div>
1.148     asau     1972: <div class="sect1">
1.75      rillig   1973: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1974: <a name="selecting-build-options"></a>6.6. Selecting Build Options</h2></div></div></div>
1.88      wiz      1975: <p>Some packages have build time options, usually to select
                   1976:     between different dependencies, enable optional support for big
                   1977:     dependencies or enable experimental features.</p>
1.75      rillig   1978: <p>To see which options, if any, a package supports, and which
1.110     hubertf  1979:     options are mutually exclusive, run <span class="command"><strong>make
1.88      wiz      1980:     show-options</strong></span>, for example:</p>
1.75      rillig   1981: <pre class="programlisting">
                   1982:     The following options are supported by this package:
                   1983:         ssl      Enable SSL support.
                   1984:     Exactly one of the following gecko options is required:
                   1985:         firefox  Use firefox as gecko rendering engine.
                   1986:         mozilla  Use mozilla as gecko rendering engine.
                   1987:     At most one of the following database options may be selected:
                   1988:         mysql    Enable support for MySQL database.
                   1989:         pgsql    Enable support for PostgreSQL database.
1.1       grant    1990: 
1.75      rillig   1991:     These options are enabled by default: firefox
                   1992:     These options are currently enabled: mozilla ssl
1.1       grant    1993: </pre>
1.75      rillig   1994: <p>The following variables can be defined in
1.110     hubertf  1995:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.88      wiz      1996:     enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
                   1997:     which can be used to select or disable options for all packages
                   1998:     that support them, and
                   1999:     <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
                   2000:     which can be used to select or disable options specifically for
                   2001:     package <em class="replaceable"><code>pkgbase</code></em>.  Options listed in
1.128     wiz      2002:     these variables are selected, options preceded by <span class="quote">&#8220;<span class="quote">-</span>&#8221;</span>
1.88      wiz      2003:     are disabled. A few examples:</p>
1.75      rillig   2004: <pre class="screen">
1.110     hubertf  2005: <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   2006: PKG_DEFAULT_OPTIONS=    -arts -dvdread -esound
                   2007: PKG_OPTIONS.kdebase=    debug -sasl
                   2008: PKG_OPTIONS.apache=     suexec </pre>
1.111     rillig   2009: <p>It is important to note that options that were specifically
1.120     snj      2010:     suggested by the package maintainer must be explicitly removed if
1.111     rillig   2011:     you do not wish to include the option.  If you are unsure you can view
                   2012:     the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.88      wiz      2013: <p>The following settings are consulted in the order given, and
                   2014:     the last setting that selects or disables an option is
                   2015:     used:</p>
1.128     wiz      2016: <div class="orderedlist"><ol class="orderedlist" type="1">
                   2017: <li class="listitem"><p>the default options as suggested by the package
1.88      wiz      2018:       maintainer</p></li>
1.128     wiz      2019: <li class="listitem"><p>the options implied by the settings of legacy
1.88      wiz      2020:       variables (see below)</p></li>
1.128     wiz      2021: <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
                   2022: <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
1.75      rillig   2023: </ol></div>
                   2024: <p>For groups of mutually exclusive options, the last option
1.88      wiz      2025:     selected is used, all others are automatically disabled.  If an
                   2026:     option of the group is explicitly disabled, the previously
                   2027:     selected option, if any, is used.  It is an error if no option
                   2028:     from a required group of options is selected, and building the
                   2029:     package will fail.</p>
                   2030: <p>Before the options framework was introduced, build options
                   2031:     were selected by setting a variable (often named
                   2032:     <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.110     hubertf  2033:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option.  To ease
1.88      wiz      2034:     transition to the options framework for the user, these legacy
                   2035:     variables are converted to the appropriate options setting
                   2036:     (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
                   2037:     automatically.  A warning is issued to prompt the user to update
1.110     hubertf  2038:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.88      wiz      2039:     directly.  Support for the legacy variables will be removed
                   2040:     eventually.</p>
1.75      rillig   2041: </div>
                   2042: </div>
1.148     asau     2043: <div class="chapter">
1.75      rillig   2044: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   2045: <a name="binary"></a>Chapter 7. Creating binary packages</h2></div></div></div>
1.75      rillig   2046: <div class="toc">
                   2047: <p><b>Table of Contents</b></p>
1.210     leot     2048: <dl class="toc">
1.267     rillig   2049: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
                   2050: <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   2051: </dl>
                   2052: </div>
1.148     asau     2053: <div class="sect1">
1.75      rillig   2054: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2055: <a name="building-a-single-binary-package"></a>7.1. Building a single binary package</h2></div></div></div>
1.87      wiz      2056: <p>Once you have built and installed a package, you can create
                   2057:     a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.311     leot     2058:     another system with <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. This saves having to build
1.87      wiz      2059:     the same package on a group of hosts and wasting CPU time. It also
                   2060:     provides a simple means for others to install your package, should
                   2061:     you distribute it.</p>
                   2062: <p>To create a binary package, change into the appropriate
1.110     hubertf  2063:     directory in pkgsrc, and run <span class="command"><strong>make
1.87      wiz      2064:     package</strong></span>:</p>
                   2065: <pre class="screen">
1.223     rillig   2066: <code class="prompt">$</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
                   2067: <code class="prompt">$</code> <strong class="userinput"><code>make package</code></strong>
                   2068: </pre>
1.87      wiz      2069: <p>This will build and install your package (if not already done),
                   2070:     and then build a binary package from what was installed. You can
1.110     hubertf  2071:     then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.87      wiz      2072:     it. Binary packages are created by default in
                   2073:     <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.110     hubertf  2074:     gzipped tar file. See <a class="xref" href="#logs.package" title="B.2. Packaging figlet">Section B.2, &#8220;Packaging figlet&#8221;</a> for a
1.250     leot     2075:     continuation of the above <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/misc/figlet/README.html" target="_top"><code class="filename">misc/figlet</code></a> example.</p>
1.267     rillig   2076: <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      2077:     such a binary package.</p>
1.75      rillig   2078: </div>
1.148     asau     2079: <div class="sect1">
1.75      rillig   2080: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2081: <a name="settings-for-creationg-of-binary-packages"></a>7.2. Settings for creation of binary packages</h2></div></div></div>
1.299     rillig   2082: <p>See <a class="xref" href="#build.helpful-targets" title="13.17. Other helpful targets">Section 13.17, &#8220;Other helpful targets&#8221;</a>.</p>
1.106     rillig   2083: </div>
                   2084: </div>
1.148     asau     2085: <div class="chapter">
1.106     rillig   2086: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   2087: <a name="bulk"></a>Chapter 8. Creating binary packages for everything in pkgsrc (bulk
1.106     rillig   2088: builds)</h2></div></div></div>
                   2089: <div class="toc">
                   2090: <p><b>Table of Contents</b></p>
1.210     leot     2091: <dl class="toc">
1.267     rillig   2092: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
1.295     rillig   2093: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a bulk build</a></span></dt>
1.267     rillig   2094: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
                   2095: <dt><span class="sect1"><a href="#bulk.req">8.3. Requirements of a full bulk build</a></span></dt>
1.293     rillig   2096: <dt><span class="sect1"><a href="#bulk.var">8.4. Bulk build variants</a></span></dt>
                   2097: <dd><dl>
1.294     rillig   2098: <dt><span class="sect2"><a href="#bulk.var.confopt">8.4.1. Detect unknown configure options</a></span></dt>
                   2099: <dt><span class="sect2"><a href="#bulk.var.comperr">8.4.2. Detect classes of bugs by forcing compiler warnings</a></span></dt>
1.296     rillig   2100: <dt><span class="sect2"><a href="#bulk.var.builderr">8.4.3. Force compiler options only in the build phase</a></span></dt>
                   2101: <dt><span class="sect2"><a href="#bulk.var.dirs">8.4.4. Use custom directories</a></span></dt>
                   2102: <dt><span class="sect2"><a href="#bulk.var.warn">8.4.5. Turn warnings into errors</a></span></dt>
                   2103: <dt><span class="sect2"><a href="#bulk.var.pkglint">8.4.6. Reject packages for which pkglint reports errors</a></span></dt>
                   2104: <dt><span class="sect2"><a href="#bulk.var.strings">8.4.7. Reject packages that contain forbidden strings</a></span></dt>
                   2105: <dt><span class="sect2"><a href="#bulk.var.test">8.4.8. Reject packages whose self-test fails</a></span></dt>
                   2106: <dt><span class="sect2"><a href="#bulk.var.shvar">8.4.9. Reject packages that use undefined shell variables</a></span></dt>
                   2107: <dt><span class="sect2"><a href="#bulk.var.quiet">8.4.10. Turn off verbose logging</a></span></dt>
1.293     rillig   2108: </dl></dd>
                   2109: <dt><span class="sect1"><a href="#creating-cdroms">8.5. Creating a multiple CD-ROM packages collection</a></span></dt>
                   2110: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.5.1. Example of cdpack</a></span></dt></dl></dd>
1.106     rillig   2111: </dl>
                   2112: </div>
1.290     gutterid 2113: <p>For a number of reasons, you may want to build binary packages
                   2114: for a large selected set of packages in pkgsrc, or even for all pkgsrc packages.
1.180     wiz      2115: For instance, when you have multiple machines that should run the same software,
                   2116: it is wasted time if they all build their packages themselves from source.
                   2117: Or you may want to build a list of packages you want and check them before
1.290     gutterid 2118: deploying onto production systems.
1.180     wiz      2119: There is a way of getting a set of binary packages:
1.290     gutterid 2120: the bulk build system, or pbulk ("p" stands for "parallel").
1.223     rillig   2121: This chapter describes how to set it up.</p>
1.148     asau     2122: <div class="sect1">
1.106     rillig   2123: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2124: <a name="bulk.pre"></a>8.1. Preparations</h2></div></div></div>
1.180     wiz      2125: <p>First of all, you have to decide whether you build all packages
                   2126: or a limited set of them. Full bulk builds usually consume a lot more resources,
                   2127: both space and time, than builds for some practical sets of packages.
1.290     gutterid 2128: A number of particularly heavy packages exist that are not actually
                   2129: interesting to a wide audience. (The approximate resource consumption for a
                   2130: full bulk build is given in section <a class="xref" href="#bulk.req" title="8.3. Requirements of a full bulk build">Section 8.3, &#8220;Requirements of a full bulk build&#8221;</a>.)
                   2131: For limited bulk builds you need to make a list of packages you want to build.
1.223     rillig   2132: Note that all their dependencies will be built, so you don't need to track them manually.
1.180     wiz      2133: </p>
                   2134: <p>During bulk builds various packages are installed and deinstalled
                   2135: in <code class="filename">/usr/pkg</code> (or whatever <code class="filename">LOCALBASE</code> is),
                   2136: so make sure that you don't need any package during the builds.
1.223     rillig   2137: Essentially, you should provide a fresh system, either a chroot environment
1.180     wiz      2138: or something even more restrictive, depending on what the operating system provides,
                   2139: or dedicate the whole physical machine.
                   2140: As a useful side effect this makes sure that bulk builds cannot
                   2141: break anything in your system. There have been numerous cases where
1.106     rillig   2142: certain packages tried to install files outside the
                   2143: <code class="filename">LOCALBASE</code> or wanted to edit some files in
1.180     wiz      2144: <code class="filename">/etc</code>.
                   2145: </p>
1.106     rillig   2146: </div>
1.148     asau     2147: <div class="sect1">
1.106     rillig   2148: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.295     rillig   2149: <a name="bulk.pbulk"></a>8.2. Running a bulk build</h2></div></div></div>
                   2150: <p>Running a bulk build works roughly as follows:</p>
1.148     asau     2151: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2152: <li class="listitem"><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
                   2153: <li class="listitem"><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
1.116     rillig   2154: </ul></div>
1.148     asau     2155: <div class="sect2">
1.116     rillig   2156: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   2157: <a name="bulk.pbulk.conf"></a>8.2.1. Configuration</h3></div></div></div>
1.223     rillig   2158: <p>To simplify configuration, we provide the helper script <code class="filename">mk/pbulk/pbulk.sh</code>.</p>
1.178     asau     2159: <p>In order to use it, prepare a clear system (real one, chroot environment, jail, zone, virtual machine).
                   2160: Configure network access to fetch distribution files.
1.223     rillig   2161: Create a user with name "pbulk".</p>
1.178     asau     2162: <p>Fetch and extract pkgsrc. Use a command like one of these:</p>
                   2163: <pre class="screen">
1.264     sevan    2164: <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>
                   2165: <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      2166: <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     2167: </pre>
                   2168: <p>Or any other way that fits (e.g., curl, wget).</p>
                   2169: <p>Deploy and configure pbulk tools, e.g.:</p>
                   2170: <pre class="screen">
1.230     sevan    2171: <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     2172: <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>
                   2173: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -nlc mk.conf.frag # native, apply settings, configure for limited build</code></strong>
                   2174: </pre>
                   2175: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2176: <h3 class="title">Note</h3>
                   2177: <p><code class="filename">mk.conf.frag</code> is a fragment of
                   2178: <code class="filename">mk.conf</code> that contains settings you want to
                   2179: apply to packages you build. For instance,</p>
                   2180: <pre class="programlisting">
1.223     rillig   2181: PKG_DEVELOPER=          yes     # perform more checks
                   2182: X11_TYPE=               modular # use pkgsrc X11
                   2183: SKIP_LICENSE_CHECK=     yes     # accept all licences (useful
                   2184:                                 # when building all packages)
1.178     asau     2185: </pre>
                   2186: </div>
                   2187: <p>If configured for limited list, replace the list in <code class="filename">/usr/pbulk/etc/pbulk.list</code>
1.223     rillig   2188: with your list of packages, one per line without empty lines or comments. E.g.:</p>
1.178     asau     2189: <pre class="programlisting">
                   2190: www/firefox
                   2191: mail/thunderbird
                   2192: misc/libreoffice4
                   2193: </pre>
1.179     asau     2194: <p>At this point you can also review configuration in <code class="filename">/usr/pbulk/etc</code>
                   2195: and make final amendments, if wanted.</p>
1.178     asau     2196: <p>Start it:</p>
                   2197: <pre class="screen">
                   2198: <code class="prompt">#</code> <strong class="userinput"><code>/usr/pbulk/bin/bulkbuild</code></strong>
                   2199: </pre>
                   2200: <p>After it finishes, you'll have <code class="filename">/mnt</code> filled with distribution files, binary packages, and reports,
                   2201: plain text summary in <code class="filename">/mnt/bulklog/meta/report.txt</code>
                   2202: </p>
                   2203: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2204: <h3 class="title">Note</h3>
                   2205: <p>The <code class="filename">pbulk.sh</code> script does not cover all possible use cases.
                   2206: While being ready to run, it serves as a good starting point to understand and build more complex setups.
                   2207: The script is kept small enough for better understanding.</p>
                   2208: </div>
                   2209: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2210: <h3 class="title">Note</h3>
                   2211: <p>The <code class="filename">pbulk.sh</code> script supports running
                   2212: unprivileged bulk build and helps configuring distributed bulk builds.</p>
                   2213: </div>
1.106     rillig   2214: </div>
                   2215: </div>
1.148     asau     2216: <div class="sect1">
1.106     rillig   2217: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2218: <a name="bulk.req"></a>8.3. Requirements of a full bulk build</h2></div></div></div>
1.180     wiz      2219: <p>A complete bulk build requires lots of disk space. Some of the
                   2220: disk space can be read-only, some other must be writable. Some can be on
                   2221: remote filesystems (such as NFS) and some should be local. Some can be
                   2222: temporary filesystems, others must survive a sudden reboot.</p>
                   2223: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   2224: <li class="listitem"><p>40 GB for the distfiles (read-write, remote, temporary)</p></li>
                   2225: <li class="listitem"><p>30 GB for the binary packages (read-write, remote, permanent)</p></li>
                   2226: <li class="listitem"><p>1 GB for the pkgsrc tree (read-only, remote, permanent)</p></li>
                   2227: <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary)</p></li>
                   2228: <li class="listitem"><p>10 GB for the log files (read-write, remote, permanent)</p></li>
                   2229: <li class="listitem"><p>5 GB for temporary files (read-write, local, temporary)</p></li>
                   2230: </ul></div>
                   2231: </div>
                   2232: <div class="sect1">
                   2233: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.293     rillig   2234: <a name="bulk.var"></a>8.4. Bulk build variants</h2></div></div></div>
                   2235: <p>To ensure that pkgsrc packages work in different configurations, it
                   2236: makes sense to run non-default bulk builds from time to time. This
                   2237: section lists some ideas for bulk builds that intentionally let packages
                   2238: fail if they don't follow the pkgsrc style.</p>
                   2239: <div class="sect2">
                   2240: <div class="titlepage"><div><div><h3 class="title">
1.294     rillig   2241: <a name="bulk.var.confopt"></a>8.4.1. Detect unknown configure options</h3></div></div></div>
1.293     rillig   2242: <p>Add the following line to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
                   2243: <pre class="programlisting">
                   2244: GNU_CONFIGURE_STRICT=   yes
                   2245: </pre>
                   2246: <p>When a package fails this additional check, the most common cause
                   2247: is that the configure option was valid for an older version of the
                   2248: package but does not apply anymore. In that case, just remove it.</p>
                   2249: </div>
                   2250: <div class="sect2">
                   2251: <div class="titlepage"><div><div><h3 class="title">
1.294     rillig   2252: <a name="bulk.var.comperr"></a>8.4.2. Detect classes of bugs by forcing compiler warnings</h3></div></div></div>
1.293     rillig   2253: <p>The job of a compiler is not restricted to producing executable
1.294     rillig   2254: code, most compilers also detect typical programming mistakes. The pkgsrc
                   2255: compiler wrappers make it easy to force compiler options when the package
                   2256: is built. This can be used to find typical bugs across all packages that
                   2257: are in pkgsrc. By reporting these bugs upstream, the packages will be
                   2258: more reliable with the next updates.</p>
                   2259: <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   2260: <pre class="programlisting">
                   2261: CFLAGS+=        -Werror=char-subscripts
1.294     rillig   2262: CFLAGS+=        -Werror=implicit-function-declaration
1.293     rillig   2263: </pre>
1.294     rillig   2264: <p>When a package fails to build using these stricter compiler
                   2265: options, document the circumstances in which the compiler produced the
                   2266: error message. This includes:</p>
1.293     rillig   2267: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   2268: <li class="listitem"><p>The platform
                   2269: (<code class="varname">MACHINE_PLATFORM</code>)</p></li>
                   2270: <li class="listitem"><p>The source file</p></li>
                   2271: <li class="listitem"><p>An excerpt of the code. GCC and Clang already do this as
                   2272: part of the diagnostic.</p></li>
1.294     rillig   2273: <li class="listitem"><p>The exact error message from the compiler.</p></li>
1.293     rillig   2274: </ul></div>
                   2275: <p>If a package produces these error messages, but the package is
1.294     rillig   2276: 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
                   2277: in the next builds:</p>
1.293     rillig   2278: <pre class="programlisting">
1.294     rillig   2279: .if ${PKGPATH} == category/package
1.293     rillig   2280: # Version ${VERSION} failed on ${MACHINE_PLATFORM}:
                   2281: # error message
                   2282: # code
1.294     rillig   2283: # Reason why the code does not need to be fixed.
1.293     rillig   2284: BUILDLINK_TRANSFORM+=   rm:-Werror=char-subscripts
1.294     rillig   2285: .endif
1.293     rillig   2286: </pre>
                   2287: <p>If the error messages from the compiler are valid and the code
1.294     rillig   2288: needs to be fixed, prepare a local patch (see
                   2289: <code class="varname">LOCALPATCHES</code>) and report the bug to the upstream
                   2290: authors of the package, providing them with the information you collected
                   2291: above.</p>
                   2292: <p>Patches that are not essential for the package to work should only
                   2293: be reported upstream but not committed to pkgsrc, to make future updates
                   2294: easier.</p>
1.293     rillig   2295: </div>
                   2296: <div class="sect2">
                   2297: <div class="titlepage"><div><div><h3 class="title">
1.296     rillig   2298: <a name="bulk.var.builderr"></a>8.4.3. Force compiler options only in the build phase</h3></div></div></div>
                   2299: <p>When adding custom compiler flags via <code class="varname">CFLAGS</code>,
                   2300: these apply to all phases of the package build process. Especially in the
                   2301: configure phase, adding <code class="literal">-Werror</code> leads to wrong
                   2302: decisions. The GNU configure scripts feed many small test programs to the
                   2303: C compiler to see whether certain headers are available, functions are
                   2304: defined in a library and programs can be run. In many cases these
                   2305: programs would not survive a strict compiler run with <code class="literal">-Wall
                   2306: -Wextra -Werror</code>.</p>
                   2307: <p>The pkgsrc infrastructure is flexible enough to support compiler
                   2308: options being added between the <code class="literal">configure</code> and
                   2309: <code class="literal">build</code> phases. It's a little more complicated than the
                   2310: other examples in this section but still easy enough.</p>
                   2311: <p>The basic idea is to use the pkgsrc compiler wrapper to inject the
                   2312: desired compiler options. The compiler wrapper's original task is to hide
                   2313: unwanted directories of include files and to normalize compiler options.
                   2314: It does this by wrapping the compiler command and rewriting the command
                   2315: line. To see this in action, run <span class="command"><strong>bmake patch</strong></span> in a
                   2316: package directory and examine the
                   2317: <code class="filename">work/.cwrappers/config</code> directory. It contains
                   2318: individual configurations for the C compiler and the related tools. The
                   2319: plan is to find a hook between the configure and build phases, and to
                   2320: modify these configuration files at that point.</p>
                   2321: <p>To find this hook, have a look at
                   2322: <code class="filename">mk/build/build.mk</code>, which contains among others the
                   2323: <code class="literal">pre-build-checks-hook</code>. The word
                   2324: <code class="literal">checks</code> doesn't quite fit, but the
                   2325: <code class="literal">pre-build-hook</code> sounds good enough.</p>
                   2326: <p>The code to be included in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> is:</p>
                   2327: <pre class="programlisting">
                   2328: # Just a few example options.
                   2329: BUILD_ONLY_CFLAGS=      -Wall -Werror -O2 -DTEMPDIR='"/tmp"'
                   2330: 
                   2331: .if ${BUILD_ONLY_CFLAGS:U:M*}
                   2332: pre-build-checks-hook: add-build-only-cflags
                   2333: 
                   2334: add-build-only-cflags: .PHONY
                   2335:         ${RUN} cd ${CWRAPPERS_CONFIG_DIR};      \
                   2336:         ${TEST} ! -f ${.TARGET} || exit 0;      \
                   2337:         for flag in ${BUILD_ONLY_CFLAGS}; do    \
                   2338:                 ${ECHO} "append=$$flag" &gt;&gt; cc;  \
                   2339:         done;                                   \
                   2340:         &gt; ${.TARGET}
                   2341: .endif
                   2342: </pre>
                   2343: <p>(When editing the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, make sure that the commands of the
                   2344: <code class="literal">add-build-only-cflags</code> target are indented with a tab,
                   2345: not with spaces.)</p>
                   2346: <p>The condition in the <code class="literal">.if</code> statement contains the
                   2347: <code class="literal">:U</code> modifier to prevent parse errors if the variable
                   2348: should be undefined, possibly because it is only defined for a subset of
                   2349: the packages. The <code class="literal">:M*</code> modifier ensures that there is
                   2350: at least one compiler option, to prevent a syntax error in the shell
                   2351: parser.</p>
                   2352: <p>The code around the <code class="literal">${.TARGET}</code> variable ensures
                   2353: that the additional compiler options are only appended once, even if
                   2354: <span class="command"><strong>bmake build</strong></span> is run multiple times. To do this, it
                   2355: creates a marker file.</p>
                   2356: <p>To verify that this setup works, run <span class="command"><strong>bmake
                   2357: configure</strong></span> in a package directory. Up to now, everything works
                   2358: as usual. Examine the directory
                   2359: <code class="filename">work/.cwrappers/config</code> to see that the compiler
                   2360: options from <code class="varname">BUILD_ONLY_CFLAGS</code> are not yet added to
                   2361: the file <code class="filename">cc</code>. Examine the tail of the
                   2362: <code class="filename">work/.work.log</code> file to see that the normal compiler
                   2363: options are used.</p>
                   2364: <p>Now run <span class="command"><strong>bmake build</strong></span>. This will append the
                   2365: options to the file <code class="filename">cc</code> and will create the marker
                   2366: file in the same directory. After that, the build starts as usual, but
                   2367: with the added compiler options. Examine the tail of the file
                   2368: <code class="filename">work/.work.log</code> to see that the lines starting with
                   2369: <code class="literal">[*]</code> don't contain the compiler options, but the
                   2370: corresponding lines starting with <code class="literal">&lt;.&gt;</code> do end
                   2371: with these options.</p>
                   2372: <p>Building packages using this setup variant and fixing the resulting
                   2373: bugs is the same as in <a class="xref" href="#bulk.var.comperr" title="8.4.2. Detect classes of bugs by forcing compiler warnings">Section 8.4.2, &#8220;Detect classes of bugs by forcing compiler warnings&#8221;</a>.</p>
                   2374: </div>
                   2375: <div class="sect2">
                   2376: <div class="titlepage"><div><div><h3 class="title">
                   2377: <a name="bulk.var.dirs"></a>8.4.4. Use custom directories</h3></div></div></div>
1.293     rillig   2378: <p>Some directories like <code class="varname">PREFIX</code>,
                   2379: <code class="varname">VARBASE</code>, <code class="varname">PKG_SYSCONFDIR</code>,
                   2380: <code class="varname">PKGMANDIR</code>, <code class="varname">PKG_INFODIR</code> can be
                   2381: configured in pkgsrc. Set these to arbitrary paths during bootstrap or
                   2382: afterwards in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
                   2383: <pre class="programlisting">
                   2384: PREFIX=         /a-random-uuid
                   2385: PKG_SYSCONFDIR= /a-random-uuid
                   2386: VARBASE=        /a-random-uuid
                   2387: PKGMANDIR=     a-random-uuid
                   2388: PKG_INFODIR=   a-random-uuid
                   2389: </pre>
                   2390: </div>
                   2391: <div class="sect2">
                   2392: <div class="titlepage"><div><div><h3 class="title">
1.296     rillig   2393: <a name="bulk.var.warn"></a>8.4.5. Turn warnings into errors</h3></div></div></div>
1.293     rillig   2394: <p>When building a package, warnings are typically ignored since they
                   2395: just flow by and do not cause the build to fail immediately. To find
                   2396: these warnings, redefine them to errors in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
                   2397: <pre class="programlisting">
                   2398: DELAYED_WARNING_MSG=    ${DELAYED_ERROR_MSG} "(was warning)"
                   2399: WARNING_MSG=            ${FAIL_MSG} "(was warning)"
                   2400: </pre>
                   2401: <p>(There are many more classes of warnings in pkgsrc, and most of
                   2402: them can be redefined with a simple definition like above.</p>
1.294     rillig   2403: <p>If a package suggests to add <code class="varname">USE_TOOLS+=perl</code> to
1.293     rillig   2404: the package Makefile, research whether the package actually needs Perl.
                   2405: If it does, add <code class="varname">USE_TOOLS+=perl</code> to the package
                   2406: Makefile, and if it doesn't, add
                   2407: <code class="varname">TOOLS_BROKEN+=perl</code>.</p>
                   2408: </div>
                   2409: <div class="sect2">
                   2410: <div class="titlepage"><div><div><h3 class="title">
1.296     rillig   2411: <a name="bulk.var.pkglint"></a>8.4.6. Reject packages for which pkglint reports errors</h3></div></div></div>
1.293     rillig   2412: <p>Using pkglint as part of the regular build process is mostly a
                   2413: waste of time. If you want to fix some of the warnings, just run pkglint
                   2414: recursively on the whole pkgsrc tree. This will take a few minutes (up to
                   2415: 10), which is much faster than a complete bulk build.</p>
                   2416: </div>
                   2417: <div class="sect2">
                   2418: <div class="titlepage"><div><div><h3 class="title">
1.296     rillig   2419: <a name="bulk.var.strings"></a>8.4.7. Reject packages that contain forbidden strings</h3></div></div></div>
1.293     rillig   2420: <p>To ensure that the binary packages don't contain references to the
                   2421: build directory, there is already <code class="varname">CHECK_WRKREF</code>. If
                   2422: that variable includes the item <code class="literal">extra</code>, it is
                   2423: possible to define additional patterns that must not appear in any
                   2424: installed file. This is specified in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
                   2425: <pre class="programlisting">
                   2426: CHECK_WRKREF=                   extra
                   2427: CHECK_WRKREF_EXTRA_DIRS+=       /usr/local
                   2428: CHECK_WRKREF_EXTRA_DIRS+=       /usr/pkg
                   2429: CHECK_WRKREF_EXTRA_DIRS+=      @[A-Z][A-Z]*@
                   2430: </pre>
                   2431: <p>The above patterns will probably generate many false positives,
                   2432: therefore the results need to be taken with a grain of salt.</p>
                   2433: </div>
                   2434: <div class="sect2">
                   2435: <div class="titlepage"><div><div><h3 class="title">
1.296     rillig   2436: <a name="bulk.var.test"></a>8.4.8. Reject packages whose self-test fails</h3></div></div></div>
1.293     rillig   2437: <p>To run the test suites that come with each package, add this line
                   2438: to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
                   2439: <pre class="programlisting">
                   2440: PKGSRC_RUN_TEST=        yes
                   2441: </pre>
                   2442: <p>Be prepared that even the most basic packages fail this test. When
                   2443: doing a bulk build with this, it will often abort in the early phase
                   2444: where the packages are scanned for their dependencies since there are
                   2445: cyclic dependencies. There is still a lot to do in this area.</p>
                   2446: </div>
                   2447: <div class="sect2">
                   2448: <div class="titlepage"><div><div><h3 class="title">
1.296     rillig   2449: <a name="bulk.var.shvar"></a>8.4.9. Reject packages that use undefined shell variables</h3></div></div></div>
1.293     rillig   2450: <p>To catch typos in the shell snippets from the Makefile fragments,
                   2451: add the <code class="literal">-u</code> flag to most of the commands by adding this
                   2452: line to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
                   2453: <pre class="programlisting">
                   2454: RUN=    @set -eu;
                   2455: </pre>
1.296     rillig   2456: <p>After that, ensure that none of the bulk build log files (even
                   2457: those for successfully built packages) contains the string
                   2458: <code class="literal">parameter not set</code> or whatever error message the
                   2459: command <span class="command"><strong>sh -ceu '$undefined'</strong></span> outputs.</p>
1.293     rillig   2460: <p>See <code class="filename">mk/misc/common.mk</code> for the existing
                   2461: definition.</p>
                   2462: </div>
                   2463: <div class="sect2">
                   2464: <div class="titlepage"><div><div><h3 class="title">
1.296     rillig   2465: <a name="bulk.var.quiet"></a>8.4.10. Turn off verbose logging</h3></div></div></div>
1.293     rillig   2466: <p>The build logs of a package are often quite long. This allows error
                   2467: messages or other interesting details to hide between the noise. To make
                   2468: the actual error message stand out more, add these lines to
                   2469: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
                   2470: <pre class="programlisting">
                   2471: GNU_CONFIGURE_QUIET=    yes
                   2472: MAKE_FLAGS+=            -s
                   2473: </pre>
                   2474: <p>The <code class="literal">-s</code> option works for both GNU Make and BSD
                   2475: Make. On exotic platforms with their own make, it may be a little
                   2476: different.</p>
                   2477: </div>
                   2478: </div>
                   2479: <div class="sect1">
                   2480: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2481: <a name="creating-cdroms"></a>8.5. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.87      wiz      2482: <p>After your pkgsrc bulk-build has completed, you may wish to
                   2483:     create a CD-ROM set of the resulting binary packages to assist
                   2484:     in installing packages on other machines.  The
1.250     leot     2485:     <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/cdpack/README.html" target="_top"><code class="filename">pkgtools/cdpack</code></a> package provides
1.87      wiz      2486:     a simple tool for creating the ISO 9660 images.
1.110     hubertf  2487:     <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.87      wiz      2488:     way that keeps all the dependencies for a given package on the same
                   2489:     CD as that package.</p>
1.148     asau     2490: <div class="sect2">
1.75      rillig   2491: <div class="titlepage"><div><div><h3 class="title">
1.293     rillig   2492: <a name="cdpack-example"></a>8.5.1. Example of cdpack</h3></div></div></div>
1.87      wiz      2493: <p>Complete documentation for cdpack is found in the cdpack(1)
                   2494:       man page. The following short example assumes that the binary
                   2495:       packages are left in
                   2496:       <code class="filename">/usr/pkgsrc/packages/All</code> and that
                   2497:       sufficient disk space exists in <code class="filename">/u2</code> to
                   2498:       hold the ISO 9660 images.</p>
                   2499: <pre class="screen">
                   2500: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
1.75      rillig   2501: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
1.87      wiz      2502: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
                   2503:       </pre>
                   2504: <p>If you wish to include a common set of files
                   2505:       (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
                   2506:       etc.) on each CD in the collection, then you need to create a
1.290     gutterid 2507:       directory which contains these files, e.g.:</p>
1.87      wiz      2508: <pre class="screen">
                   2509: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
1.75      rillig   2510: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" &gt; /tmp/common/README</code></strong>
                   2511: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" &gt; /tmp/common/COPYING</code></strong>
                   2512: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
                   2513: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" &gt; /tmp/common/bin/myscript</code></strong>
                   2514: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" &gt;&gt; /tmp/common/bin/myscript</code></strong>
1.87      wiz      2515: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
                   2516:       </pre>
1.75      rillig   2517: <p>Now create the images:</p>
                   2518: <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   2519: <p>Each image will contain <code class="filename">README</code>,
1.87      wiz      2520:       <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
                   2521:       in their root directories.</p>
1.75      rillig   2522: </div>
                   2523: </div>
                   2524: </div>
1.148     asau     2525: <div class="chapter">
1.75      rillig   2526: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   2527: <a name="files"></a>Chapter 9. Directory layout of the installed files</h2></div></div></div>
1.90      rillig   2528: <div class="toc">
                   2529: <p><b>Table of Contents</b></p>
1.210     leot     2530: <dl class="toc">
1.267     rillig   2531: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
                   2532: <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   2533: </dl>
                   2534: </div>
                   2535: <p>The files that are installed by pkgsrc are organized in a way that
                   2536: is similar to what you find in the <code class="filename">/usr</code> directory
                   2537: of the base system. But some details are different. This is because
                   2538: pkgsrc initially came from FreeBSD and had adopted its file system
                   2539: hierarchy. Later it was largely influenced by NetBSD. But no matter
                   2540: which operating system you are using pkgsrc with, you can expect the
                   2541: same layout for pkgsrc.</p>
1.91      rillig   2542: <p>There are mainly four root directories for pkgsrc, which are all
                   2543: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
                   2544: When pkgsrc has been installed as root, the default locations
                   2545: are:</p>
                   2546: <pre class="programlisting">
1.100     rillig   2547: LOCALBASE=              /usr/pkg
                   2548: PKG_SYSCONFBASE=        /usr/pkg/etc
                   2549: VARBASE=                /var
1.231     sevan    2550: PKG_DBDIR=              /usr/pkg/pkgdb
1.91      rillig   2551: </pre>
                   2552: <p>In unprivileged mode (when pkgsrc has been installed as any other
                   2553: user), the default locations are:</p>
                   2554: <pre class="programlisting">
1.100     rillig   2555: LOCALBASE=              ${HOME}/pkg
                   2556: PKG_SYSCONFBASE=        ${HOME}/pkg/etc
                   2557: VARBASE=                ${HOME}/pkg/var
1.231     sevan    2558: PKG_DBDIR=              ${HOME}/pkg/pkgdb
1.91      rillig   2559: </pre>
                   2560: <p>What these four directories are for, and what they look like is
                   2561: explained below.</p>
1.148     asau     2562: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2563: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.90      rillig   2564: <code class="filename">/usr</code> directory in the base system. It is the
1.128     wiz      2565: <span class="quote">&#8220;<span class="quote">main</span>&#8221;</span> directory where the files are installed and contains
1.90      rillig   2566: the well-known subdirectories like <code class="filename">bin</code>,
                   2567: <code class="filename">include</code>, <code class="filename">lib</code>,
                   2568: <code class="filename">share</code> and
                   2569: <code class="filename">sbin</code>.</p></li>
1.128     wiz      2570: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.90      rillig   2571: <code class="filename">/var</code> in the base system. Some programs (especially
                   2572: games, network daemons) need write access to it during normal
                   2573: operation.</p></li>
1.128     wiz      2574: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.90      rillig   2575: <code class="filename">/etc</code> in the base system. It contains configuration
1.110     hubertf  2576: 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   2577: itself.</p></li>
                   2578: </ul></div>
1.148     asau     2579: <div class="sect1">
1.90      rillig   2580: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2581: <a name="files.localbase"></a>9.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.93      rillig   2582: </h2></div></div></div>
1.90      rillig   2583: <p>The following directories exist in a typical pkgsrc installation
1.91      rillig   2584: in <code class="filename">${LOCALBASE}</code>.</p>
1.148     asau     2585: <div class="variablelist"><dl class="variablelist">
1.90      rillig   2586: <dt><span class="term"><code class="filename">bin</code></span></dt>
                   2587: <dd><p>Contains executable programs that are intended to be
                   2588: directly used by the end user.</p></dd>
                   2589: <dt><span class="term"><code class="filename">emul</code></span></dt>
                   2590: <dd><p>Contains files for the emulation layers of various other
                   2591: operating systems, especially for
                   2592: NetBSD.</p></dd>
                   2593: <dt><span class="term"><code class="filename">etc</code> (the usual location of
                   2594: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
                   2595: <dd><p>Contains
                   2596: the configuration files.</p></dd>
                   2597: <dt><span class="term"><code class="filename">include</code></span></dt>
                   2598: <dd><p>Contains headers for the C and C++ programming
                   2599: languages.</p></dd>
                   2600: <dt><span class="term"><code class="filename">info</code></span></dt>
                   2601: <dd><p>Contains GNU info files of various
                   2602: packages.</p></dd>
                   2603: <dt><span class="term"><code class="filename">lib</code></span></dt>
                   2604: <dd><p>Contains shared and static
                   2605: libraries.</p></dd>
                   2606: <dt><span class="term"><code class="filename">libdata</code></span></dt>
                   2607: <dd><p>Contains data files that don't change after
                   2608: installation. Other data files belong into
                   2609: <code class="filename">${VARBASE}</code>.</p></dd>
                   2610: <dt><span class="term"><code class="filename">libexec</code></span></dt>
                   2611: <dd><p>Contains programs that are not intended to be used by
                   2612: end users, such as helper programs or network
                   2613: daemons.</p></dd>
                   2614: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
                   2615: <dd><p>Contains programs that are intended to be executed as
                   2616: CGI scripts by a web server.</p></dd>
                   2617: <dt><span class="term"><code class="filename">man</code> (the usual value of
                   2618: <code class="filename">${PKGMANDIR}</code>)</span></dt>
                   2619: <dd><p>Contains brief
                   2620: documentation in form of manual pages.</p></dd>
                   2621: <dt><span class="term"><code class="filename">sbin</code></span></dt>
                   2622: <dd><p>Contains programs that are intended to be used only by
                   2623: the super-user.</p></dd>
                   2624: <dt><span class="term"><code class="filename">share</code></span></dt>
                   2625: <dd><p>Contains platform-independent data files that don't
                   2626: change after installation.</p></dd>
                   2627: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
                   2628: <dd><p>Contains documentation files provided by the
                   2629: packages.</p></dd>
                   2630: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
                   2631: <dd><p>Contains example files provided by the packages. Among
                   2632: others, the original configuration files are saved here and copied to
                   2633: <code class="filename">${PKG_SYSCONFDIR}</code> during
                   2634: installation.</p></dd>
                   2635: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
                   2636: <dd><p>Contains the original files for rc.d
                   2637: scripts.</p></dd>
                   2638: <dt><span class="term"><code class="filename">var</code> (the usual location of
                   2639: <code class="filename">${VARBASE}</code>)</span></dt>
                   2640: <dd><p>Contains files
                   2641: that may be modified after
                   2642: installation.</p></dd>
                   2643: </dl></div>
                   2644: </div>
1.148     asau     2645: <div class="sect1">
1.90      rillig   2646: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2647: <a name="files.varbase"></a>9.2. File system layout in <code class="literal">${VARBASE}</code>
1.93      rillig   2648: </h2></div></div></div>
1.148     asau     2649: <div class="variablelist"><dl class="variablelist">
1.90      rillig   2650: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
                   2651: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
                   2652: <dd><p>Contains
                   2653: information about the currently installed
                   2654: packages.</p></dd>
                   2655: <dt><span class="term"><code class="filename">games</code></span></dt>
                   2656: <dd><p>Contains highscore
                   2657: files.</p></dd>
                   2658: <dt><span class="term"><code class="filename">log</code></span></dt>
                   2659: <dd><p>Contains log files.</p></dd>
                   2660: <dt><span class="term"><code class="filename">run</code></span></dt>
                   2661: <dd><p>Contains informational files about daemons that are
                   2662: currently running.</p></dd>
                   2663: </dl></div>
                   2664: </div>
                   2665: </div>
1.148     asau     2666: <div class="chapter">
1.90      rillig   2667: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   2668: <a name="faq"></a>Chapter 10. Frequently Asked Questions</h2></div></div></div>
1.75      rillig   2669: <div class="toc">
                   2670: <p><b>Table of Contents</b></p>
1.210     leot     2671: <dl class="toc">
1.267     rillig   2672: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                   2673: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
                   2674: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
                   2675: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
                   2676: <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>
                   2677: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
                   2678: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
                   2679: <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>
                   2680: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
                   2681: <dt><span class="sect1"><a href="#tmac.andoc-missing">10.10. What does <span class="quote">&#8220;<span class="quote">Don't know how to make
1.128     wiz      2682: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</a></span></dt>
1.267     rillig   2683: <dt><span class="sect1"><a href="#bsd.own.mk-missing">10.11. What does <span class="quote">&#8220;<span class="quote">Could not find bsd.own.mk</span>&#8221;</span> mean?</a></span></dt>
                   2684: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' with pkgsrc</a></span></dt>
                   2685: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
                   2686: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
                   2687: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
                   2688: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build.  What shall I do?</a></span></dt>
                   2689: <dt><span class="sect1"><a href="#faq.rcs-conflicts">10.17. What does <span class="quote">&#8220;<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>&#8221;</span> mean?</a></span></dt>
1.75      rillig   2690: </dl>
                   2691: </div>
                   2692: <p>This section contains hints, tips &amp; tricks on special things in
                   2693: pkgsrc that we didn't find a better place for in the previous chapters, and
                   2694: it contains items for both pkgsrc users and developers.</p>
1.148     asau     2695: <div class="sect1">
1.75      rillig   2696: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2697: <a name="mailing-list-pointers"></a>10.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.75      rillig   2698: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.148     asau     2699: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2700: <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   2701:          This is a general purpose list for most issues regarding
                   2702:          pkgsrc, regardless of platform, e.g. soliciting user help
                   2703:          for pkgsrc configuration, unexpected build failures, using
                   2704:          particular packages, upgrading pkgsrc installations,
                   2705:          questions regarding the pkgsrc release branches, etc.  General announcements or
                   2706:          proposals for changes that impact the pkgsrc user community,
                   2707:          e.g. major infrastructure changes, new features, package
                   2708:          removals, etc., may also be posted.</p></li>
1.289     leot     2709: <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   2710:          A list where the results of pkgsrc bulk builds are sent and
                   2711:          discussed.</p></li>
1.289     leot     2712: <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   2713:          This list is for those who are interested in getting a
                   2714:          commit message for every change committed to pkgsrc. It is
                   2715:          also available in digest form, meaning one daily message
                   2716:          containing all commit messages for changes to the package
                   2717:          source tree in that 24 hour period.</p></li>
                   2718: </ul></div>
                   2719: <p>To subscribe, do:</p>
                   2720: <pre class="programlisting">
1.100     rillig   2721: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
1.75      rillig   2722: </pre>
                   2723: <p>Archives for all these mailing lists are available from
1.289     leot     2724: <a class="ulink" href="https://mail-index.NetBSD.org/" target="_top">https://mail-index.NetBSD.org/</a>.</p>
1.75      rillig   2725: </div>
1.148     asau     2726: <div class="sect1">
1.75      rillig   2727: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2728: <a name="faq-pkgtools"></a>10.2. Utilities for package management (pkgtools)</h2></div></div></div>
1.80      rillig   2729: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
1.75      rillig   2730: a number of useful utilities for both users and developers of pkgsrc.  This
1.233     sevan    2731: section attempts only to make the reader aware of some of the utilities and when
1.75      rillig   2732: they might be useful, and not to duplicate the documentation that comes
                   2733: with each package.</p>
                   2734: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.250     leot     2735: <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/README.html" target="_top"><code class="filename">pkgtools/x11-links</code></a>:
1.75      rillig   2736:       Symlinks for use by buildlink.</p></li></ul></div>
                   2737: <p>OS tool augmentation (automatically installed when needed):</p>
1.148     asau     2738: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.250     leot     2739: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/digest/README.html" target="_top"><code class="filename">pkgtools/digest</code></a>:
1.233     sevan    2740:       Calculates various kinds of checksums (including SHA3).</p></li>
1.250     leot     2741: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libnbcompat/README.html" target="_top"><code class="filename">pkgtools/libnbcompat</code></a>:
1.75      rillig   2742:       Compatibility library for pkgsrc tools.</p></li>
1.250     leot     2743: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/mtree/README.html" target="_top"><code class="filename">pkgtools/mtree</code></a>: Installed on
1.87      wiz      2744:       non-BSD systems due to lack of native mtree.</p></li>
1.250     leot     2745: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a>:
1.75      rillig   2746:       Up-to-date replacement for
1.76      rillig   2747:       <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
1.75      rillig   2748:       systems where pkg_install is not present.</p></li>
                   2749: </ul></div>
                   2750: <p>Utilities used by pkgsrc (not automatically installed):</p>
1.148     asau     2751: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.250     leot     2752: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_tarup/README.html" target="_top"><code class="filename">pkgtools/pkg_tarup</code></a>:
1.75      rillig   2753:       Create a binary package from an
1.110     hubertf  2754:       already-installed package.  Used by <span class="command"><strong>make replace</strong></span> to
1.75      rillig   2755:       save the old package.</p></li>
1.250     leot     2756: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/dfdisk/README.html" target="_top"><code class="filename">pkgtools/dfdisk</code></a>:
1.75      rillig   2757:       Adds extra functionality to pkgsrc, allowing it to fetch distfiles
                   2758:       from multiple locations. It currently supports the following
                   2759:       methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.250     leot     2760: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/README.html" target="_top"><code class="filename">devel/cpuflags</code></a>: Determine
1.117     jnemeth  2761:       the best compiler flags to optimise code for your current
1.128     wiz      2762:       CPU and compiler. </p></li>
1.75      rillig   2763: </ul></div>
                   2764: <p>Utilities for keeping track of installed packages, being up to date,
                   2765: etc:</p>
1.148     asau     2766: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.250     leot     2767: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgin/README.html" target="_top"><code class="filename">pkgtools/pkgin</code></a>: A package
1.173     wiz      2768:     update tool similar to apt(1). Download, install, and upgrade
                   2769:     binary packages easily.</p></li>
1.250     leot     2770: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_chk/README.html" target="_top"><code class="filename">pkgtools/pkg_chk</code></a>: Reports on
1.75      rillig   2771:       packages whose installed versions do not match the latest pkgsrc
                   2772:       entries.</p></li>
1.250     leot     2773: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdep/README.html" target="_top"><code class="filename">pkgtools/pkgdep</code></a>: Makes
1.75      rillig   2774:       dependency graphs of packages, to aid in choosing a strategy for
                   2775:       updating.</p></li>
1.250     leot     2776: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdepgraph/README.html" target="_top"><code class="filename">pkgtools/pkgdepgraph</code></a>: Makes
                   2777:       graphs from the output of <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdep/README.html" target="_top"><code class="filename">pkgtools/pkgdep</code></a> (uses graphviz).</p></li>
                   2778: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>: The
1.112     weinem   2779:       pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.250     leot     2780: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/lintpkgsrc/README.html" target="_top"><code class="filename">pkgtools/lintpkgsrc</code></a>: The lintpkgsrc(1) program
1.75      rillig   2781:       does various checks on the complete pkgsrc system.</p></li>
1.250     leot     2782: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgsurvey/README.html" target="_top"><code class="filename">pkgtools/pkgsurvey</code></a>: Report what
1.75      rillig   2783:       packages you have installed.</p></li>
                   2784: </ul></div>
                   2785: <p>Utilities for people maintaining or creating individual packages:</p>
1.148     asau     2786: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.250     leot     2787: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a>: Automate
1.75      rillig   2788:       making and maintaining patches for a package (includes pkgdiff,
                   2789:       pkgvi, mkpatches, etc.).</p></li>
1.250     leot     2790: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a>: Aids in
1.75      rillig   2791:       converting to pkgsrc.</p></li>
                   2792: </ul></div>
                   2793: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
                   2794: utilities)</p>
1.148     asau     2795: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.250     leot     2796: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_comp/README.html" target="_top"><code class="filename">pkgtools/pkg_comp</code></a>: Build
1.75      rillig   2797:       packages in a chrooted area.</p></li>
1.250     leot     2798: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libkver/README.html" target="_top"><code class="filename">pkgtools/libkver</code></a>: Spoof
1.75      rillig   2799:       kernel version for chrooted cross builds.</p></li>
                   2800: </ul></div>
                   2801: </div>
1.148     asau     2802: <div class="sect1">
1.75      rillig   2803: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2804: <a name="non-root-pkgsrc"></a>10.3. How to use pkgsrc as non-root</h2></div></div></div>
1.219     rillig   2805: <p>To install packages from source as a non-root user, download
1.267     rillig   2806: 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   2807: directory and run the command <span class="command"><strong>./bootstrap/bootstrap
                   2808: --unprivileged</strong></span>.</p>
                   2809: <p>This will install the binary part of pkgsrc to
                   2810: <code class="filename">~/pkg</code> and put the pkgsrc configuration <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
                   2811: into <code class="filename">~/pkg/etc</code>.</p>
                   2812: <p>For more details, see <code class="filename">mk/unprivileged.mk</code>.</p>
1.75      rillig   2813: </div>
1.148     asau     2814: <div class="sect1">
1.75      rillig   2815: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2816: <a name="resume-transfers"></a>10.4. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.75      rillig   2817: <p>By default, resuming transfers in pkgsrc is disabled, but you can
                   2818: enable this feature by adding the option
                   2819: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.110     hubertf  2820: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  If, during a fetch step, an incomplete
1.75      rillig   2821: distfile is found, pkgsrc will try to resume it.</p>
                   2822: <p>You can also
1.168     wiz      2823: use a different program than the platform default program by changing the
1.117     jnemeth  2824: <code class="varname">FETCH_USING</code> variable.  You can specify the program by
                   2825: using of ftp, fetch, wget or curl.  Alternatively, fetching can be disabled
                   2826: by using the value manual.  A value of custom disables the system defaults
                   2827: and dependency tracking for the fetch program.  In that case you have to
                   2828: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
                   2829: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
                   2830: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.75      rillig   2831: <p>For example, if you want to use
1.117     jnemeth  2832: <code class="filename">wget</code> to download, you'll have to use something
1.75      rillig   2833: like:</p>
                   2834: <pre class="programlisting">
1.223     rillig   2835: FETCH_USING=    wget
1.1       grant    2836: </pre>
1.75      rillig   2837: </div>
1.148     asau     2838: <div class="sect1">
1.75      rillig   2839: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2840: <a name="x.org-from-pkgsrc"></a>10.5. How can I install/use modular X.org from pkgsrc?</h2></div></div></div>
1.103     wiz      2841: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.76      rillig   2842: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
1.75      rillig   2843: you will have to add the following line into
1.110     hubertf  2844: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75      rillig   2845: <pre class="programlisting">
1.103     wiz      2846: X11_TYPE=modular
1.1       grant    2847: </pre>
1.75      rillig   2848: </div>
1.148     asau     2849: <div class="sect1">
1.75      rillig   2850: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2851: <a name="fetch-behind-firewall"></a>10.6. How to fetch files from behind a firewall</h2></div></div></div>
1.75      rillig   2852: <p>If you are sitting behind a firewall which does not allow direct
                   2853: connections to Internet hosts (i.e. non-NAT), you may specify the
                   2854: relevant proxy hosts.  This is done using an environment variable in the
                   2855: form of a URL, e.g. in Amdahl, the machine
1.128     wiz      2856: <span class="quote">&#8220;<span class="quote">orpheus.amdahl.com</span>&#8221;</span> is one of the firewalls, and it uses
1.75      rillig   2857: port 80 as the proxy port number.  So the proxy environment variables
                   2858: are:</p>
                   2859: <pre class="programlisting">
1.100     rillig   2860: ftp_proxy=ftp://orpheus.amdahl.com:80/
                   2861: http_proxy=http://orpheus.amdahl.com:80/
1.1       grant    2862: </pre>
1.75      rillig   2863: </div>
1.148     asau     2864: <div class="sect1">
1.75      rillig   2865: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2866: <a name="fetch-https"></a>10.7. How to fetch files from HTTPS sites</h2></div></div></div>
1.173     wiz      2867: <p>Some fetch tools are not prepared to support HTTPS by default
                   2868: (for example, the one in NetBSD 6.0), or the one installed by the
                   2869: pkgsrc bootstrap (to avoid an openssl dependency that low in the
                   2870: dependency graph).</p>
                   2871: <p>Usually you won't notice, because distribution files are
                   2872: mirrored weekly to <span class="quote">&#8220;<span class="quote">ftp.NetBSD.org</span>&#8221;</span>, but that might not
                   2873: be often enough if you are following pkgsrc-current. In that case, set
                   2874: <code class="varname">FETCH_USING</code> in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file to
                   2875: <span class="quote">&#8220;<span class="quote">curl</span>&#8221;</span> or <span class="quote">&#8220;<span class="quote">wget</span>&#8221;</span>, which are both compiled
                   2876: with HTTPS support by default. Of course, these tools need to be
                   2877: installed before you can use them this way.</p>
                   2878: </div>
                   2879: <div class="sect1">
                   2880: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2881: <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   2882: <p>This depends on which utility is used to retrieve distfiles.  From
1.76      rillig   2883: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
1.75      rillig   2884: the first available command from the following list:</p>
1.148     asau     2885: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2886: <li class="listitem"><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
                   2887: <li class="listitem"><p><code class="filename">/usr/bin/ftp</code></p></li>
1.75      rillig   2888: </ul></div>
                   2889: <p>On a default NetBSD installation, this will be
1.76      rillig   2890: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
1.75      rillig   2891: connections first, and falls back to active connections if the server
                   2892: refuses to do passive.  For the other tools, add the following to your
1.110     hubertf  2893: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.75      rillig   2894: <code class="varname">PASSIVE_FETCH=1</code>.</p>
                   2895: <p>Having that option present will prevent
1.76      rillig   2896: <code class="filename">/usr/bin/ftp</code> from falling back to active
1.75      rillig   2897: transfers.</p>
                   2898: </div>
1.148     asau     2899: <div class="sect1">
1.75      rillig   2900: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2901: <a name="fetching-all-distfiles"></a>10.9. How to fetch all distfiles at once</h2></div></div></div>
1.88      wiz      2902: <p>You would like to download all the distfiles in a single batch
1.110     hubertf  2903: from work or university, where you can't run a <span class="command"><strong>make
1.132     spz      2904: 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   2905: but downloading the entire directory may not be appropriate.</p>
1.110     hubertf  2906: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.76      rillig   2907: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
1.75      rillig   2908: resulting list to your machine at work/school and use it there.  If you
1.311     leot     2909: don't have a NetBSD-compatible <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/ftp.1"><span class="citerefentry"><span class="refentrytitle">ftp</span>(1)</span></a> (like tnftp) at work, don't
1.75      rillig   2910: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
                   2911: URL:</p>
                   2912: <p>At home:</p>
                   2913: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   2914: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles &gt;/tmp/fetch.sh</code></strong>
                   2915: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
                   2916: <p>At work:</p>
                   2917: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
1.76      rillig   2918: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
1.75      rillig   2919: home.</p>
                   2920: <p>If you have a machine running NetBSD, and you want to get
1.88      wiz      2921: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
                   2922: machine architecture), you can do so by using the above-mentioned
1.110     hubertf  2923: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.88      wiz      2924: directly by running:</p>
1.75      rillig   2925: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
                   2926: <p>If you even decide to ignore
                   2927: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
                   2928: by running:</p>
                   2929: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
                   2930: </div>
1.148     asau     2931: <div class="sect1">
1.75      rillig   2932: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2933: <a name="tmac.andoc-missing"></a>10.10. What does <span class="quote">&#8220;<span class="quote">Don't know how to make
1.128     wiz      2934: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</h2></div></div></div>
1.250     leot     2935: <p>When compiling the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a>
1.75      rillig   2936: package, you get the error from make that it doesn't know how to make
1.76      rillig   2937: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.128     wiz      2938: you don't have installed the <span class="quote">&#8220;<span class="quote">text</span>&#8221;</span> set (nroff, ...) from
1.75      rillig   2939: the NetBSD base distribution on your machine.  It is recommended to do
                   2940: that to format man pages.</p>
1.250     leot     2941: <p>In the case of the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a> package, you
1.75      rillig   2942: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.110     hubertf  2943: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75      rillig   2944: </div>
1.148     asau     2945: <div class="sect1">
1.75      rillig   2946: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2947: <a name="bsd.own.mk-missing"></a>10.11. What does <span class="quote">&#8220;<span class="quote">Could not find bsd.own.mk</span>&#8221;</span> mean?</h2></div></div></div>
1.87      wiz      2948: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
1.75      rillig   2949: when you installed your NetBSD machine.  Please get and install it, by
1.76      rillig   2950: extracting it in <code class="filename">/</code>:</p>
1.75      rillig   2951: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
                   2952: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
1.76      rillig   2953: <p><code class="filename">comp.tgz</code> is part of every NetBSD release.  Get
1.110     hubertf  2954: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.75      rillig   2955: -r</strong></span>).</p>
                   2956: </div>
1.148     asau     2957: <div class="sect1">
1.75      rillig   2958: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2959: <a name="using-sudo-with-pkgsrc"></a>10.12. Using 'sudo' with pkgsrc</h2></div></div></div>
1.75      rillig   2960: <p>When installing packages as non-root user and using the just-in-time
1.311     leot     2961: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/su.1"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a> feature of pkgsrc, it can become annoying to type in the root
1.75      rillig   2962: password for each required package installed.  To avoid this, the sudo
                   2963: package can be used, which does password caching over a limited time.  To
                   2964: use it, install sudo (either as binary package or from
1.250     leot     2965: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/sudo/README.html" target="_top"><code class="filename">security/sudo</code></a>) and then put the
1.110     hubertf  2966: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.98      wiz      2967: <span class="emphasis"><em>after</em></span> the definition of the
                   2968: <code class="varname">LOCALBASE</code> variable:</p>
1.75      rillig   2969: <pre class="programlisting">
1.100     rillig   2970: .if exists(${LOCALBASE}/bin/sudo)
                   2971: SU_CMD=        ${LOCALBASE}/bin/sudo /bin/sh -c
                   2972: .endif
1.1       grant    2973: </pre>
1.75      rillig   2974: </div>
1.148     asau     2975: <div class="sect1">
1.75      rillig   2976: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2977: <a name="faq.conf"></a>10.13. How do I change the location of configuration files?</h2></div></div></div>
1.75      rillig   2978: <p>As the system administrator, you can choose where configuration files
                   2979: are installed.  The default settings make all these files go into
1.76      rillig   2980: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
1.75      rillig   2981: be suboptimal depending on your expectations (e.g., a read-only,
                   2982: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
                   2983: configuration of the provided packages).</p>
                   2984: <p>In order to change the defaults, you can modify the
                   2985: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.110     hubertf  2986: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.76      rillig   2987: directory; some common examples include <code class="filename">/etc</code> or
                   2988: <code class="filename">/etc/pkg</code>.</p>
1.75      rillig   2989: <p>Furthermore, you can change this value on a per-package basis by
                   2990: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
                   2991: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
                   2992: package you would like to modify, that is, the contents of
                   2993: <code class="varname">PKGBASE</code>.</p>
                   2994: <p>Note that after changing these settings, you must rebuild and
                   2995: reinstall any affected packages.</p>
                   2996: </div>
1.148     asau     2997: <div class="sect1">
1.75      rillig   2998: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2999: <a name="audit-packages"></a>10.14. Automated security checks</h2></div></div></div>
1.75      rillig   3000: <p>Please be aware that there can often be bugs in third-party software,
                   3001: and some of these bugs can leave a machine vulnerable to exploitation by
                   3002: attackers.  In an effort to lessen the exposure, the NetBSD packages team
                   3003: maintains a database of known-exploits to packages which have at one time
                   3004: been included in pkgsrc.  The database can be downloaded automatically, and
                   3005: a security audit of all packages installed on a system can take place.  To
1.114     jmcneill 3006: do this, refer to the following two tools (installed as part of the
1.250     leot     3007: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a> package):</p>
1.128     wiz      3008: <div class="orderedlist"><ol class="orderedlist" type="1">
                   3009: <li class="listitem">
1.122     reed     3010: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.75      rillig   3011:     download a list of the security vulnerabilities information.  This list
1.132     spz      3012:     is kept up to date by the pkgsrc security team, and is distributed
                   3013:     from the NetBSD ftp server:</p>
1.292     leot     3014: <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   3015: </li>
1.128     wiz      3016: <li class="listitem"><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
                   3017:     current machine, checking each known vulnerability.  If a
1.75      rillig   3018:     vulnerable package is installed, it will be shown by output to stdout,
                   3019:     including a description of the type of vulnerability, and a URL
                   3020:     containing more information.</p></li>
                   3021: </ol></div>
1.233     sevan    3022: <p>Use of these tools is strongly recommended!
1.317   ! nia      3023: See <a class="xref" href="#vulnerabilities" title="5.1.6. Checking for security vulnerabilities in installed packages">Section 5.1.6, &#8220;Checking for security vulnerabilities in installed packages&#8221;</a> for instructions on how to automate checking and
1.233     sevan    3024: reporting.</p>
                   3025: <p>If this database is installed, pkgsrc builds will use it to
                   3026: perform a security check before building any package.</p>
1.75      rillig   3027: </div>
1.148     asau     3028: <div class="sect1">
1.75      rillig   3029: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   3030: <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   3031: <p>When you add your own preferences to the
                   3032:        <code class="varname">CFLAGS</code> variable in your
1.110     hubertf  3033:        <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.76      rillig   3034:        environment variables to the <code class="filename">./configure</code>
1.311     leot     3035:        scripts and to <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>. Some package authors ignore the
1.75      rillig   3036:        <code class="varname">CFLAGS</code> from the environment variable by
1.76      rillig   3037:        overriding them in the <code class="filename">Makefile</code>s of their
1.75      rillig   3038:        package.</p>
                   3039: <p>Currently there is no solution to this problem. If you
                   3040:        really need the package to use your <code class="varname">CFLAGS</code>
1.110     hubertf  3041:        you should run <span class="command"><strong>make patch</strong></span> in the package
1.76      rillig   3042:        directory and then inspect any <code class="filename">Makefile</code> and
                   3043:        <code class="filename">Makefile.in</code> for whether they define
1.75      rillig   3044:        <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.128     wiz      3045:        these lines. But be aware that some <span class="quote">&#8220;<span class="quote">smart</span>&#8221;</span>
1.75      rillig   3046:        programmers write so bad code that it only works for the
                   3047:        specific combination of <code class="varname">CFLAGS</code> they have
                   3048:        chosen.</p>
1.287     rillig   3049: <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>
                   3050: <pre class="programlisting">
                   3051: CPPFLAGS+=              -Dpkgsrc___CPPFLAGS
                   3052: CFLAGS+=                -Dpkgsrc___CFLAGS
                   3053: CXXFLAGS+=              -Dpkgsrc___CXXFLAGS
                   3054: </pre>
                   3055: <p>Then run <span class="command"><strong>bmake show-all-configure show-all-build</strong></span>
                   3056: to see whether the above flags are passed to the actual build
                   3057: commands in general.</p>
                   3058: <p>To find out whether the flags are passed to individual compiler
                   3059: commands, have a look at the file <code class="filename">work/.work.log</code>. In
                   3060: most cases, the flags from the original command lines (the lines starting
                   3061: with <code class="literal">[*]</code>) are passed unmodified to the actual compiler
                   3062: (the lines starting with <code class="literal">&lt;.&gt;</code>). If the flag is
                   3063: missing from the actual compiler command, it must have been removed by
1.299     rillig   3064: the <a class="link" href="#build.wrapper" title="13.10. The wrapper phase">pkgsrc compiler wrappers</a>.</p>
1.75      rillig   3065: </div>
1.148     asau     3066: <div class="sect1">
1.80      rillig   3067: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   3068: <a name="ufaq-fail"></a>10.16. A package does not build.  What shall I do?</h2></div></div></div>
1.128     wiz      3069: <div class="procedure"><ol class="procedure" type="1">
1.148     asau     3070: <li class="step"><p>Make sure that your copy of pkgsrc is consistent. A
1.80      rillig   3071:        case that occurs often is that people only update pkgsrc in
                   3072:        parts, because of performance reasons. Since pkgsrc is one large
                   3073:        system, not a collection of many small systems, there are
                   3074:        sometimes changes that only work when the whole pkgsrc tree is
                   3075:        updated.</p></li>
1.148     asau     3076: <li class="step"><p>Make sure that you don't have any CVS conflicts.
1.128     wiz      3077:        Search for <span class="quote">&#8220;<span class="quote">&lt;&lt;&lt;&lt;&lt;&lt;</span>&#8221;</span> or
                   3078:        <span class="quote">&#8220;<span class="quote">&gt;&gt;&gt;&gt;&gt;&gt;</span>&#8221;</span> in all your pkgsrc
1.80      rillig   3079:        files.</p></li>
1.148     asau     3080: <li class="step"><p>Make sure that you don't have old copies of the packages
1.110     hubertf  3081:        extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.80      rillig   3082:        verify this.</p></li>
1.218     rillig   3083: <li class="step"><p>If you are a package developer who wants to invest
1.267     rillig   3084:        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     3085: <li class="step"><p>If the problem still exists, write a mail to the
1.80      rillig   3086:        <code class="literal">pkgsrc-users</code> mailing list.</p></li>
                   3087: </ol></div>
                   3088: </div>
1.148     asau     3089: <div class="sect1">
1.88      wiz      3090: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   3091: <a name="faq.rcs-conflicts"></a>10.17. What does <span class="quote">&#8220;<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>&#8221;</span> mean?</h2></div></div></div>
1.89      rillig   3092: <p>You have modified a file from pkgsrc, and someone else has
                   3093: modified that same file afterwards in the CVS repository. Both changes
                   3094: are in the same region of the file, so when you updated pkgsrc, the
                   3095: <code class="literal">cvs</code> command marked the conflicting changes in the
                   3096: file. Because of these markers, the file is no longer a valid
                   3097: <code class="filename">Makefile</code>.</p>
                   3098: <p>Have a look at that file, and if you don't need your local changes
1.110     hubertf  3099: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.89      rillig   3100: -dP</strong></span> in that directory to download the current version.</p>
                   3101: </div>
1.75      rillig   3102: </div>
                   3103: </div>
1.148     asau     3104: <div class="part">
1.75      rillig   3105: <div class="titlepage"><div><div><h1 class="title">
                   3106: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.148     asau     3107: <div class="partintro">
1.77      rillig   3108: <div></div>
                   3109: <p>This part of the book deals with creating and
1.128     wiz      3110:        modifying packages. It starts with a <span class="quote">&#8220;<span class="quote">HOWTO</span>&#8221;</span>-like
1.77      rillig   3111:        guide on creating a new package. The remaining chapters are more
                   3112:        like a reference manual for pkgsrc.</p>
1.75      rillig   3113: <div class="toc">
                   3114: <p><b>Table of Contents</b></p>
1.210     leot     3115: <dl class="toc">
1.267     rillig   3116: <dt><span class="chapter"><a href="#help-devel">11. Getting help</a></span></dt>
1.299     rillig   3117: <dt><span class="chapter"><a href="#components">12. Package components - files, directories and contents</a></span></dt>
1.91      rillig   3118: <dd><dl>
1.299     rillig   3119: <dt><span class="sect1"><a href="#components.Makefile">12.1. <code class="filename">Makefile</code></a></span></dt>
                   3120: <dt><span class="sect1"><a href="#components.distinfo">12.2. <code class="filename">distinfo</code></a></span></dt>
                   3121: <dt><span class="sect1"><a href="#components.patches">12.3. <code class="filename">patches/*</code></a></span></dt>
1.91      rillig   3122: <dd><dl>
1.299     rillig   3123: <dt><span class="sect2"><a href="#components.patch.structure">12.3.1. Structure of a single patch file</a></span></dt>
                   3124: <dt><span class="sect2"><a href="#components.patches.caveats">12.3.2. Creating patch files</a></span></dt>
                   3125: <dt><span class="sect2"><a href="#components.patches.sources">12.3.3. Sources where the patch files come from</a></span></dt>
                   3126: <dt><span class="sect2"><a href="#components.patches.guidelines">12.3.4. Patching guidelines</a></span></dt>
                   3127: <dt><span class="sect2"><a href="#components.patches.feedback">12.3.5. Feedback to the author</a></span></dt>
1.91      rillig   3128: </dl></dd>
1.299     rillig   3129: <dt><span class="sect1"><a href="#other-mandatory-files">12.4. Other mandatory files</a></span></dt>
                   3130: <dt><span class="sect1"><a href="#components.optional">12.5. Optional files</a></span></dt>
                   3131: <dd><dl>
                   3132: <dt><span class="sect2"><a href="#components.optional.bin">12.5.1. Files affecting the binary package</a></span></dt>
                   3133: <dt><span class="sect2"><a href="#components.optional.build">12.5.2. Files affecting the build process</a></span></dt>
                   3134: <dt><span class="sect2"><a href="#components.optional.none">12.5.3. Files affecting nothing at all</a></span></dt>
                   3135: </dl></dd>
                   3136: <dt><span class="sect1"><a href="#work-dir">12.6. <code class="filename">work*</code></a></span></dt>
                   3137: <dt><span class="sect1"><a href="#files-dir">12.7. <code class="filename">files/*</code></a></span></dt>
1.106     rillig   3138: </dl></dd>
1.299     rillig   3139: <dt><span class="chapter"><a href="#build">13. The build process</a></span></dt>
1.106     rillig   3140: <dd><dl>
1.299     rillig   3141: <dt><span class="sect1"><a href="#build.intro">13.1. Introduction</a></span></dt>
                   3142: <dt><span class="sect1"><a href="#build.prefix">13.2. Program location</a></span></dt>
                   3143: <dt><span class="sect1"><a href="#build.builddirs">13.3. Directories used during the build process</a></span></dt>
                   3144: <dt><span class="sect1"><a href="#build.running">13.4. Running a phase</a></span></dt>
                   3145: <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   3146: <dd><dl>
1.299     rillig   3147: <dt><span class="sect2"><a href="#build.fetch.what">13.5.1. What to fetch and where to get it from</a></span></dt>
                   3148: <dt><span class="sect2"><a href="#build.fetch.how">13.5.2. How are the files fetched?</a></span></dt>
1.106     rillig   3149: </dl></dd>
1.299     rillig   3150: <dt><span class="sect1"><a href="#build.checksum">13.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                   3151: <dt><span class="sect1"><a href="#build.extract">13.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                   3152: <dt><span class="sect1"><a href="#build.patch">13.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                   3153: <dt><span class="sect1"><a href="#build.tools">13.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                   3154: <dt><span class="sect1"><a href="#build.wrapper">13.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                   3155: <dt><span class="sect1"><a href="#build.configure">13.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   3156: <dt><span class="sect1"><a href="#build.build">13.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   3157: <dt><span class="sect1"><a href="#build.test">13.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                   3158: <dt><span class="sect1"><a href="#build.install">13.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   3159: <dt><span class="sect1"><a href="#build.package">13.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
                   3160: <dt><span class="sect1"><a href="#build.clean">13.16. Cleaning up</a></span></dt>
                   3161: <dt><span class="sect1"><a href="#build.helpful-targets">13.17. Other helpful targets</a></span></dt>
                   3162: </dl></dd>
                   3163: <dt><span class="chapter"><a href="#creating">14. Creating a new pkgsrc package from scratch</a></span></dt>
                   3164: <dd><dl>
                   3165: <dt><span class="sect1"><a href="#creating.common">14.1. Common types of packages</a></span></dt>
1.106     rillig   3166: <dd><dl>
1.299     rillig   3167: <dt><span class="sect2"><a href="#creating.perl-module">14.1.1. Perl modules</a></span></dt>
                   3168: <dt><span class="sect2"><a href="#creating.python-module">14.1.2. Python modules and programs</a></span></dt>
                   3169: <dt><span class="sect2"><a href="#creating.R-package">14.1.3. R packages</a></span></dt>
                   3170: <dt><span class="sect2"><a href="#creating.TeX-package">14.1.4. TeXlive packages</a></span></dt>
1.106     rillig   3171: </dl></dd>
1.299     rillig   3172: <dt><span class="sect1"><a href="#creating.examples">14.2. Examples</a></span></dt>
                   3173: <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   3174: </dl></dd>
1.299     rillig   3175: <dt><span class="chapter"><a href="#makefile">15. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.106     rillig   3176: <dd><dl>
1.299     rillig   3177: <dt><span class="sect1"><a href="#makefile.style">15.1. Caveats</a></span></dt>
                   3178: <dt><span class="sect1"><a href="#makefile.variables">15.2. <code class="filename">Makefile</code> variables</a></span></dt>
                   3179: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">15.2.1. Naming conventions</a></span></dt></dl></dd>
                   3180: <dt><span class="sect1"><a href="#makefile.code">15.3. Code snippets</a></span></dt>
1.106     rillig   3181: <dd><dl>
1.299     rillig   3182: <dt><span class="sect2"><a href="#adding-to-list">15.3.1. Adding things to a list</a></span></dt>
                   3183: <dt><span class="sect2"><a href="#echo-literal">15.3.2. Echoing a string exactly as-is</a></span></dt>
                   3184: <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>
                   3185: <dt><span class="sect2"><a href="#empty-variables">15.3.4. Handling possibly empty variables</a></span></dt>
1.106     rillig   3186: </dl></dd>
                   3187: </dl></dd>
1.299     rillig   3188: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
1.106     rillig   3189: <dd><dl>
1.299     rillig   3190: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
                   3191: <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>
                   3192: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
                   3193: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106     rillig   3194: </dl></dd>
1.299     rillig   3195: <dt><span class="chapter"><a href="#tools">17. Tools needed for building or running</a></span></dt>
1.106     rillig   3196: <dd><dl>
1.299     rillig   3197: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
                   3198: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
                   3199: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
                   3200: </dl></dd>
                   3201: <dt><span class="chapter"><a href="#buildlink">18. Buildlink methodology</a></span></dt>
                   3202: <dd><dl>
                   3203: <dt><span class="sect1"><a href="#converting-to-buildlink3">18.1. Converting packages to use buildlink3</a></span></dt>
                   3204: <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   3205: <dd><dl>
1.299     rillig   3206: <dt><span class="sect2"><a href="#anatomy-of-bl3">18.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
                   3207: <dt><span class="sect2"><a href="#updating-buildlink-depends">18.2.2. Updating
1.133     wiz      3208:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   3209:       and
                   3210:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   3211:       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106     rillig   3212: </dl></dd>
1.299     rillig   3213: <dt><span class="sect1"><a href="#writing-builtin.mk">18.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
                   3214: <dd><dl>
                   3215: <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>
                   3216: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">18.3.2. Global preferences for native or pkgsrc software</a></span></dt>
                   3217: </dl></dd>
                   3218: </dl></dd>
                   3219: <dt><span class="chapter"><a href="#plist">19. PLIST issues</a></span></dt>
1.106     rillig   3220: <dd><dl>
1.299     rillig   3221: <dt><span class="sect1"><a href="#rcs-id">19.1. RCS ID</a></span></dt>
                   3222: <dt><span class="sect1"><a href="#automatic-plist-generation">19.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                   3223: <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>
                   3224: <dt><span class="sect1"><a href="#plist.misc">19.4. Variable substitution in PLIST</a></span></dt>
                   3225: <dt><span class="sect1"><a href="#manpage-compression">19.5. Man page compression</a></span></dt>
                   3226: <dt><span class="sect1"><a href="#using-PLIST_SRC">19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
                   3227: <dt><span class="sect1"><a href="#platform-specific-plist">19.7. Platform-specific and differing PLISTs</a></span></dt>
                   3228: <dt><span class="sect1"><a href="#build-plist">19.8. Build-specific PLISTs</a></span></dt>
                   3229: <dt><span class="sect1"><a href="#faq.common-dirs">19.9. Sharing directories between packages</a></span></dt>
1.106     rillig   3230: </dl></dd>
1.299     rillig   3231: <dt><span class="chapter"><a href="#pkginstall">20. The pkginstall framework</a></span></dt>
                   3232: <dd><dl>
                   3233: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">20.1. Files and directories outside the installation prefix</a></span></dt>
                   3234: <dd><dl>
                   3235: <dt><span class="sect2"><a href="#dirs-outside-prefix">20.1.1. Directory manipulation</a></span></dt>
                   3236: <dt><span class="sect2"><a href="#files-outside-prefix">20.1.2. File manipulation</a></span></dt>
1.106     rillig   3237: </dl></dd>
1.299     rillig   3238: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
1.106     rillig   3239: <dd><dl>
1.299     rillig   3240: <dt><span class="sect2"><a href="#conf-files-sysconfdir">20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
                   3241: <dt><span class="sect2"><a href="#conf-files-configure">20.2.2. Telling the software where configuration files are</a></span></dt>
                   3242: <dt><span class="sect2"><a href="#conf-files-patching">20.2.3. Patching installations</a></span></dt>
                   3243: <dt><span class="sect2"><a href="#conf-files-disable">20.2.4. Disabling handling of configuration files</a></span></dt>
                   3244: </dl></dd>
                   3245: <dt><span class="sect1"><a href="#rcd-scripts">20.3. System startup scripts</a></span></dt>
                   3246: <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>
                   3247: <dt><span class="sect1"><a href="#users-and-groups">20.4. System users and groups</a></span></dt>
                   3248: <dt><span class="sect1"><a href="#shells">20.5. System shells</a></span></dt>
                   3249: <dd><dl><dt><span class="sect2"><a href="#shells-disable">20.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   3250: <dt><span class="sect1"><a href="#fonts">20.6. Fonts</a></span></dt>
                   3251: <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   3252: </dl></dd>
                   3253: <dt><span class="chapter"><a href="#fixes">21. Making your package work</a></span></dt>
                   3254: <dd><dl>
                   3255: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
                   3256: <dd><dl>
                   3257: <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>
                   3258: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
                   3259: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
                   3260: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
                   3261: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
                   3262: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
                   3263: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
                   3264: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
                   3265: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
                   3266: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
                   3267: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                   3268: </dl></dd>
                   3269: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                   3270: <dd><dl>
                   3271: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   3272: <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>
                   3273: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
                   3274: </dl></dd>
                   3275: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   3276: <dd><dl>
                   3277: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
                   3278: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   3279: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
                   3280: </dl></dd>
                   3281: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
                   3282: <dd><dl>
                   3283: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
                   3284: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
                   3285: <dt><span class="sect2"><a href="#perl-scripts">21.4.3. Packages containing perl scripts</a></span></dt>
                   3286: <dt><span class="sect2"><a href="#shell-scripts">21.4.4. Packages containing shell scripts</a></span></dt>
                   3287: <dt><span class="sect2"><a href="#other-programming-languages">21.4.5. Other programming languages</a></span></dt>
                   3288: </dl></dd>
                   3289: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   3290: <dd><dl>
                   3291: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   3292: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.287     rillig   3293: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
                   3294: <dt><span class="sect2"><a href="#undefined-reference">21.5.4. Undefined reference to <span class="quote">&#8220;<span class="quote">...</span>&#8221;</span></a></span></dt>
                   3295: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.267     rillig   3296: </dl></dd>
                   3297: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   3298: <dd><dl>
                   3299: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
                   3300: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
                   3301: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
                   3302: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
                   3303: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
                   3304: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing perl modules</a></span></dt>
                   3305: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
                   3306: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
                   3307: <dt><span class="sect2"><a href="#gconf-data-files">21.6.9. Packages installing GConf data files</a></span></dt>
                   3308: <dt><span class="sect2"><a href="#scrollkeeper-data-files">21.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
                   3309: <dt><span class="sect2"><a href="#x11-fonts">21.6.11. Packages installing X11 fonts</a></span></dt>
                   3310: <dt><span class="sect2"><a href="#gtk2-modules">21.6.12. Packages installing GTK2 modules</a></span></dt>
                   3311: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.13. Packages installing SGML or XML data</a></span></dt>
                   3312: <dt><span class="sect2"><a href="#mime-database">21.6.14. Packages installing extensions to the MIME database</a></span></dt>
                   3313: <dt><span class="sect2"><a href="#intltool">21.6.15. Packages using intltool</a></span></dt>
                   3314: <dt><span class="sect2"><a href="#startup-scripts">21.6.16. Packages installing startup scripts</a></span></dt>
                   3315: <dt><span class="sect2"><a href="#tex-packages">21.6.17. Packages installing TeX modules</a></span></dt>
                   3316: <dt><span class="sect2"><a href="#emulation-packages">21.6.18. Packages supporting running binaries in
1.87      wiz      3317:     emulation</a></span></dt>
1.267     rillig   3318: <dt><span class="sect2"><a href="#hicolor-theme">21.6.19. Packages installing hicolor theme icons</a></span></dt>
                   3319: <dt><span class="sect2"><a href="#desktop-files">21.6.20. Packages installing desktop files</a></span></dt>
1.77      rillig   3320: </dl></dd>
1.267     rillig   3321: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.77      rillig   3322: </dl></dd>
1.299     rillig   3323: <dt><span class="chapter"><a href="#gnome">22. GNOME packaging and porting</a></span></dt>
                   3324: <dd><dl>
                   3325: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
                   3326: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
                   3327: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
                   3328: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
                   3329: </dl></dd>
1.267     rillig   3330: <dt><span class="chapter"><a href="#submit">23. Submitting and Committing</a></span></dt>
1.77      rillig   3331: <dd><dl>
1.267     rillig   3332: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
                   3333: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   3334: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
                   3335: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
                   3336: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
                   3337: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
                   3338: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
                   3339: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
                   3340: </dl></dd>
                   3341: <dt><span class="chapter"><a href="#devfaq">24. Frequently Asked Questions</a></span></dt>
1.75      rillig   3342: </dl>
                   3343: </div>
1.77      rillig   3344: </div>
1.148     asau     3345: <div class="chapter">
1.77      rillig   3346: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   3347: <a name="help-devel"></a>Chapter 11. Getting help</h2></div></div></div>
                   3348: <p>
                   3349:        To get help when developing pkgsrc, the definitive source is this
                   3350:        document, the pkgsrc guide. If you don't find anything here,
                   3351:        there are alternatives:
                   3352: </p>
                   3353: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   3354: <li class="listitem">
                   3355: <p>
                   3356:        The built-in pkgsrc help, which is available after bootstrapping
                   3357:        pkgsrc. Run <span class="command"><strong>bmake help topic=&#8230;</strong></span> to get
                   3358:        help for any topic, such as a variable name like
                   3359:        <code class="varname">BUILD_DEFS</code>, a make target like
                   3360:        <span class="command"><strong>do-build</strong></span>, a missing C or C++ function like
                   3361:        <span class="command"><strong>strcasecmp</strong></span> or any other topic.</p>
                   3362: <p>The available help topics are listed in <a class="xref" href="#help-topics" title="Appendix D. Help topics">Appendix D, <i>Help topics</i></a>.</p>
                   3363: </li>
                   3364: <li class="listitem"><p>
1.278     rillig   3365:        To see the value of a single variable, run <span class="command"><strong>bmake
                   3366:        show-var VARNAME=<em class="replaceable"><code>X</code></em></strong></span>.
                   3367: </p></li>
                   3368: <li class="listitem"><p>
                   3369:        To see the values of the most common variables, run
                   3370:        <span class="command"><strong>bmake show-all</strong></span>. These variables are grouped by
                   3371:        topic. To see the variables for a single topic, run
                   3372:        <span class="command"><strong>bmake
                   3373:        show-all-<em class="replaceable"><code>topic</code></em></strong></span>, for example
                   3374:        <span class="command"><strong>bmake show-all-fetch</strong></span>.
                   3375: </p></li>
                   3376: <li class="listitem"><p>
1.267     rillig   3377:        The tech-pkg mailing list, to which
                   3378:        <a class="ulink" href="https://www.NetBSD.org/mailinglists/#tech-pkg" target="_top">you
                   3379:        can subscribe</a> and then <a class="ulink" href="mailto:tech-pkg@NetBSD.org" target="_top">ask your
                   3380:        questions</a>.</p></li>
                   3381: <li class="listitem"><p>The #pkgsrc IRC channel, which is accessible
                   3382:        <a class="ulink" href="https://webchat.freenode.net/" target="_top">via a web browser</a>
                   3383:        or by using a specialized chat program such as
                   3384:        <a class="ulink" href="http://xchat.org/" target="_top">XChat</a>.
                   3385:        Pick any user name and join the channel #pkgsrc.</p></li>
                   3386: </ul></div>
                   3387: </div>
                   3388: <div class="chapter">
                   3389: <div class="titlepage"><div><div><h2 class="title">
1.299     rillig   3390: <a name="components"></a>Chapter 12. Package components - files, directories and contents</h2></div></div></div>
1.91      rillig   3391: <div class="toc">
                   3392: <p><b>Table of Contents</b></p>
1.210     leot     3393: <dl class="toc">
1.299     rillig   3394: <dt><span class="sect1"><a href="#components.Makefile">12.1. <code class="filename">Makefile</code></a></span></dt>
                   3395: <dt><span class="sect1"><a href="#components.distinfo">12.2. <code class="filename">distinfo</code></a></span></dt>
                   3396: <dt><span class="sect1"><a href="#components.patches">12.3. <code class="filename">patches/*</code></a></span></dt>
                   3397: <dd><dl>
                   3398: <dt><span class="sect2"><a href="#components.patch.structure">12.3.1. Structure of a single patch file</a></span></dt>
                   3399: <dt><span class="sect2"><a href="#components.patches.caveats">12.3.2. Creating patch files</a></span></dt>
                   3400: <dt><span class="sect2"><a href="#components.patches.sources">12.3.3. Sources where the patch files come from</a></span></dt>
                   3401: <dt><span class="sect2"><a href="#components.patches.guidelines">12.3.4. Patching guidelines</a></span></dt>
                   3402: <dt><span class="sect2"><a href="#components.patches.feedback">12.3.5. Feedback to the author</a></span></dt>
                   3403: </dl></dd>
                   3404: <dt><span class="sect1"><a href="#other-mandatory-files">12.4. Other mandatory files</a></span></dt>
                   3405: <dt><span class="sect1"><a href="#components.optional">12.5. Optional files</a></span></dt>
                   3406: <dd><dl>
                   3407: <dt><span class="sect2"><a href="#components.optional.bin">12.5.1. Files affecting the binary package</a></span></dt>
                   3408: <dt><span class="sect2"><a href="#components.optional.build">12.5.2. Files affecting the build process</a></span></dt>
                   3409: <dt><span class="sect2"><a href="#components.optional.none">12.5.3. Files affecting nothing at all</a></span></dt>
1.91      rillig   3410: </dl></dd>
1.299     rillig   3411: <dt><span class="sect1"><a href="#work-dir">12.6. <code class="filename">work*</code></a></span></dt>
                   3412: <dt><span class="sect1"><a href="#files-dir">12.7. <code class="filename">files/*</code></a></span></dt>
1.91      rillig   3413: </dl>
                   3414: </div>
1.299     rillig   3415: <p>Whenever you're preparing a package, there are a number of
                   3416: files involved which are described in the following
                   3417: sections.</p>
                   3418: <div class="sect1">
                   3419: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   3420: <a name="components.Makefile"></a>12.1. <code class="filename">Makefile</code>
                   3421: </h2></div></div></div>
                   3422: <p>Building, installation and creation of a binary package are all
                   3423:   controlled by the package's <code class="filename">Makefile</code>.
                   3424:   The <code class="filename">Makefile</code> describes various things about
                   3425:   a package, for example from where to get it, how to configure,
                   3426:   build, and install it.</p>
                   3427: <p>A package <code class="filename">Makefile</code> contains several
                   3428:   sections that describe the package.</p>
                   3429: <p>In the first section there are the following variables, which
                   3430:   should appear exactly in the order given here.  The order and
                   3431:   grouping of the variables is mostly historical and has no further
                   3432:   meaning.</p>
                   3433: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   3434: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
                   3435:     distribution file to be downloaded from the package's
                   3436:     website.</p></li>
                   3437: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
                   3438:     package, as used by pkgsrc. You need to provide it if
                   3439:     <code class="varname">DISTNAME</code> (which is the default) is not a good
                   3440:     name for the package in pkgsrc or <code class="varname">DISTNAME</code> is not
                   3441:     provided (no distribution file is required).  Usually it is the pkgsrc
                   3442:     directory name together with the version number. It must match the
                   3443:     regular expression
                   3444:     <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
                   3445:     starts with a letter or digit, and contains only letters, digits,
                   3446:     dashes, underscores, dots and plus signs.</p></li>
                   3447: <li class="listitem">
                   3448: <p><code class="varname">CATEGORIES</code> is a list of categories
                   3449:     which the package fits in. You can choose any of the top-level
                   3450:     directories of pkgsrc for it.</p>
                   3451: <p>Currently the following values are available for
                   3452:     <code class="varname">CATEGORIES</code>. If more than
                   3453:     one is used, they need to be separated by spaces:</p>
1.77      rillig   3454: <pre class="programlisting">
1.299     rillig   3455: archivers     cross         geography     meta-pkgs     security
                   3456: audio         databases     graphics      misc          shells
                   3457: benchmarks    devel         ham           multimedia    sysutils
                   3458: biology       editors       inputmethod   net           textproc
                   3459: cad           emulators     lang          news          time
                   3460: chat          finance       mail          parallel      wm
                   3461: comms         fonts         math          pkgtools      www
                   3462: converters    games         mbone         print         x11
1.77      rillig   3463: </pre>
                   3464: </li>
1.299     rillig   3465: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
                   3466:     <code class="varname">DYNAMIC_MASTER_SITES</code>,
                   3467:     <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
                   3468:     and <code class="varname">DISTFILES</code> are discussed in detail in
                   3469:     <a class="xref" href="#build.fetch" title="13.5. The fetch phase">Section 13.5, &#8220;The <span class="emphasis"><em>fetch</em></span> phase&#8221;</a>.</p></li>
                   3470: </ul></div>
                   3471: <p>The second section contains information about separately
                   3472:   downloaded patches, if any.
                   3473:   </p>
                   3474: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   3475: <li class="listitem"><p><code class="varname">PATCHFILES</code>:
                   3476:     Name(s) of additional files that contain distribution patches.
                   3477:     There is no default. pkgsrc will look for them at
                   3478:     <code class="varname">PATCH_SITES</code>.
                   3479:     They will automatically be uncompressed before patching if
                   3480:     the names end with <code class="filename">.gz</code> or
                   3481:     <code class="filename">.Z</code>.</p></li>
                   3482: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
                   3483:     Primary location(s) for distribution patch files (see
                   3484:     <code class="varname">PATCHFILES</code> above) if not found locally.</p></li>
                   3485: <li class="listitem"><p><code class="varname">PATCH_DIST_STRIP</code>:
1.311     leot     3486:     an argument to <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/patch.1"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> that sets the pathname strip count to
1.299     rillig   3487:     help find the correct files to patch. It defaults to
                   3488:     <span class="command"><strong>-p0</strong></span>.</p></li>
                   3489: </ul></div>
                   3490: <p>The third section contains the following variables.
                   3491:   </p>
                   3492: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   3493: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email
                   3494:     address of the person who feels responsible for this package,
                   3495:     and who is most likely to look at problems or questions regarding
1.311     leot     3496:     this package which have been reported with <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/send-pr.1"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a>.
1.299     rillig   3497:     Other developers may contact the <code class="varname">MAINTAINER</code>
                   3498:     before making changes to the package, but are not required to
                   3499:     do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
                   3500:     to yourself. If you really can't maintain the package for future
                   3501:     updates, set it to
                   3502:     <code class="email">&lt;<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>&gt;</code>.</p></li>
                   3503: <li class="listitem"><p><code class="varname">OWNER</code> should be used instead
                   3504:     of <code class="varname">MAINTAINER</code> when you do not want other
                   3505:     developers to update or change the package without contacting
                   3506:     you first. A package Makefile should contain one of
                   3507:     <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
                   3508:     not both.  </p></li>
                   3509: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
                   3510:     find more information about the package.</p></li>
                   3511: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
                   3512:     description of the package (should not include the package
                   3513:     name).</p></li>
                   3514: <li class="listitem"><p><code class="varname">LICENSE</code> indicates the license(s)
                   3515:     applicable for the package. See <a class="xref" href="#handling-licenses" title="21.1.3. Handling licenses">Section 21.1.3, &#8220;Handling licenses&#8221;</a> for further details.</p></li>
                   3516: </ul></div>
                   3517: <p>Other variables that affect the build:
                   3518:   </p>
                   3519: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
                   3520: <p><code class="varname">WRKSRC</code>: The directory where the
                   3521:       interesting distribution files of the package are found. The
                   3522:       default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
                   3523:       works for most packages.</p>
                   3524: <p>If a package doesn't create a subdirectory for itself
                   3525:       (most GNU software does, for instance), but extracts itself in
                   3526:       the current directory, you should set
                   3527:       <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
                   3528: <p>If a package doesn't create a subdirectory with the
                   3529:       name of <code class="varname">DISTNAME</code> but some different name,
                   3530:       set <code class="varname">WRKSRC</code> to point to the proper name in
                   3531:       <code class="filename">${WRKDIR}</code>, for example
                   3532:       <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
                   3533:       <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/tcl/README.html" target="_top"><code class="filename">lang/tcl</code></a> and <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/tk/README.html" target="_top"><code class="filename">x11/tk</code></a> for other examples.</p>
                   3534: <p>The name of the working directory created by pkgsrc is
                   3535:       taken from the <code class="varname">WRKDIR_BASENAME</code>
                   3536:       variable. By default, its value is
                   3537:       <code class="filename">work</code>. If you want to use the same
                   3538:       pkgsrc tree for building different kinds of binary packages,
                   3539:       you can change the variable according to your needs. Two
                   3540:       other variables handle common cases of setting
                   3541:       <code class="varname">WRKDIR_BASENAME</code> individually. If
                   3542:       <code class="varname">OBJHOSTNAME</code> is defined in
                   3543:       <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
                   3544:       the host's name is attached to the directory name. If
                   3545:       <code class="varname">OBJMACHINE</code> is defined, the platform name
                   3546:       is attached, which might look like
                   3547:       <code class="filename">work.i386</code> or
                   3548:       <code class="filename">work.sparc</code>.</p>
                   3549: </li></ul></div>
                   3550: <p>Please pay attention to the following gotchas:</p>
                   3551: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   3552: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
                   3553:       installed in compressed form by the package.  For packages using
                   3554:       BSD-style makefiles which honor MANZ, there is
                   3555:       <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
                   3556: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
                   3557:       <span class="quote">&#8220;<span class="quote">${PREFIX}</span>&#8221;</span> in all files (see patches,
                   3558:       below).</p></li>
                   3559: <li class="listitem"><p>If the package installs any info files, see <a class="xref" href="#faq.info-files" title="21.6.7. Packages installing info files">Section 21.6.7, &#8220;Packages installing info files&#8221;</a>.</p></li>
                   3560: </ul></div>
                   3561: </div>
1.148     asau     3562: <div class="sect1">
1.91      rillig   3563: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   3564: <a name="components.distinfo"></a>12.2. <code class="filename">distinfo</code>
                   3565: </h2></div></div></div>
                   3566: <p>The <code class="filename">distinfo</code> file contains the message
                   3567:   digest, or checksum, of each distfile needed for the package. This
                   3568:   ensures that the distfiles retrieved from the Internet have not been
                   3569:   corrupted during transfer or altered by a malign force to introduce
                   3570:   a security hole. To provide maximum security, all distfiles are
                   3571:   protected using three different message digest algorithms (SHA1,
                   3572:   RMD160, SHA512), as well as the file size.</p>
                   3573: <p>The <code class="filename">distinfo</code> file also contains the
                   3574:   checksums for all the patches found in the
                   3575:   <code class="filename">patches</code> directory (see <a class="xref" href="#components.patches" title="12.3. patches/*">Section 12.3, &#8220;<code class="filename">patches/*</code>&#8221;</a>). These checksums ensure that patches
                   3576:   are only applied intentionally and that they don't accidentally change,
                   3577:   e.g. when merging different changes together. They also make sure that
                   3578:   new patches are actually added to CVS and old ones are removed.
                   3579:   Too see whether the patches and the <code class="filename">distinfo</code> file
                   3580:   match, run <span class="command"><strong>pkglint</strong></span> after changing the patches.</p>
                   3581: <p>To regenerate the <code class="filename">distinfo</code> file, use the
                   3582:   <span class="command"><strong>make distinfo</strong></span> command.</p>
                   3583: <p>Some packages have different sets of distfiles depending on
                   3584:   the platform, for example <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/openjdk8/README.html" target="_top"><code class="filename">lang/openjdk8</code></a>. These are kept in the same
                   3585:   <code class="filename">distinfo</code> file and care should be taken when
                   3586:   upgrading such a package to ensure distfile information is not
                   3587:   lost.</p>
                   3588: </div>
                   3589: <div class="sect1">
                   3590: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   3591: <a name="components.patches"></a>12.3. <code class="filename">patches/*</code>
                   3592: </h2></div></div></div>
                   3593: <p>Some packages don't work out-of-the box on the various
                   3594:   platforms that are supported by pkgsrc. These packages need
                   3595:   to be patched to make them work. The patch files can be
                   3596:   found in the <code class="filename">patches/</code> directory.</p>
                   3597: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
                   3598:   applied to the files in <code class="varname">WRKSRC</code> directory after
                   3599:   extracting them, in alphabetic order.</p>
1.148     asau     3600: <div class="sect2">
1.91      rillig   3601: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   3602: <a name="components.patch.structure"></a>12.3.1. Structure of a single patch file</h3></div></div></div>
                   3603: <p>The <code class="filename">patch-*</code> files should be in
                   3604:   <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
                   3605:   problems. (To force patches to apply with fuzz you can set
                   3606:   <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
                   3607:   should contain only changes for a single file, and no file should be
                   3608:   patched by more than one patch file. This helps to keep future
                   3609:   modifications simple.</p>
                   3610: <p>Each patch file is structured as follows: In the first line,
                   3611:   there is the RCS Id of the patch itself. The second line should be
                   3612:   empty for aesthetic reasons. After that, there should be a comment for
                   3613:   each change that the patch does. There are a number of standard
                   3614:   cases:</p>
                   3615: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   3616: <li class="listitem"><p>Patches for commonly known vulnerabilities should
                   3617:   mention the vulnerability ID (CAN, CVE).</p></li>
                   3618: <li class="listitem"><p>Patches that change source code should mention the
                   3619:   platform and other environment (for example, the compiler) that the
                   3620:   patch is needed for.</p></li>
                   3621: </ul></div>
                   3622: <p>The patch should be commented so that any
                   3623:   developer who knows the code of the application can make some use of
                   3624:   the patch. Special care should be taken for the upstream developers,
                   3625:   since we generally want that they accept our patches, so we have less
                   3626:   work in the future.</p>
1.91      rillig   3627: </div>
1.148     asau     3628: <div class="sect2">
1.91      rillig   3629: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   3630: <a name="components.patches.caveats"></a>12.3.2. Creating patch files</h3></div></div></div>
                   3631: <p>One important thing to mention is to pay attention that no RCS
                   3632:   IDs get stored in the patch files, as these will cause problems when
                   3633:   later checked into the NetBSD CVS tree. Use the
                   3634:   <span class="command"><strong>pkgdiff</strong></span> command from the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a> package to avoid these
                   3635:   problems.</p>
                   3636: <p>For even more automation, we recommend using
                   3637:   <span class="command"><strong>mkpatches</strong></span> from the same package to make a
                   3638:   whole set of patches. You just have to backup files before you
                   3639:   edit them to <code class="filename">filename.orig</code>, e.g. with
                   3640:   <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
                   3641:   using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
                   3642:   you upgrade a package this way, you can easily compare the new
                   3643:   set of patches with the previously existing one with
                   3644:   <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
                   3645:   are replaced by new files, so carefully check if you want to take all
                   3646:   the changes.</p>
                   3647: <p>When you have finished a package, remember to generate
                   3648:   the checksums for the patch files by using the <span class="command"><strong>make
                   3649:   makepatchsum</strong></span> command, see <a class="xref" href="#components.distinfo" title="12.2. distinfo">Section 12.2, &#8220;<code class="filename">distinfo</code>&#8221;</a>.</p>
                   3650: <p>When adding a patch that corrects a problem in the
                   3651:   distfile (rather than e.g. enforcing pkgsrc's view of where
                   3652:   man pages should go), send the patch as a bug report to the
                   3653:   maintainer.  This benefits non-pkgsrc users of the package,
                   3654:   and usually makes it possible to remove the patch in future
                   3655:   version.</p>
                   3656: <p>The file names of the patch files are usually of the form
                   3657:   <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
                   3658:   Many packages still use the previous convention
                   3659:   <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
                   3660:   but new patches should be of the form containing the filename.
                   3661:   <span class="command"><strong>mkpatches</strong></span> included in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a> takes care of the name
                   3662:   automatically.</p>
1.118     imil     3663: </div>
1.275     brook    3664: <div class="sect2">
                   3665: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   3666: <a name="components.patches.sources"></a>12.3.3. Sources where the patch files come from</h3></div></div></div>
                   3667: <p>If you want to share patches between multiple packages
                   3668:   in pkgsrc, e.g. because they use the same distfiles, set
                   3669:   <code class="varname">PATCHDIR</code> to the path where the patch files
                   3670:   can be found, e.g.:</p>
                   3671: <pre class="programlisting">
                   3672: PATCHDIR=       ../../editors/xemacs/patches
                   3673: </pre>
                   3674: <p>Patch files that are distributed by the author or other
                   3675:     maintainers can be listed in
                   3676:     <code class="varname">PATCHFILES</code>.</p>
                   3677: <p>If it is desired to store any patches that should not be
                   3678:     committed into pkgsrc, they can be kept outside the pkgsrc
                   3679:     tree in the <code class="filename">$LOCALPATCHES</code> directory. The
                   3680:     directory tree there is expected to have the same
                   3681:     <span class="quote">&#8220;<span class="quote">category/package</span>&#8221;</span> structure as pkgsrc, and
                   3682:     patches are expected to be stored inside these dirs (also
                   3683:     known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
                   3684:     example, if you want to keep a private patch for
                   3685:     <code class="filename">pkgsrc/graphics/png</code>, keep it in
                   3686:     <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
                   3687:     files in the named directory are expected to be patch files,
                   3688:     and <span class="emphasis"><em>they are applied after pkgsrc patches are
                   3689:     applied</em></span>.</p>
1.275     brook    3690: </div>
                   3691: <div class="sect2">
                   3692: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   3693: <a name="components.patches.guidelines"></a>12.3.4. Patching guidelines</h3></div></div></div>
                   3694: <p>When fixing a portability issue in the code do not use
                   3695:       preprocessor magic to check for the current operating system nor
                   3696:       platform.  Doing so hurts portability to other platforms because
                   3697:       the OS-specific details are not abstracted appropriately.</p>
                   3698: <p>The general rule to follow is: instead of checking for the
                   3699:       operating system the application is being built on, check for the
                   3700:       specific <span class="emphasis"><em>features</em></span> you need.  For example,
                   3701:       instead of assuming that kqueue is available under NetBSD and
                   3702:       using the <code class="varname">__NetBSD__</code> macro to conditionalize
                   3703:       kqueue support, add a check that detects kqueue itself &mdash;
                   3704:       yes, this generally involves patching the
                   3705:       <span class="command"><strong>configure</strong></span> script.  There is absolutely nothing
                   3706:       that prevents some OSes from adopting interfaces from other OSes
                   3707:       (e.g. Linux implementing kqueue), something that the above checks
                   3708:       cannot take into account.</p>
                   3709: <p>Of course, checking for features generally involves more
                   3710:       work on the developer's side, but the resulting changes are
                   3711:       cleaner and there are chances they will work on many other
                   3712:       platforms.  Not to mention that there are higher chances of being
                   3713:       later integrated into the mainstream sources.  Remember:
                   3714:       <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
                   3715: <p>Some typical examples:</p>
                   3716: <div class="table">
                   3717: <a name="patch-examples"></a><p class="title"><b>Table 12.1. Patching examples</b></p>
                   3718: <div class="table-contents"><table class="table" summary="Patching examples" border="1">
                   3719: <colgroup>
                   3720: <col>
                   3721: <col>
                   3722: <col>
                   3723: </colgroup>
                   3724: <thead><tr>
                   3725: <th>Where</th>
                   3726: <th>Incorrect</th>
                   3727: <th>Correct</th>
                   3728: </tr></thead>
                   3729: <tbody>
                   3730: <tr>
                   3731: <td>configure script</td>
                   3732: <td>
1.275     brook    3733: <pre class="programlisting">
1.299     rillig   3734: case ${target_os} in
                   3735: netbsd*) have_kvm=yes ;;
                   3736: *)       have_kvm=no  ;;
                   3737: esac
1.275     brook    3738: </pre>
1.299     rillig   3739:              </td>
                   3740: <td>
1.275     brook    3741: <pre class="programlisting">
1.299     rillig   3742: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
1.275     brook    3743: </pre>
1.299     rillig   3744:              </td>
                   3745: </tr>
                   3746: <tr>
                   3747: <td>C source file</td>
                   3748: <td>
1.91      rillig   3749: <pre class="programlisting">
1.299     rillig   3750: #if defined(__NetBSD__)
                   3751: #  include &lt;sys/event.h&gt;
                   3752: #endif
1.91      rillig   3753: </pre>
1.299     rillig   3754:              </td>
                   3755: <td>
1.91      rillig   3756: <pre class="programlisting">
1.299     rillig   3757: #if defined(HAVE_SYS_EVENT_H)
                   3758: #  include &lt;sys/event.h&gt;
                   3759: #endif
1.91      rillig   3760: </pre>
1.299     rillig   3761:              </td>
                   3762: </tr>
                   3763: <tr>
                   3764: <td>C source file</td>
                   3765: <td>
1.91      rillig   3766: <pre class="programlisting">
1.299     rillig   3767: int
                   3768: monitor_file(...)
                   3769: {
                   3770: #if defined(__NetBSD__)
                   3771:         int fd = kqueue();
                   3772:         ...
                   3773: #else
                   3774:         ...
                   3775: #endif
                   3776: }
1.91      rillig   3777: </pre>
1.299     rillig   3778:              </td>
                   3779: <td>
1.91      rillig   3780: <pre class="programlisting">
1.299     rillig   3781: int
                   3782: monitor_file(...)
                   3783: {
                   3784: #if defined(HAVE_KQUEUE)
                   3785:         int fd = kqueue();
                   3786:         ...
                   3787: #else
                   3788:         ...
                   3789: #endif
                   3790: }
1.91      rillig   3791: </pre>
1.299     rillig   3792:              </td>
                   3793: </tr>
                   3794: </tbody>
                   3795: </table></div>
                   3796: </div>
                   3797: <br class="table-break">
                   3798: </div>
                   3799: <div class="sect2">
                   3800: <div class="titlepage"><div><div><h3 class="title">
                   3801: <a name="components.patches.feedback"></a>12.3.5. Feedback to the author</h3></div></div></div>
                   3802: <p>Always, always, <span class="strong"><strong>always</strong></span>
                   3803:       feed back any <span class="emphasis"><em>portability fixes</em></span> or
                   3804:       improvements you do to a package to the mainstream developers.
                   3805:       This is the only way to get their attention on portability issues
                   3806:       and to ensure that future versions can be built out-of-the box on
                   3807:       NetBSD.  Furthermore, any user that gets newer distfiles will get
                   3808:       the fixes straight from the packaged code.</p>
                   3809: <p>This generally involves cleaning up the patches
                   3810:       (because sometimes the patches that are
                   3811:       added to pkgsrc are quick hacks), filing bug reports in the
                   3812:       appropriate trackers for the projects and working with the
                   3813:       mainstream authors to accept your changes.  It is
                   3814:       <span class="emphasis"><em>extremely important</em></span> that you do it so that
                   3815:       the packages in pkgsrc are kept simple and thus further changes
                   3816:       can be done without much hassle.</p>
                   3817: <p>When you have done this, please add a URL to the upstream
                   3818:       bug report to the patch comment.</p>
                   3819: <p>Support the idea of free software!</p>
                   3820: </div>
1.91      rillig   3821: </div>
1.299     rillig   3822: <div class="sect1">
                   3823: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   3824: <a name="other-mandatory-files"></a>12.4. Other mandatory files</h2></div></div></div>
                   3825: <div class="variablelist"><dl class="variablelist">
                   3826: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
                   3827: <dd><p>A multi-line description of the piece of software.  This should include
                   3828:          any credits where they are due.  Please bear in mind that others do not
                   3829:          share your sense of humour (or spelling idiosyncrasies), and that others
                   3830:          will read everything that you write here.</p></dd>
                   3831: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
                   3832: <dd><p>This file governs the files that are installed on your
                   3833:          system: all the binaries, manual pages, etc. There are other
                   3834:          directives which may be entered in this file, to control the
                   3835:          creation and deletion of directories, and the location of
                   3836:          inserted files.  See <a class="xref" href="#plist" title="Chapter 19. PLIST issues">Chapter 19, <i>PLIST issues</i></a> for more
                   3837:          information.</p></dd>
                   3838: </dl></div>
                   3839: </div>
                   3840: <div class="sect1">
                   3841: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   3842: <a name="components.optional"></a>12.5. Optional files</h2></div></div></div>
                   3843: <div class="sect2">
                   3844: <div class="titlepage"><div><div><h3 class="title">
                   3845: <a name="components.optional.bin"></a>12.5.1. Files affecting the binary package</h3></div></div></div>
                   3846: <div class="variablelist"><dl class="variablelist">
                   3847: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
                   3848: <dd>
1.311     leot     3849: <p>This shell script is invoked twice by <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>.
1.299     rillig   3850:            First time after package extraction and before files are
                   3851:            moved in place, the second time after the files to install
                   3852:            are moved in place. This can be used to do any custom
                   3853:            procedures not possible with @exec commands in
1.311     leot     3854:            <code class="filename">PLIST</code>. See <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> and
                   3855:            <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/pkg_create.1"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information.  See also <a class="xref" href="#files-and-dirs-outside-prefix" title="20.1. Files and directories outside the installation prefix">Section 20.1, &#8220;Files and directories outside the installation prefix&#8221;</a>.
1.299     rillig   3856:            Please note that you can modify variables in it easily by using
                   3857:            <code class="varname">FILES_SUBST</code> in the package's
                   3858:            <code class="filename">Makefile</code>:</p>
1.91      rillig   3859: <pre class="programlisting">
1.299     rillig   3860: FILES_SUBST+=  SOMEVAR="somevalue"
1.91      rillig   3861: </pre>
1.299     rillig   3862: <p>replaces "@SOMEVAR@" with <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span> in the
                   3863:            <code class="filename">INSTALL</code>.  By default, substitution is
                   3864:            performed for <code class="varname">PREFIX</code>,
                   3865:            <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
                   3866:            <code class="varname">VARBASE</code>, and a few others, type
                   3867:            <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
                   3868:            complete list.</p>
                   3869: </dd>
                   3870: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
                   3871: <dd><p>This script is executed before and after any files are removed.  It is
                   3872:            this script's responsibility to clean up any additional messy details
                   3873:            around the package's installation, since all pkg_delete knows is how to
                   3874:            delete the files created in the original distribution.
1.311     leot     3875:            See <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
                   3876:            and <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/pkg_create.1"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information.
1.299     rillig   3877:            The same methods to replace variables can be used as for
                   3878:            the <code class="filename">INSTALL</code> file.</p></dd>
                   3879: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
                   3880: <dd>
                   3881: <p>This file is displayed after installation of the package.
1.312     gdt      3882:            While this was used often in the past, it has two
                   3883:            problems: the display will be missed if many packages are
                   3884:            intalled at once, and the person installing the package
                   3885:            and the one using or configuring it may be different.  It
                   3886:            should therefore be used only in exceptional circumstances
                   3887:            where lasting negative consequences would result from
                   3888:            someone not reading it.</p>
                   3889: <p>MESSAGE should not be used for:</p>
                   3890: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   3891: <li class="listitem"><p>exhortations to read the documentation</p></li>
                   3892: <li class="listitem"><p>reminders to install rc.d files and set variables</p></li>
                   3893: <li class="listitem"><p>anything that should be explained in the
                   3894:              installation/configuration documentation that should
                   3895:              come with the package</p></li>
                   3896: </ul></div>
                   3897: <p>If the documentation provided by upstream needs
1.313     leot     3898:            enhancing, create e.g. files/README.pkgsrc and install it
                   3899:            in the package's documentation directory.
1.312     gdt      3900:            </p>
                   3901: <p>Note that MESSAGE is shown for all operating
                   3902:            systems and all init systems.  If a MESSAGE is necessary,
1.313     leot     3903:            it should be narrowed to only those operating systems and
1.312     gdt      3904:            init systems to which it applies.</p>
                   3905: <p>Note that you can modify variables in it easily by using
1.299     rillig   3906:            <code class="varname">MESSAGE_SUBST</code> in the package's
                   3907:            <code class="filename">Makefile</code>:</p>
1.91      rillig   3908: <pre class="programlisting">
1.299     rillig   3909: MESSAGE_SUBST+=  SOMEVAR="somevalue"
1.91      rillig   3910: </pre>
1.299     rillig   3911: <p>replaces "${SOMEVAR}" with <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span> in
                   3912:            <code class="filename">MESSAGE</code>.  By default, substitution is
                   3913:            performed for <code class="varname">PKGNAME</code>,
                   3914:            <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
                   3915:            <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
                   3916:            <code class="varname">PKG_SYSCONFDIR</code>,
                   3917:            <code class="varname">ROOT_GROUP</code>, and
                   3918:            <code class="varname">ROOT_USER</code>.</p>
                   3919: <p>You can display a different or additional files by
                   3920:            setting the <code class="varname">MESSAGE_SRC</code> variable.  Its
                   3921:            default is <code class="filename">MESSAGE</code>, if the file
                   3922:            exists.</p>
                   3923: </dd>
                   3924: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
                   3925: <dd>
                   3926: <p>This file is used by the alternatives framework.
                   3927:            It creates, configures, and destroys generic wrappers used to
                   3928:            run programs with similar interfaces.
                   3929:            See pkg_alternatives(8) from pkgtools/pkg_alternatives
                   3930:             for more information.</p>
                   3931: <p>Each line of the file contains two filenames, first
                   3932:            the wrapper and then the alternative provided by the package.
                   3933:            Both paths are relative to <code class="varname">PREFIX</code>.</p>
                   3934: </dd>
                   3935: </dl></div>
                   3936: </div>
                   3937: <div class="sect2">
                   3938: <div class="titlepage"><div><div><h3 class="title">
                   3939: <a name="components.optional.build"></a>12.5.2. Files affecting the build process</h3></div></div></div>
                   3940: <div class="variablelist"><dl class="variablelist">
                   3941: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
                   3942: <dd><p>This file contains arbitrary things that could
                   3943:        also go into a <code class="filename">Makefile</code>, but its purpose is
                   3944:        to be used by more than one package. This file should only be
                   3945:        used when the packages that will use the file are known in
                   3946:        advance. For other purposes it is often better to write a
                   3947:        <code class="filename">*.mk</code> file and give it a good name that
                   3948:        describes what it does.</p></dd>
                   3949: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
                   3950: <dd><p>This file contains the dependency information
                   3951:        for the buildlink3 framework (see <a class="xref" href="#buildlink" title="Chapter 18. Buildlink methodology">Chapter 18, <i>Buildlink methodology</i></a>).</p></dd>
                   3952: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
                   3953: <dd><p>This file contains workarounds for compiler bugs
                   3954:        and similar things. It is included automatically by the pkgsrc
                   3955:        infrastructure, so you don't need an extra
                   3956:        <code class="literal">.include</code> line for
                   3957:        it.</p></dd>
                   3958: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
                   3959: <dd><p>This file contains the code for the
                   3960:        package-specific options (see <a class="xref" href="#options" title="Chapter 16. Options handling">Chapter 16, <i>Options handling</i></a>) that can be
                   3961:        selected by the user. If a package has only one or two options,
                   3962:        it is equally acceptable to put the code directly into the
                   3963:        <code class="filename">Makefile</code>.</p></dd>
                   3964: </dl></div>
                   3965: </div>
                   3966: <div class="sect2">
                   3967: <div class="titlepage"><div><div><h3 class="title">
                   3968: <a name="components.optional.none"></a>12.5.3. Files affecting nothing at all</h3></div></div></div>
                   3969: <div class="variablelist"><dl class="variablelist">
                   3970: <dt><span class="term"><code class="filename">README*</code></span></dt>
                   3971: <dd><p>These files do not take place in the creation of
                   3972:        a package and thus are purely informative to the package
                   3973:        developer.</p></dd>
                   3974: <dt><span class="term"><code class="filename">TODO</code></span></dt>
                   3975: <dd><p>This file contains things that need to be done
                   3976:        to make the package even
                   3977:        better.</p></dd>
                   3978: </dl></div>
                   3979: </div>
                   3980: </div>
                   3981: <div class="sect1">
                   3982: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   3983: <a name="work-dir"></a>12.6. <code class="filename">work*</code>
                   3984: </h2></div></div></div>
                   3985: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
                   3986:     unpacked into the directory denoted by
                   3987:     <code class="varname">WRKDIR</code>. It can be removed by running
                   3988:     <span class="command"><strong>make clean</strong></span>. Besides the sources, this
                   3989:     directory is also used to keep various timestamp files.
                   3990:     The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
                   3991:     The default is <code class="filename">${.CURDIR}/work</code>
                   3992:     or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
                   3993:     if <code class="varname">OBJMACHINE</code> is set.</p>
1.91      rillig   3994: </div>
1.299     rillig   3995: <div class="sect1">
                   3996: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   3997: <a name="files-dir"></a>12.7. <code class="filename">files/*</code>
                   3998: </h2></div></div></div>
                   3999: <p>If you have any files that you wish to be placed in the package
                   4000:     prior to configuration or building, you can place these files here
                   4001:     and use a <span class="command"><strong>${CP}</strong></span> command in the
                   4002:     <span class="quote">&#8220;<span class="quote">post-extract</span>&#8221;</span> target to achieve this.</p>
                   4003: <p>If you want to share files in this way with other
                   4004:     packages, set the <code class="varname">FILESDIR</code> variable to point
                   4005:     to the other package's <code class="filename">files</code> directory,
                   4006:     e.g.:</p>
1.91      rillig   4007: <pre class="programlisting">
1.299     rillig   4008: FILESDIR=       ../../editors/xemacs/files
1.91      rillig   4009: </pre>
                   4010: </div>
                   4011: </div>
1.148     asau     4012: <div class="chapter">
1.75      rillig   4013: <div class="titlepage"><div><div><h2 class="title">
1.299     rillig   4014: <a name="build"></a>Chapter 13. The build process</h2></div></div></div>
1.75      rillig   4015: <div class="toc">
                   4016: <p><b>Table of Contents</b></p>
1.210     leot     4017: <dl class="toc">
1.299     rillig   4018: <dt><span class="sect1"><a href="#build.intro">13.1. Introduction</a></span></dt>
                   4019: <dt><span class="sect1"><a href="#build.prefix">13.2. Program location</a></span></dt>
                   4020: <dt><span class="sect1"><a href="#build.builddirs">13.3. Directories used during the build process</a></span></dt>
                   4021: <dt><span class="sect1"><a href="#build.running">13.4. Running a phase</a></span></dt>
                   4022: <dt><span class="sect1"><a href="#build.fetch">13.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                   4023: <dd><dl>
                   4024: <dt><span class="sect2"><a href="#build.fetch.what">13.5.1. What to fetch and where to get it from</a></span></dt>
                   4025: <dt><span class="sect2"><a href="#build.fetch.how">13.5.2. How are the files fetched?</a></span></dt>
                   4026: </dl></dd>
                   4027: <dt><span class="sect1"><a href="#build.checksum">13.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                   4028: <dt><span class="sect1"><a href="#build.extract">13.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                   4029: <dt><span class="sect1"><a href="#build.patch">13.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                   4030: <dt><span class="sect1"><a href="#build.tools">13.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                   4031: <dt><span class="sect1"><a href="#build.wrapper">13.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                   4032: <dt><span class="sect1"><a href="#build.configure">13.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   4033: <dt><span class="sect1"><a href="#build.build">13.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   4034: <dt><span class="sect1"><a href="#build.test">13.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                   4035: <dt><span class="sect1"><a href="#build.install">13.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   4036: <dt><span class="sect1"><a href="#build.package">13.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
                   4037: <dt><span class="sect1"><a href="#build.clean">13.16. Cleaning up</a></span></dt>
                   4038: <dt><span class="sect1"><a href="#build.helpful-targets">13.17. Other helpful targets</a></span></dt>
1.75      rillig   4039: </dl>
                   4040: </div>
1.148     asau     4041: <div class="sect1">
1.75      rillig   4042: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4043: <a name="build.intro"></a>13.1. Introduction</h2></div></div></div>
                   4044: <p>This chapter gives a detailed description on how a package is
                   4045:     built. Building a package is separated into different
                   4046:     <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
                   4047:     <code class="varname">build</code>, <code class="varname">install</code>), all of which are
                   4048:     described in the following sections. Each phase is split into
                   4049:     so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
                   4050:     containing phase, prefixed by one of <code class="varname">pre-</code>,
                   4051:     <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
                   4052:     <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
                   4053:     of the actual work is done in the <code class="varname">do-*</code> stages.</p>
                   4054: <p>Never override the regular targets (like
                   4055:     <code class="varname">fetch</code>), if you have to, override the
                   4056:     <code class="varname">do-*</code> ones instead.</p>
                   4057: <p>The basic steps for building a program are always the same.  First
                   4058:     the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
                   4059:     the local system and then extracted. After any pkgsrc-specific patches
                   4060:     to compile properly are applied, the software can be configured, then
                   4061:     built (usually by compiling), and finally the generated binaries, etc.
                   4062:     can be put into place on the system.</p>
                   4063: <p>To get more details about what is happening at each step,
                   4064:     you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
                   4065:     <code class="varname">PATCH_DEBUG</code> variable if you are just interested
                   4066:     in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
                   4067: </div>
                   4068: <div class="sect1">
                   4069: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   4070: <a name="build.prefix"></a>13.2. Program location</h2></div></div></div>
                   4071: <p>Before outlining the process performed by the NetBSD package system in
                   4072:     the next section, here's a brief discussion on where programs are
                   4073:     installed, and which variables influence this.</p>
                   4074: <p>The automatic variable <code class="varname">PREFIX</code> indicates
                   4075:     where all files of the final program shall be installed. It is
                   4076:     usually set to <code class="varname">LOCALBASE</code>
                   4077:     (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
                   4078:     for pkgs in the <code class="filename">cross</code> category.  The value of
                   4079:     <code class="varname">PREFIX</code> needs to be put
                   4080:     into the various places in the program's source where paths to
                   4081:     these files are encoded.  See <a class="xref" href="#components.patches" title="12.3. patches/*">Section 12.3, &#8220;<code class="filename">patches/*</code>&#8221;</a> and <a class="xref" href="#fixes.libtool" title="21.3.1. Shared libraries - libtool">Section 21.3.1, &#8220;Shared libraries - libtool&#8221;</a> for more details.</p>
                   4082: <p>When choosing which of these variables to use,
                   4083:     follow the following rules:</p>
1.148     asau     4084: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.299     rillig   4085: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
                   4086:        where the current pkg will be installed.  When referring to a
                   4087:        pkg's own installation path, use
                   4088:        <span class="quote">&#8220;<span class="quote">${PREFIX}</span>&#8221;</span>.</p></li>
                   4089: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
                   4090:        are installed.  If you need to construct a -I or -L argument
                   4091:        to the compiler to find includes and libraries installed by
                   4092:        another non-X11 pkg, use <span class="quote">&#8220;<span class="quote">${LOCALBASE}</span>&#8221;</span>. The name
                   4093:        <code class="varname">LOCALBASE</code> stems from FreeBSD, which
                   4094:        installed all packages in <code class="filename">/usr/local</code>. As
                   4095:        pkgsrc leaves <code class="filename">/usr/local</code> for the system
                   4096:        administrator, this variable is a misnomer.</p></li>
                   4097: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
                   4098:        distribution (from xsrc, etc.) is installed. When looking for
                   4099:        <span class="emphasis"><em>standard</em></span> X11 includes (not those
                   4100:        installed by a package), use <span class="quote">&#8220;<span class="quote">${X11BASE}</span>&#8221;</span>.</p></li>
                   4101: <li class="listitem"><p>X11-based packages using imake must set
                   4102:        <code class="varname">USE_IMAKE</code> to be installed correctly under
                   4103:        <code class="varname">LOCALBASE</code>.</p></li>
                   4104: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.311     leot     4105:        install files according to <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/hier.7"><span class="citerefentry"><span class="refentrytitle">hier</span>(7)</span></a>, with the exception that
1.299     rillig   4106:        manual pages go into <code class="filename">${PREFIX}/man</code>, not
                   4107:        <code class="filename">${PREFIX}/share/man</code>.</p></li>
                   4108: </ul></div>
                   4109: </div>
                   4110: <div class="sect1">
                   4111: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   4112: <a name="build.builddirs"></a>13.3. Directories used during the build process</h2></div></div></div>
                   4113: <p>When building a package, various directories are used to store
                   4114:     source files, temporary files, pkgsrc-internal files, and so on. These
                   4115:     directories are explained here.</p>
                   4116: <p>Some of the directory variables contain relative pathnames. There
                   4117:     are two common base directories for these relative directories:
                   4118:     <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
                   4119:     pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
                   4120:     inside the package itself.</p>
                   4121: <div class="variablelist"><dl class="variablelist">
                   4122: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
                   4123: <dd><p>This is an absolute pathname that points to the pkgsrc
                   4124:       root directory. Generally, you don't need
                   4125:       it.</p></dd>
                   4126: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
                   4127: <dd><p>This is an absolute pathname that points to the
                   4128:       current package.</p></dd>
                   4129: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
                   4130: <dd><p>This is a pathname relative to
                   4131:       <code class="varname">PKGSRCDIR</code> that points to the current
                   4132:       package.</p></dd>
                   4133: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
                   4134: <dd><p>This is an absolute pathname pointing to the directory
                   4135:       where all work takes place. The distfiles are extracted to this
                   4136:       directory. It also contains temporary directories and log files used by
                   4137:       the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
                   4138:       the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
                   4139: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
                   4140: <dd><p>This is an absolute pathname pointing to the directory
                   4141:       where the distfiles are extracted. It is usually a direct subdirectory
                   4142:       of <code class="varname">WRKDIR</code>, and often it's the only directory entry
                   4143:       that isn't hidden. This variable may be changed by a package
                   4144:       <code class="filename">Makefile</code>.</p></dd>
                   4145: </dl></div>
                   4146: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
                   4147:     the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
                   4148:     to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
                   4149:     <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
                   4150:     If users would like to have their pkgsrc trees behave in a
                   4151:     read-only manner, then the value of
                   4152:     <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
                   4153:     <span class="emphasis"><em>no</em></span>.</p>
1.75      rillig   4154: </div>
1.148     asau     4155: <div class="sect1">
1.75      rillig   4156: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4157: <a name="build.running"></a>13.4. Running a phase</h2></div></div></div>
                   4158: <p>You can run a particular phase by typing <span class="command"><strong>make
                   4159:     phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
                   4160:     phase. This will automatically run all phases that are required for this
                   4161:     phase. The default phase is <code class="varname">build</code>, that is, when you
                   4162:     run <span class="command"><strong>make</strong></span> without parameters in a package directory,
                   4163:     the package will be built, but not installed.</p>
1.75      rillig   4164: </div>
1.148     asau     4165: <div class="sect1">
1.75      rillig   4166: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4167: <a name="build.fetch"></a>13.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
                   4168: <p>The first step in building a package is to fetch the
                   4169:     distribution files (distfiles) from the sites that are providing
                   4170:     them. This is the task of the <span class="emphasis"><em>fetch</em></span>
                   4171:     phase.</p>
1.148     asau     4172: <div class="sect2">
1.93      rillig   4173: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   4174: <a name="build.fetch.what"></a>13.5.1. What to fetch and where to get it from</h3></div></div></div>
                   4175: <p>In simple cases, <code class="varname">MASTER_SITES</code>
                   4176:       defines all URLs from where the distfile, whose name is
                   4177:       derived from the <code class="varname">DISTNAME</code> variable, is
                   4178:       fetched. The more complicated cases are described
                   4179:       below.</p>
                   4180: <p>The variable <code class="varname">DISTFILES</code> specifies
                   4181:       the list of distfiles that have to be fetched. Its value
                   4182:       defaults to <code class="literal">${DEFAULT_DISTFILES}</code> and
                   4183:       its value is <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
                   4184:       so that most packages don't need to define it at all.
                   4185:       <code class="varname">EXTRACT_SUFX</code> is
                   4186:       <code class="literal">.tar.gz</code> by default, but can be changed
                   4187:       freely. Note that if your package requires additional
                   4188:       distfiles to the default one, you cannot just append the
                   4189:       additional filenames using the <code class="literal">+=</code>
                   4190:       operator, but you have write for example:</p>
                   4191: <pre class="programlisting">
                   4192: DISTFILES=      ${DEFAULT_DISTFILES} additional-files.tar.gz
                   4193: </pre>
                   4194: <p>Each distfile is fetched from a list of sites, usually
                   4195:       <code class="varname">MASTER_SITES</code>. If the package has multiple
                   4196:       <code class="varname">DISTFILES</code> or multiple
                   4197:       <code class="varname">PATCHFILES</code> from different sites, you can
                   4198:       set
                   4199:       <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
                   4200:       to the list of URLs where the file
                   4201:       <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
                   4202:       (including the suffix) can be found.</p>
                   4203: <pre class="programlisting">
                   4204: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX}
                   4205: DISTFILES+=     foo-file.tar.gz
                   4206: SITES.foo-file.tar.gz= \
                   4207: https://www.somewhere.com/somehow/ \
                   4208: https://www.somewhereelse.com/mirror/somehow/
                   4209: </pre>
                   4210: <p>When actually fetching the distfiles, each item from
                   4211:       <code class="varname">MASTER_SITES</code> or
                   4212:       <code class="varname">SITES.*</code> gets the name of each distfile
                   4213:       appended to it, without an intermediate slash. Therefore,
                   4214:       all site values have to end with a slash or other separator
                   4215:       character. This allows for example to set
                   4216:       <code class="varname">MASTER_SITES</code> to a URL of a CGI script
                   4217:       that gets the name of the distfile as a parameter. In this
                   4218:       case, the definition would look like:</p>
                   4219: <pre class="programlisting">
                   4220: MASTER_SITES=   https://www.example.com/download.cgi?file=
                   4221: </pre>
                   4222: <p> The exception to this rule are URLs starting with a dash.
                   4223:       In that case the URL is taken as is, fetched and the result
                   4224:       stored under the name of the distfile. You can use this style
                   4225:       for the case when the download URL style does not match the
                   4226:       above common case. For example, if permanent download URL is a
                   4227:       redirector to the real download URL, or the download file name
                   4228:       is offered by an HTTP Content-Disposition header. In the
                   4229:       following example, <code class="filename">foo-1.0.0.tar.gz</code> will be
                   4230:       created instead of the default
                   4231:       <code class="filename">v1.0.0.tar.gz</code>.</p>
                   4232: <pre class="programlisting">
                   4233: DISTNAME=       foo-1.0.0
                   4234: MASTER_SITES=   -https://www.example.com/archive/v1.0.0.tar.gz
                   4235: </pre>
                   4236: <p>There are some predefined values for
                   4237:       <code class="varname">MASTER_SITES</code>, which can be used in
                   4238:       packages.  The names of the variables should speak for
                   4239:       themselves.</p>
                   4240: <table border="0" summary="Simple list" class="simplelist">
                   4241: <tr>
                   4242: <td>MASTER_SITE_APACHE</td>
                   4243: <td>MASTER_SITE_BACKUP</td>
                   4244: </tr>
                   4245: <tr>
                   4246: <td>MASTER_SITE_CRATESIO</td>
                   4247: <td>MASTER_SITE_CYGWIN</td>
                   4248: </tr>
                   4249: <tr>
                   4250: <td>MASTER_SITE_DEBIAN</td>
                   4251: <td>MASTER_SITE_FREEBSD</td>
                   4252: </tr>
                   4253: <tr>
                   4254: <td>MASTER_SITE_FREEBSD_LOCAL</td>
                   4255: <td>MASTER_SITE_GENTOO</td>
                   4256: </tr>
                   4257: <tr>
                   4258: <td>MASTER_SITE_GITHUB</td>
                   4259: <td>MASTER_SITE_GNOME</td>
                   4260: </tr>
                   4261: <tr>
                   4262: <td>MASTER_SITE_GNU</td>
                   4263: <td>MASTER_SITE_GNUSTEP</td>
                   4264: </tr>
                   4265: <tr>
                   4266: <td>MASTER_SITE_HASKELL_HACKAGE</td>
                   4267: <td>MASTER_SITE_IFARCHIVE</td>
                   4268: </tr>
                   4269: <tr>
                   4270: <td>MASTER_SITE_KDE</td>
                   4271: <td>MASTER_SITE_MOZILLA</td>
                   4272: </tr>
                   4273: <tr>
                   4274: <td>MASTER_SITE_MOZILLA_ALL</td>
                   4275: <td>MASTER_SITE_MYSQL</td>
                   4276: </tr>
                   4277: <tr>
                   4278: <td>MASTER_SITE_NETLIB</td>
                   4279: <td>MASTER_SITE_OPENBSD</td>
                   4280: </tr>
                   4281: <tr>
                   4282: <td>MASTER_SITE_OPENOFFICE</td>
                   4283: <td>MASTER_SITE_OSDN</td>
                   4284: </tr>
                   4285: <tr>
                   4286: <td>MASTER_SITE_PERL_CPAN</td>
                   4287: <td>MASTER_SITE_PGSQL</td>
                   4288: </tr>
                   4289: <tr>
                   4290: <td>MASTER_SITE_PYPI</td>
                   4291: <td>MASTER_SITE_RUBYGEMS</td>
                   4292: </tr>
                   4293: <tr>
                   4294: <td>MASTER_SITE_R_CRAN</td>
                   4295: <td>MASTER_SITE_SOURCEFORGE</td>
                   4296: </tr>
1.85      jmmv     4297: <tr>
1.299     rillig   4298: <td>MASTER_SITE_SUNSITE</td>
                   4299: <td>MASTER_SITE_SUSE</td>
1.85      jmmv     4300: </tr>
                   4301: <tr>
1.299     rillig   4302: <td>MASTER_SITE_TEX_CTAN</td>
                   4303: <td>MASTER_SITE_XCONTRIB</td>
1.85      jmmv     4304: </tr>
                   4305: <tr>
1.299     rillig   4306: <td>MASTER_SITE_XEMACS</td>
                   4307: <td>MASTER_SITE_XORG</td>
                   4308: </tr>
                   4309: </table>
                   4310: <p>Some explanations for the less self-explaining ones:
                   4311:       <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
                   4312:       for packages that are maintained in <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/%24%7BDIST_SUBDIR%7D" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}</a>.  <code class="varname">MASTER_SITE_LOCAL</code> contains local
                   4313:       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>
                   4314: <p>If you choose one of these predefined sites, you may
                   4315:       want to specify a subdirectory of that site. Since these
                   4316:       macros may expand to more than one actual site, you
                   4317:       <span class="emphasis"><em>must</em></span> use the following construct to
                   4318:       specify a subdirectory:</p>
1.100     rillig   4319: <pre class="programlisting">
1.299     rillig   4320: MASTER_SITES=   ${MASTER_SITE_GNU:=subdirectory/name/}
                   4321: MASTER_SITES=   ${MASTER_SITE_SOURCEFORGE:=project_name/}
1.100     rillig   4322: </pre>
1.299     rillig   4323: <p>Note the trailing slash after the subdirectory
                   4324:       name.</p>
                   4325: </div>
                   4326: <div class="sect2">
                   4327: <div class="titlepage"><div><div><h3 class="title">
                   4328: <a name="build.fetch.how"></a>13.5.2. How are the files fetched?</h3></div></div></div>
                   4329: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
                   4330:       all the distfiles exist in a local directory
                   4331:       (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
                   4332:       user). If the files do not exist, they are fetched using
                   4333:       commands of the form</p>
1.100     rillig   4334: <pre class="programlisting">
1.299     rillig   4335: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
                   4336: </pre>
                   4337: <p>where <code class="literal">${site}</code> varies through
                   4338:       several possibilities in turn: first,
                   4339:       <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
                   4340:       sites specified in either <code class="varname">SITES.file</code> if
                   4341:       defined, else <code class="varname">MASTER_SITES</code> or
                   4342:       <code class="varname">PATCH_SITES</code>, as applies, then finally the
                   4343:       value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
                   4344:       all except the first and the last can be optionally sorted
                   4345:       by the user, via setting either
                   4346:       <code class="varname">MASTER_SORT_RANDOM</code>, and
                   4347:       <code class="varname">MASTER_SORT_AWK</code> or
                   4348:       <code class="varname">MASTER_SORT_REGEX</code>.</p>
                   4349: <p> The specific command and arguments used depend on the
                   4350:       <code class="varname">FETCH_USING</code> parameter. The example above is
                   4351:       for <code class="literal">FETCH_USING=custom</code>.</p>
                   4352: <p>The distfiles mirror run by the NetBSD Foundation uses the
                   4353:       <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
                   4354:       distfiles, if they are freely distributable.  Packages setting
                   4355:       <code class="varname">NO_SRC_ON_FTP</code> (usually to
                   4356:       <span class="quote">&#8220;<span class="quote">${RESTRICTED}</span>&#8221;</span>) will not have their distfiles
                   4357:       mirrored.</p>
1.85      jmmv     4358: </div>
                   4359: </div>
1.299     rillig   4360: <div class="sect1">
                   4361: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   4362: <a name="build.checksum"></a>13.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
                   4363: <p>After the distfile(s) are fetched, their checksum is
                   4364:     generated and compared with the checksums stored in the
                   4365:     distinfo file. If the checksums don't match, the build is
                   4366:     aborted. This is to ensure the same distfile is used for
                   4367:     building, and that the distfile wasn't changed, e.g. by some
                   4368:     malign force, deliberately changed distfiles on the master
                   4369:     distribution site or network lossage.</p>
1.75      rillig   4370: </div>
1.148     asau     4371: <div class="sect1">
1.75      rillig   4372: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4373: <a name="build.extract"></a>13.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
                   4374: <p>When the distfiles are present on the local system, they
                   4375:     need to be extracted, as they usually come in the form of some
                   4376:     compressed archive format.</p>
                   4377: <p>By default, all <code class="varname">DISTFILES</code> are
                   4378:     extracted. If you only need some of them, you can set the
                   4379:     <code class="varname">EXTRACT_ONLY</code> variable to the list of those
                   4380:     files.</p>
                   4381: <p>Extracting the files is usually done by a little
                   4382:     program, <code class="filename">mk/extract/extract</code>, which
                   4383:     already knows how to extract various archive formats, so most
                   4384:     likely you will not need to change anything here. But if you
                   4385:     need, the following variables may help you:</p>
1.148     asau     4386: <div class="variablelist"><dl class="variablelist">
1.299     rillig   4387: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
                   4388: <dd><p>Use these variables to override the default
                   4389:       options for an extract command, which are defined in
                   4390:       <code class="filename">mk/extract/extract</code>.</p></dd>
                   4391: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
                   4392: <dd><p>This variable can be set to
                   4393:       <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
                   4394:       (which is the default value), <code class="literal">pax</code>, or an
                   4395:       absolute pathname pointing to the command with which tar
                   4396:       archives should be extracted.  It is preferred to choose bsdtar over gtar
                   4397:       if NetBSD's pax-as-tar is not good enough.</p></dd>
1.75      rillig   4398: </dl></div>
1.299     rillig   4399: <p>If the <code class="filename">extract</code> program doesn't
                   4400:     serve your needs, you can also override the
                   4401:     <code class="varname">EXTRACT_CMD</code> variable, which holds the
                   4402:     command used for extracting the files. This command is
                   4403:     executed in the <code class="filename">${WRKSRC}</code>
                   4404:     directory. During execution of this command, the shell
                   4405:     variable <code class="varname">extract_file</code> holds the absolute
                   4406:     pathname of the file that is going to be extracted.</p>
                   4407: <p>And if that still does not suffice, you can override the
                   4408:     <code class="varname">do-extract</code> target in the package
                   4409:     Makefile.</p>
1.75      rillig   4410: </div>
1.148     asau     4411: <div class="sect1">
1.75      rillig   4412: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4413: <a name="build.patch"></a>13.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
                   4414: <p>After extraction, all the patches named by the
                   4415:     <code class="varname">PATCHFILES</code>, those present in the patches
                   4416:     subdirectory of the package as well as in
                   4417:     $LOCALPATCHES/$PKGPATH (e.g.
                   4418:     <code class="filename">/usr/local/patches/graphics/png</code>) are
                   4419:     applied.  Patchfiles ending in <code class="filename">.Z</code> or
                   4420:     <code class="filename">.gz</code> are uncompressed before they are
                   4421:     applied, files ending in <code class="filename">.orig</code> or
                   4422:     <code class="filename">.rej</code> are ignored. Any special options to
1.311     leot     4423:     <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/patch.1"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> can be handed in
1.299     rillig   4424:     <code class="varname">PATCH_DIST_ARGS</code>.  See <a class="xref" href="#components.patches" title="12.3. patches/*">Section 12.3, &#8220;<code class="filename">patches/*</code>&#8221;</a> for more details.</p>
1.311     leot     4425: <p>By default <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/patch.1"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> is given special arguments to make it
1.299     rillig   4426:     fail if the expected text from the patch context is not found in the
                   4427:     patched file. If that happens, fix the patch file by comparing it
                   4428:     with the actual text in the file to be patched.</p>
1.78      rillig   4429: </div>
1.148     asau     4430: <div class="sect1">
1.75      rillig   4431: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4432: <a name="build.tools"></a>13.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
                   4433: <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>.
                   4434:     </p>
1.75      rillig   4435: </div>
1.148     asau     4436: <div class="sect1">
1.75      rillig   4437: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4438: <a name="build.wrapper"></a>13.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
                   4439: <p>This phase creates wrapper programs for the compilers and
                   4440:     linkers. The following variables can be used to tweak the
                   4441:     wrappers.</p>
                   4442: <div class="variablelist"><dl class="variablelist">
                   4443: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
                   4444: <dd><p>The command used to print progress
                   4445:       messages. Does nothing by default. Set to
                   4446:       <code class="literal">${ECHO}</code> to see the progress
                   4447:       messages.</p></dd>
                   4448: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
                   4449: <dd><p>This variable can be set to
                   4450:       <code class="literal">yes</code> (default) or <code class="literal">no</code>,
                   4451:       depending on whether you want additional information in the
                   4452:       wrapper log file.</p></dd>
                   4453: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
                   4454: <dd><p>This variable can be set to
                   4455:       <code class="literal">yes</code> or <code class="literal">no</code>, depending
                   4456:       on whether the wrapper should use its cache, which will
                   4457:       improve the speed. The default value is
                   4458:       <code class="literal">yes</code>, but is forced to
                   4459:       <code class="literal">no</code> if the platform does not support
                   4460:       it.</p></dd>
                   4461: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
                   4462: <dd><p>A list of reordering commands. A reordering
                   4463:       command has the form
                   4464:       <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
                   4465:       It ensures that that
                   4466:       <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
                   4467:       before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
                   4468:       </p></dd>
                   4469: </dl></div>
                   4470: </div>
                   4471: <div class="sect1">
                   4472: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   4473: <a name="build.configure"></a>13.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
                   4474: <p>Most pieces of software need information on the header
                   4475:     files, system calls, and library routines which are available
                   4476:     on the platform they run on. The process of determining this
                   4477:     information is known as configuration, and is usually
                   4478:     automated. In most cases, a script is supplied with the
                   4479:     distfiles, and its invocation results in generation of header
                   4480:     files, Makefiles, etc.</p>
                   4481: <p>If the package contains a configure script, this can be
                   4482:     invoked by setting <code class="varname">HAS_CONFIGURE</code> to
                   4483:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. If the configure script is a GNU autoconf
                   4484:     script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.301     rillig   4485:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> instead.</p>
                   4486: <p>In the <code class="literal">do-configure</code> stage, a rough
                   4487:     equivalent of the following command is run. See
                   4488:     <code class="filename">mk/configure/configure.mk</code>, target
                   4489:     <code class="literal">do-configure-script</code> for the exact
                   4490:     definition.</p>
                   4491: <pre class="programlisting">
                   4492: .for dir in ${CONFIGURE_DIRS}
                   4493:         cd ${WRKSRC} &amp;&amp; cd ${dir} \
                   4494:         &amp;&amp; env ${CONFIGURE_ENV} \
                   4495:             ${CONFIG_SHELL} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
1.299     rillig   4496: .endfor
1.100     rillig   4497: </pre>
1.299     rillig   4498: <p><code class="varname">CONFIGURE_DIRS</code> (default:
                   4499:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span>) is a list of pathnames relative to
                   4500:     <code class="varname">WRKSRC</code>. In each of these directories, the
                   4501:     configure script is run with the environment
                   4502:     <code class="varname">CONFIGURE_ENV</code> and arguments
                   4503:     <code class="varname">CONFIGURE_ARGS</code>. The variables
                   4504:     <code class="varname">CONFIGURE_ENV</code>,
                   4505:     <code class="varname">CONFIGURE_SCRIPT</code> (default:
                   4506:     <span class="quote">&#8220;<span class="quote">./configure</span>&#8221;</span>) and
                   4507:     <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
                   4508:     package.</p>
                   4509: <p>If the program uses the Perl way of configuration (mainly Perl
                   4510:     modules, but not only), i.e. a file called
                   4511:     <code class="filename">Makefile.PL</code>, it should include
                   4512:     <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
                   4513:     <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
                   4514:     variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
                   4515: <p>If the program uses an <code class="filename">Imakefile</code>
                   4516:     for configuration, the appropriate steps can be invoked by
                   4517:     setting <code class="varname">USE_IMAKE</code> to
                   4518:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.  If you only need xmkmf, add it to <code class="varname">USE_TOOLS</code>.
                   4519:     You can add variables to xmkmf's environment by adding them to the
                   4520:     <code class="varname">SCRIPTS_ENV</code> variable.</p>
                   4521: <p>If the program uses <code class="filename">cmake</code>
                   4522:     for configuration, the appropriate steps can be invoked by
                   4523:     setting <code class="varname">USE_CMAKE</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.
                   4524:     You can add variables to cmake's environment by adding them to the
                   4525:     <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
                   4526:     by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
                   4527:     The top directory argument is given by the
                   4528:     <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
                   4529:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span> (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
                   4530: <p>If there is no configure step at all, set
                   4531:     <code class="varname">NO_CONFIGURE</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.</p>
1.75      rillig   4532: </div>
1.148     asau     4533: <div class="sect1">
1.75      rillig   4534: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4535: <a name="build.build"></a>13.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.301     rillig   4536: <p>For building a package, a rough equivalent of the following
                   4537:     code is executed; see <code class="filename">mk/build/build.mk</code>, target
                   4538:     <code class="literal">do-build</code> for the exact definition.</p>
1.97      rillig   4539: <pre class="programlisting">
1.301     rillig   4540: .for dir in ${BUILD_DIRS}
                   4541:         cd ${WRKSRC} &amp;&amp; cd ${dir} \
1.299     rillig   4542:         &amp;&amp; env ${MAKE_ENV} \
1.301     rillig   4543:             ${MAKE_PROGRAM} ${MAKE_FLAGS} ${BUILD_MAKE_FLAGS} \
1.299     rillig   4544:                 -f ${MAKE_FILE} \
                   4545:                 ${BUILD_TARGET}
                   4546: .endfor
1.97      rillig   4547: </pre>
1.299     rillig   4548: <p><code class="varname">BUILD_DIRS</code> (default:
                   4549:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span>) is a list of pathnames relative to
                   4550:     <code class="varname">WRKSRC</code>. In each of these directories,
                   4551:     <code class="varname">MAKE_PROGRAM</code> is run with the environment
                   4552:     <code class="varname">MAKE_ENV</code> and arguments
                   4553:     <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
                   4554:     <code class="varname">MAKE_ENV</code>,
                   4555:     <code class="varname">BUILD_MAKE_FLAGS</code>,
                   4556:     <code class="varname">MAKE_FILE</code> and
                   4557:     <code class="varname">BUILD_TARGET</code> may all be changed by the
                   4558:     package.</p>
                   4559: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
                   4560:     <span class="quote">&#8220;<span class="quote">gmake</span>&#8221;</span> if <code class="varname">USE_TOOLS</code> contains
                   4561:     <span class="quote">&#8220;<span class="quote">gmake</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">make</span>&#8221;</span> otherwise. The
                   4562:     default value of <code class="varname">MAKE_FILE</code> is
                   4563:     <span class="quote">&#8220;<span class="quote">Makefile</span>&#8221;</span>, and <code class="varname">BUILD_TARGET</code>
                   4564:     defaults to <span class="quote">&#8220;<span class="quote">all</span>&#8221;</span>.</p>
                   4565: <p>If there is no build step at all, set
                   4566:     <code class="varname">NO_BUILD</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.</p>
1.97      rillig   4567: </div>
1.148     asau     4568: <div class="sect1">
1.97      rillig   4569: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4570: <a name="build.test"></a>13.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
                   4571: <p>[TODO]</p>
1.75      rillig   4572: </div>
1.148     asau     4573: <div class="sect1">
1.75      rillig   4574: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4575: <a name="build.install"></a>13.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
                   4576: <p>Once the build stage has completed, the final step is to
                   4577:     install the software in public directories, so users can
                   4578:     access the programs and files.</p>
1.301     rillig   4579: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough equivalent
                   4580:     of the following code is executed; see
                   4581:     <code class="filename">mk/install/install.mk</code>, target
                   4582:     <code class="literal">do-install</code> for the exact definition. Additionally,
                   4583:     before and after this code, several consistency checks are run
                   4584:     against the files-to-be-installed, see
                   4585:     <code class="filename">mk/check/*.mk</code> for details.</p>
                   4586: <pre class="programlisting">
                   4587: .for dir in ${INSTALL_DIRS}
                   4588:         cd ${WRKSRC} &amp;&amp; cd ${dir} \
                   4589:         &amp;&amp; env ${INSTALL_ENV} ${MAKE_ENV} \
                   4590:             ${MAKE_PROGRAM} ${MAKE_FLAGS} ${INSTALL_MAKE_FLAGS} \
                   4591:                 -f ${MAKE_FILE} ${INSTALL_TARGET}
1.299     rillig   4592: .endfor
1.220     wiz      4593: </pre>
1.299     rillig   4594: <p>The variable's meanings are analogous to the ones in the
                   4595:     <span class="emphasis"><em>build</em></span> phase.
                   4596:     <code class="varname">INSTALL_DIRS</code> defaults to
                   4597:     <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
                   4598:     is <span class="quote">&#8220;<span class="quote">install</span>&#8221;</span> by default, plus
                   4599:     <span class="quote">&#8220;<span class="quote">install.man</span>&#8221;</span> if <code class="varname">USE_IMAKE</code> is
                   4600:     defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
                   4601:     defined.</p>
                   4602: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
                   4603:     variables are useful. They are all variations of the
1.311     leot     4604:     <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/install.1"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a> command that have the owner, group and
1.299     rillig   4605:     permissions preset. <code class="varname">INSTALL</code> is the plain
                   4606:     install command. The specialized variants, together with their
                   4607:     intended use, are:</p>
                   4608: <div class="variablelist"><dl class="variablelist">
                   4609: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
                   4610: <dd><p>directories that contain
                   4611:       binaries</p></dd>
                   4612: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
                   4613: <dd><p>directories that contain
                   4614:       scripts</p></dd>
                   4615: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
                   4616: <dd><p>directories that contain shared and static
                   4617:       libraries</p></dd>
                   4618: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
                   4619: <dd><p>directories that contain data
                   4620:       files</p></dd>
                   4621: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
                   4622: <dd><p>directories that contain man
                   4623:       pages</p></dd>
                   4624: <dt><span class="term"><code class="varname">INSTALL_GAME_DIR</code></span></dt>
                   4625: <dd><p>directories that contain data files for games
                   4626:       </p></dd>
                   4627: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
                   4628: <dd><p>binaries that can be stripped from debugging
                   4629:       symbols</p></dd>
                   4630: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
                   4631: <dd><p>binaries that cannot be
                   4632:       stripped</p></dd>
                   4633: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
                   4634: <dd><p>game
                   4635:       binaries</p></dd>
                   4636: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
                   4637: <dd><p>shared and static
                   4638:       libraries</p></dd>
                   4639: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
                   4640: <dd><p>data files</p></dd>
                   4641: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
                   4642: <dd><p>data files for
                   4643:       games</p></dd>
                   4644: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
                   4645: <dd><p>man pages</p></dd>
                   4646: </dl></div>
                   4647: <p>Some other variables are:</p>
                   4648: <div class="variablelist"><dl class="variablelist">
                   4649: <dt><span class="term"><code class="varname">INSTALL_UNSTRIPPED</code></span></dt>
1.311     leot     4650: <dd><p>If set to <code class="literal">yes</code>, do not run <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/strip.1"><span class="citerefentry"><span class="refentrytitle">strip</span>(1)</span></a>
1.299     rillig   4651:       when installing binaries. Any debugging sections and symbols present in
                   4652:       binaries will be preserved.
                   4653:       </p></dd>
                   4654: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
                   4655: <dd><p>A list of directories relative to
                   4656:       <code class="varname">PREFIX</code> that are created by pkgsrc at the
                   4657:       beginning of the <span class="emphasis"><em>install</em></span> phase.
                   4658:       The package is supposed to create all needed directories itself
                   4659:       before installing files to it and list all other directories here.
                   4660:       </p></dd>
                   4661: </dl></div>
                   4662: <p>In the rare cases that a package shouldn't install anything,
                   4663:     set <code class="varname">NO_INSTALL</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. This is
                   4664:     mostly relevant for packages in the <code class="filename">regress</code>
                   4665:     category.</p>
1.75      rillig   4666: </div>
1.148     asau     4667: <div class="sect1">
1.75      rillig   4668: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4669: <a name="build.package"></a>13.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
                   4670: <p>Once the install stage has completed, a binary package of
                   4671:     the installed files can be built.  These binary packages can be
                   4672:     used for quick installation without previous compilation, e.g. by
                   4673:     the <span class="command"><strong>make bin-install</strong></span> or by using
                   4674:     <span class="command"><strong>pkg_add</strong></span>.</p>
                   4675: <p>By default, the binary packages are created in
                   4676:     <code class="filename">${PACKAGES}/All</code> and symlinks are created in
                   4677:     <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
                   4678:     one for each category in the <code class="varname">CATEGORIES</code>
                   4679:     variable.  <code class="varname">PACKAGES</code> defaults to
                   4680:     <code class="filename">pkgsrc/packages</code>.</p>
1.75      rillig   4681: </div>
1.148     asau     4682: <div class="sect1">
1.75      rillig   4683: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4684: <a name="build.clean"></a>13.16. Cleaning up</h2></div></div></div>
                   4685: <p>Once you're finished with a package, you can clean the work
                   4686:     directory by running <span class="command"><strong>make clean</strong></span>.  If you want
                   4687:     to clean the work directories of all dependencies too, use
                   4688:     <span class="command"><strong>make clean-depends</strong></span>.</p>
1.75      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.299     rillig   4692: <a name="build.helpful-targets"></a>13.17. Other helpful targets</h2></div></div></div>
1.148     asau     4693: <div class="variablelist"><dl class="variablelist">
1.299     rillig   4694: <dt><span class="term">pre/post-*</span></dt>
                   4695: <dd>
                   4696: <p>For any of the main targets described in the previous
                   4697:          section (configure, build, install, etc.), two auxiliary
                   4698:          targets exist with
                   4699:          <span class="quote">&#8220;<span class="quote">pre-</span>&#8221;</span> and <span class="quote">&#8220;<span class="quote">post-</span>&#8221;</span> used as a
                   4700:          prefix for the main target's name.  These targets are
                   4701:          invoked before and after the main target is called,
                   4702:          allowing extra configuration or installation steps be
                   4703:          performed from a package's Makefile, for example, which
                   4704:          a program's configure script or install target
                   4705:          omitted.</p>
                   4706: <p>About 5% of the pkgsrc packages define their custom
                   4707:          post-extract target, another 5% define pre-configure, and 10%
                   4708:          define post-install. The other pre/post-* targets are defined
                   4709:          even less often.</p>
                   4710: </dd>
                   4711: <dt><span class="term">do-*</span></dt>
1.75      rillig   4712: <dd>
1.299     rillig   4713: <p>Should one of the main targets do the wrong thing,
                   4714:          and should there be no variable to fix this, you can
                   4715:          redefine it with the do-* target.  (Note that redefining
                   4716:          the target itself instead of the do-* target is a bad
                   4717:          idea, as the pre-* and post-* targets won't be called
                   4718:          anymore, etc.)</p>
                   4719: <p>About 15% of the pkgsrc packages override the default
                   4720:          do-install, the other do-* targets are overridden even less
                   4721:          often.</p>
1.75      rillig   4722: </dd>
1.299     rillig   4723: <dt><span class="term">reinstall</span></dt>
1.75      rillig   4724: <dd>
1.299     rillig   4725: <p>If you did a <span class="command"><strong>make install</strong></span> and
                   4726:          you noticed some file was not installed properly, you
                   4727:          can repeat the installation with this target, which will
                   4728:          ignore the <span class="quote">&#8220;<span class="quote">already installed</span>&#8221;</span> flag.</p>
                   4729: <p>This is the default value of
                   4730:          <code class="varname">DEPENDS_TARGET</code> except in the case of
                   4731:          <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
                   4732:          package</strong></span>, where the defaults are
                   4733:          <span class="quote">&#8220;<span class="quote">package</span>&#8221;</span> and <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span>,
                   4734:          respectively.</p>
1.75      rillig   4735: </dd>
1.299     rillig   4736: <dt><span class="term">deinstall</span></dt>
                   4737: <dd>
1.311     leot     4738: <p>This target does a <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> in the
1.299     rillig   4739:          current directory, effectively de-installing the
                   4740:          package. The following variables can be used to tune the
                   4741:          behaviour:</p>
                   4742: <div class="variablelist"><dl class="variablelist">
                   4743: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.311     leot     4744: <dd><p>Add a "-v" to the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> command.</p></dd>
1.299     rillig   4745: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
                   4746: <dd><p>Remove all packages that require (depend on)
                   4747:                the given package.  This can be used to remove any
                   4748:                packages that may have been pulled in by a given
                   4749:                package, e.g. if <span class="command"><strong>make deinstall
                   4750:                DEINSTALLDEPENDS=1</strong></span> is done in
                   4751:                <code class="filename">pkgsrc/x11/kde</code>, this is
                   4752:                likely to remove whole KDE. Works by adding
1.311     leot     4753:                <span class="quote">&#8220;<span class="quote">-R</span>&#8221;</span> to the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
1.299     rillig   4754:                command line.</p></dd>
                   4755: </dl></div>
                   4756: </dd>
                   4757: <dt><span class="term">bin-install</span></dt>
                   4758: <dd><p>Install a binary package from local disk and via FTP
                   4759:          from a list of sites (see the
                   4760:          <code class="varname">BINPKG_SITES</code> variable), and do a
                   4761:          <span class="command"><strong>make package</strong></span> if no binary package is
                   4762:          available anywhere.  The arguments given to
                   4763:          <span class="command"><strong>pkg_add</strong></span> can be set via
                   4764:          <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
                   4765:          operation, etc.</p></dd>
                   4766: <dt><span class="term">install-clean</span></dt>
                   4767: <dd><p>This target removes the state files for the "install" and later
                   4768:          phases so that the "install" target may be re-invoked. This can be
                   4769:          used after editing the PLIST to install the package without
                   4770:          rebuilding it.</p></dd>
                   4771: <dt><span class="term">build-clean</span></dt>
                   4772: <dd><p>This target removes the state files for the "build" and later
                   4773:          phases so that the "build" target may be re-invoked.</p></dd>
                   4774: <dt><span class="term">update</span></dt>
                   4775: <dd>
                   4776: <p>This target causes the current package to be
                   4777:          updated to the latest version.  The package and all
                   4778:          depending packages first get de-installed, then current
                   4779:          versions of the corresponding packages get compiled and
                   4780:          installed.  This is similar to manually noting which
                   4781:          packages are currently installed, then performing a
                   4782:          series of <span class="command"><strong>make deinstall</strong></span> and
                   4783:          <span class="command"><strong>make install</strong></span> (or whatever
                   4784:          <code class="varname">UPDATE_TARGET</code> is set to) for these
                   4785:          packages.</p>
                   4786: <p>You can use the <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> target to
                   4787:          resume package updating in case a previous <span class="command"><strong>make
                   4788:          update</strong></span> was interrupted for some reason.
                   4789:          However, in this case, make sure you don't call
                   4790:          <span class="command"><strong>make clean</strong></span> or otherwise remove the
                   4791:          list of dependent packages in <code class="varname">WRKDIR</code>.
                   4792:          Otherwise, you lose the ability to automatically update
                   4793:          the current package along with the dependent packages
                   4794:          you have installed.</p>
                   4795: <p>Resuming an interrupted <span class="command"><strong>make
                   4796:          update</strong></span> will only work as long as the package
                   4797:          tree remains unchanged.  If the source code for one of
                   4798:          the packages to be updated has been changed, resuming
                   4799:          <span class="command"><strong>make update</strong></span> will most certainly
                   4800:          fail!</p>
                   4801: <p>The following variables can be used either on the
                   4802:          command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
                   4803:          alter the behaviour of <span class="command"><strong>make
                   4804:          update</strong></span>:</p>
                   4805: <div class="variablelist"><dl class="variablelist">
                   4806: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
                   4807: <dd><p>Install target to recursively use for the
                   4808:                updated package and the dependent packages.
                   4809:                Defaults to <code class="varname">DEPENDS_TARGET</code> if
                   4810:                set, <span class="quote">&#8220;<span class="quote">install</span>&#8221;</span> otherwise for
                   4811:                <span class="command"><strong>make update</strong></span>.  Other good
                   4812:                targets are <span class="quote">&#8220;<span class="quote">package</span>&#8221;</span> or
                   4813:                <span class="quote">&#8220;<span class="quote">bin-install</span>&#8221;</span>.  Do not set this to
                   4814:                <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> or you will get stuck in an
                   4815:                endless loop!</p></dd>
                   4816: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
                   4817: <dd><p>Don't clean up after updating.  Useful if
                   4818:                you want to leave the work sources of the updated
                   4819:                packages around for inspection or other purposes.
                   4820:                Be sure you eventually clean up the source tree
                   4821:                (see the <span class="quote">&#8220;<span class="quote">clean-update</span>&#8221;</span> target below)
                   4822:                or you may run into troubles with old source code
                   4823:                still lying around on your next
                   4824:                <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
                   4825:                update</strong></span>.</p></dd>
                   4826: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
                   4827: <dd><p>Deinstall each package before installing
                   4828:                (making <code class="varname">DEPENDS_TARGET</code>). This
                   4829:                may be necessary if the
                   4830:                <span class="quote">&#8220;<span class="quote">clean-update</span>&#8221;</span> target (see below) was
                   4831:                called after interrupting a running <span class="command"><strong>make
                   4832:                update</strong></span>.</p></dd>
                   4833: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
                   4834: <dd><p>Allows you to disable recursion and hardcode
                   4835:                the target for packages.  The default is
                   4836:                <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> for the update target,
                   4837:                facilitating a recursive update of prerequisite
                   4838:                packages.  Only set
                   4839:                <code class="varname">DEPENDS_TARGET</code> if you want to
                   4840:                disable recursive updates. Use
                   4841:                <code class="varname">UPDATE_TARGET</code> instead to just
                   4842:                set a specific target for each package to be
                   4843:                installed during <span class="command"><strong>make update</strong></span>
                   4844:                (see above).</p></dd>
                   4845: </dl></div>
                   4846: </dd>
                   4847: <dt><span class="term">clean-update</span></dt>
                   4848: <dd>
                   4849: <p>Clean the source tree for all packages that would
                   4850:          get updated if <span class="command"><strong>make update</strong></span> was called
                   4851:          from the current directory.  This target should not be
                   4852:          used if the current package (or any of its depending
                   4853:          packages) have already been de-installed (e.g., after
                   4854:          calling <span class="command"><strong>make update</strong></span>) or you may lose
                   4855:          some packages you intended to update. As a rule of
                   4856:          thumb: only use this target <span class="emphasis"><em>before</em></span>
                   4857:          the first time you run <span class="command"><strong>make update</strong></span>
                   4858:          and only if you have a dirty package tree (e.g., if you
                   4859:          used <code class="varname">NOCLEAN</code>).</p>
                   4860: <p>If you are unsure about whether your tree is
                   4861:          clean, you can either perform a <span class="command"><strong>make
                   4862:          clean</strong></span> at the top of the tree, or use the
                   4863:          following sequence of commands from the directory of the
                   4864:          package you want to update (<span class="emphasis"><em>before</em></span>
                   4865:          running <span class="command"><strong>make update</strong></span> for the first
                   4866:          time, otherwise you lose all the packages you wanted to
                   4867:          update!):</p>
                   4868: <pre class="screen">
                   4869: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
                   4870: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
                   4871: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
                   4872:          </pre>
                   4873: <p>The following variables can be used either on the
                   4874:          command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
                   4875:          <span class="command"><strong>make clean-update</strong></span>:</p>
                   4876: <div class="variablelist"><dl class="variablelist">
                   4877: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
                   4878: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
                   4879:                reconstruct the list of directories to update for
                   4880:                this package.  Only use this if <span class="command"><strong>make
                   4881:                update</strong></span> successfully installed all
                   4882:                packages you wanted to update.  Normally, this is
                   4883:                done automatically on <span class="command"><strong>make
                   4884:                update</strong></span>, but may have been suppressed by
                   4885:                the <code class="varname">NOCLEAN</code> variable (see
                   4886:                above).</p></dd>
                   4887: </dl></div>
                   4888: </dd>
                   4889: <dt><span class="term">replace</span></dt>
                   4890: <dd>
                   4891: <p>Update the installation of the current package.  This
                   4892:          differs from update in that it does not replace dependent
                   4893:          packages.  You will need to install <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_tarup/README.html" target="_top"><code class="filename">pkgtools/pkg_tarup</code></a> for this
                   4894:          target to work.</p>
                   4895: <p><span class="emphasis"><em>Be careful when using this
                   4896:          target!</em></span> There are no guarantees that dependent
                   4897:          packages will still work, in particular they will most
                   4898:          certainly break if you <span class="command"><strong>make replace</strong></span> a
                   4899:          library package whose shared library major version changed
                   4900:          between your installed version and the new one.  For this
                   4901:          reason, this target is not officially supported and only
                   4902:          recommended for advanced users.</p>
                   4903: </dd>
                   4904: <dt><span class="term">info</span></dt>
1.311     leot     4905: <dd><p>This target invokes <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/pkg_info.1"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a> for the current
1.299     rillig   4906:          package. You can use this to check which version of a
                   4907:          package is installed.</p></dd>
                   4908: <dt><span class="term">index</span></dt>
                   4909: <dd>
                   4910: <p>This is a top-level command, i.e. it should be used in
                   4911:          the <code class="filename">pkgsrc</code> directory.  It creates a
                   4912:          database of all packages in the local pkgsrc tree, including
                   4913:          dependencies, comment, maintainer, and some other useful
                   4914:          information.  Individual entries are created by running
                   4915:          <span class="command"><strong>make describe</strong></span> in the packages'
                   4916:          directories.  This index file is saved as
                   4917:          <code class="filename">pkgsrc/INDEX</code>.  It can be displayed in
                   4918:          verbose format by running <span class="command"><strong>make
                   4919:          print-index</strong></span>.  You can search in it with
                   4920:          <span class="command"><strong>make search
                   4921:          key=<em class="replaceable"><code>something</code></em></strong></span>.  You can
                   4922:          extract a list of all packages that depend on a particular
                   4923:          one by running <span class="command"><strong>make show-deps
                   4924:          PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
                   4925: <p>Running this command takes a very long time, some
                   4926:          hours even on fast machines!</p>
                   4927: </dd>
                   4928: <dt><span class="term">readme</span></dt>
                   4929: <dd>
                   4930: <p>This target generates a
1.314     nia      4931:          <code class="filename">index.html</code> file, which can be
1.299     rillig   4932:          viewed using a browser such as <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a> or <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/links/README.html" target="_top"><code class="filename">www/links</code></a>.  The generated files
                   4933:          contain references to any packages which are in the
                   4934:          <code class="varname">PACKAGES</code> directory on the local
                   4935:          host. The generated files can be made to refer to URLs
                   4936:          based on <code class="varname">FTP_PKG_URL_HOST</code> and
                   4937:          <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
1.314     nia      4938:          wanted to generate <code class="filename">index.html</code>
1.299     rillig   4939:          files which pointed to binary packages on the local
                   4940:          machine, in the directory
                   4941:          <code class="filename">/usr/packages</code>, set
                   4942:          <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
                   4943:          <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
                   4944:          <code class="varname">${PACKAGES}</code> directory and its
                   4945:          subdirectories will be searched for all the binary
                   4946:          packages.</p>
                   4947: <p>The target can be run at the toplevel or in category
                   4948:          directories, in which case it descends recursively.</p>
                   4949: </dd>
                   4950: <dt><span class="term">readme-all</span></dt>
                   4951: <dd><p>This is a top-level command, run it in
                   4952:          <code class="filename">pkgsrc</code>.  Use this target to create a
                   4953:          file <code class="filename">README-all.html</code> which contains a
                   4954:          list of all packages currently available in the NetBSD
                   4955:          Packages Collection, together with the category they belong
                   4956:          to and a short description. This file is compiled from the
1.314     nia      4957:          <code class="filename">pkgsrc/*/index.html</code> files, so be sure
1.299     rillig   4958:          to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
                   4959:          readme</strong></span>.</p></dd>
                   4960: <dt><span class="term">cdrom-readme</span></dt>
                   4961: <dd><p>This is very much the same as the
                   4962:          <span class="quote">&#8220;<span class="quote">readme</span>&#8221;</span> target (see above), but is to be
                   4963:          used when generating a pkgsrc tree to be written to a
                   4964:          CD-ROM.  This target also produces
1.314     nia      4965:          <code class="filename">index.html</code> files, and can be made
1.299     rillig   4966:          to refer to URLs based on
                   4967:          <code class="varname">CDROM_PKG_URL_HOST</code> and
                   4968:          <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
                   4969: <dt><span class="term">show-distfiles</span></dt>
                   4970: <dd><p>This target shows which distfiles and patchfiles
                   4971:          are needed to build the package
                   4972:          (<code class="varname">ALLFILES</code>, which contains all
                   4973:          <code class="varname">DISTFILES</code> and
                   4974:          <code class="varname">PATCHFILES</code>, but not
                   4975:          <code class="filename">patches/*</code>).</p></dd>
                   4976: <dt><span class="term">show-downlevel</span></dt>
                   4977: <dd><p>This target shows nothing if the package is not
                   4978:          installed. If a version of this package is installed,
                   4979:          but is not the version provided in this version of
                   4980:          pkgsrc, then a warning message is displayed. This target
                   4981:          can be used to show which of your installed packages are
                   4982:          downlevel, and so the old versions can be deleted, and
                   4983:          the current ones added.</p></dd>
                   4984: <dt><span class="term">show-pkgsrc-dir</span></dt>
                   4985: <dd><p>This target shows the directory in the pkgsrc
                   4986:          hierarchy from which the package can be built and
                   4987:          installed. This may not be the same directory as the one
                   4988:          from which the package was installed. This target is
                   4989:          intended to be used by people who may wish to upgrade
                   4990:          many packages on a single host, and can be invoked from
                   4991:          the top-level pkgsrc Makefile by using the
                   4992:          <span class="quote">&#8220;<span class="quote">show-host-specific-pkgs</span>&#8221;</span> target.</p></dd>
                   4993: <dt><span class="term">show-installed-depends</span></dt>
                   4994: <dd><p>This target shows which installed packages match
                   4995:          the current package's <code class="varname">DEPENDS</code>. Useful
                   4996:          if out of date dependencies are causing build
                   4997:          problems.</p></dd>
                   4998: <dt><span class="term">print-build-depends-list</span></dt>
                   4999: <dd><p>This target shows the list of packages that the current package
                   5000:            depends on for building.</p></dd>
                   5001: <dt><span class="term">print-run-depends-list</span></dt>
                   5002: <dd><p>This target shows the list of packages that the current package
                   5003:            depends on for running.</p></dd>
                   5004: <dt><span class="term">check-shlibs</span></dt>
                   5005: <dd><p>After a package is installed, check all its
                   5006:          binaries and (on ELF platforms) shared libraries to see
                   5007:          if they find the shared libs they need.  Run by default
                   5008:          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>
                   5009: <dt><span class="term">print-PLIST</span></dt>
                   5010: <dd>
                   5011: <p>After a <span class="quote">&#8220;<span class="quote">make install</span>&#8221;</span> from a new or
                   5012:          upgraded pkg, this prints out an attempt to generate a
                   5013:          new <code class="filename">PLIST</code> from a <span class="command"><strong>find
                   5014:          -newer work/.extract_done</strong></span>.  An attempt is made
                   5015:          to care for shared libs etc., but it is
                   5016:          <span class="emphasis"><em>strongly</em></span> recommended to review the
                   5017:          result before putting it into
                   5018:          <code class="filename">PLIST</code>. On upgrades, it's useful to
                   5019:          diff the output of this command against an already
                   5020:          existing <code class="filename">PLIST</code> file.</p>
1.311     leot     5021: <p>If the package installs files via <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/tar.1"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a> or
1.299     rillig   5022:          other methods that don't update file access times, be
                   5023:          sure to add these files manually to your
                   5024:          <code class="filename">PLIST</code>, as the <span class="quote">&#8220;<span class="quote">find
                   5025:          -newer</span>&#8221;</span> command used by this target won't catch
                   5026:          them!</p>
                   5027: <p>See <a class="xref" href="#print-PLIST" title="19.3. Tweaking output of make print-PLIST">Section 19.3, &#8220;Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>&#8221;</a> for more
                   5028:          information on this target.</p>
                   5029: </dd>
                   5030: </dl></div>
                   5031: </div>
                   5032: </div>
                   5033: <div class="chapter">
                   5034: <div class="titlepage"><div><div><h2 class="title">
                   5035: <a name="creating"></a>Chapter 14. Creating a new pkgsrc package from scratch</h2></div></div></div>
                   5036: <div class="toc">
                   5037: <p><b>Table of Contents</b></p>
                   5038: <dl class="toc">
                   5039: <dt><span class="sect1"><a href="#creating.common">14.1. Common types of packages</a></span></dt>
                   5040: <dd><dl>
                   5041: <dt><span class="sect2"><a href="#creating.perl-module">14.1.1. Perl modules</a></span></dt>
                   5042: <dt><span class="sect2"><a href="#creating.python-module">14.1.2. Python modules and programs</a></span></dt>
                   5043: <dt><span class="sect2"><a href="#creating.R-package">14.1.3. R packages</a></span></dt>
                   5044: <dt><span class="sect2"><a href="#creating.TeX-package">14.1.4. TeXlive packages</a></span></dt>
                   5045: </dl></dd>
                   5046: <dt><span class="sect1"><a href="#creating.examples">14.2. Examples</a></span></dt>
                   5047: <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>
                   5048: </dl>
                   5049: </div>
                   5050: <p>When you find a package that is not yet in pkgsrc, you
                   5051: most likely have a URL from where you can download the source
                   5052: code. Starting with this URL, creating a package involves only a
                   5053: few steps.</p>
                   5054: <div class="procedure"><ol class="procedure" type="1">
                   5055: <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
                   5056: enable the basic quality checks.</p></li>
                   5057: <li class="step">
                   5058: <p>Install the package <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/pkg_developer/README.html" target="_top"><code class="filename">meta-pkgs/pkg_developer</code></a>, which among others will
                   5059: install the utilities <span class="command"><strong>url2pkg</strong></span>,
                   5060: <span class="command"><strong>pkglint</strong></span>, <span class="command"><strong>pkgvi</strong></span> and
                   5061: <span class="command"><strong>mkpatches</strong></span>:</p>
                   5062: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   5063: <code class="prompt">$</code> <strong class="userinput"><code>(cd meta-pkgs/pkg_developer &amp;&amp; bmake update)</code></strong></pre>
                   5064: </li>
                   5065: <li class="step">
                   5066: <p>Choose one of the top-level directories as the category in
                   5067: which you want to place your package. You can also create a directory of
                   5068: your own (maybe called <code class="filename">local</code>). In that category
                   5069: directory, create another directory for your package and change into
                   5070: it:</p>
                   5071: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>mkdir <em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em></code></strong>
                   5072: <code class="prompt">$</code> <strong class="userinput"><code>cd <em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em></code></strong></pre>
                   5073: </li>
                   5074: <li class="step">
                   5075: <p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
                   5076: you for a URL. Enter the URL of the distribution file (in most cases a
                   5077: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
                   5078: of your package are created automatically. The distribution file is
                   5079: extracted automatically to fill in some details in the
                   5080: <code class="filename">Makefile</code> that would otherwise have to be done
                   5081: manually:</p>
                   5082: <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>
                   5083: </li>
                   5084: <li class="step">
                   5085: <p>Examine the extracted files to determine the dependencies of
                   5086: your package. Ideally, this is mentioned in some
                   5087: <code class="filename">README</code> file, but things may differ. For each of
                   5088: these dependencies, look where it exists in pkgsrc, and if there is a
                   5089: file called <code class="filename">buildlink3.mk</code> in that directory, add a
                   5090: line to your package <code class="filename">Makefile</code> which includes that
                   5091: file just before the last line. If the
                   5092: <code class="filename">buildlink3.mk</code> file does not exist, it must be
                   5093: created first. The <code class="filename">buildlink3.mk</code> file makes sure
                   5094: that the package's include files and libraries are provided.</p>
                   5095: <p>If you just need binaries from a package, add a
                   5096: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
                   5097: version of the dependency and where it can be found in pkgsrc. This line
                   5098: should be placed in the third paragraph. If the dependency is only
                   5099: needed for building the package, but not when using it, use
                   5100: <code class="varname">TOOL_DEPENDS</code> or <code class="varname">BUILD_DEPENDS</code>
                   5101: instead of <code class="varname">DEPENDS</code>.
                   5102: The difference between <code class="varname">TOOL_DEPENDS</code> and
                   5103: <code class="varname">BUILD_DEPENDS</code> occurs when cross-compiling:
                   5104: <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
                   5105: packages, i.e. packages for the architecture where the package
                   5106: is built;
                   5107: <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
                   5108: packages, i.e. packages for the architecture for which the package
                   5109: is built. There is also <code class="varname">TEST_DEPENDS</code>, which is used
                   5110: to specify a dependency used only for testing the resulting package
                   5111: built, using the upstream project's included test suite.
                   5112: Your package may then look like this:</p>
                   5113: <pre class="programlisting">
                   5114: [...]
                   5115: 
                   5116: TOOL_DEPENDS+=  libxslt-[0-9]*:../../textproc/libxslt
                   5117: DEPENDS+=       screen-[0-9]*:../../misc/screen
                   5118: DEPENDS+=       screen&gt;=4.0:../../misc/screen
                   5119: 
                   5120: [...]
                   5121: 
                   5122: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
                   5123: .include "../../devel/glib2/buildlink3.mk"
                   5124: .include "../../mk/bsd.pkg.mk"
                   5125: </pre>
                   5126: </li>
                   5127: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
                   5128: to be done to make your package a <span class="quote">&#8220;<span class="quote">good</span>&#8221;</span> one. If you don't
                   5129: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
                   5130: --explain</strong></span> or <span class="command"><strong>pkglint -e</strong></span>, which outputs
                   5131: additional explanations.</p></li>
                   5132: <li class="step"><p>In many cases the package is not yet ready to build. You can
                   5133: find instructions for the most common cases in the next section, <a class="xref" href="#creating.common" title="14.1. Common types of packages">Section 14.1, &#8220;Common types of packages&#8221;</a>. After you have followed the instructions
                   5134: over there, you can hopefully continue here.</p></li>
                   5135: <li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
                   5136: directory from the extracted files. Besides these files, a lot of cache
                   5137: files and other system information has been saved in the working
                   5138: directory, which may become wrong after you edited the
                   5139: <code class="filename">Makefile</code>.</p></li>
                   5140: <li class="step">
                   5141: <p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
                   5142: 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>
                   5143: <p>If the extracted files from the package need to be fixed, run multiple rounds of these commands:</p>
                   5144: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>make</code></strong>
                   5145: <code class="prompt">$</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
                   5146: <code class="prompt">$</code> <strong class="userinput"><code>mkpatches</code></strong>
                   5147: <code class="prompt">$</code> <strong class="userinput"><code>make mps</code></strong>
                   5148: <code class="prompt">$</code> <strong class="userinput"><code>make clean</code></strong></pre>
                   5149: </li>
                   5150: <li class="step"><p>When the package builds fine, the next step is to install
                   5151: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
                   5152: everything works.</p></li>
                   5153: <li class="step"><p>Up to now, the file <code class="filename">PLIST</code>, which
                   5154: contains a list of the files that are installed by the package, is
                   5155: nearly empty. Run <span class="command"><strong>bmake print-PLIST
                   5156: &gt;PLIST</strong></span> to generate a probably correct list. Check
                   5157: the file using your preferred text editor to see if the list of
                   5158: files looks plausible.</p></li>
                   5159: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
                   5160: <code class="filename">PLIST</code> contains garbage or not.</p></li>
                   5161: <li class="step"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
                   5162: had been registered in the database of installed files, but with an
                   5163: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
                   5164: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
                   5165: registered with the list of files from
                   5166: <code class="filename">PLIST</code>.</p></li>
                   5167: <li class="step"><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
                   5168: package from the set of installed files.</p></li>
                   5169: <li class="step"><p>Run <span class="command"><strong>bmake clean update</strong></span> to run everything
                   5170: from above again in a single step, making sure that the PLIST is correct
                   5171: and the whole package is created as intended.</p></li>
                   5172: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see if there's anything left to do.</p></li>
                   5173: <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>
                   5174: </ol></div>
                   5175: <div class="sect1">
                   5176: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   5177: <a name="creating.common"></a>14.1. Common types of packages</h2></div></div></div>
                   5178: <div class="sect2">
                   5179: <div class="titlepage"><div><div><h3 class="title">
                   5180: <a name="creating.perl-module"></a>14.1.1. Perl modules</h3></div></div></div>
                   5181: <p>Simple Perl modules are handled automatically by
                   5182: <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
                   5183: </div>
                   5184: <div class="sect2">
                   5185: <div class="titlepage"><div><div><h3 class="title">
                   5186: <a name="creating.python-module"></a>14.1.2. Python modules and programs</h3></div></div></div>
                   5187: <p>Python modules and programs packages are easily created using a
                   5188: set of predefined variables.</p>
                   5189: <p>
                   5190: If some Python versions are not supported by the software, set the
                   5191: <code class="varname">PYTHON_VERSIONS_INCOMPATIBLE</code> variable to the Python versions
                   5192: that are not supported, e.g.
                   5193: </p>
                   5194: <pre class="programlisting">
                   5195: PYTHON_VERSIONS_INCOMPATIBLE=       27
                   5196: </pre>
                   5197: <p>
                   5198: If the packaged software is a Python module, include one of
                   5199: <code class="filename">../../lang/python/egg.mk</code>,
                   5200: <code class="filename">../../lang/python/distutils.mk</code>, or
                   5201: <code class="filename">../../lang/python/extension.mk</code>.</p>
                   5202: <p>Most Python packages use either <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span> or
                   5203: easy-setup/setuptools (<span class="quote">&#8220;<span class="quote">eggs</span>&#8221;</span>).
                   5204: If the packaged software is using setuptools, you only need
                   5205: to include <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>&#8221;</span>.
                   5206: Otherwise, if the software uses <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span>, include 
                   5207: <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/distutils.mk</code></span>&#8221;</span>,
                   5208: so pkgsrc will use this framework.
                   5209: <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span> uses a script called <code class="filename">setup.py</code>;
                   5210: if the <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span> driver is not called
                   5211: <code class="filename">setup.py</code>, set the <code class="varname">PYSETUP</code> variable
                   5212: to the name of the script.</p>
                   5213: <p>Either way, the package directory should be called
                   5214: <span class="quote">&#8220;<span class="quote">py-software</span>&#8221;</span> and <code class="varname">PKGNAME</code> should be set to
                   5215: <span class="quote">&#8220;<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>&#8221;</span>, e.g.
                   5216: </p>
                   5217: <pre class="programlisting">
                   5218: DISTNAME=   foopymodule-1.2.10
                   5219: PKGNAME=    ${PYPKGPREFIX}-${DISTNAME}
                   5220: </pre>
                   5221: <p>If it is an application, include
                   5222: <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>&#8221;</span>.
                   5223: In order to correctly set the path to the Python interpreter, use the
                   5224: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
                   5225: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
                   5226: For example:
                   5227: </p>
                   5228: <pre class="programlisting">
                   5229: REPLACE_PYTHON=   *.py
                   5230: </pre>
                   5231: <p>Some Python modules have separate distributions for Python-2.x
                   5232: and Python-3.x support. In pkgsrc this is handled by the
                   5233: <code class="filename">versioned_dependencies.mk</code> file. Set
                   5234: <code class="varname">PYTHON_VERSIONED_DEPENDENCIES</code> to the list of
                   5235: packages that should be depended upon and include
                   5236: <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/versioned_dependencies.mk</code></span>&#8221;</span>,
                   5237: then the pkgsrc infrastructure will depend on the appropriate package
                   5238: version. For example:
                   5239: </p>
                   5240: <pre class="programlisting">
                   5241: PYTHON_VERSIONED_DEPENDENCIES=dialog
                   5242: </pre>
                   5243: <p>
                   5244: Look inside <code class="filename">versioned_dependencies.mk</code> for a list
                   5245: of supported packages.</p>
                   5246: </div>
                   5247: <div class="sect2">
                   5248: <div class="titlepage"><div><div><h3 class="title">
                   5249: <a name="creating.R-package"></a>14.1.3. R packages</h3></div></div></div>
                   5250: <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>
                   5251: are handled automatically by <span class="command"><strong>R2pkg</strong></span>, which is
                   5252: available in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/R2pkg/README.html" target="_top"><code class="filename">pkgtools/R2pkg</code></a>.
                   5253: Individual packages (and optionally their dependencies) may be created
                   5254: and updated.  R packages generally follow the same form, and most of
                   5255: the relevant information needed is contained in a
                   5256: <code class="filename">DESCRIPTION</code> file as part of each R package on
                   5257: <a class="ulink" href="https://cran.r-project.org/web/packages/available_packages_by_name.html" target="_top">CRAN</a>.
                   5258: Consequently, <span class="command"><strong>R2pkg</strong></span> downloads that information and
                   5259: creates or updates a package in the canonical form.  The resulting
                   5260: package should be reviewed for correctness.</p>
                   5261: </div>
                   5262: <div class="sect2">
                   5263: <div class="titlepage"><div><div><h3 class="title">
                   5264: <a name="creating.TeX-package"></a>14.1.4. TeXlive packages</h3></div></div></div>
                   5265: <p>TeXlive packages from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> are handled automatically by
                   5266: <span class="command"><strong>texlive2pkg</strong></span>, which is available in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/texlive2pkg/README.html" target="_top"><code class="filename">pkgtools/texlive2pkg</code></a>.</p>
                   5267: <p>If the TeXlive package name is not known, it may be useful to
                   5268: search <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>.  A
                   5269: <span class="quote">&#8220;<span class="quote">Contained in</span>&#8221;</span> field on the package page typically
                   5270: 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
                   5271: archive</a>.</p>
                   5272: <p>If the TeXlive package name is known, download the files from
                   5273: the <a class="ulink" href="https://www.ctan.org/tex-archive/systems/texlive/tlnet/archive" target="_top">TeXlive
                   5274: archive</a>.  For package <code class="filename">foo</code>, you will need
                   5275: to download <code class="filename">foo.tar.xz</code>.  Most TeXlive packages
                   5276: also have associated documentation packages, so download
                   5277: <code class="filename">foo.doc.tar.xz</code> at the same time.  These files
                   5278: should be placed in the appropriate category directory, which is often
                   5279: but not always <code class="filename">print</code>.  Then run the following
                   5280: command in the category directory.</p>
                   5281: <pre class="programlisting">
                   5282: texlive2pkg foo.tar.xz foo.doc.tar.xz
                   5283: </pre>
                   5284: <p>This will create two packages, <code class="filename">tex-foo</code> and
                   5285: <code class="filename">tex-foo-doc</code>.  Be sure to check that both packages
                   5286: are correct.</p>
                   5287: <p>Finally, <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>
                   5288: currently does not include version information in package filenames
                   5289: and changes their contents periodically when updates occur.
                   5290: Consequently, pkgsrc avoids downloading distfiles directly from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> and instead relies on the
                   5291: pkgsrc archives.  For each new or updated TeXlive package, e.g., the
                   5292: main one and the corresponding documentation, upload the distfiles
                   5293: with the following command in each package directory.</p>
                   5294: <pre class="programlisting">
                   5295: make upload-distfiles
                   5296: </pre>
                   5297: </div>
                   5298: </div>
                   5299: <div class="sect1">
                   5300: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   5301: <a name="creating.examples"></a>14.2. Examples</h2></div></div></div>
                   5302: <div class="sect2">
                   5303: <div class="titlepage"><div><div><h3 class="title">
                   5304: <a name="creating.nvu"></a>14.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
                   5305: <div class="sect3">
                   5306: <div class="titlepage"><div><div><h4 class="title">
                   5307: <a name="creating.nvu.init"></a>14.2.1.1. The initial package</h4></div></div></div>
                   5308: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
                   5309: that the <span class="quote">&#8220;<span class="quote">nvu</span>&#8221;</span> package has not yet been imported into
                   5310: pkgsrc. As the description says it has to do with the web, the obvious
                   5311: choice for the category is <span class="quote">&#8220;<span class="quote">www</span>&#8221;</span>.</p>
                   5312: <pre class="programlisting">
                   5313: <code class="prompt">$</code> mkdir www/nvu
                   5314: <code class="prompt">$</code> cd www/nvu
                   5315: </pre>
                   5316: <p>The web site says that the sources are available as a tar file, so
                   5317: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
                   5318: <pre class="programlisting">
                   5319: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
                   5320: </pre>
                   5321: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
                   5322: below the <code class="varname">DISTNAME</code> line, as the package name should
                   5323: not have the word <span class="quote">&#8220;<span class="quote">sources</span>&#8221;</span> in it. I also filled in the
                   5324: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
                   5325: <code class="varname">COMMENT</code> fields. Then the package
                   5326: <code class="filename">Makefile</code> looked like that:</p>
                   5327: <pre class="programlisting">
                   5328: # $NetBSD $
                   5329: #
                   5330: 
                   5331: DISTNAME=       nvu-1.0-sources
                   5332: PKGNAME=        nvu-1.0
                   5333: CATEGORIES=     www
                   5334: MASTER_SITES=   http://cvs.nvu.com/download/
                   5335: EXTRACT_SUFX=   .tar.bz2
                   5336: 
                   5337: MAINTAINER=     rillig@NetBSD.org
                   5338: HOMEPAGE=       http://cvs.nvu.com/
                   5339: COMMENT=        Web Authoring System
                   5340: 
                   5341: # url2pkg-marker (please do not remove this line.)
                   5342: .include "../../mk/bsd.pkg.mk"
                   5343: </pre>
                   5344: <p>On the first line of output above, an artificial space has been added between NetBSD and $,
                   5345: this is a workaround to prevent CVS expanding to the filename of the
                   5346: guide.</p>
                   5347: <p>Then, I quit the editor and watched pkgsrc downloading a large
                   5348: source archive:</p>
                   5349: <pre class="programlisting">
                   5350: url2pkg&gt; Running "make makesum" ...
                   5351: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   5352: =&gt; Fetching nvu-1.0-sources.tar.bz2
                   5353: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
                   5354: 100% |*************************************| 28992 KB  150.77 KB/s00:00 ETA
                   5355: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
                   5356: url2pkg&gt; Running "make extract" ...
                   5357: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   5358: =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   5359: =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   5360: work.bacc -&gt; /tmp/roland/pkgsrc/www/nvu/work.bacc
                   5361: ===&gt; Installing dependencies for nvu-1.0
                   5362: ===&gt; Overriding tools for nvu-1.0
                   5363: ===&gt; Extracting for nvu-1.0
                   5364: url2pkg&gt; Adjusting the Makefile.
                   5365: 
                   5366: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
                   5367: 
                   5368: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
                   5369: </pre>
                   5370: </div>
                   5371: <div class="sect3">
                   5372: <div class="titlepage"><div><div><h4 class="title">
                   5373: <a name="creating.nvu.problems"></a>14.2.1.2. Fixing all kinds of problems to make the package work</h4></div></div></div>
                   5374: <p>Now that the package has been extracted, let's see what's inside
                   5375: it. The package has a <code class="filename">README.txt</code>, but that only
                   5376: says something about mozilla, so it's probably useless for seeing what
                   5377: dependencies this package has. But since there is a GNU configure script
                   5378: in the package, let's hope that it will complain about everything it
                   5379: needs.</p>
                   5380: <pre class="programlisting">
                   5381: <code class="prompt">$</code> bmake
                   5382: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   5383: =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   5384: =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   5385: ===&gt; Patching for nvu-1.0
                   5386: ===&gt; Creating toolchain wrappers for nvu-1.0
                   5387: ===&gt; Configuring for nvu-1.0
                   5388: [...]
                   5389: configure: error: Perl 5.004 or higher is required.
                   5390: [...]
                   5391: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
                   5392: [...]
                   5393: </pre>
                   5394: <p>That worked quite well. So I opened the package Makefile in my
                   5395: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
                   5396: just appended <span class="quote">&#8220;<span class="quote">perl</span>&#8221;</span> to it. Since the dependencies of the
                   5397: package have changed now, and since a perl wrapper is automatically
                   5398: installed in the <span class="quote">&#8220;<span class="quote">tools</span>&#8221;</span> phase, I need to build the package
                   5399: from scratch.</p>
                   5400: <pre class="programlisting">
                   5401: <code class="prompt">$</code> bmake clean
                   5402: ===&gt; Cleaning for nvu-1.0
                   5403: <code class="prompt">$</code> bmake
                   5404: [...]
                   5405: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
                   5406: GNU Make.  You will not be able to build Mozilla without GNU Make.
                   5407: [...]
                   5408: </pre>
                   5409: <p>So I added <span class="quote">&#8220;<span class="quote">gmake</span>&#8221;</span> to the
                   5410: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
                   5411: <pre class="programlisting">
                   5412: [...]
                   5413: checking for GTK - version &gt;= 1.2.0... no
                   5414: *** Could not run GTK test program, checking why...
                   5415: [...]
                   5416: </pre>
                   5417: <p>Now to the other dependencies. The first question is: Where is the
                   5418: GTK package hidden in pkgsrc?</p>
                   5419: <pre class="programlisting">
                   5420: <code class="prompt">$</code> echo ../../*/gtk*
                   5421: [many packages ...]
                   5422: <code class="prompt">$</code> echo ../../*/gtk
                   5423: ../../x11/gtk
                   5424: <code class="prompt">$</code> echo ../../*/gtk2
                   5425: ../../x11/gtk2
                   5426: <code class="prompt">$</code> echo ../../*/gtk2/bui*
                   5427: ../../x11/gtk2/buildlink3.mk
                   5428: </pre>
                   5429: <p>The first try was definitely too broad. The second one had exactly
                   5430: one result, which is very good. But there is one pitfall with GNOME
                   5431: packages. Before GNOME 2 had been released, there were already many
                   5432: GNOME 1 packages in pkgsrc. To be able to continue to use these
                   5433: packages, the GNOME 2 packages were imported as separate packages, and
                   5434: their names usually have a <span class="quote">&#8220;<span class="quote">2</span>&#8221;</span> appended. So I checked
                   5435: whether this was the case here, and indeed it was.</p>
                   5436: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
                   5437: file, adding the dependency is very easy. I just inserted an
                   5438: <code class="literal">.include</code> line before the last line of the package
                   5439: <code class="filename">Makefile</code>, so that it now looks like this:</p>
                   5440: <pre class="programlisting">
                   5441: [...]
                   5442: .include "../../x11/gtk2/buildlink3.mk"
                   5443: .include "../../mk/bsd.pkg.mk
                   5444: </pre>
                   5445: <p>After another <span class="command"><strong>bmake clean &amp;&amp; bmake</strong></span>, the answer
                   5446: was:</p>
1.75      rillig   5447: <pre class="programlisting">
1.299     rillig   5448: [...]
                   5449: checking for gtk-config... /home/roland/pkg/bin/gtk-config
                   5450: checking for GTK - version &gt;= 1.2.0... no
                   5451: *** Could not run GTK test program, checking why...
                   5452: *** The test program failed to compile or link. See the file config.log for the
                   5453: *** exact error that occured. This usually means GTK was incorrectly installed
                   5454: *** or that you have moved GTK since it was installed. In the latter case, you
                   5455: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
                   5456: configure: error: Test for GTK failed.
                   5457: [...]
1.222     sevan    5458: </pre>
1.299     rillig   5459: <p>In this particular case, the assumption that <span class="quote">&#8220;<span class="quote">every package
                   5460: prefers GNOME 2</span>&#8221;</span> had been wrong. The first of the lines above
                   5461: told me that this package really wanted to have the GNOME 1 version of
                   5462: GTK. If the package had looked for GTK2, it would have looked for
                   5463: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
                   5464: So I changed the <code class="literal">x11/gtk2</code> to
                   5465: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
                   5466: and tried again.</p>
1.119     mishka   5467: <pre class="programlisting">
1.299     rillig   5468: [...]
                   5469: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\"  [...]
                   5470: In file included from xpidl.c:42:
                   5471: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
                   5472: In file included from xpidl.c:42:
                   5473: xpidl.h:132: error: parse error before "IDL_ns"
                   5474: [...]
1.222     sevan    5475: </pre>
1.299     rillig   5476: <p>The package still does not find all of its dependencies. Now the
                   5477: question is: Which package provides the
                   5478: <code class="filename">libIDL/IDL.h</code> header file?</p>
1.119     mishka   5479: <pre class="programlisting">
1.299     rillig   5480: <code class="prompt">$</code> echo ../../*/*idl*
                   5481: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
                   5482: <code class="prompt">$</code> echo ../../*/*IDL*
                   5483: ../../net/libIDL
1.222     sevan    5484: </pre>
1.299     rillig   5485: <p>Let's take the one from the second try. So I included the
                   5486: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
                   5487: again. But the error didn't change. After digging through some of the
                   5488: code, I concluded that the build process of the package was broken and
                   5489: couldn't have ever worked, but since the Mozilla source tree is quite
                   5490: large, I didn't want to fix it. So I added the following to the package
                   5491: <code class="filename">Makefile</code> and tried again:</p>
1.197     wiz      5492: <pre class="programlisting">
1.299     rillig   5493: CPPFLAGS+=              -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
                   5494: BUILDLINK_TRANSFORM+=   l:IDL:IDL-2
1.222     sevan    5495: </pre>
1.299     rillig   5496: <p>The latter line is needed because the package expects the library
                   5497: <code class="filename">libIDL.so</code>, but only
                   5498: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
                   5499: wrapper to rewrite that on the fly.</p>
                   5500: <p>The next problem was related to a recent change of the FreeType
                   5501: interface. I looked up in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/seamonkey/README.html" target="_top"><code class="filename">www/seamonkey</code></a>
                   5502: which patch files were relevant for this issue and copied them to the
                   5503: <code class="filename">patches</code> directory. Then I retried, fixed the
                   5504: patches so that they applied cleanly and retried again. This time,
                   5505: everything worked.</p>
1.197     wiz      5506: </div>
1.299     rillig   5507: <div class="sect3">
                   5508: <div class="titlepage"><div><div><h4 class="title">
                   5509: <a name="creating.nvu.inst"></a>14.2.1.3. Installing the package</h4></div></div></div>
1.87      wiz      5510: <pre class="programlisting">
1.299     rillig   5511: <code class="prompt">$</code> bmake CHECK_FILES=no install
                   5512: [...]
                   5513: <code class="prompt">$</code> bmake print-PLIST &gt;PLIST
                   5514: <code class="prompt">$</code> bmake deinstall
                   5515: <code class="prompt">$</code> bmake install
1.222     sevan    5516: </pre>
1.299     rillig   5517: </div>
                   5518: </div>
1.75      rillig   5519: </div>
                   5520: </div>
1.148     asau     5521: <div class="chapter">
1.75      rillig   5522: <div class="titlepage"><div><div><h2 class="title">
1.299     rillig   5523: <a name="makefile"></a>Chapter 15. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.75      rillig   5524: <div class="toc">
                   5525: <p><b>Table of Contents</b></p>
1.210     leot     5526: <dl class="toc">
1.299     rillig   5527: <dt><span class="sect1"><a href="#makefile.style">15.1. Caveats</a></span></dt>
                   5528: <dt><span class="sect1"><a href="#makefile.variables">15.2. <code class="filename">Makefile</code> variables</a></span></dt>
                   5529: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">15.2.1. Naming conventions</a></span></dt></dl></dd>
                   5530: <dt><span class="sect1"><a href="#makefile.code">15.3. Code snippets</a></span></dt>
                   5531: <dd><dl>
                   5532: <dt><span class="sect2"><a href="#adding-to-list">15.3.1. Adding things to a list</a></span></dt>
                   5533: <dt><span class="sect2"><a href="#echo-literal">15.3.2. Echoing a string exactly as-is</a></span></dt>
                   5534: <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>
                   5535: <dt><span class="sect2"><a href="#empty-variables">15.3.4. Handling possibly empty variables</a></span></dt>
1.75      rillig   5536: </dl></dd>
                   5537: </dl>
                   5538: </div>
1.299     rillig   5539: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
                   5540:   each of which forms a well-defined part of the pkgsrc system. Using
1.311     leot     5541:   the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> system as a programming language for a big system
1.299     rillig   5542:   like pkgsrc requires some discipline to keep the code correct and
                   5543:   understandable.</p>
                   5544: <p>The basic ingredients for <code class="filename">Makefile</code>
                   5545:   programming are variables and shell
                   5546:   commands. Among these shell commands may even be more complex ones
1.311     leot     5547:   like <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/awk.1"><span class="citerefentry"><span class="refentrytitle">awk</span>(1)</span></a> programs. To make sure that every shell command runs
1.299     rillig   5548:   as intended it is necessary to quote all variables correctly when they
                   5549:   are used.</p>
                   5550: <p>This chapter describes some patterns that appear quite often in
                   5551:   <code class="filename">Makefile</code>s, including the pitfalls that come along
                   5552:   with them.</p>
1.148     asau     5553: <div class="sect1">
1.75      rillig   5554: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   5555: <a name="makefile.style"></a>15.1. Caveats</h2></div></div></div>
                   5556: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
                   5557: <p>When you are creating a file as a
                   5558:     target of a rule, always write the data to a temporary file first
                   5559:     and finally rename that file. Otherwise there might occur an error
                   5560:     in the middle of generating the file, and when the user runs
1.311     leot     5561:     <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> for the second time, the file exists and will not be
1.299     rillig   5562:     regenerated properly. Example:</p>
1.75      rillig   5563: <pre class="programlisting">
1.299     rillig   5564: wrong:
                   5565:         @echo "line 1" &gt; ${.TARGET}
                   5566:         @echo "line 2" &gt;&gt; ${.TARGET}
                   5567:         @false
                   5568: 
                   5569: correct:
                   5570:         @echo "line 1" &gt; ${.TARGET}.tmp
                   5571:         @echo "line 2" &gt;&gt; ${.TARGET}.tmp
                   5572:         @false
                   5573:         @mv ${.TARGET}.tmp ${.TARGET}
1.100     rillig   5574: </pre>
1.299     rillig   5575: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
                   5576:     <code class="filename">wrong</code> will exist, although there was an error
                   5577:     message in the first run. On the other hand, running <span class="command"><strong>make
                   5578:     correct</strong></span> gives an error message twice, as expected.</p>
1.311     leot     5579: <p>You might remember that <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> sometimes removes
1.299     rillig   5580:     <code class="literal">${.TARGET}</code> in case of error, but this only
                   5581:     happens when it is interrupted, for example by pressing
                   5582:     <code class="literal">Ctrl+C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.311     leot     5583:     when one of the commands fails (like <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/false.1"><span class="citerefentry"><span class="refentrytitle">false</span>(1)</span></a> above).</p>
1.299     rillig   5584: </li></ul></div>
                   5585: </div>
                   5586: <div class="sect1">
                   5587: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   5588: <a name="makefile.variables"></a>15.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
                   5589: <p><code class="filename">Makefile</code> variables contain strings that
                   5590:     can be processed using the five operators <code class="code">=</code>,
                   5591:     <code class="code">+=</code>, <code class="code">?=</code>, <code class="code">:=</code> and
1.311     leot     5592:     <code class="code">!=</code>, which are described in the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man
1.299     rillig   5593:     page.</p>
                   5594: <p>When a variable's value is parsed from a
                   5595:     <code class="filename">Makefile</code>, the hash character <code class="code">#</code> and
                   5596:     the backslash character <code class="code">\</code> are handled specially. If a
                   5597:     backslash is the last character in a line, that backslash is removed
                   5598:     from the line and the line continues with the next line of the file.</p>
                   5599: <p>The <code class="code">#</code> character starts a comment that reaches
                   5600:     until the end of the line. To get an actual <code class="code">#</code> character,
                   5601:     such as in a URL, write <code class="code">\#</code> instead.</p>
                   5602: <p>The evaluation of variables either happens immediately or lazy.
                   5603:     It happens immediately when the variable occurs on the right-hand
                   5604:     side of the <code class="code">:=</code> or the <code class="code">!=</code> operator, in a
                   5605:     <code class="varname">.if</code> condition or a <code class="varname">.for</code> loop.
                   5606:     In the other cases, it is evaluated lazily.</p>
                   5607: <p>Some of the modifiers split the string into words and then
                   5608:     operate on the words, others operate on the string as a whole. When a
                   5609:     string is split into words, double quotes and single quotes are
1.311     leot     5610:     interpreted as delimiters, just like in <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/sh.1"><span class="citerefentry"><span class="refentrytitle">sh</span>(1)</span></a>.</p>
1.299     rillig   5611: <div class="sect2">
                   5612: <div class="titlepage"><div><div><h3 class="title">
                   5613: <a name="makefile.variables.names"></a>15.2.1. Naming conventions</h3></div></div></div>
                   5614: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   5615: <li class="listitem"><p>All variable names starting with an underscore
                   5616:        are reserved for use by the pkgsrc infrastructure. They shall
                   5617:        not be used by packages.</p></li>
                   5618: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
                   5619:        lowercase variable names for the iteration
                   5620:        variables.</p></li>
                   5621: <li class="listitem"><p>All list variables should have a plural name,
                   5622:        such as <code class="varname">PKG_OPTIONS</code> or
                   5623:        <code class="varname">DISTFILES</code>.</p></li>
                   5624: </ul></div>
                   5625: </div>
                   5626: </div>
                   5627: <div class="sect1">
                   5628: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   5629: <a name="makefile.code"></a>15.3. Code snippets</h2></div></div></div>
                   5630: <div class="sect2">
                   5631: <div class="titlepage"><div><div><h3 class="title">
                   5632: <a name="adding-to-list"></a>15.3.1. Adding things to a list</h3></div></div></div>
                   5633: <p>When adding a string that possibly contains whitespace or quotes to
                   5634: a list (example 1), it must be quoted using the <code class="code">:Q</code>
                   5635: modifier.</p>
                   5636: <p>When adding another list to a list (example 2), it must not be
                   5637: quoted, since its elements are already quoted.</p>
1.75      rillig   5638: <pre class="programlisting">
1.299     rillig   5639: STRING=         foo * bar `date`
                   5640: LIST=           # empty
                   5641: ANOTHER_LIST=   a=b c=d
                   5642: 
                   5643: LIST+=          ${STRING:Q}       # 1
                   5644: LIST+=          ${ANOTHER_LIST}   # 2
1.100     rillig   5645: </pre>
1.299     rillig   5646: </div>
                   5647: <div class="sect2">
                   5648: <div class="titlepage"><div><div><h3 class="title">
                   5649: <a name="echo-literal"></a>15.3.2. Echoing a string exactly as-is</h3></div></div></div>
                   5650: <p>Echoing a string containing special characters needs special
                   5651: work.</p>
1.75      rillig   5652: <pre class="programlisting">
1.299     rillig   5653: STRING=         foo bar &lt;    &gt; * `date` $$HOME ' "
                   5654: EXAMPLE_ENV=    string=${STRING:Q} x=multiple\ quoted\ words
                   5655: 
                   5656: all:
                   5657:         echo ${STRING}                  # 1
                   5658:         echo ${STRING:Q}                # 2
                   5659:         printf '%s\n' ${STRING:Q}''     # 3
                   5660:         env ${EXAMPLE_ENV} sh -c 'echo "$$string"; echo "$$x"'   # 4
1.100     rillig   5661: </pre>
1.299     rillig   5662: <p>Example 1 leads to a syntax error in the shell, as the characters
                   5663: are just copied.</p>
                   5664: <p>Example 2 quotes the string so that the shell interprets it
                   5665: correctly. But the echo command may additionally interpret strings with a
                   5666: leading dash or those containing backslashes.</p>
1.311     leot     5667: <p>Example 3 can handle arbitrary strings, since <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/printf.1"><span class="citerefentry"><span class="refentrytitle">printf</span>(1)</span></a> only
1.299     rillig   5668: interprets the format string, but not the next argument. The trailing
                   5669: single quotes handle the case when the string is empty. In that case, the
                   5670: :Q modifier would result in an empty string too, which would then be
1.311     leot     5671: skipped by the shell. For <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/printf.1"><span class="citerefentry"><span class="refentrytitle">printf</span>(1)</span></a> this doesn't make a difference,
1.299     rillig   5672: but other programs may care.</p>
                   5673: <p>In example 4, the <code class="varname">EXAMPLE_ENV</code> does not
                   5674: need to be quoted because the quoting has already been done
                   5675: when adding elements to the list.</p>
1.75      rillig   5676: </div>
1.148     asau     5677: <div class="sect2">
1.75      rillig   5678: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   5679: <a name="cflags-gnu-configure"></a>15.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</h3></div></div></div>
                   5680: <p>When passing <code class="varname">CFLAGS</code> or similar variables to a
                   5681: GNU-style configure script (especially those that call other configure
                   5682: scripts), it must not have leading or trailing whitespace, since
                   5683: otherwise the configure script gets confused. To trim leading and
                   5684: trailing whitespace, use the <code class="code">:M</code> modifier, as in the
                   5685: following example:</p>
1.75      rillig   5686: <pre class="programlisting">
1.299     rillig   5687: CPPFLAGS=               # empty
                   5688: CPPFLAGS+=              -Wundef -DPREFIX=\"${PREFIX}\"
                   5689: CPPFLAGS+=              ${MY_CPPFLAGS}
1.1       grant    5690: 
1.299     rillig   5691: CONFIGURE_ARGS+=        CPPFLAGS=${CPPFLAGS:M*:Q}
1.1       grant    5692: 
1.299     rillig   5693: all:
                   5694:         echo x${CPPFLAGS:Q}x            # leading and trailing whitespace
                   5695:         echo x${CONFIGURE_ARGS:Q}x      # properly trimmed
                   5696: </pre>
                   5697: <p>In this example, <code class="varname">CPPFLAGS</code> has both leading and
                   5698: trailing whitespace because the <code class="code">+=</code> operator always adds a
                   5699: space.</p>
                   5700: </div>
                   5701: <div class="sect2">
                   5702: <div class="titlepage"><div><div><h3 class="title">
                   5703: <a name="empty-variables"></a>15.3.4. Handling possibly empty variables</h3></div></div></div>
                   5704: <p>When a possibly empty variable is used in a shell program, it may
                   5705: lead to a syntax error.</p>
                   5706: <pre class="programlisting">
                   5707: EGFILES=        # empty
1.87      wiz      5708: 
1.299     rillig   5709: install-examples:   # produces a syntax error in the shell
                   5710:         for egfile in ${EGFILES}; do            \
                   5711:                 echo "Installing $$egfile";     \
                   5712:         done
                   5713: </pre>
                   5714: <p>The shell only sees the text <code class="code">for egfile in ; do</code>, since
1.311     leot     5715: <code class="code">${EGFILES}</code> is replaced with an empty string by <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>.
1.299     rillig   5716: To fix this syntax error, use one of the snippets below.</p>
                   5717: <pre class="programlisting">
                   5718: EMPTY=          # empty
1.87      wiz      5719: 
1.299     rillig   5720: install-examples:
                   5721:         for egfile in ${EGFILES} ""; do         \
                   5722:                 [ -n "$$egfile" ] || continue;  \
                   5723:                 echo "Installing $$egfile";     \
                   5724:         done
                   5725: </pre>
                   5726: <p>In this case, an empty string is appended to the iteration list (to
                   5727: prevent the syntax error) and filtered out later.</p>
                   5728: <pre class="programlisting">
                   5729: EGFILES=        # empty
1.87      wiz      5730: 
1.299     rillig   5731: install-examples:
                   5732: .for egfile in ${EGFILES}
                   5733:         echo "Installing ${egfile}"
                   5734: .endfor
1.100     rillig   5735: </pre>
1.299     rillig   5736: <p>If one of the filenames contains special characters, it should be
                   5737: enclosed in single or double quotes.</p>
                   5738: <p>To have a shell command test whether a make variable is empty, use
                   5739: the following code: <code class="code">${TEST} -z ${POSSIBLY_EMPTY:Q}""</code>.</p>
                   5740: </div>
                   5741: </div>
                   5742: </div>
                   5743: <div class="chapter">
                   5744: <div class="titlepage"><div><div><h2 class="title">
                   5745: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
                   5746: <div class="toc">
                   5747: <p><b>Table of Contents</b></p>
                   5748: <dl class="toc">
                   5749: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
                   5750: <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>
                   5751: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
                   5752: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
                   5753: </dl>
1.75      rillig   5754: </div>
1.299     rillig   5755: <p>Many packages have the ability to be built to support different
                   5756: sets of features.  <code class="filename">bsd.options.mk</code> is a framework
                   5757: in pkgsrc that provides generic handling of those options that
                   5758: determine different ways in which the packages can be built.  It's
                   5759: possible for the user to specify exactly which sets of options will be
                   5760: built into a package or to allow a set of global default options
                   5761: apply.</p>
                   5762: <p>There are two broad classes of behaviors that one might want to
                   5763: control via options.  One is whether some particular feature is
                   5764: enabled in a program that will be built anyway, often by including or
                   5765: not including a dependency on some other package.  The other is
                   5766: whether or not an additional program will be built as part of the
                   5767: package.  Generally, it is better to make a split package for such
                   5768: additional programs instead of using options, because it enables
                   5769: binary packages to be built which can then be added separately.  For
                   5770: example, the foo package might have minimal dependencies (those
                   5771: packages without which foo doesn't make sense), and then the foo-gfoo
                   5772: package might include the GTK frontend program gfoo.  This is better
                   5773: than including a gtk option to foo that adds gfoo, because either that
                   5774: option is default, in which case binary users can't get foo without
                   5775: gfoo, or not default, in which case they can't get gfoo.  With split
                   5776: packages, they can install foo without having GTK, and later decide to
                   5777: install gfoo (pulling in GTK at that time).  This is an advantage to
                   5778: source users too, avoiding the need for rebuilds.</p>
                   5779: <p>Plugins with widely varying dependencies should usually be split
                   5780: instead of options.</p>
                   5781: <p>It is often more work to maintain split packages, especially if
                   5782: the upstream package does not support this.  The decision of split
                   5783: vs. option should be made based on the likelihood that users will want
                   5784: or object to the various pieces, the size of the dependencies that are
                   5785: included, and the amount of work.</p>
                   5786: <p>A further consideration is licensing.  Non-free parts, or parts
                   5787: that depend on non-free dependencies (especially plugins) should
                   5788: almost always be split if feasible.</p>
                   5789: <div class="sect1">
                   5790: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   5791: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
                   5792: <p>Global default options are listed in
                   5793: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
                   5794: that should be built into every package if that option is supported.
                   5795: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75      rillig   5796: </div>
1.148     asau     5797: <div class="sect1">
1.75      rillig   5798: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   5799: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
                   5800: </h2></div></div></div>
                   5801: <p>The following example shows how
                   5802: <code class="filename">bsd.options.mk</code> should be used
                   5803: by the hypothetical ``wibble'' package, either in the package
                   5804: <code class="filename">Makefile</code>, or in a file,
                   5805: e.g. <code class="filename">options.mk</code>, that is included by the
                   5806: main package <code class="filename">Makefile</code>.</p>
1.75      rillig   5807: <pre class="programlisting">
1.299     rillig   5808: PKG_OPTIONS_VAR=                PKG_OPTIONS.wibble
                   5809: PKG_SUPPORTED_OPTIONS=          wibble-foo ldap
                   5810: PKG_OPTIONS_OPTIONAL_GROUPS=    database
                   5811: PKG_OPTIONS_GROUP.database=     mysql pgsql
                   5812: PKG_SUGGESTED_OPTIONS=          wibble-foo
                   5813: PKG_OPTIONS_LEGACY_VARS+=       WIBBLE_USE_OPENLDAP:ldap
                   5814: PKG_OPTIONS_LEGACY_OPTS+=       foo:wibble-foo
                   5815: 
                   5816: .include "../../mk/bsd.prefs.mk"
                   5817: 
                   5818: # this package was previously named wibble2
                   5819: .if defined(PKG_OPTIONS.wibble2)
                   5820: PKG_LEGACY_OPTIONS+=            ${PKG_OPTIONS.wibble2}
                   5821: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
                   5822:         "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
                   5823: .endif
                   5824: 
                   5825: .include "../../mk/bsd.options.mk"
                   5826: 
                   5827: # Package-specific option-handling
1.100     rillig   5828: 
1.299     rillig   5829: ###
                   5830: ### FOO support
                   5831: ###
                   5832: .if !empty(PKG_OPTIONS:Mwibble-foo)
                   5833: CONFIGURE_ARGS+=    --enable-foo
                   5834: .endif
1.100     rillig   5835: 
1.299     rillig   5836: ###
                   5837: ### LDAP support
                   5838: ###
                   5839: .if !empty(PKG_OPTIONS:Mldap)
                   5840: .  include "../../databases/openldap-client/buildlink3.mk"
                   5841: CONFIGURE_ARGS+=    --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
                   5842: .endif
1.100     rillig   5843: 
1.299     rillig   5844: ###
                   5845: ### database support
                   5846: ###
                   5847: .if !empty(PKG_OPTIONS:Mmysql)
                   5848: .  include "../../mk/mysql.buildlink3.mk"
                   5849: .endif
                   5850: .if !empty(PKG_OPTIONS:Mpgsql)
                   5851: .  include "../../mk/pgsql.buildlink3.mk"
                   5852: .endif
                   5853: </pre>
                   5854: <p>The first section contains the information about which build
                   5855: options are supported by the package, and any default options settings
                   5856: if needed.</p>
                   5857: <div class="orderedlist"><ol class="orderedlist" type="1">
                   5858: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.311     leot     5859: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> variable that the user can set to override the default
1.299     rillig   5860: options.  It should be set to
                   5861: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
                   5862: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
                   5863: at the point where the options are processed.</p></li>
                   5864: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
                   5865: build options supported by the package.</p></li>
                   5866: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
                   5867: list of names of groups of mutually exclusive options.  The options in
                   5868: each group are listed in
                   5869: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
                   5870: The most specific setting of any option from the group takes
                   5871: precedence over all other options in the group.  Options from the
                   5872: groups will be automatically added to
                   5873: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
                   5874: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
                   5875: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
                   5876: packages will fail if no option from the group is
                   5877: selected.</p></li>
                   5878: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
                   5879: of names of sets of options.  At least one option from each set must
                   5880: be selected.  The options in each set are listed in
                   5881: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
                   5882: Options from the sets will be automatically added to
                   5883: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.  Building the package will
                   5884: fail if no option from the set is selected.</p></li>
                   5885: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
                   5886: build options which are enabled by default.</p></li>
                   5887: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
                   5888: of
                   5889: <span class="quote">&#8220;<span class="quote"><em class="replaceable"><code>USE_VARIABLE</code></em>:<em class="replaceable"><code>option</code></em></span>&#8221;</span>
                   5890: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
                   5891: their option counterparts.  Pairs should be added with
                   5892: <span class="quote">&#8220;<span class="quote">+=</span>&#8221;</span> to keep the listing of global legacy variables.  A
                   5893: warning will be issued if the user uses a legacy
                   5894: variable.</p></li>
                   5895: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
                   5896: of
                   5897: <span class="quote">&#8220;<span class="quote"><em class="replaceable"><code>old-option</code></em>:<em class="replaceable"><code>new-option</code></em></span>&#8221;</span>
                   5898: pairs that map options that have been renamed to their new
                   5899: counterparts.  Pairs should be added with <span class="quote">&#8220;<span class="quote">+=</span>&#8221;</span> to keep
                   5900: the listing of global legacy options.  A warning will be issued if
                   5901: the user uses a legacy option.</p></li>
                   5902: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
                   5903: options implied by deprecated variables used.  This can be used for
                   5904: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
                   5905: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
                   5906: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
                   5907: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
                   5908: a list of warnings about deprecated variables or options used, and
                   5909: what to use instead.</p></li>
                   5910: </ol></div>
                   5911: <p>A package should never modify
                   5912: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
                   5913: <code class="varname">PKG_OPTIONS_VAR</code>.  These are strictly user-settable.
                   5914: To suggest a default set of options, use
                   5915: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
                   5916: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
                   5917: including <code class="filename">bsd.options.mk</code>.  If none of
                   5918: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
                   5919: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
                   5920: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
                   5921: happen with platform-specific options if none of them is supported on
                   5922: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
                   5923: empty list and the package is otherwise treated as not using the
                   5924: options framework.</p>
                   5925: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
                   5926: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
                   5927: build options, properly filtered to remove unsupported and duplicate
                   5928: options.</p>
                   5929: <p>The remaining sections contain the logic that is specific to
                   5930: each option.  The correct way to check for an option is to check
                   5931: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
                   5932: <pre class="programlisting">
                   5933: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
1.100     rillig   5934: </pre>
1.75      rillig   5935: </div>
1.299     rillig   5936: <div class="sect1">
                   5937: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   5938: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
                   5939: <p>Options that enable similar features in different packages (like
                   5940: optional support for a library) should use a common name in all
                   5941: packages that support it (like the name of the library).  If another
                   5942: package already has an option with the same meaning, use the same
                   5943: name.</p>
                   5944: <p>Options that enable features specific to one package, where it's
                   5945: unlikely that another (unrelated) package has the same (or a similar)
                   5946: optional feature, should use a name prefixed with
                   5947: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
                   5948: <p>If a group of related packages share an optional feature
                   5949: specific to that group, prefix it with the name of the
                   5950: <span class="quote">&#8220;<span class="quote">main</span>&#8221;</span> package
                   5951: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
                   5952: <p>For new options, add a line to
                   5953: <code class="filename">mk/defaults/options.description</code>.  Lines have two
                   5954: fields, separated by tab.  The first field is the option name, the
                   5955: second its description.  The description should be a whole sentence
                   5956: (starting with an uppercase letter and ending with a period) that
                   5957: describes what enabling the option does.  E. g. <span class="quote">&#8220;<span class="quote">Enable ispell
                   5958: support.</span>&#8221;</span> The file is sorted by option names.</p>
                   5959: </div>
                   5960: <div class="sect1">
                   5961: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   5962: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
                   5963: <p>When writing <a class="link" href="#buildlink3.mk"><code class="filename">buildlink3.mk</code></a> files, it is often necessary to list
                   5964: different dependencies based on the options with which the package was
                   5965: built. For querying these options, the file
                   5966: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
                   5967: typical example looks like this:</p>
1.87      wiz      5968: <pre class="programlisting">
1.299     rillig   5969: pkgbase := libpurple
                   5970: .include "../../mk/pkg-build-options.mk"
                   5971: 
                   5972: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
                   5973: ...
                   5974: .endif
1.229     sevan    5975: </pre>
1.299     rillig   5976: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
                   5977: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
                   5978: options of the libpurple package, which can then be queried like
                   5979: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
                   5980: file. See the file <code class="filename">pkg-build-options.mk</code> for more
                   5981: details.</p>
1.75      rillig   5982: </div>
                   5983: </div>
1.148     asau     5984: <div class="chapter">
1.75      rillig   5985: <div class="titlepage"><div><div><h2 class="title">
1.299     rillig   5986: <a name="tools"></a>Chapter 17. Tools needed for building or running</h2></div></div></div>
1.75      rillig   5987: <div class="toc">
                   5988: <p><b>Table of Contents</b></p>
1.210     leot     5989: <dl class="toc">
1.299     rillig   5990: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
                   5991: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
                   5992: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
1.75      rillig   5993: </dl>
                   5994: </div>
1.299     rillig   5995: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
                   5996: by pkgsrc and also for individual packages to define what commands
                   5997: are needed for building a package (like <code class="varname">TOOL_DEPENDS</code>)
                   5998: or for later run-time of an installed packaged (such as
                   5999: <code class="varname">DEPENDS</code>).
                   6000: If the native system provides an adequate tool, then in many cases, a pkgsrc
                   6001: package will not be used.</p>
                   6002: <p>When building a package, the replacement tools are
                   6003: made available in a directory (as symlinks or wrapper scripts)
                   6004: that is early in the executable search path. Just like the buildlink
                   6005: system, this helps with consistent builds.</p>
                   6006: <p>A tool may be needed to help build a specific package. For example,
                   6007: perl, GNU make (gmake) or yacc may be needed.</p>
                   6008: <p>Also a tool may be needed, for example, because the native system's supplied
                   6009: tool may be inefficient for building a package with pkgsrc.
                   6010: For example, a package may need GNU awk, bison (instead of
                   6011: yacc) or a better sed.</p>
                   6012: <p>The tools used by a package can be listed by running
                   6013: <span class="command"><strong>make show-tools</strong></span>.</p>
1.148     asau     6014: <div class="sect1">
1.75      rillig   6015: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6016: <a name="pkgsrc-tools"></a>17.1. Tools for pkgsrc builds</h2></div></div></div>
                   6017: <p>The default set of tools used by pkgsrc is defined in
                   6018: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
                   6019: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
                   6020: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
                   6021: These can be seen by running:
                   6022: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
                   6023: <p>If a package needs a specific program to build
                   6024: then the <code class="varname">USE_TOOLS</code> variable can be used
                   6025: to define the tools needed.</p>
1.75      rillig   6026: </div>
1.299     rillig   6027: <div class="sect1">
                   6028: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   6029: <a name="package-tools"></a>17.2. Tools needed by packages</h2></div></div></div>
                   6030: <p>In the following examples, the :run means that it is needed at
                   6031: run-time (and becomes a DEPENDS).
                   6032: The default is a build dependency which can be set with
                   6033: :build. (So in this example, it is the same as gmake:build
                   6034: and pkg-config:build.)</p>
1.75      rillig   6035: <pre class="programlisting">
1.299     rillig   6036: USE_TOOLS+=     gmake perl:run pkg-config
1.1       grant    6037: </pre>
1.299     rillig   6038: <p>When using the tools framework, a
                   6039: <code class="varname">TOOLS_PATH.foo</code> variable is defined
                   6040: which contains the full path to the appropriate tool. For example,
                   6041: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">&#8220;<span class="quote">/bin/bash</span>&#8221;</span>
                   6042: on Linux systems.</p>
                   6043: <p>If you always need a pkgsrc version of the
                   6044: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
                   6045: </p>
1.75      rillig   6046: </div>
1.299     rillig   6047: <div class="sect1">
                   6048: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   6049: <a name="platform-tools"></a>17.3. Tools provided by platforms</h2></div></div></div>
                   6050: <p>When improving or porting pkgsrc to a new platform, have a look
                   6051: at (or create) the corresponding platform specific make file fragment under
                   6052: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
                   6053: the name of the common tools. For example:</p>
1.75      rillig   6054: <pre class="programlisting">
1.299     rillig   6055: .if exists(/usr/bin/bzcat)
                   6056: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzcat
                   6057: .elif exists(/usr/bin/bzip2)
                   6058: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzip2 -cd
                   6059: .endif
                   6060: 
                   6061: TOOLS_PLATFORM.true?=           true                    # shell builtin
1.1       grant    6062: </pre>
1.75      rillig   6063: </div>
                   6064: </div>
1.299     rillig   6065: <div class="chapter">
                   6066: <div class="titlepage"><div><div><h2 class="title">
                   6067: <a name="buildlink"></a>Chapter 18. Buildlink methodology</h2></div></div></div>
                   6068: <div class="toc">
                   6069: <p><b>Table of Contents</b></p>
                   6070: <dl class="toc">
                   6071: <dt><span class="sect1"><a href="#converting-to-buildlink3">18.1. Converting packages to use buildlink3</a></span></dt>
                   6072: <dt><span class="sect1"><a href="#creating-buildlink3.mk">18.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
                   6073: <dd><dl>
                   6074: <dt><span class="sect2"><a href="#anatomy-of-bl3">18.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
                   6075: <dt><span class="sect2"><a href="#updating-buildlink-depends">18.2.2. Updating
                   6076:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6077:       and
                   6078:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6079:       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
                   6080: </dl></dd>
                   6081: <dt><span class="sect1"><a href="#writing-builtin.mk">18.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
                   6082: <dd><dl>
                   6083: <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>
                   6084: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">18.3.2. Global preferences for native or pkgsrc software</a></span></dt>
                   6085: </dl></dd>
                   6086: </dl>
1.75      rillig   6087: </div>
1.299     rillig   6088: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
                   6089:   are seen by a package's configure and build processes.  This is implemented
                   6090:   in a two step process:</p>
                   6091: <div class="orderedlist"><ol class="orderedlist" type="1">
                   6092: <li class="listitem"><p>Symlink headers and libraries for dependencies into
                   6093:       <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
                   6094:       of <code class="varname">WRKDIR</code>.</p></li>
                   6095: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
                   6096:       tools that translate <code class="option">-I${LOCALBASE}/include</code> and
                   6097:       <code class="option">-L${LOCALBASE}/lib</code> into references to
                   6098:       <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
                   6099:       native compiler on some operating systems look like GCC, so that
                   6100:       packages that expect GCC won't require modifications to build with
                   6101:       those native compilers.</p></li>
                   6102: </ol></div>
                   6103: <p>This normalizes the environment in which a package is built so that the
                   6104:   package may be built consistently despite what other software may be
                   6105:   installed. Please note that the normal system header and library paths,
                   6106:   e.g. <code class="filename">/usr/include</code>,
                   6107:   <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
                   6108:   designed to insulate the package build from non-system-supplied
                   6109:   software.</p>
1.148     asau     6110: <div class="sect1">
1.75      rillig   6111: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6112: <a name="converting-to-buildlink3"></a>18.1. Converting packages to use buildlink3</h2></div></div></div>
                   6113: <p>The process of converting packages to use the buildlink3
                   6114:     framework (<span class="quote">&#8220;<span class="quote">bl3ifying</span>&#8221;</span>) is fairly straightforward.
                   6115:     The things to keep in mind are:</p>
1.128     wiz      6116: <div class="orderedlist"><ol class="orderedlist" type="1">
1.299     rillig   6117: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
                   6118:        instead of the actual toolchain.  Some packages are tricky,
                   6119:        and the only way to know for sure is the check
                   6120:        <code class="filename">${WRKDIR}/.work.log</code> to see if the
                   6121:        wrappers are being invoked.</p></li>
                   6122: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
                   6123:        the package Makefile, e.g. Java VMs, standalone shells,
                   6124:        etc., because the code to symlink files into
                   6125:        <code class="filename">${BUILDLINK_DIR}</code> looks for files
                   6126:        relative to <span class="quote">&#8220;<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>&#8221;</span>.
                   6127:        </p></li>
                   6128: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
                   6129:        <code class="filename">buildlink3.mk</code> files that you list in a
                   6130:        package's Makefile are added as dependencies for that package.
                   6131:        </p></li>
                   6132: </ol></div>
                   6133: <p>If a dependency on a particular package is required for its libraries and
                   6134:     headers, then we replace:</p>
                   6135: <pre class="programlisting">
                   6136: DEPENDS+=       foo&gt;=1.1.0:../../category/foo
                   6137: </pre>
                   6138: <p>with</p>
                   6139: <pre class="programlisting">
                   6140: .include "../../category/foo/buildlink3.mk"
                   6141: </pre>
                   6142: <p>The buildlink3.mk files usually define the required dependencies.
                   6143:     If you need a newer version of the dependency when using buildlink3.mk
                   6144:     files, then you can define it in your Makefile; for example:</p>
1.75      rillig   6145: <pre class="programlisting">
1.299     rillig   6146: BUILDLINK_API_DEPENDS.foo+=   foo&gt;=1.1.0
                   6147: .include "../../category/foo/buildlink3.mk"
1.1       grant    6148: </pre>
1.299     rillig   6149: <p>There are several <code class="filename">buildlink3.mk</code>
                   6150:     files in <code class="filename">pkgsrc/mk</code>
                   6151:     that handle special package issues:</p>
                   6152: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6153: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
                   6154:        the native or a pkgsrc Berkeley DB implementation based on
                   6155:        the values of <code class="varname">BDB_ACCEPTED</code> and
                   6156:        <code class="varname">BDB_DEFAULT</code>.</p></li>
                   6157: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
                   6158:        comes with neither Curses nor NCurses, this will take care
                   6159:        to install the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/ncurses/README.html" target="_top"><code class="filename">devel/ncurses</code></a> package.</p></li>
                   6160: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
                   6161:        of <code class="varname">KRB5_ACCEPTED</code> to choose between
                   6162:        adding a dependency on Heimdal or MIT-krb5 for packages that
                   6163:        require a Kerberos 5 implementation.</p></li>
                   6164: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
                   6165:        system-provided Motif installation or adds a dependency on
                   6166:        <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/lesstif/README.html" target="_top"><code class="filename">x11/lesstif</code></a> or <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/motif/README.html" target="_top"><code class="filename">x11/motif</code></a>. The user can set
                   6167:        <code class="varname">MOTIF_TYPE</code> to <span class="quote">&#8220;<span class="quote">dt</span>&#8221;</span>,
                   6168:        <span class="quote">&#8220;<span class="quote">lesstif</span>&#8221;</span> or <span class="quote">&#8220;<span class="quote">motif</span>&#8221;</span>
                   6169:        to choose which Motif version will be used.</p></li>
                   6170: <li class="listitem"><p><code class="filename">readline.buildlink3.mk</code> checks for a
                   6171:        system-provided GNU readline or editline (libedit) installation,
                   6172:        or adds a dependency on <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/readline/README.html" target="_top"><code class="filename">devel/readline</code></a>,
                   6173:        <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/editline/README.html" target="_top"><code class="filename">devel/editline</code></a>. The user can set
                   6174:        <code class="varname">READLINE_DEFAULT</code> to choose readline implementation.
                   6175:        If your package really needs GNU readline library, its Makefile
                   6176:        should include <code class="filename">devel/readline/buildlink3.mk</code>
                   6177:        instead of <code class="filename">readline.buildlink3.mk</code>.</p></li>
                   6178: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
                   6179:        variables that may be used by packages that use the
                   6180:        Open Sound System (OSS) API.</p></li>
                   6181: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
                   6182:        any of the Postgres versions in the variable
                   6183:        <code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
                   6184:        the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
                   6185:        the file for more information.</p></li>
                   6186: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
                   6187:        <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
                   6188:        a dependency on <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/pth/README.html" target="_top"><code class="filename">devel/pth</code></a> as needed.</p></li>
                   6189: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
                   6190:        <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
                   6191:        library.</p></li>
                   6192: </ul></div>
                   6193: <p>The comments in those <code class="filename">buildlink3.mk</code>
                   6194:     files provide a more complete
                   6195:     description of how to use them properly.</p>
1.75      rillig   6196: </div>
1.148     asau     6197: <div class="sect1">
1.75      rillig   6198: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6199: <a name="creating-buildlink3.mk"></a>18.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
                   6200: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
                   6201:     included by Makefiles to indicate the need to compile and link
                   6202:     against header files and libraries provided by the package.  A
                   6203:     <code class="filename">buildlink3.mk</code> file should always provide
                   6204:     enough information to add the correct type of dependency
                   6205:     relationship and include any other
                   6206:     <code class="filename">buildlink3.mk</code> files that it needs to find
                   6207:     headers and libraries that it needs in turn.</p>
                   6208: <p>To generate an initial <code class="filename">buildlink3.mk</code>
                   6209:     file for further editing, Rene Hexel's <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/createbuildlink/README.html" target="_top"><code class="filename">pkgtools/createbuildlink</code></a>
                   6210:     package is highly recommended.  For most packages, the following
                   6211:     command will generate a good starting point for
                   6212:     <code class="filename">buildlink3.mk</code> files:</p>
                   6213: <pre class="screen">
                   6214: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
                   6215: <code class="prompt">%</code> createbuildlink &gt;buildlink3.mk</code></strong>
                   6216:     </pre>
1.148     asau     6217: <div class="sect2">
1.75      rillig   6218: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   6219: <a name="anatomy-of-bl3"></a>18.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
                   6220: <p>The following real-life example
                   6221:       <code class="filename">buildlink3.mk</code> is taken
                   6222:       from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
1.75      rillig   6223: <pre class="programlisting">
1.299     rillig   6224: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
                   6225: 
                   6226: BUILDLINK_TREE+=        tiff
                   6227: 
                   6228: .if !defined(TIFF_BUILDLINK3_MK)
                   6229: TIFF_BUILDLINK3_MK:=
                   6230: 
                   6231: BUILDLINK_API_DEPENDS.tiff+=    tiff&gt;=3.6.1
                   6232: BUILDLINK_ABI_DEPENDS.tiff+=    tiff&gt;=3.7.2nb1
                   6233: BUILDLINK_PKGSRCDIR.tiff?=      ../../graphics/tiff
                   6234: 
                   6235: .include "../../devel/zlib/buildlink3.mk"
                   6236: .include "../../graphics/jpeg/buildlink3.mk"
                   6237: .endif # TIFF_BUILDLINK3_MK
                   6238: 
                   6239: BUILDLINK_TREE+=        -tiff
1.1       grant    6240: </pre>
1.299     rillig   6241: <p>The header and footer manipulate
                   6242:       <code class="varname">BUILDLINK_TREE</code>, which is common across all
                   6243:       <code class="filename">buildlink3.mk</code> files and is used to track
                   6244:       the dependency tree.</p>
                   6245: <p>The main section is protected from multiple inclusion
                   6246:       and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
                   6247:       added.  Several important variables are set in the section:</p>
                   6248: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6249: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300     wiz      6250:          is the dependency version recorded in the installed
1.299     rillig   6251:          package; this should always be set using
                   6252:          <span class="command"><strong>+=</strong></span> to ensure that
                   6253:          we're appending to any pre-existing list of values.  This
1.300     wiz      6254:          variable should be set to the last version of the
1.299     rillig   6255:          package that had an backwards-incompatible API change.
                   6256:          </p></li>
                   6257: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
                   6258:          is the location of the <em class="replaceable"><code>pkg</code></em>
                   6259:          pkgsrc directory.</p></li>
                   6260: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
                   6261:          (not shown above) controls whether we use
                   6262:          <code class="varname">BUILD_DEPENDS</code> or
                   6263:          <code class="varname">DEPENDS</code> to add the dependency on
                   6264:          <em class="replaceable"><code>pkg</code></em>.  The build dependency is
                   6265:          selected by setting
                   6266:          <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
                   6267:          to <span class="quote">&#8220;<span class="quote">build</span>&#8221;</span>.  By default, the full dependency is
                   6268:          used.</p></li>
                   6269: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
                   6270:            and
                   6271:            <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
                   6272:            (not shown above) are lists of subdirectories of
                   6273:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
                   6274:            to add to the header and library search paths.  These
                   6275:            default to <span class="quote">&#8220;<span class="quote">include</span>&#8221;</span> and <span class="quote">&#8220;<span class="quote">lib</span>&#8221;</span>
                   6276:          respectively.</p></li>
                   6277: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
                   6278:            (not shown above) is the list of preprocessor flags to add
                   6279:            to <code class="varname">CPPFLAGS</code>, which are passed on to the
                   6280:            configure and build phases.  The <span class="quote">&#8220;<span class="quote">-I</span>&#8221;</span> option
                   6281:            should be avoided and instead be handled using
                   6282:            <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
                   6283:          above.</p></li>
                   6284: </ul></div>
                   6285: <p>The following variables are all optionally defined within
                   6286:       this second section (protected against multiple inclusion) and
                   6287:       control which package files are symlinked into
                   6288:       <code class="filename">${BUILDLINK_DIR}</code> and how their names are
                   6289:       transformed during the symlinking:</p>
                   6290: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6291: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
                   6292:            (not shown above) is a shell glob pattern relative to
                   6293:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
                   6294:            to be symlinked into
                   6295:            <code class="filename">${BUILDLINK_DIR}</code>,
                   6296:          e.g. <code class="filename">include/*.h</code>.</p></li>
                   6297: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
                   6298:            (not shown above) is a shell pipeline that
                   6299:            outputs to stdout a list of files relative to
                   6300:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
                   6301:            The resulting files are to be symlinked
                   6302:            into <code class="filename">${BUILDLINK_DIR}</code>.  By default,
                   6303:            this takes the <code class="filename">+CONTENTS</code> of a
                   6304:            <em class="replaceable"><code>pkg</code></em> and filters it through
                   6305:            <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
                   6306: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
                   6307:            (not shown above) is a filter command that filters
                   6308:            <code class="filename">+CONTENTS</code> input into a list of files
                   6309:            relative to
                   6310:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
                   6311:            on stdout.  By default,
                   6312:            <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
                   6313:            outputs the contents of the <code class="filename">include</code>
                   6314:            and <code class="filename">lib</code> directories in the package
                   6315:            <code class="filename">+CONTENTS</code>.</p></li>
                   6316: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
                   6317:            (not shown above) is a list of sed arguments used to
                   6318:            transform the name of the source filename into a
                   6319:            destination filename, e.g. <span class="command"><strong>-e
                   6320:            "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
                   6321: </ul></div>
                   6322: <p>This section can additionally include any
                   6323:       <code class="filename">buildlink3.mk</code> needed for
                   6324:       <em class="replaceable"><code>pkg</code></em>'s library dependencies.
                   6325:       Including these <code class="filename">buildlink3.mk</code> files
                   6326:       means that the headers and libraries for these
                   6327:       dependencies are also symlinked into
                   6328:       <code class="filename">${BUILDLINK_DIR}</code>
                   6329:       whenever the <em class="replaceable"><code>pkg</code></em>
                   6330:       <code class="filename">buildlink3.mk</code>
                   6331:       file is included. Dependencies are only added for directly
                   6332:       include <code class="filename">buildlink3.mk</code> files.</p>
                   6333: <p>When providing a <code class="filename">buildlink3.mk</code> and
                   6334:       including other <code class="filename">buildlink3.mk</code> files in it,
                   6335:       please only add necessary ones, i.e., those whose libraries or
                   6336:       header files are automatically exposed when the package is
                   6337:       use.</p>
                   6338: <p>In particular, if only an executable
                   6339:       (<code class="filename">bin/foo</code>) is linked against a library, that
                   6340:       library does not need to be propagated in the
                   6341:       <code class="filename">buildlink3.mk</code> file.</p>
                   6342: <p>The following steps should help you decide if a
                   6343:       <code class="filename">buildlink3.mk</code> file needs to be included:
                   6344:       </p>
                   6345: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6346: <li class="listitem"><p>Look at the installed header files: What
                   6347:        headers do they include? The packages providing these files
                   6348:        must be buildlinked.</p></li>
                   6349: <li class="listitem"><p>Run <code class="filename">ldd</code> on all installed
                   6350:        libraries and look against what other libraries they link.
                   6351:        Some of the packages providing these probably need to be
                   6352:        buildlinked; however, it's not automatic, since e.g. GTK on
                   6353:        some systems pulls in the X libraries, so they will show up in
                   6354:        the <code class="filename">ldd</code> output, while on others (like OS
                   6355:        X) it won't. <code class="filename">ldd</code> output can thus only be
                   6356:        used as a hint.</p></li>
                   6357: </ul></div>
                   6358: <p>
                   6359:       </p>
                   6360: </div>
1.148     asau     6361: <div class="sect2">
1.75      rillig   6362: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   6363: <a name="updating-buildlink-depends"></a>18.2.2. Updating
                   6364:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6365:       and
                   6366:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6367:       in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
1.300     wiz      6368: <p>Both variables set lower bounds for a version of this package.
                   6369:       The two variables differ in that one describes source
1.299     rillig   6370:       compatibility (API) and the other binary compatibility (ABI).
                   6371:       The difference is that a change in the API breaks compilation of
                   6372:       programs while changes in the ABI stop compiled programs from
                   6373:       running.</p>
1.300     wiz      6374: <p>The
                   6375:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6376:       variable in a <code class="filename">buildlink3.mk</code> should be
                   6377:       changed very rarely.  (One possible scenario: If all packages
                   6378:       using this package need a higher version than defined in the
                   6379:       <code class="filename">buildlink3.mk</code>,
1.299     rillig   6380:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300     wiz      6381:       could be updated to that higher version.)</p>
                   6382: <p>On the other hand, changes to
1.299     rillig   6383:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300     wiz      6384:       are more common.  The variable will need to be updated every
                   6385:       time the major version of one of its shared libraries is changed,
                   6386:       or any other change where a binary built against the previous
                   6387:       version of the package will not run against the new version any
                   6388:       longer.</p>
                   6389: <p>In such a case, the package's
1.299     rillig   6390:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300     wiz      6391:       must be increased to require the new package version.  Then the
                   6392:       <code class="varname">PKGREVISION</code> of all packages
                   6393:       <em class="replaceable"><code>foo</code></em> that depend on this package need
                   6394:       to be increased, and if they have
                   6395:       <code class="filename">buildlink3.mk</code> files,
                   6396:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>foo</code></em></code>
                   6397:       in their <code class="filename">buildlink3.mk</code> files must be
                   6398:       increased to the new version as well. This is required so that a
                   6399:       package will pull in the versions of the packages that use the
                   6400:       new ABI and that the packages' <code class="varname">PKGREVISION</code>s
                   6401:       uniquely identify the packages built against the new ABI. The
                   6402:       <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/revbump/README.html" target="_top"><code class="filename">pkgtools/revbump</code></a> package can
                   6403:       help with these updates.</p>
                   6404: <p>See <a class="xref" href="#dependencies" title="21.1.5. Handling dependencies">Section 21.1.5, &#8220;Handling dependencies&#8221;</a> for more information
                   6405:       about dependencies on other packages, including the
                   6406:       <code class="varname">BUILDLINK_API_DEPENDS</code> definitions.</p>
1.299     rillig   6407: <p>Please take careful consideration before adjusting
                   6408:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6409:       or
                   6410:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300     wiz      6411:       in a <code class="filename">buildlink3.mk</code> file as we don't want to
                   6412:       cause unneeded package deletions and rebuilds.  In many cases,
                   6413:       new versions of packages work just fine with older
                   6414:       dependencies.</p>
1.299     rillig   6415: <p>Also it is not needed to set
                   6416:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6417:       when it is identical to
                   6418:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.        </p>
1.75      rillig   6419: </div>
                   6420: </div>
1.148     asau     6421: <div class="sect1">
1.75      rillig   6422: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6423: <a name="writing-builtin.mk"></a>18.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
                   6424: <p>Some packages in pkgsrc install headers and libraries that
                   6425:       coincide with headers and libraries present in the base system.
                   6426:       Aside from a <code class="filename">buildlink3.mk</code> file, these
                   6427:       packages should also include a <code class="filename">builtin.mk</code>
                   6428:       file that includes the necessary checks to decide whether using
                   6429:       the built-in software or the pkgsrc software is
                   6430:     appropriate.</p>
                   6431: <p>The only requirements of a builtin.mk file for
                   6432:     <em class="replaceable"><code>pkg</code></em> are:</p>
                   6433: <div class="orderedlist"><ol class="orderedlist" type="1">
                   6434: <li class="listitem"><p>It should set
                   6435:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6436:        to either <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> or <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span>
                   6437:        after it is included.</p></li>
                   6438: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
                   6439:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6440:        which is already set before the
                   6441:        <code class="filename">builtin.mk</code> file is included.</p></li>
                   6442: <li class="listitem"><p>It should be written to allow multiple inclusion.  This
                   6443:        is <span class="emphasis"><em>very</em></span> important and takes careful
                   6444:        attention to <code class="filename">Makefile</code> coding.</p></li>
                   6445: </ol></div>
                   6446: <div class="sect2">
                   6447: <div class="titlepage"><div><div><h3 class="title">
                   6448: <a name="anatomy-of-builtin.mk"></a>18.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</h3></div></div></div>
                   6449: <p>The following is the recommended template for builtin.mk
                   6450:       files:</p>
1.75      rillig   6451: <pre class="programlisting">
1.299     rillig   6452: .if !defined(IS_BUILTIN.foo)
                   6453: #
                   6454: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
                   6455: # genuinely exists in the system or not.
                   6456: #
                   6457: IS_BUILTIN.foo?=        no
1.100     rillig   6458: 
1.299     rillig   6459: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
                   6460: # version can be determined.
                   6461: #
                   6462: .  if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
                   6463: BUILTIN_PKG.foo?=       foo-1.0
                   6464: .  endif
                   6465: .endif  # IS_BUILTIN.foo
1.100     rillig   6466: 
1.299     rillig   6467: .if !defined(USE_BUILTIN.foo)
                   6468: USE_BUILTIN.foo?=       ${IS_BUILTIN.foo}
                   6469: .  if defined(BUILTIN_PKG.foo)
                   6470: .    for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
                   6471: .      if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
                   6472: USE_BUILTIN.foo!=                                                       \
                   6473:         ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo}            \
                   6474:         &amp;&amp; ${ECHO} "yes" || ${ECHO} "no"
                   6475: .      endif
                   6476: .    endfor
                   6477: .  endif
                   6478: .endif  # USE_BUILTIN.foo
1.100     rillig   6479: 
1.299     rillig   6480: CHECK_BUILTIN.foo?=     no
                   6481: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
                   6482: #
                   6483: # Here we place code that depends on whether USE_BUILTIN.foo is set to
                   6484: # "yes" or "no".
                   6485: #
                   6486: .endif  # CHECK_BUILTIN.foo
1.75      rillig   6487: </pre>
1.299     rillig   6488: <p>The first section sets
                   6489:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6490:       depending on if <em class="replaceable"><code>pkg</code></em> really exists
                   6491:       in the base system.  This should not be a base system software
                   6492:       with similar functionality to <em class="replaceable"><code>pkg</code></em>;
                   6493:       it should only be <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> if the actual package is
                   6494:       included as part of the base system.  This variable is only
                   6495:       used internally within the <code class="filename">builtin.mk</code>
                   6496:       file.</p>
                   6497: <p>The second section sets
                   6498:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   6499:       to the version of <em class="replaceable"><code>pkg</code></em> in the base
                   6500:       system if it exists (if
                   6501:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6502:       is <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>).  This variable is only used internally
                   6503:       within the <code class="filename">builtin.mk</code> file.</p>
                   6504: <p>The third section sets
                   6505:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6506:       and is <span class="emphasis"><em>required</em></span> in all
                   6507:       <code class="filename">builtin.mk</code> files.  The code in this
                   6508:       section must make the determination whether the built-in
                   6509:       software is adequate to satisfy the dependencies listed in
                   6510:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   6511:       This is typically done by comparing
                   6512:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   6513:       against each of the dependencies in
                   6514:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   6515:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6516:       <span class="emphasis"><em>must</em></span> be set to the correct value by the
                   6517:       end of the <code class="filename">builtin.mk</code> file.  Note that
                   6518:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6519:       may be <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> even if
                   6520:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6521:       is <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span> because we may make the determination
                   6522:       that the built-in version of the software is similar enough to
                   6523:       be used as a replacement.</p>
                   6524: <p>The last section is guarded by
                   6525:       <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
                   6526:       and includes code that uses the value of
                   6527:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6528:       set in the previous section.  This typically includes, e.g.,
                   6529:       adding additional dependency restrictions and listing additional
                   6530:       files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
                   6531:       <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
                   6532: </div>
                   6533: <div class="sect2">
                   6534: <div class="titlepage"><div><div><h3 class="title">
                   6535: <a name="native-or-pkgsrc-preference"></a>18.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
                   6536: <p>When building packages, it's possible to choose whether to set
                   6537:        a global preference for using either the built-in (native)
                   6538:        version or the pkgsrc version of software to satisfy a
                   6539:        dependency.  This is controlled by setting
                   6540:        <code class="varname">PREFER_PKGSRC</code> and
                   6541:        <code class="varname">PREFER_NATIVE</code>.  These variables take values
                   6542:        of either <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span>, or a list of
                   6543:        packages.  <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
                   6544:        use the pkgsrc versions of software, while
                   6545:        <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
                   6546:        built-in versions.  Preferences are determined by the most
                   6547:        specific instance of the package in either
                   6548:        <code class="varname">PREFER_PKGSRC</code> or
                   6549:        <code class="varname">PREFER_NATIVE</code>.  If a package is specified
                   6550:        in neither or in both variables, then
                   6551:        <code class="varname">PREFER_PKGSRC</code> has precedence over
                   6552:        <code class="varname">PREFER_NATIVE</code>.  For example, to require
                   6553:        using pkgsrc versions of software for all but the most basic
                   6554:       bits on a NetBSD system, you can set:</p>
1.75      rillig   6555: <pre class="programlisting">
1.299     rillig   6556: PREFER_PKGSRC=  yes
                   6557: PREFER_NATIVE=  getopt skey tcp_wrappers
                   6558: </pre>
                   6559: <p>A package <span class="emphasis"><em>must</em></span> have a
                   6560:       <code class="filename">builtin.mk</code>
                   6561:       file to be listed in <code class="varname">PREFER_NATIVE</code>,
                   6562:       otherwise it is simply ignored in that list.</p>
1.305     bacon    6563: <p><code class="varname">PREFER_PKGSRC</code> and
                   6564:       <code class="varname">PREFER_NATIVE</code> should be set during bootstrap
                   6565:       to ensure that the bootstrap process does not use inapropriate
                   6566:       native tools as dependencies for core packages.
                   6567: 
                   6568: </p>
                   6569: <pre class="screen">
                   6570: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap --prefer-pkgsrc yes --prefer-native openssl</code></strong>
                   6571: </pre>
                   6572: <p>
                   6573: 
1.299     rillig   6574:       Switching between settings globally at a later date can introduce
                   6575:       complications with dependency resolution. This is caused by packages
1.305     bacon    6576:       built with the opposite preference being installed alongside each
                   6577:       other.  Hence, any changes to these variables after bootstrap will
                   6578:       necessitate rebuilding all packages depending on one whose preference
                   6579:       has been changed.  This is not trivial and should be avoided.</p>
                   6580: <p>When using pkgsrc on Linux systems, there is high risk of
                   6581:       "leakage", where programs installed by pkgsrc may inadvertently use a
                   6582:       command or library not installed by pkgsrc, e.g. those installed by
                   6583:       yum or apt.  Such foreign dependencies may be installed, removed, or
                   6584:       upgraded to a version incompatible with the pkgsrc package at any
                   6585:       time, causing pkgsrc packages to subsequently malfunction.  Pkgsrc
                   6586:       cannot prevent this, as it has no control over other package managers.
                   6587:       Another potential problem is that under Redhat Enterprise and related
                   6588:       Linux systems, yum packages are only patched and never upgraded, so
                   6589:       eventually they may become too outdated for use by pkgsrc.  Even
                   6590:       intentionally using foreign dependencies, not considered leakage, can
                   6591:       lead to these problems, so it is generally discouraged.  In order to
                   6592:       minimize such problems, PREFER_PKGSRC defaults to "yes" on Linux systems.
                   6593:       This ensures that pkgsrc is aware of any changes to dependency packages
                   6594:       and can rebuild or upgrade the entire dependency tree as needed.  This
                   6595:       default can be overridden by setting --prefer-pkgsrc to "no" or a list of
                   6596:       packages, or by setting --prefer-native to "yes".</p>
1.75      rillig   6597: </div>
1.107     rillig   6598: </div>
1.75      rillig   6599: </div>
1.148     asau     6600: <div class="chapter">
1.75      rillig   6601: <div class="titlepage"><div><div><h2 class="title">
1.299     rillig   6602: <a name="plist"></a>Chapter 19. PLIST issues</h2></div></div></div>
1.75      rillig   6603: <div class="toc">
                   6604: <p><b>Table of Contents</b></p>
1.210     leot     6605: <dl class="toc">
1.299     rillig   6606: <dt><span class="sect1"><a href="#rcs-id">19.1. RCS ID</a></span></dt>
                   6607: <dt><span class="sect1"><a href="#automatic-plist-generation">19.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                   6608: <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>
                   6609: <dt><span class="sect1"><a href="#plist.misc">19.4. Variable substitution in PLIST</a></span></dt>
                   6610: <dt><span class="sect1"><a href="#manpage-compression">19.5. Man page compression</a></span></dt>
                   6611: <dt><span class="sect1"><a href="#using-PLIST_SRC">19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
                   6612: <dt><span class="sect1"><a href="#platform-specific-plist">19.7. Platform-specific and differing PLISTs</a></span></dt>
                   6613: <dt><span class="sect1"><a href="#build-plist">19.8. Build-specific PLISTs</a></span></dt>
                   6614: <dt><span class="sect1"><a href="#faq.common-dirs">19.9. Sharing directories between packages</a></span></dt>
1.75      rillig   6615: </dl>
                   6616: </div>
1.299     rillig   6617: <p>The <code class="filename">PLIST</code> file contains a package's
                   6618:   <span class="quote">&#8220;<span class="quote">packing list</span>&#8221;</span>, i.e. a list of files that belong to
                   6619:   the package (relative to the <code class="filename">${PREFIX}</code>
                   6620:   directory it's been installed in) plus some additional statements
1.311     leot     6621:   - see the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/pkg_create.1"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> man page for a full list.
1.299     rillig   6622:   This chapter addresses some issues that need attention when
                   6623:   dealing with the <code class="filename">PLIST</code> file (or files, see
                   6624:   below!).</p>
1.148     asau     6625: <div class="sect1">
1.75      rillig   6626: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6627: <a name="rcs-id"></a>19.1. RCS ID</h2></div></div></div>
                   6628: <p>Be sure to add a RCS ID line as the first thing in any
                   6629:     <code class="filename">PLIST</code> file you write:</p>
                   6630: <pre class="programlisting">
                   6631: @comment $NetBSD $
                   6632: </pre>
                   6633: <p>An artificial space has been added between NetBSD and $, this is a
                   6634: workaround here to prevent CVS expanding to the filename of the guide. When
                   6635: adding the RCS ID the space should be omitted.</p>
1.75      rillig   6636: </div>
1.148     asau     6637: <div class="sect1">
1.75      rillig   6638: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6639: <a name="automatic-plist-generation"></a>19.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
                   6640: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
                   6641:     to output a PLIST that matches any new files since the package
                   6642:     was extracted.  See <a class="xref" href="#build.helpful-targets" title="13.17. Other helpful targets">Section 13.17, &#8220;Other helpful targets&#8221;</a> for
                   6643:     more information on this target.</p>
1.75      rillig   6644: </div>
1.148     asau     6645: <div class="sect1">
1.75      rillig   6646: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6647: <a name="print-PLIST"></a>19.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
                   6648: </h2></div></div></div>
                   6649: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
                   6650:     of AWK patterns and actions that are used to filter the output of
                   6651:     print-PLIST.  You can <span class="emphasis"><em>append</em></span> any chunk of AWK
                   6652:     scripting you like to it, but be careful with quoting.</p>
                   6653: <p>For example, to get all files inside the
                   6654:     <code class="filename">libdata/foo</code> directory removed from the
                   6655:     resulting PLIST:</p>
1.88      wiz      6656: <pre class="programlisting">
1.299     rillig   6657: PRINT_PLIST_AWK+=       /^libdata\/foo/ { next; }
1.100     rillig   6658: </pre>
1.300     wiz      6659: <p>The <code class="varname">PRINT_PLIST_AWK</code> transformations are
                   6660:     evaluated after the file list and directory list are sorted.
                   6661:     <code class="varname">EARLY_PRINT_PLIST_AWK</code> is like
                   6662:     <code class="varname">PRINT_PLIST_AWK</code> except it operates before the file
                   6663:     list and directory list are sorted.</p>
1.299     rillig   6664: </div>
                   6665: <div class="sect1">
                   6666: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   6667: <a name="plist.misc"></a>19.4. Variable substitution in PLIST</h2></div></div></div>
                   6668: <p>A number of variables are substituted automatically in
                   6669:     PLISTs when a package is installed on a system. This includes the
                   6670:     following variables:</p>
                   6671: <div class="variablelist"><dl class="variablelist">
                   6672: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
                   6673: <dd>
                   6674: <p>Some packages like emacs and perl embed information
                   6675:          about which architecture they were built on into the
                   6676:          pathnames where they install their files. To handle this
                   6677:          case, PLIST will be preprocessed before actually used, and
                   6678:          the symbol
                   6679:          <span class="quote">&#8220;<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>&#8221;</span> will be
                   6680:          replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
                   6681:          same is done if the string
                   6682:          <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
                   6683:          PLIST somewhere - use this on packages that have GNU
                   6684:          autoconf-created configure scripts.</p>
                   6685: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   6686: <h3 class="title">Legacy note</h3>
                   6687: <p>There used to be a symbol
                   6688:            <span class="quote">&#8220;<span class="quote"><code class="varname">$ARCH</code></span>&#8221;</span> that
                   6689:            was replaced by the output of <span class="command"><strong>uname
                   6690:            -m</strong></span>, but that's no longer supported and has
                   6691:            been removed.</p>
                   6692: </div>
                   6693: </dd>
                   6694: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
                   6695: <dd>
                   6696: <p>Some packages want to embed the OS name and version
                   6697:          into some paths.  To do this, use these variables in the
                   6698:          <code class="filename">PLIST</code>:
                   6699:          </p>
                   6700: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6701: <li class="listitem"><p><code class="varname">${OPSYS}</code> - output of <span class="quote">&#8220;<span class="quote"><span class="command"><strong>uname -s</strong></span></span>&#8221;</span></p></li>
                   6702: <li class="listitem"><p><code class="varname">${LOWER_OPSYS}</code> - lowercase common name (eg. <span class="quote">&#8220;<span class="quote">solaris</span>&#8221;</span>)</p></li>
                   6703: <li class="listitem"><p><code class="varname">${OS_VERSION}</code> - <span class="quote">&#8220;<span class="quote"><span class="command"><strong>uname -r</strong></span></span>&#8221;</span></p></li>
                   6704: </ul></div>
                   6705: </dd>
                   6706: </dl></div>
                   6707: <p>For a list of values which are replaced by
                   6708:     default, the output of <span class="command"><strong>make help topic=PLIST_SUBST</strong></span> as
                   6709: well as searching the <code class="filename">pkgsrc/mk</code> directory with <span class="command"><strong>grep</strong></span> for
                   6710: <code class="varname">PLIST_SUBST</code> should help.</p>
                   6711: <p>If you want to change other variables not listed above, you
                   6712:     can add variables and their expansions to this variable in the
                   6713:     following way, similar to <code class="varname">MESSAGE_SUBST</code> (see <a class="xref" href="#components.optional" title="12.5. Optional files">Section 12.5, &#8220;Optional files&#8221;</a>):</p>
1.81      rillig   6714: <pre class="programlisting">
1.299     rillig   6715: PLIST_SUBST+=   SOMEVAR="somevalue"
1.100     rillig   6716: </pre>
1.299     rillig   6717: <p>This replaces all occurrences of <span class="quote">&#8220;<span class="quote">${SOMEVAR}</span>&#8221;</span>
                   6718:     in the <code class="filename">PLIST</code> with
                   6719:     <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span>.</p>
                   6720: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
                   6721:     the common case of conditionally including some
                   6722:     <code class="filename">PLIST</code> entries. It can be done by adding
                   6723:     <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
                   6724:     setting the corresponding <code class="varname">PLIST.foo</code> variable
                   6725:     to <code class="literal">yes</code> if the entry should be included.
                   6726:     This will substitute <span class="quote">&#8220;<span class="quote"><code class="varname">${PLIST.foo}</code></span>&#8221;</span>
                   6727:     in the <code class="filename">PLIST</code> with either
                   6728:     <span class="quote">&#8220;<span class="quote"><code class="literal">""</code></span>&#8221;</span> or
                   6729:     <span class="quote">&#8220;<span class="quote"><code class="literal">"@comment "</code></span>&#8221;</span>.
                   6730:     For example, in <code class="filename">Makefile</code>:</p>
1.174     asau     6731: <pre class="programlisting">
1.299     rillig   6732: PLIST_VARS+=    foo
                   6733: .if <em class="replaceable"><code>condition</code></em>
                   6734: PLIST.foo=      yes
                   6735: .else
1.174     asau     6736: </pre>
1.299     rillig   6737: <p>And then in <code class="filename">PLIST</code>:</p>
1.81      rillig   6738: <pre class="programlisting">
1.299     rillig   6739: @comment $NetBSD $
                   6740: bin/bar
                   6741: man/man1/bar.1
                   6742: ${PLIST.foo}bin/foo
                   6743: ${PLIST.foo}man/man1/foo.1
                   6744: ${PLIST.foo}share/bar/foo.data
1.100     rillig   6745: </pre>
1.299     rillig   6746: <p>An artificial space has been added between NetBSD and $, this is a
                   6747: workaround here to prevent CVS expanding to the filename of the guide. When
1.309     gutterid 6748: adding the RCS ID the space should be omitted.</p>
1.81      rillig   6749: </div>
1.299     rillig   6750: <div class="sect1">
                   6751: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   6752: <a name="manpage-compression"></a>19.5. Man page compression</h2></div></div></div>
                   6753: <p>Man pages should be installed in compressed form if
                   6754:     <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
                   6755:     and uncompressed otherwise. To handle this in the
                   6756:     <code class="filename">PLIST</code> file, the suffix <span class="quote">&#8220;<span class="quote">.gz</span>&#8221;</span> is
                   6757:     appended/removed automatically for man pages according to
                   6758:     <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
                   6759:     or not, see above for details. This modification of the
                   6760:     <code class="filename">PLIST</code> file is done on a copy of it, not
                   6761:     <code class="filename">PLIST</code> itself.</p>
1.75      rillig   6762: </div>
1.148     asau     6763: <div class="sect1">
1.75      rillig   6764: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6765: <a name="using-PLIST_SRC"></a>19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
                   6766: </h2></div></div></div>
                   6767: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
                   6768:     in generating the binary package, set the variable
                   6769:     <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.311     leot     6770:     The files are later concatenated using <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/cat.1"><span class="citerefentry"><span class="refentrytitle">cat</span>(1)</span></a>, and the order of things is
1.299     rillig   6771:     important. The default for <code class="varname">PLIST_SRC</code> is
                   6772:     <code class="filename">${PKGDIR}/PLIST</code>.</p>
1.75      rillig   6773: </div>
1.148     asau     6774: <div class="sect1">
1.75      rillig   6775: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6776: <a name="platform-specific-plist"></a>19.7. Platform-specific and differing PLISTs</h2></div></div></div>
                   6777: <p>Some packages decide to install a different set of files based on
                   6778:     the operating system being used. These differences can be
                   6779:     automatically handled by using the following files:</p>
                   6780: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6781: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
                   6782: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
                   6783: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
                   6784: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
                   6785: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
                   6786: </ul></div>
1.75      rillig   6787: </div>
1.148     asau     6788: <div class="sect1">
1.75      rillig   6789: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6790: <a name="build-plist"></a>19.8. Build-specific PLISTs</h2></div></div></div>
                   6791: <p>Some packages decide to generate hard-to-guess file names
                   6792:     during installation that are hard to wire down.</p>
                   6793: <p>In such cases, you can set the
                   6794:     <code class="varname">GENERATE_PLIST</code> variable to shell code
                   6795:     terminated (with a semicolon) that will output PLIST entries which
                   6796:     will be appended to the PLIST</p>
                   6797: <p>You can find one example in editors/xemacs:</p>
                   6798: <pre class="programlisting">
                   6799: GENERATE_PLIST+=        ${ECHO} bin/${DISTNAME}-`${WRKSRC}/src/xemacs -sd`.dmp ;
                   6800: </pre>
                   6801: <p>which will append something like
                   6802:     <code class="filename">bin/xemacs-21.4.23-54e8ea71.dmp</code> to the
                   6803:     <code class="filename">PLIST</code>.
                   6804:     </p>
1.75      rillig   6805: </div>
1.148     asau     6806: <div class="sect1">
1.75      rillig   6807: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6808: <a name="faq.common-dirs"></a>19.9. Sharing directories between packages</h2></div></div></div>
                   6809: <p>A <span class="quote">&#8220;<span class="quote">shared directory</span>&#8221;</span> is a directory where
                   6810:     multiple (and unrelated) packages install files.  These
                   6811:     directories were problematic because you had to add special
                   6812:     tricks in the PLIST to conditionally remove them, or have some
                   6813:     centralized package handle them.</p>
                   6814: <p>In pkgsrc, it is now easy: Each package should create
                   6815:     directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
                   6816:     will remove any directories left empty after uninstalling a
                   6817:     package.</p>
                   6818: <p>If a package needs an empty directory to work, create
                   6819:     the directory during installation as usual, and also add an
                   6820:     entry to the PLIST:
                   6821: 
                   6822: </p>
                   6823: <pre class="programlisting">
                   6824: @pkgdir path/to/empty/directory
                   6825: </pre>
                   6826: <p>
                   6827: 
                   6828:     or take a look at <code class="varname">MAKE_DIRS</code> and
                   6829:     <code class="varname">OWN_DIRS</code>.
1.88      wiz      6830:     </p>
1.75      rillig   6831: </div>
1.299     rillig   6832: </div>
                   6833: <div class="chapter">
                   6834: <div class="titlepage"><div><div><h2 class="title">
                   6835: <a name="pkginstall"></a>Chapter 20. The pkginstall framework</h2></div></div></div>
                   6836: <div class="toc">
                   6837: <p><b>Table of Contents</b></p>
                   6838: <dl class="toc">
                   6839: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">20.1. Files and directories outside the installation prefix</a></span></dt>
                   6840: <dd><dl>
                   6841: <dt><span class="sect2"><a href="#dirs-outside-prefix">20.1.1. Directory manipulation</a></span></dt>
                   6842: <dt><span class="sect2"><a href="#files-outside-prefix">20.1.2. File manipulation</a></span></dt>
                   6843: </dl></dd>
                   6844: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
                   6845: <dd><dl>
                   6846: <dt><span class="sect2"><a href="#conf-files-sysconfdir">20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
                   6847: <dt><span class="sect2"><a href="#conf-files-configure">20.2.2. Telling the software where configuration files are</a></span></dt>
                   6848: <dt><span class="sect2"><a href="#conf-files-patching">20.2.3. Patching installations</a></span></dt>
                   6849: <dt><span class="sect2"><a href="#conf-files-disable">20.2.4. Disabling handling of configuration files</a></span></dt>
                   6850: </dl></dd>
                   6851: <dt><span class="sect1"><a href="#rcd-scripts">20.3. System startup scripts</a></span></dt>
                   6852: <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>
                   6853: <dt><span class="sect1"><a href="#users-and-groups">20.4. System users and groups</a></span></dt>
                   6854: <dt><span class="sect1"><a href="#shells">20.5. System shells</a></span></dt>
                   6855: <dd><dl><dt><span class="sect2"><a href="#shells-disable">20.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   6856: <dt><span class="sect1"><a href="#fonts">20.6. Fonts</a></span></dt>
                   6857: <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>
                   6858: </dl>
                   6859: </div>
                   6860: <p>This chapter describes the framework known as
                   6861: <code class="literal">pkginstall</code>, whose key features are:</p>
                   6862: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6863: <li class="listitem"><p>Generic installation and manipulation of directories and files
                   6864:     outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
                   6865: <li class="listitem"><p>Automatic handling of configuration files during installation,
                   6866:     provided that packages are correctly designed.</p></li>
                   6867: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
                   6868: <li class="listitem"><p>Registration of system users and groups.</p></li>
                   6869: <li class="listitem"><p>Registration of system shells.</p></li>
                   6870: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
                   6871: </ul></div>
                   6872: <p>The following sections inspect each of the above points in detail.</p>
                   6873: <p>You may be thinking that many of the things described here could be
                   6874: easily done with simple code in the package's post-installation target
                   6875: (<code class="literal">post-install</code>).  <span class="emphasis"><em>This is incorrect</em></span>,
                   6876: as the code in them is only executed when building from source.  Machines
                   6877: using binary packages could not benefit from it at all (as the code itself
                   6878: could be unavailable).  Therefore, the only way to achieve any of the items
                   6879: described above is by means of the installation scripts, which are
                   6880: automatically generated by pkginstall.</p>
1.148     asau     6881: <div class="sect1">
1.75      rillig   6882: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6883: <a name="files-and-dirs-outside-prefix"></a>20.1. Files and directories outside the installation prefix</h2></div></div></div>
                   6884: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
                   6885: of files and directories that belong to a package.  The names used in it
                   6886: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
                   6887: which means that it cannot register files outside this directory (absolute
                   6888: path names are not allowed).  Despite this restriction, some packages need
                   6889: to install files outside this location; e.g., under
                   6890: <code class="filename">${VARBASE}</code> or
                   6891: <code class="filename">${PKG_SYSCONFDIR}</code>.  The only way to achieve this
                   6892: is to create such files during installation time by using
                   6893: installation scripts.</p>
                   6894: <p>The generic installation scripts are shell scripts that can
                   6895: contain arbitrary code.  The list of scripts to execute is taken from
                   6896: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
                   6897: <code class="filename">INSTALL</code>.  A similar variable exists for package
                   6898: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
                   6899: <code class="filename">DEINSTALL</code>).  These scripts can run arbitrary
                   6900: commands, so they have the potential to create and manage files
                   6901: anywhere in the file system.</p>
                   6902: <p>Using these general installation files is not recommended, but
                   6903: may be needed in some special cases.  One reason for avoiding them is
                   6904: that the user has to trust the packager that there is no unwanted or
                   6905: simply erroneous code included in the installation script. Also,
                   6906: previously there were many similar scripts for the same functionality,
                   6907: and fixing a common error involved finding and changing all of
                   6908: them.</p>
                   6909: <p>The pkginstall framework offers another, standardized way.  It
                   6910: provides generic scripts to abstract the manipulation of such files
                   6911: and directories based on variables set in the package's
                   6912: <code class="filename">Makefile</code>.  The rest of this section describes
                   6913: these variables.</p>
                   6914: <div class="sect2">
                   6915: <div class="titlepage"><div><div><h3 class="title">
                   6916: <a name="dirs-outside-prefix"></a>20.1.1. Directory manipulation</h3></div></div></div>
                   6917: <p>The following variables can be set to request the creation of
                   6918: directories anywhere in the file system:</p>
                   6919: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6920: <li class="listitem">
                   6921: <p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
                   6922:     contain a list of directories that should be created and should attempt
                   6923:     to be destroyed by the installation scripts.  The difference between
                   6924:     the two is that the latter prompts the administrator to remove any
                   6925:     directories that may be left after deinstallation (because they were
                   6926:     not empty), while the former does not.  Example:</p>
                   6927: <pre class="programlisting">
                   6928: MAKE_DIRS+=             ${VARBASE}/foo/private
                   6929: </pre>
                   6930: </li>
                   6931: <li class="listitem">
                   6932: <p><code class="varname">MAKE_DIRS_PERMS</code> and
                   6933:     <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
                   6934:     which directories should be created and should attempt to be destroyed
                   6935:     by the installation scripts.  Each tuple holds the following values,
                   6936:     separated by spaces: the directory name, its owner, its group and its
                   6937:     numerical mode.  For example:</p>
                   6938: <pre class="programlisting">
                   6939: MAKE_DIRS_PERMS+=       ${VARBASE}/foo/private \
                   6940:                         ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
                   6941: </pre>
                   6942: <p>The difference between the two is exactly the same as their
                   6943:     non-<code class="varname">PERMS</code> counterparts.</p>
                   6944: </li>
                   6945: </ul></div>
1.75      rillig   6946: </div>
1.299     rillig   6947: <div class="sect2">
                   6948: <div class="titlepage"><div><div><h3 class="title">
                   6949: <a name="files-outside-prefix"></a>20.1.2. File manipulation</h3></div></div></div>
                   6950: <p>Creating non-empty files outside the installation prefix is tricky
                   6951: because the <code class="filename">PLIST</code> forces all files to be inside it.
                   6952: To overcome this problem, the only solution is to extract the file in the
                   6953: known place (i.e., inside the installation prefix) and copy it to the
                   6954: appropriate location during installation (done by the installation scripts
                   6955: generated by pkginstall).  We will call the former the <span class="emphasis"><em>master
                   6956: file</em></span> in the following paragraphs, which describe the variables
                   6957: that can be used to automatically and consistently handle files outside the
                   6958: installation prefix:</p>
                   6959: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6960: <li class="listitem">
                   6961: <p><code class="varname">CONF_FILES</code> and
                   6962:     <code class="varname">REQD_FILES</code> are pairs of master and target files.
                   6963:     During installation time, the master file is copied to the target one
                   6964:     if and only if the latter does not exist.  Upon deinstallation, the
                   6965:     target file is removed provided that it was not modified by the
                   6966:     installation.</p>
                   6967: <p>The difference between the two is that the latter prompts the
                   6968:     administrator to remove any files that may be left after
                   6969:     deinstallation (because they were not empty), while the former does
                   6970:     not.</p>
                   6971: </li>
                   6972: <li class="listitem">
                   6973: <p><code class="varname">CONF_FILES_PERMS</code> and
                   6974:     <code class="varname">REQD_FILES_PERMS</code> contain tuples describing master
                   6975:     files as well as their target locations.  For each of them, it also
                   6976:     specifies their owner, their group and their numeric permissions, in
                   6977:     this order.  For example:</p>
1.88      wiz      6978: <pre class="programlisting">
1.299     rillig   6979: REQD_FILES_PERMS+=      ${PREFIX}/share/somefile ${VARBASE}/somefile \
                   6980:                         ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.100     rillig   6981: </pre>
1.299     rillig   6982: <p>The difference between the two is exactly the same as their
                   6983:     non-<code class="varname">PERMS</code> counterparts.</p>
                   6984: </li>
                   6985: </ul></div>
                   6986: </div>
1.75      rillig   6987: </div>
1.148     asau     6988: <div class="sect1">
1.75      rillig   6989: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6990: <a name="conf-files"></a>20.2. Configuration files</h2></div></div></div>
                   6991: <p>Configuration files are special in the sense that they are installed
                   6992: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
                   6993: need special treatment during installation (most of which is automated by
                   6994: pkginstall).  The main concept you must bear in mind is that files marked
                   6995: as configuration files are automatically copied to the right place (somewhere
                   6996: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
                   6997: and only if</em></span> they didn't exist before.  Similarly, they will not
                   6998: be removed if they have local modifications.  This ensures that
                   6999: administrators never lose any custom changes they may have made.</p>
                   7000: <div class="sect2">
                   7001: <div class="titlepage"><div><div><h3 class="title">
                   7002: <a name="conf-files-sysconfdir"></a>20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</h3></div></div></div>
                   7003: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
                   7004: specifies where configuration files shall be installed.  Its contents are
                   7005: set based upon the following variables:</p>
                   7006: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   7007: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
                   7008:     directory.  Defaults to <code class="filename">${PREFIX}/etc</code> although it may
                   7009:     be overridden by the user to point to his preferred location (e.g.,
                   7010:     <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
                   7011:     Packages must not use it directly.</p></li>
                   7012: <li class="listitem">
                   7013: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
                   7014:     <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
                   7015:     for the package being built shall be installed.  The definition of this
                   7016:     variable only makes sense in the package's
                   7017:     <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
                   7018: <p>As an example, consider the Apache package,
                   7019:     <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache24/README.html" target="_top"><code class="filename">www/apache24</code></a>, which places its
                   7020:     configuration files under the
                   7021:     <code class="filename">httpd/</code> subdirectory of
                   7022:     <code class="varname">PKG_SYSCONFBASE</code>.  This should be set in the package
                   7023:     Makefile.</p>
                   7024: </li>
                   7025: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
                   7026:     variable that holds this package's configuration directory (if
                   7027:     different from <code class="varname">PKG_SYSCONFBASE</code>).  It defaults to
                   7028:     <code class="varname">PKGBASE</code>'s value, and is always prefixed with
                   7029:     <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
                   7030: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
                   7031:     directory where the configuration files for the package identified by
                   7032:     <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
                   7033: </ul></div>
                   7034: <p>Based on the above variables, pkginstall determines the value of
                   7035: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
                   7036: variable that can be used within a package to refer to its configuration
                   7037: directory.  The algorithm used to set its value is basically the
                   7038: following:</p>
                   7039: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7040: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
                   7041:     its value is used.</p></li>
                   7042: <li class="listitem"><p>If the previous variable is not defined but
                   7043:     <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
                   7044:     <code class="filename">Makefile</code>, the resulting value is
                   7045:     <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
                   7046: <li class="listitem"><p>Otherwise, it is set to
                   7047:     <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
                   7048: </ol></div>
                   7049: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
                   7050: automatically added to <code class="filename">OWN_DIRS</code>.  See <a class="xref" href="#dirs-outside-prefix" title="20.1.1. Directory manipulation">Section 20.1.1, &#8220;Directory manipulation&#8221;</a> what this means.  This does not apply to
                   7051: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
                   7052: be created with OWN_DIRS or MAKE_DIRS.</p>
                   7053: </div>
                   7054: <div class="sect2">
                   7055: <div class="titlepage"><div><div><h3 class="title">
                   7056: <a name="conf-files-configure"></a>20.2.2. Telling the software where configuration files are</h3></div></div></div>
                   7057: <p>Given that pkgsrc (and users!) expect configuration files to be in a
                   7058: known place, you need to teach each package where it shall install its
                   7059: files.  In some cases you will have to patch the package Makefiles to
                   7060: achieve it.  If you are lucky, though, it may be as easy as passing an
                   7061: extra flag to the configuration script; this is the case of GNU Autoconf-
                   7062: generated files:</p>
1.75      rillig   7063: <pre class="programlisting">
1.299     rillig   7064: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.100     rillig   7065: </pre>
1.299     rillig   7066: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
                   7067: for</em></span> its configuration files, not where they will be originally
                   7068: installed (although the difference is never explicit,
                   7069: unfortunately).</p>
1.75      rillig   7070: </div>
1.299     rillig   7071: <div class="sect2">
                   7072: <div class="titlepage"><div><div><h3 class="title">
                   7073: <a name="conf-files-patching"></a>20.2.3. Patching installations</h3></div></div></div>
                   7074: <p>As said before, pkginstall automatically handles configuration files.
                   7075: This means that <span class="strong"><strong>the packages themselves must not
                   7076: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
                   7077: directly</strong></span>.  Bad news is that many software installation scripts
                   7078: will, out of the box, mess with the contents of that directory.  So what is
                   7079: the correct procedure to fix this issue?</p>
                   7080: <p>You must teach the package (usually by manually patching it) to
                   7081: install any configuration files under the examples hierarchy,
                   7082: <code class="filename">share/examples/${PKGBASE}/</code>.  This way, the
                   7083: <code class="filename">PLIST</code> registers them and the administrator always
                   7084: has the original copies available.</p>
                   7085: <p>Once the required configuration files are in place (i.e., under the
                   7086: examples hierarchy), the pkginstall framework can use them as master copies
                   7087: during the package installation to update what is in
                   7088: <code class="filename">${PKG_SYSCONFDIR}</code>.  To achieve this, the variables
                   7089: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
                   7090: used.  Check out <a class="xref" href="#files-outside-prefix" title="20.1.2. File manipulation">Section 20.1.2, &#8220;File manipulation&#8221;</a> for information
                   7091: about their syntax and their purpose.  Here is an example, taken from the
                   7092: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/mail/mutt/README.html" target="_top"><code class="filename">mail/mutt</code></a> package:</p>
1.88      wiz      7093: <pre class="programlisting">
1.299     rillig   7094: EGDIR=        ${PREFIX}/share/doc/mutt/samples
                   7095: CONF_FILES=   ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
1.100     rillig   7096: </pre>
1.299     rillig   7097: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
                   7098: package and has no meaning outside it.</p>
1.75      rillig   7099: </div>
1.299     rillig   7100: <div class="sect2">
                   7101: <div class="titlepage"><div><div><h3 class="title">
                   7102: <a name="conf-files-disable"></a>20.2.4. Disabling handling of configuration files</h3></div></div></div>
                   7103: <p>The automatic copying of config files can be toggled by setting the
                   7104: environment variable <code class="varname">PKG_CONFIG</code> prior to package
                   7105: installation.</p>
1.88      wiz      7106: </div>
1.75      rillig   7107: </div>
1.148     asau     7108: <div class="sect1">
1.75      rillig   7109: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   7110: <a name="rcd-scripts"></a>20.3. System startup scripts</h2></div></div></div>
                   7111: <p>System startup scripts are special files because they must be
                   7112: installed in a place known by the underlying OS, usually outside the
                   7113: installation prefix.  Therefore, the same rules described in <a class="xref" href="#files-and-dirs-outside-prefix" title="20.1. Files and directories outside the installation prefix">Section 20.1, &#8220;Files and directories outside the installation prefix&#8221;</a> apply, and the same solutions
                   7114: can be used.  However, pkginstall provides a special mechanism to handle
                   7115: these files.</p>
                   7116: <p>In order to provide system startup scripts, the package has
                   7117: to:</p>
                   7118: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7119: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
                   7120:     the <code class="literal">.sh</code> suffix appended.  Considering the
                   7121:     <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/cups/README.html" target="_top"><code class="filename">print/cups</code></a> package as an example, it has a
                   7122:     <code class="filename">cupsd.sh</code> in its files directory.</p></li>
                   7123: <li class="listitem">
                   7124: <p>Tell pkginstall to handle it, appending the name of the script,
                   7125:     without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
                   7126:     Continuing the previous example:</p>
                   7127: <pre class="programlisting">
                   7128: RCD_SCRIPTS+=   cupsd
                   7129: </pre>
                   7130: </li>
                   7131: </ol></div>
                   7132: <p>Once this is done, pkginstall will do the following steps for each
                   7133: script in an automated fashion:</p>
                   7134: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7135: <li class="listitem"><p>Process the file found in the files directory applying all the
                   7136:     substitutions described in the <code class="filename">FILES_SUBST</code>
                   7137:     variable.</p></li>
                   7138: <li class="listitem"><p>Copy the script from the files directory to the examples
                   7139:     hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>.  Note
                   7140:     that this master file must be explicitly registered in the
                   7141:     <code class="filename">PLIST</code>.</p></li>
                   7142: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
                   7143:     from the examples hierarchy into the system-wide startup scripts
                   7144:     directory.</p></li>
                   7145: </ol></div>
                   7146: <div class="sect2">
                   7147: <div class="titlepage"><div><div><h3 class="title">
                   7148: <a name="rcd-scripts-disable"></a>20.3.1. Disabling handling of system startup scripts</h3></div></div></div>
                   7149: <p>The automatic copying of config files can be toggled by setting the
                   7150: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
                   7151: installation.  Note that the scripts will be always copied inside the
                   7152: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
                   7153: matter what the value of this variable is.</p>
1.75      rillig   7154: </div>
                   7155: </div>
1.299     rillig   7156: <div class="sect1">
                   7157: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   7158: <a name="users-and-groups"></a>20.4. System users and groups</h2></div></div></div>
                   7159: <p>If a package needs to create special users and/or groups during
                   7160: installation, it can do so by using the pkginstall framework.</p>
                   7161: <p>Users can be created by adding entries to the
                   7162: <code class="varname">PKG_USERS</code> variable.  Each entry has the following
                   7163: syntax:</p>
                   7164: <pre class="programlisting">
                   7165: user:group
                   7166: </pre>
                   7167: <p>Further specification of user details may be done by setting
                   7168: per-user variables.
                   7169: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
                   7170: numeric UID for the user.
                   7171: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
                   7172: user's description or comment.
                   7173: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
                   7174: user's home directory, and defaults to
                   7175: <code class="filename">/nonexistent</code> if not specified.
                   7176: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
                   7177: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
                   7178: not specified.</p>
                   7179: <p>Similarly, groups can be created by adding entries to the
                   7180: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
                   7181: <pre class="programlisting">
                   7182: group
                   7183: </pre>
                   7184: <p>The numeric GID of the group may be set by defining
                   7185: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
                   7186: <p>If a package needs to create the users and groups at an earlier
                   7187: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to either
                   7188: <code class="literal">configure</code>,<code class="literal">build</code>, or
                   7189: <code class="literal">pre-install</code> to indicate the phase before which the
                   7190: users and groups are created. In this case, the numeric UIDs and GIDs
                   7191: of the created users and groups are automatically hardcoded into the
                   7192: final installation scripts.</p>
1.75      rillig   7193: </div>
1.148     asau     7194: <div class="sect1">
1.75      rillig   7195: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   7196: <a name="shells"></a>20.5. System shells</h2></div></div></div>
                   7197: <p>Packages that install system shells should register them in the shell
                   7198: database, <code class="filename">/etc/shells</code>, to make things easier to the
                   7199: administrator.  This must be done from the installation scripts to keep
                   7200: binary packages working on any system.  pkginstall provides an easy way to
                   7201: accomplish this task.</p>
                   7202: <p>When a package provides a shell interpreter, it has to set the
                   7203: <code class="varname">PKG_SHELL</code> variable to its absolute file name.  This will
                   7204: add some hooks to the installation scripts to handle it.  Consider the
                   7205: following example, taken from <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/zsh/README.html" target="_top"><code class="filename">shells/zsh</code></a>:</p>
                   7206: <pre class="programlisting">
                   7207: PKG_SHELL=      ${PREFIX}/bin/zsh
                   7208: </pre>
                   7209: <div class="sect2">
                   7210: <div class="titlepage"><div><div><h3 class="title">
                   7211: <a name="shells-disable"></a>20.5.1. Disabling shell registration</h3></div></div></div>
                   7212: <p>The automatic registration of shell interpreters can be disabled by
                   7213: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
                   7214: environment variable to <code class="literal">NO</code>.</p>
                   7215: </div>
1.75      rillig   7216: </div>
1.148     asau     7217: <div class="sect1">
1.75      rillig   7218: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   7219: <a name="fonts"></a>20.6. Fonts</h2></div></div></div>
                   7220: <p>Packages that install X11 fonts should update the database files
                   7221: that index the fonts within each fonts directory.  This can easily be
                   7222: accomplished within the pkginstall framework.</p>
                   7223: <p>When a package installs X11 fonts, it must list the directories in
                   7224: which fonts are installed in the
                   7225: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
                   7226: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">&#8220;<span class="quote">ttf</span>&#8221;</span>,
                   7227: <span class="quote">&#8220;<span class="quote">type1</span>&#8221;</span> or <span class="quote">&#8220;<span class="quote">x11</span>&#8221;</span>.  This will add hooks to the
                   7228: installation scripts to run the appropriate commands to update the fonts
                   7229: database files within each of those directories.  For convenience, if the
                   7230: directory path is relative, it is taken to be relative to the package's
                   7231: installation prefix.  Consider the following example, taken from <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/fonts/dbz-ttf/README.html" target="_top"><code class="filename">fonts/dbz-ttf</code></a>:</p>
1.75      rillig   7232: <pre class="programlisting">
1.299     rillig   7233: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF
1.75      rillig   7234: </pre>
1.299     rillig   7235: <div class="sect2">
                   7236: <div class="titlepage"><div><div><h3 class="title">
                   7237: <a name="fonts-disable"></a>20.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
                   7238: <p>The automatic update of fonts databases can be disabled by
                   7239: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
                   7240: environment variable to <code class="literal">NO</code>.</p>
1.75      rillig   7241: </div>
                   7242: </div>
                   7243: </div>
1.148     asau     7244: <div class="chapter">
1.75      rillig   7245: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   7246: <a name="fixes"></a>Chapter 21. Making your package work</h2></div></div></div>
1.75      rillig   7247: <div class="toc">
                   7248: <p><b>Table of Contents</b></p>
1.210     leot     7249: <dl class="toc">
1.267     rillig   7250: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
1.75      rillig   7251: <dd><dl>
1.267     rillig   7252: <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>
                   7253: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
                   7254: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
                   7255: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
                   7256: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
                   7257: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
                   7258: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
                   7259: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
                   7260: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
                   7261: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
                   7262: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                   7263: </dl></dd>
                   7264: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                   7265: <dd><dl>
                   7266: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   7267: <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>
                   7268: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
                   7269: </dl></dd>
                   7270: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   7271: <dd><dl>
                   7272: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
                   7273: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   7274: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
                   7275: </dl></dd>
                   7276: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
                   7277: <dd><dl>
                   7278: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
                   7279: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
                   7280: <dt><span class="sect2"><a href="#perl-scripts">21.4.3. Packages containing perl scripts</a></span></dt>
                   7281: <dt><span class="sect2"><a href="#shell-scripts">21.4.4. Packages containing shell scripts</a></span></dt>
                   7282: <dt><span class="sect2"><a href="#other-programming-languages">21.4.5. Other programming languages</a></span></dt>
                   7283: </dl></dd>
                   7284: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   7285: <dd><dl>
                   7286: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   7287: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.287     rillig   7288: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
                   7289: <dt><span class="sect2"><a href="#undefined-reference">21.5.4. Undefined reference to <span class="quote">&#8220;<span class="quote">...</span>&#8221;</span></a></span></dt>
                   7290: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.267     rillig   7291: </dl></dd>
                   7292: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   7293: <dd><dl>
                   7294: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
                   7295: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
                   7296: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
                   7297: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
                   7298: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
                   7299: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing perl modules</a></span></dt>
                   7300: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
                   7301: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
                   7302: <dt><span class="sect2"><a href="#gconf-data-files">21.6.9. Packages installing GConf data files</a></span></dt>
                   7303: <dt><span class="sect2"><a href="#scrollkeeper-data-files">21.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
                   7304: <dt><span class="sect2"><a href="#x11-fonts">21.6.11. Packages installing X11 fonts</a></span></dt>
                   7305: <dt><span class="sect2"><a href="#gtk2-modules">21.6.12. Packages installing GTK2 modules</a></span></dt>
                   7306: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.13. Packages installing SGML or XML data</a></span></dt>
                   7307: <dt><span class="sect2"><a href="#mime-database">21.6.14. Packages installing extensions to the MIME database</a></span></dt>
                   7308: <dt><span class="sect2"><a href="#intltool">21.6.15. Packages using intltool</a></span></dt>
                   7309: <dt><span class="sect2"><a href="#startup-scripts">21.6.16. Packages installing startup scripts</a></span></dt>
                   7310: <dt><span class="sect2"><a href="#tex-packages">21.6.17. Packages installing TeX modules</a></span></dt>
                   7311: <dt><span class="sect2"><a href="#emulation-packages">21.6.18. Packages supporting running binaries in
1.87      wiz      7312:     emulation</a></span></dt>
1.267     rillig   7313: <dt><span class="sect2"><a href="#hicolor-theme">21.6.19. Packages installing hicolor theme icons</a></span></dt>
                   7314: <dt><span class="sect2"><a href="#desktop-files">21.6.20. Packages installing desktop files</a></span></dt>
1.75      rillig   7315: </dl></dd>
1.267     rillig   7316: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.75      rillig   7317: </dl>
                   7318: </div>
1.148     asau     7319: <div class="sect1">
1.75      rillig   7320: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   7321: <a name="general-operation"></a>21.1. General operation</h2></div></div></div>
1.78      rillig   7322: <p>One appealing feature of pkgsrc is that it runs on many
1.218     rillig   7323:   different platforms. As a result, it is important to ensure,
                   7324:   where possible, that packages in pkgsrc are portable. This
                   7325:   chapter mentions some particular details you should pay
                   7326:   attention to while working on pkgsrc.</p>
1.148     asau     7327: <div class="sect2">
1.78      rillig   7328: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7329: <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   7330: </h3></div></div></div>
1.78      rillig   7331: <p>The pkgsrc user can configure pkgsrc by overriding several
1.87      wiz      7332:     variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.110     hubertf  7333:     which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.87      wiz      7334:     want to use those variables in the preprocessor directives of
1.311     leot     7335:     <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> (for example <code class="literal">.if</code> or
1.87      wiz      7336:     <code class="literal">.for</code>), you need to include the file
                   7337:     <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
                   7338:     loads the user preferences.</p>
1.78      rillig   7339: <p>But note that some variables may not be completely defined
1.219     rillig   7340:     after <code class="filename">../../mk/bsd.prefs.mk</code> has been
                   7341:     included, as they may contain references to variables that are
                   7342:     not yet defined. In shell commands (the lines in
                   7343:     <code class="filename">Makefile</code> that are indented with a tab) this
                   7344:     is no problem, since variables are only expanded when they are
                   7345:     used. But in the preprocessor directives mentioned above and in
                   7346:     dependency lines (of the form <code class="literal">target:
                   7347:     dependencies</code>) the variables are expanded at load
                   7348:     time.</p>
1.148     asau     7349: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.78      rillig   7350: <h3 class="title">Note</h3>
1.218     rillig   7351: <p>To check whether a variable can be used at load time,
                   7352:     run <span class="command"><strong>pkglint -Wall</strong></span> on your package.</p>
1.78      rillig   7353: </div>
                   7354: </div>
1.148     asau     7355: <div class="sect2">
1.78      rillig   7356: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7357: <a name="user-interaction"></a>21.1.2. User interaction</h3></div></div></div>
1.88      wiz      7358: <p>Occasionally, packages require interaction from the user,
                   7359:     and this can be in a number of ways:</p>
1.148     asau     7360: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      7361: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.87      wiz      7362:        interaction such as entering username/password or accepting a
                   7363:        license on a web page.</p></li>
1.128     wiz      7364: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.88      wiz      7365:        passwords.</p></li>
1.128     wiz      7366: <li class="listitem"><p>help to configure the package before it is built</p></li>
                   7367: <li class="listitem"><p>help during the build process</p></li>
                   7368: <li class="listitem"><p>help during the installation of a package</p></li>
1.78      rillig   7369: </ul></div>
1.218     rillig   7370: <p>A package can set the <code class="varname">INTERACTIVE_STAGE</code>
                   7371:     variable to define which stages need interaction. This should be
                   7372:     done in the package's <code class="filename">Makefile</code>, e.g.:</p>
1.75      rillig   7373: <pre class="programlisting">
1.100     rillig   7374: INTERACTIVE_STAGE=      configure install
1.222     sevan    7375: </pre>
1.88      wiz      7376: <p>The user can then decide to skip this package by setting the
1.218     rillig   7377:     <code class="varname">BATCH</code> variable. Packages that require interaction
                   7378:     are also excluded from bulk builds.</p>
1.75      rillig   7379: </div>
1.148     asau     7380: <div class="sect2">
1.75      rillig   7381: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7382: <a name="handling-licenses"></a>21.1.3. Handling licenses</h3></div></div></div>
1.222     sevan    7383: <p>Authors of software can choose the licence under which software
                   7384:     can be copied.  The Free Software Foundation has declared some
                   7385:     licenses "Free", and the Open Source Initiative has a definition of
                   7386:     "Open Source".</p>
                   7387: <p>By default, pkgsrc allows packages with Free or Open Source
                   7388:     licenses to be built.  To allow packages with other licenses to be
                   7389:     built as well, the pkgsrc user needs to add these licenses to the
                   7390:     <code class="varname">ACCEPTABLE_LICENSES</code> variable in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  Note
                   7391:     that this variable only affects which packages may be
                   7392:     <span class="emphasis"><em>built</em></span>, while the license terms often also
                   7393:     restrict the actual use of the package and its redistribution.</p>
1.98      wiz      7394: <p>One might want to only install packages with a BSD license,
1.218     rillig   7395:     or the GPL, and not the other.  The free licenses are added to the
1.222     sevan    7396:     default <code class="varname">ACCEPTABLE_LICENSES</code> variable.  The pkgsrc
1.121     jnemeth  7397:     user can override the default by setting the
                   7398:     <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
1.222     sevan    7399:     of "+=".  The licenses accepted by default are defined in the
                   7400:     <code class="varname">DEFAULT_ACCEPTABLE_LICENSES</code> variable in the file
                   7401:     <code class="filename">pkgsrc/mk/license.mk</code>.</p>
1.78      rillig   7402: <p>The license tag mechanism is intended to address
1.87      wiz      7403:     copyright-related issues surrounding building, installing and
                   7404:     using a package, and not to address redistribution issues (see
                   7405:     <code class="varname">RESTRICTED</code> and
1.222     sevan    7406:     <code class="varname">NO_SRC_ON_FTP</code>, etc.).
1.121     jnemeth  7407:     Packages with redistribution restrictions should set these
                   7408:     tags.</p>
1.98      wiz      7409: <p>Denoting that a package may be copied according to a
                   7410:     particular license is done by placing the license in
1.87      wiz      7411:     <code class="filename">pkgsrc/licenses</code> and setting the
                   7412:     <code class="varname">LICENSE</code> variable to a string identifying the
1.250     leot     7413:     license, e.g. in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/graphics/xv/README.html" target="_top"><code class="filename">graphics/xv</code></a>:</p>
1.87      wiz      7414: <pre class="programlisting">
1.100     rillig   7415: LICENSE=        xv-license
1.222     sevan    7416: </pre>
1.87      wiz      7417: <p>When trying to build, the user will get a notice that the
1.98      wiz      7418:     package is covered by a license which has not been placed in the
                   7419:     <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
1.87      wiz      7420: <pre class="programlisting">
1.100     rillig   7421: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   7422: ===&gt; xv-3.10anb9 has an unacceptable license: xv-license.
                   7423: ===&gt;     To view the license, enter "/usr/bin/make show-license".
                   7424: ===&gt;     To indicate acceptance, add this line to your /etc/mk.conf:
                   7425: ===&gt;     ACCEPTABLE_LICENSES+=xv-license
                   7426: *** Error code 1
1.222     sevan    7427: </pre>
1.110     hubertf  7428: <p>The license can be viewed with <span class="command"><strong>make
1.98      wiz      7429:     show-license</strong></span>, and if the user so chooses, the line
1.110     hubertf  7430:     printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.98      wiz      7431:     convey to pkgsrc that it should not in the future fail because of
                   7432:     that license:</p>
1.78      rillig   7433: <pre class="programlisting">
1.100     rillig   7434: ACCEPTABLE_LICENSES+=xv-license
1.222     sevan    7435: </pre>
                   7436: <p>The use of <code class="varname">LICENSE=shareware</code>,
                   7437:     <code class="varname">LICENSE=no-commercial-use</code>, and similar language
                   7438:     is deprecated because it does not crisply refer to a particular
                   7439:     license text.  Another problem with such usage is that it does not
                   7440:     enable a user to tell pkgsrc to proceed for a single package
                   7441:     without also telling pkgsrc to proceed for all packages with that
                   7442:     tag.</p>
                   7443: <div class="sect3">
                   7444: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   7445: <a name="new-license"></a>21.1.3.1. Adding a package with a new license</h4></div></div></div>
1.154     rodent   7446: <p>When adding a package with a new license, the following steps
                   7447:     are required:</p>
                   7448: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7449: <li class="listitem">
1.284     rillig   7450: <p>Check whether the license qualifies as Free or Open Source by
                   7451:     referencing <a class="ulink" href="https://www.gnu.org/licenses/license-list.en.html" target="_top">Various
                   7452:     Licenses and Comments about Them</a> and <a class="ulink" href="https://opensource.org/licenses/alphabetical" target="_top">Licenses by Name |
1.222     sevan    7453:     Open Source Initiative</a>.  If this is the case, the filename in
                   7454:     <code class="filename">pkgsrc/licenses/</code> does not need the
                   7455:     <code class="filename">-license</code> suffix, and the license name should be
                   7456:     added to:</p>
1.154     rodent   7457: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.284     rillig   7458: <li class="listitem"><p>DEFAULT_ACCEPTABLE_LICENSES in
                   7459:     <code class="filename">pkgsrc/mk/license.mk</code></p></li>
                   7460: <li class="listitem"><p>default_acceptable_licenses in
                   7461:     <code class="filename">pkgsrc/pkgtools/pkg_install/files/lib/license.c</code></p></li>
1.154     rodent   7462: </ul></div>
                   7463: </li>
1.284     rillig   7464: <li class="listitem"><p>The license text should be added to
                   7465:     <code class="filename">pkgsrc/licenses</code> for displaying.  A list of known
                   7466:     licenses can be seen in this directory.</p></li>
1.154     rodent   7467: </ol></div>
1.222     sevan    7468: </div>
                   7469: <div class="sect3">
                   7470: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   7471: <a name="change-license"></a>21.1.3.2. Change to the license</h4></div></div></div>
1.98      wiz      7472: <p>When the license changes (in a way other than formatting),
1.222     sevan    7473:     make sure that the new license has a different name (e.g.,
1.98      wiz      7474:     append the version number if it exists, or the date).  Just
                   7475:     because a user told pkgsrc to build programs under a previous
                   7476:     version of a license does not mean that pkgsrc should build
1.99      rillig   7477:     programs under the new licenses.  The higher-level point is that
1.98      wiz      7478:     pkgsrc does not evaluate licenses for reasonableness; the only
                   7479:     test is a mechanistic test of whether a particular text has been
1.222     sevan    7480:     approved by either of two bodies (FSF or OSI).</p>
                   7481: </div>
1.75      rillig   7482: </div>
1.148     asau     7483: <div class="sect2">
1.75      rillig   7484: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7485: <a name="restricted-packages"></a>21.1.4. Restricted packages</h3></div></div></div>
1.75      rillig   7486: <p>Some licenses restrict how software may be re-distributed.
1.222     sevan    7487:     By declaring the restrictions, package tools can
1.98      wiz      7488:     automatically refrain from e.g. placing binary packages on FTP
                   7489:     sites.</p>
1.222     sevan    7490: <p>There are four possible restrictions, which are
1.98      wiz      7491:     the cross product of sources (distfiles) and binaries not being
                   7492:     placed on FTP sites and CD-ROMs.  Because this is rarely the exact
                   7493:     language in any license, and because non-Free licenses tend to be
                   7494:     different from each other, pkgsrc adopts a definition of FTP and
1.222     sevan    7495:     CD-ROM.
                   7496: 
                   7497:     "FTP" means making the source or binary file available over the
                   7498:     Internet at no charge.
                   7499: 
                   7500:     "CD-ROM" means making the source or binary available on some kind of
                   7501:     media, together with other source and binary packages, which is sold
                   7502:     for a distribution charge.
1.98      wiz      7503:     </p>
                   7504: <p>In order to encode these restrictions, the package system
1.87      wiz      7505:     defines five make variables that can be set to note these
                   7506:     restrictions:</p>
1.148     asau     7507: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      7508: <li class="listitem">
1.75      rillig   7509: <p><code class="varname">RESTRICTED</code></p>
                   7510: <p>This variable should be set whenever a restriction
1.87      wiz      7511:        exists (regardless of its kind).  Set this variable to a
1.98      wiz      7512:        string containing the reason for the restriction.  It should
                   7513:        be understood that those wanting to understand the restriction
                   7514:        will have to read the license, and perhaps seek advice of
                   7515:        counsel.</p>
1.75      rillig   7516: </li>
1.128     wiz      7517: <li class="listitem">
1.75      rillig   7518: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
1.98      wiz      7519: <p>Binaries may not be placed on CD-ROM containing other
                   7520:        binary packages, for which a distribution charge may be made.
                   7521:        In this case, set this variable to
                   7522:        <code class="varname">${RESTRICTED}</code>.</p>
1.75      rillig   7523: </li>
1.128     wiz      7524: <li class="listitem">
1.75      rillig   7525: <p><code class="varname">NO_BIN_ON_FTP</code></p>
1.98      wiz      7526: <p>Binaries may not made available on the Internet without
                   7527:        charge.  In this case, set this variable to
                   7528:        <code class="varname">${RESTRICTED}</code>.  If this variable is set,
                   7529:        binary packages will not be included on ftp.NetBSD.org.</p>
1.75      rillig   7530: </li>
1.128     wiz      7531: <li class="listitem">
1.75      rillig   7532: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
1.98      wiz      7533: <p>Distfiles may not be placed on CD-ROM, together with
                   7534:        other distfiles, for which a fee may be charged.  In this
                   7535:        case, set this variable to <code class="varname">${RESTRICTED}</code>.
                   7536:        </p>
1.75      rillig   7537: </li>
1.128     wiz      7538: <li class="listitem">
1.75      rillig   7539: <p><code class="varname">NO_SRC_ON_FTP</code></p>
1.98      wiz      7540: <p>Distfiles may not made available via FTP at no charge.
                   7541:        In this case, set this variable to
                   7542:        <code class="varname">${RESTRICTED}</code>.  If this variable is set,
                   7543:        the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
1.75      rillig   7544: </li>
                   7545: </ul></div>
1.222     sevan    7546: <p>Please note that packages will be removed from pkgsrc when the
                   7547:     distfiles are not distributable and cannot be obtained for a period
                   7548:     of one full quarter branch. Packages with manual/interactive fetch
                   7549:     must have a maintainer and it is his/her responsibility to ensure
                   7550:     this.</p>
1.75      rillig   7551: </div>
1.148     asau     7552: <div class="sect2">
1.75      rillig   7553: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7554: <a name="dependencies"></a>21.1.5. Handling dependencies</h3></div></div></div>
1.290     gutterid 7555: <p>Your package may depend on some other package being present,
                   7556:     and there are various ways of expressing this dependency.
                   7557:     pkgsrc supports the <code class="varname">DEPENDS</code>,
                   7558:     <code class="varname">BUILD_DEPENDS</code>,
                   7559:     <code class="varname">TOOL_DEPENDS</code>, and
                   7560:     <code class="varname">TEST_DEPENDS</code> definitions, the
1.88      wiz      7561:     <code class="varname">USE_TOOLS</code> definition, as well as dependencies
                   7562:     via <code class="filename">buildlink3.mk</code>, which is the preferred way
                   7563:     to handle dependencies, and which uses the variables named above.
1.299     rillig   7564:     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 7565: <p>The basic difference is that the <code class="varname">DEPENDS</code>
                   7566:     definition registers that pre-requisite in the binary package so it
                   7567:     will be pulled in when the binary package is later installed, whilst
                   7568:     the <code class="varname">BUILD_DEPENDS</code>, <code class="varname">TOOL_DEPENDS</code>,
                   7569:     and <code class="varname">TEST_DEPENDS</code> definitions do not, marking a
                   7570:     dependency that is only needed for building or testing the resulting
1.299     rillig   7571:     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   7572: <p>This means that if you only need a package present whilst
1.290     gutterid 7573:     you are building or testing, it should be noted as a
                   7574:     <code class="varname">TOOL_DEPENDS</code>,
                   7575:     <code class="varname">BUILD_DEPENDS</code>, or
                   7576:     <code class="varname">TEST_DEPENDS</code>.  When cross-compiling,
1.269     leot     7577:     <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
                   7578:     packages, i.e. packages for the architecture where the package
                   7579:     is built;
                   7580:     <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
1.290     gutterid 7581:     packages, i.e., packages for the architecture for which the package
1.269     leot     7582:     is built.</p>
1.290     gutterid 7583: <p>The format for a <code class="varname">DEPENDS</code>,
                   7584:     <code class="varname">BUILD_DEPENDS</code>, <code class="varname">TOOL_DEPENDS</code>,
                   7585:     and <code class="varname">TEST_DEPENDS</code> definition is:</p>
1.75      rillig   7586: <pre class="programlisting">
1.100     rillig   7587: &lt;pre-req-package-name&gt;:../../&lt;category&gt;/&lt;pre-req-package&gt;
1.222     sevan    7588: </pre>
1.128     wiz      7589: <p>Please note that the <span class="quote">&#8220;<span class="quote">pre-req-package-name</span>&#8221;</span>
1.87      wiz      7590:     may include any of the wildcard version numbers recognized by
1.311     leot     7591:     <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/pkg_info.1"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a>.</p>
1.128     wiz      7592: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7593: <li class="listitem">
1.75      rillig   7594: <p>If your package needs another package's binaries or
1.160     wiz      7595:        libraries to build and run, and if that package has a
1.87      wiz      7596:        <code class="filename">buildlink3.mk</code> file available, use it:</p>
1.75      rillig   7597: <pre class="programlisting">
1.100     rillig   7598: .include "../../graphics/jpeg/buildlink3.mk"
1.222     sevan    7599: </pre>
1.75      rillig   7600: </li>
1.128     wiz      7601: <li class="listitem">
1.160     wiz      7602: <p>If your package needs another package's binaries or
                   7603:        libraries only for building, and if that package has a
                   7604:        <code class="filename">buildlink3.mk</code> file available, use it:</p>
                   7605: <pre class="programlisting">
                   7606: .include "../../graphics/jpeg/buildlink3.mk"
1.222     sevan    7607: </pre>
1.160     wiz      7608: <p>but set
                   7609:        <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>jpeg</code></em>?=build</code>
                   7610:        to make it a build dependency only. This case is rather
                   7611:        rare.</p>
                   7612: </li>
                   7613: <li class="listitem">
1.132     spz      7614: <p>If your package needs binaries from another package to build,
1.269     leot     7615:        use the <code class="varname">TOOL_DEPENDS</code> definition:</p>
1.75      rillig   7616: <pre class="programlisting">
1.269     leot     7617: TOOL_DEPENDS+= itstool-[0-9]*:../../textproc/itstool
1.222     sevan    7618: </pre>
1.75      rillig   7619: </li>
1.269     leot     7620: <li class="listitem"><p>If your package needs static libraries to link against, header
                   7621:        files to include, etc. from another package to build,
                   7622:        use the <code class="varname">BUILD_DEPENDS</code> definition.</p></li>
1.132     spz      7623: <li class="listitem"><p>If your package needs a library with which to link and
                   7624:        there is no <code class="filename">buildlink3.mk</code> file
                   7625:        available, create one. Using
                   7626:        <code class="varname">DEPENDS</code> won't be sufficient because the
                   7627:        include files and libraries will be hidden from the compiler.</p></li>
1.128     wiz      7628: <li class="listitem">
1.132     spz      7629: <p>If your package needs some executable to be able to run
                   7630:        correctly and if there's no
                   7631:        <code class="filename">buildlink3.mk</code> file, this is specified
                   7632:        using the <code class="varname">DEPENDS</code> variable. The
1.250     leot     7633:        <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/lyx/README.html" target="_top"><code class="filename">print/lyx</code></a> package needs to
1.242     wiz      7634:        be able to execute the latex binary from the tex-latex-bin package
1.132     spz      7635:        when it runs, and that is specified:</p>
1.75      rillig   7636: <pre class="programlisting">
1.242     wiz      7637: DEPENDS+=        tex-latex-bin-[0-9]*:../../print/tex-latex-bin
1.222     sevan    7638: </pre>
1.132     spz      7639: </li>
1.290     gutterid 7640: <li class="listitem"><p>If your package includes a test suite that has extra
                   7641:         dependencies only required for this purpose (frequently this
                   7642:         can be run as a <span class="quote">&#8220;<span class="quote">make test</span>&#8221;</span> target), use the
                   7643:         <code class="varname">TEST_DEPENDS</code> variable.</p></li>
1.132     spz      7644: <li class="listitem">
                   7645: <p>You can use wildcards in package dependencies. Note that
                   7646:        such wildcard dependencies are retained when creating binary
                   7647:        packages. The dependency is checked when installing the binary
                   7648:        package and any package which matches the pattern will be
                   7649:        used. Wildcard dependencies should be used with care.</p>
1.128     wiz      7650: <p>The <span class="quote">&#8220;<span class="quote">-[0-9]*</span>&#8221;</span> should be used instead of
                   7651:        <span class="quote">&#8220;<span class="quote">-*</span>&#8221;</span> to avoid potentially ambiguous matches
                   7652:        such as <span class="quote">&#8220;<span class="quote">tk-postgresql</span>&#8221;</span> matching a
                   7653:        <span class="quote">&#8220;<span class="quote">tk-*</span>&#8221;</span> <code class="varname">DEPENDS</code>.</p>
1.75      rillig   7654: <p>Wildcards can also be used to specify that a package
1.87      wiz      7655:        will only build against a certain minimum version of a
                   7656:        pre-requisite:</p>
1.75      rillig   7657: <pre class="programlisting">
1.132     spz      7658: DEPENDS+=       ImageMagick&gt;=6.0:../../graphics/ImageMagick
1.222     sevan    7659: </pre>
1.132     spz      7660: <p>This means that the package will build using version 6.0
                   7661:        of ImageMagick or newer. Such a dependency may be warranted
                   7662:        if, for example, the command line options of an executable
                   7663:        have changed.</p>
                   7664: <p>If you need to depend on minimum versions of libraries,
1.298     wiz      7665:        set
                   7666:        <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   7667:        to the appropriate pattern before including its
                   7668:        <code class="filename">buildlink3.mk</code> file, e.g.</p>
                   7669: <pre class="programlisting">
                   7670: BUILDLINK_API_DEPENDS.jpeg+=    jpeg&gt;=9.0
                   7671: .include "../../graphics/jpeg/buildlink3.mk"
                   7672: </pre>
1.75      rillig   7673: <p>For security fixes, please update the package
1.267     rillig   7674:        vulnerabilities file. See <a class="xref" href="#security-handling" title="21.1.9. Handling packages with security problems">Section 21.1.9, &#8220;Handling packages with security problems&#8221;</a> for more
1.87      wiz      7675:        information.</p>
1.75      rillig   7676: </li>
                   7677: </ol></div>
                   7678: <p>If your package needs files from another package to build,
1.87      wiz      7679:     add the relevant distribution files to
                   7680:     <code class="varname">DISTFILES</code>, so they will be extracted
1.250     leot     7681:     automatically. See the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/ghostscript/README.html" target="_top"><code class="filename">print/ghostscript</code></a> package for an example.
1.87      wiz      7682:     (It relies on the jpeg sources being present in source form
                   7683:     during the build.)</p>
1.75      rillig   7684: </div>
1.148     asau     7685: <div class="sect2">
1.75      rillig   7686: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7687: <a name="conflicts"></a>21.1.6. Handling conflicts with other packages</h3></div></div></div>
1.75      rillig   7688: <p>Your package may conflict with other packages a user might
1.87      wiz      7689:     already have installed on his system, e.g. if your package
1.88      wiz      7690:     installs the same set of files as another package in the pkgsrc
1.190     wiz      7691:     tree or has the same <code class="varname">PKGNAME</code>.</p>
1.255     leot     7692: <p>For example, <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/libXaw3d/README.html" target="_top"><code class="filename">x11/libXaw3d</code></a>
                   7693:     and <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/x11/Xaw-Xpm/README.html" target="_top"><code class="filename">x11/Xaw-Xpm</code></a>
                   7694:     install the same shared library, thus you set in
                   7695:     <code class="filename">pkgsrc/x11/libXaw3d/Makefile</code>:</p>
                   7696: <pre class="programlisting">
                   7697: CONFLICTS=      Xaw-Xpm-[0-9]*
                   7698:     </pre>
                   7699: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
                   7700: <pre class="programlisting">
                   7701: CONFLICTS=      libXaw3d-[0-9]*
                   7702:     </pre>
1.311     leot     7703: <p><a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> is able to detect attempts to install packages
1.255     leot     7704:     that conflict with existing packages and abort. However, in many
                   7705:     situations this is too late in the process. Binary package managers
                   7706:     will not know about the conflict until they attempt to install the
                   7707:     package after already downloading it and all its dependencies.
                   7708:     Users may also waste time building a package and its dependencies
                   7709:     only to find out at the end that it conflicts with another package
                   7710:     they have installed.</p>
                   7711: <p>To avoid these issues <code class="varname">CONFLICTS</code> entries
                   7712:     should be added in all cases where it is known that packages conflict
                   7713:     with each other.  These <code class="varname">CONFLICTS</code> entries are
1.311     leot     7714:     exported in <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/pkg_summary.5"><span class="citerefentry"><span class="refentrytitle">pkg_summary</span>(5)</span></a> files and consumed by binary package
1.255     leot     7715:     managers to inform users that packages cannot be installed onto
                   7716:     the target system.</p>
1.75      rillig   7717: </div>
1.148     asau     7718: <div class="sect2">
1.75      rillig   7719: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7720: <a name="not-building-packages"></a>21.1.7. Packages that cannot or should not be built</h3></div></div></div>
1.75      rillig   7721: <p>There are several reasons why a package might be
1.88      wiz      7722:     instructed to not build under certain circumstances.  If the
1.87      wiz      7723:     package builds and runs on most platforms, the exceptions
1.193     dholland 7724:     should be noted with <code class="varname">BROKEN_ON_PLATFORM</code>.  If
                   7725:     the package builds and runs on a small handful of platforms,
                   7726:     set <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> instead.
                   7727:     Both <code class="varname">BROKEN_ON_PLATFORM</code> and
                   7728:     <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> are OS triples
                   7729:     (OS-version-platform) that can use glob-style
                   7730:     wildcards.</p>
                   7731: <p>If a package is not appropriate for some platforms (as
1.225     maya     7732:     opposed to merely broken), a different set of variables should be
1.193     dholland 7733:     used as this affects failure reporting and statistics.
                   7734:     If the package is appropriate for most platforms, the exceptions
1.87      wiz      7735:     should be noted with <code class="varname">NOT_FOR_PLATFORM</code>.  If
1.193     dholland 7736:     the package is appropriate for only a small handful of platforms
                   7737:     (often exactly one), set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
1.87      wiz      7738:     Both <code class="varname">ONLY_FOR_PLATFORM</code> and
                   7739:     <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
                   7740:     (OS-version-platform) that can use glob-style
                   7741:     wildcards.</p>
1.88      wiz      7742: <p>Some packages are tightly bound to a specific version of an
1.250     leot     7743:     operating system, e.g. LKMs or <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/sysutils/lsof/README.html" target="_top"><code class="filename">sysutils/lsof</code></a>.  Such binary packages are not
1.88      wiz      7744:     backwards compatible with other versions of the OS, and should be
                   7745:     uploaded to a version specific directory on the FTP server.  Mark
                   7746:     these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.128     wiz      7747:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.  This variable is not currently used by any of
1.88      wiz      7748:     the package system internals, but may be used in the
                   7749:     future.</p>
1.75      rillig   7750: <p>If the package should be skipped (for example, because it
1.87      wiz      7751:     provides functionality already provided by the system), set
1.88      wiz      7752:     <code class="varname">PKG_SKIP_REASON</code> to a descriptive message.  If
                   7753:     the package should fail because some preconditions are not met,
                   7754:     set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
1.87      wiz      7755:     message.</p>
1.75      rillig   7756: </div>
1.148     asau     7757: <div class="sect2">
1.75      rillig   7758: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7759: <a name="undeletable-packages"></a>21.1.8. Packages which should not be deleted, once installed</h3></div></div></div>
1.75      rillig   7760: <p>To ensure that a package may not be deleted, once it has been
1.87      wiz      7761:     installed, the <code class="varname">PKG_PRESERVE</code> definition should
                   7762:     be set in the package Makefile. This will be carried into any
                   7763:     binary package that is made from this pkgsrc entry. A
1.128     wiz      7764:     <span class="quote">&#8220;<span class="quote">preserved</span>&#8221;</span> package will
1.311     leot     7765:     not be deleted using <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> unless the
1.128     wiz      7766:     <span class="quote">&#8220;<span class="quote">-f</span>&#8221;</span> option is used.</p>
1.75      rillig   7767: </div>
1.148     asau     7768: <div class="sect2">
1.75      rillig   7769: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7770: <a name="security-handling"></a>21.1.9. Handling packages with security problems</h3></div></div></div>
1.75      rillig   7771: <p>When a vulnerability is found, this should be noted in
1.87      wiz      7772:     <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
1.138     wiz      7773:     and after committing that file, ask pkgsrc-security@NetBSD.org to
                   7774:     update the file on ftp.NetBSD.org.</p>
1.75      rillig   7775: <p>After fixing the vulnerability by a patch, its
1.138     wiz      7776:     <code class="varname">PKGREVISION</code> should be increased (this is of
                   7777:     course not necessary if the problem is fixed by using a newer
                   7778:     release of the software), and the pattern in the
                   7779:     pkg-vulnerabilities file must be updated.</p>
1.75      rillig   7780: <p>Also, if the fix should be applied to the stable pkgsrc
1.87      wiz      7781:     branch, be sure to submit a pullup request!</p>
1.75      rillig   7782: <p>Binary packages already on ftp.NetBSD.org will be handled
1.87      wiz      7783:     semi-automatically by a weekly cron job.</p>
1.75      rillig   7784: </div>
1.148     asau     7785: <div class="sect2">
1.75      rillig   7786: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7787: <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   7788: <p>When making fixes to an existing package it can be useful
1.87      wiz      7789:     to change the version number in <code class="varname">PKGNAME</code>. To
                   7790:     avoid conflicting with future versions by the original author, a
1.128     wiz      7791:     <span class="quote">&#8220;<span class="quote">nb1</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">nb2</span>&#8221;</span>, ... suffix can be used
1.87      wiz      7792:     on package versions by setting <code class="varname">PKGREVISION=1</code>
1.128     wiz      7793:     (2, ...). The <span class="quote">&#8220;<span class="quote">nb</span>&#8221;</span> is treated like a
                   7794:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span> by the package tools. e.g.</p>
1.87      wiz      7795: <pre class="programlisting">
1.100     rillig   7796: DISTNAME=       foo-17.42
                   7797: PKGREVISION=    9
1.222     sevan    7798: </pre>
1.75      rillig   7799: <p>will result in a <code class="varname">PKGNAME</code> of
1.128     wiz      7800:     <span class="quote">&#8220;<span class="quote">foo-17.42nb9</span>&#8221;</span>. If you want to use the original
                   7801:     value of <code class="varname">PKGNAME</code> without the <span class="quote">&#8220;<span class="quote">nbX</span>&#8221;</span>
1.87      wiz      7802:     suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
                   7803:     <code class="varname">PKGNAME_NOREV</code>.</p>
1.75      rillig   7804: <p>When a new release of the package is released, the
1.87      wiz      7805:     <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
                   7806:     minor release of the above package, things should be like:</p>
1.75      rillig   7807: <pre class="programlisting">
1.100     rillig   7808: DISTNAME=       foo-17.43
1.222     sevan    7809: </pre>
1.87      wiz      7810: <p><code class="varname">PKGREVISION</code> should be incremented for any
                   7811:     non-trivial change in the resulting binary package.  Without a
                   7812:     <code class="varname">PKGREVISION</code> bump, someone with the previous
                   7813:     version installed has no way of knowing that their package is out
                   7814:     of date.  Thus, changes without increasing
                   7815:     <code class="varname">PKGREVISION</code> are essentially labeled "this is so
                   7816:     trivial that no reasonable person would want to upgrade", and this
                   7817:     is the rough test for when increasing
                   7818:     <code class="varname">PKGREVISION</code> is appropriate.  Examples of
                   7819:     changes that do not merit increasing
                   7820:     <code class="varname">PKGREVISION</code> are:</p>
1.148     asau     7821: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      7822: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.284     rillig   7823:       <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>, or
                   7824:       comments in Makefile.</p></li>
                   7825: <li class="listitem"><p>Changing build variables if the resulting binary
                   7826:       package is the same.</p></li>
                   7827: <li class="listitem"><p>Changing
                   7828:       <code class="filename">DESCR</code>.</p></li>
                   7829: <li class="listitem"><p>Adding <code class="varname">PKG_OPTIONS</code> if the
                   7830:       default options don't change.</p></li>
1.100     rillig   7831: </ul></div>
1.87      wiz      7832: <p>Examples of changes that do merit an increase to
                   7833:     <code class="varname">PKGREVISION</code> include:</p>
1.148     asau     7834: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.284     rillig   7835: <li class="listitem"><p>Security fixes</p></li>
                   7836: <li class="listitem"><p>Changes or additions to a patch
                   7837:       file</p></li>
                   7838: <li class="listitem"><p>Changes to the
                   7839:       <code class="filename">PLIST</code></p></li>
                   7840: <li class="listitem"><p>A dependency is changed or
                   7841:       renamed.</p></li>
1.100     rillig   7842: </ul></div>
1.78      rillig   7843: <p>PKGREVISION must also be incremented when dependencies have ABI
                   7844:     changes.</p>
1.75      rillig   7845: </div>
1.148     asau     7846: <div class="sect2">
1.79      rillig   7847: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7848: <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   7849: <p>When you want to replace the same text in multiple files, or
                   7850: multiple times in the same file, it is cumbersome to maintain a patch
                   7851: file for this. This is where the SUBST framework steps in. It provides an
                   7852: easy-to-use interface for replacing text in files. It just needs the
                   7853: following information:</p>
                   7854: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   7855: <li class="listitem"><p>In which phase of the package build cycle should the
                   7856: replacement happen?</p></li>
                   7857: <li class="listitem"><p>In which files should the replacement
1.287     rillig   7858: happen?</p></li>
1.295     rillig   7859: <li class="listitem"><p>Which text should be replaced with
                   7860: what?</p></li>
1.287     rillig   7861: </ul></div>
                   7862: <p>This information is encoded in a block of <code class="varname">SUBST</code>
1.295     rillig   7863: variables. A minimal example is:</p>
                   7864: <pre class="programlisting">
                   7865: SUBST_CLASSES+=         paths
                   7866: SUBST_STAGE.paths=      pre-configure
                   7867: SUBST_FILES.paths=      src/*.c
                   7868: SUBST_SED.paths=        -e 's,/usr/local,${PREFIX},g'
                   7869: </pre>
                   7870: <p>Translated into English, it means: In the pre-configure stage (that
                   7871: is, after applying the patches from the patches/ directory and before
                   7872: running the configure script and the portability check), replace the text
                   7873: <code class="literal">/usr/local</code> with the content of the variable
                   7874: <code class="varname">PREFIX</code>.</p>
                   7875: <p>Each SUBST block starts by appending an identifier to
                   7876: <code class="varname">SUBST_CLASSES</code> (note the <code class="literal">+=</code>). This
                   7877: identifier can be chosen freely by the package. If there should ever be
                   7878: duplicate identifiers, the pkgsrc infrastructure will catch this and fail
                   7879: early, so don't worry about name collisions.</p>
                   7880: <p>Except for <code class="varname">SUBST_CLASSES</code>, all variables in a
                   7881: SUBST block are parameterized using this identifier. In the remainder of
                   7882: this section, these parameterized variables are written as
                   7883: <code class="varname">SUBST_STAGE.*</code>.</p>
                   7884: <pre class="programlisting">
                   7885: SUBST_CLASSES+=         paths
                   7886: SUBST_STAGE.paths=      pre-configure
                   7887: SUBST_MESSAGE.paths=    Fixing absolute paths.
                   7888: SUBST_FILES.paths=      src/*.c
                   7889: SUBST_FILES.paths+=     scripts/*.sh
                   7890: SUBST_SED.paths=        -e 's,"/usr/local,"${PREFIX},g'
                   7891: SUBST_SED.paths+=       -e 's,"/var/log,"${VARBASE}/log,g'
                   7892: SUBST_VARS.paths=       LOCALBASE PREFIX PKGVERSION
                   7893: </pre>
                   7894: <p>To get a complete picture about the SUBST substitutions, run
                   7895: <span class="command"><strong>bmake show-all-subst</strong></span>. If something doesn't work as
                   7896: expected, run pkglint on the package, which detects several typical
                   7897: mistakes surrounding the SUBST blocks. For any questions that might
                   7898: remain after this, have a look at
                   7899: <code class="filename">mk/subst.mk</code>.</p>
                   7900: <div class="sect3">
                   7901: <div class="titlepage"><div><div><h4 class="title">
                   7902: <a name="fixes.subst.when"></a>21.1.11.1. Choosing the time where the substitutions happen</h4></div></div></div>
                   7903: <p>The <code class="varname">SUBST_STAGE.*</code> is one of
                   7904: {pre,do,post}-{extract,patch,configure,build,test,install}. Of these,
                   7905: <code class="literal">pre-configure</code> is used most often, by far. The most
                   7906: popular stages are, in chronological order:</p>
                   7907: <div class="variablelist"><dl class="variablelist">
                   7908: <dt><span class="term"><code class="literal">post-extract</code></span></dt>
                   7909: <dd>
                   7910: <p>The substitutions are applied immediately after the
                   7911: distfiles are extracted. Running <span class="command"><strong>bmake extract</strong></span> on the
                   7912: package will leave no traces of the original files.</p>
                   7913: <p>When the substitution applies to files for which there is also a
                   7914: patch in the <code class="filename">patches/</code> directory, this means that the
                   7915: patches will be computed based on the result of the substitution. When
                   7916: these patches are sent to the upstream maintainer later, to be fixed in
                   7917: the upstream package, these patches may no longer match what the upstream
                   7918: author is used to. Because of this, <code class="literal">pre-configure</code> is
                   7919: often a better choice.</p>
                   7920: </dd>
                   7921: <dt><span class="term"><code class="literal">pre-configure</code></span></dt>
                   7922: <dd>
                   7923: <p>The substitutions are applied after the patches from the
                   7924: <code class="filename">patches/</code> directory. This makes it possible to run
                   7925: <span class="command"><strong>bmake patch</strong></span> on the package, after which the patches
                   7926: can be edited using the tools pkgvi and mkpatches from the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a> package.</p>
                   7927: <p>When updating the patches, it is helpful to explicitly separate the
                   7928: <span class="command"><strong>bmake patch</strong></span> from the <span class="command"><strong>bmake
                   7929: configure</strong></span>, and to only edit the patches between these commands.
                   7930: Otherwise the substitutions from the SUBST block will end up in the patch
                   7931: file. When this happens in really obvious ways, pkglint will complain
                   7932: about patches that contain a hard-coded <code class="literal">/usr/pkg</code>
                   7933: instead of the correct and intended <code class="literal">@PREFIX@</code>, but it
                   7934: can only detect these really obvious
                   7935: cases.</p>
                   7936: </dd>
                   7937: <dt><span class="term"><code class="literal">do-configure</code></span></dt>
                   7938: <dd><p>This stage should only be used if the package defines a
                   7939: <code class="literal">pre-configure</code> action itself, and the substitution must
                   7940: happen after that. Typical examples are packages that use the
                   7941: <code class="literal">pre-configure</code> stage to regenerate the GNU configure
                   7942: script from
                   7943: <code class="filename">configure.ac</code>.</p></dd>
                   7944: <dt><span class="term"><code class="literal">post-configure</code></span></dt>
                   7945: <dd><p>This stage is used to fix up any mistakes by the
                   7946: configure stage.</p></dd>
                   7947: <dt><span class="term"><code class="literal">pre-build</code></span></dt>
                   7948: <dd><p>This stage should only be used for substitutions that are
                   7949: clearly related to building the package, not for fixing the
                   7950: configuration. Substitutions for pathnames (such as replacing
                   7951: <code class="filename">/usr/local</code> with <code class="literal">${PREFIX}</code>) or
                   7952: user names (such as replacing <code class="literal">@MY_USER@</code> with the
                   7953: actual username) belong in pre-configure or post-configure
                   7954: instead.</p></dd>
                   7955: <dt><span class="term"><code class="literal">post-build</code></span></dt>
                   7956: <dd>
                   7957: <p>Just as with pre-build, this stage should only be used
                   7958: for substitutions that are clearly related to building the package, not
                   7959: for fixing the configuration. Substitutions for pathnames (such as
                   7960: replacing <code class="filename">/usr/local</code> with
                   7961: <code class="literal">${PREFIX}</code>) or user names (such as replacing
                   7962: <code class="literal">@MY_USER@</code> with the actual username) belong in
                   7963: pre-configure or post-configure instead.</p>
                   7964: <p>A typical use is to update pkg-config files to include the rpath
                   7965: compiler options.</p>
                   7966: </dd>
                   7967: <dt><span class="term"><code class="literal">pre-install</code></span></dt>
                   7968: <dd><p>In general, the install phase should be as simple as
                   7969: possible. As with the pre-build and post-build stages, it should not be
                   7970: used to fix pathnames or user names, these belong in pre-configure
                   7971: instead. There are only few legitimate use cases for applying
                   7972: substitutions in this stage.</p></dd>
                   7973: </dl></div>
                   7974: </div>
                   7975: <div class="sect3">
                   7976: <div class="titlepage"><div><div><h4 class="title">
1.296     rillig   7977: <a name="fixes.subst.where"></a>21.1.11.2. Choosing the files where the substitutions happen</h4></div></div></div>
1.295     rillig   7978: <p>The <code class="varname">SUBST_FILES.*</code> variable contains a list of
                   7979: filename patterns. These patterns are relative to
                   7980: <code class="varname">WRKSRC</code> since that is where most substitutions happen.
                   7981: A typical example is:</p>
                   7982: <pre class="programlisting">
                   7983: SUBST_FILES.path=       Makefile */Makefile */*/Makefile *.[ch]
                   7984: </pre>
                   7985: <p>The above patterns, especially the last, are quite broad. The SUBST
                   7986: implementation checks that each filename pattern that is mentioned here
                   7987: has an effect. For example, if none of the
                   7988: <code class="filename">*/*/Makefile</code> files contains the patterns to be found
                   7989: and substituted, that filename pattern is redundant and should be left
1.296     rillig   7990: out. By default, the SUBST framework will complain with an error message.
                   7991: If the text to be substituted occurs in some of the files from a single
                   7992: pattern, but not in all of them, that is totally ok, and the SUBST
1.295     rillig   7993: framework will only print an INFO message for those files.</p>
                   7994: <p>If there is a good reason for having redundant filename patterns,
1.296     rillig   7995: set <code class="varname">SUBST_NOOP_OK.*</code> to <code class="literal">yes</code>.</p>
1.295     rillig   7996: <p>Another popular way of choosing the files for the substitutions is
                   7997: via a shell command, like this:</p>
                   7998: <pre class="programlisting">
1.296     rillig   7999: C_FILES_CMD=            cd ${WRKSRC} &amp;&amp; ${FIND} . -name '*.c'
1.295     rillig   8000: SUBST_FILES.path=       ${C_FILES_CMD:sh}
                   8001: </pre>
                   8002: <p>The variable name <code class="varname">C_FILES_CMD</code> in this example is
                   8003: freely chosen and independent of the SUBST framework.</p>
                   8004: <p>In this variant, the <code class="varname">SUBST_FILES.*</code> variable
                   8005: lists each file individually. Thereby chances are higher that there are
                   8006: filename patterns in which no substitution happens. Since the SUBST
                   8007: framework cannot know whether the filename patterns in
                   8008: <code class="varname">SUBST_FILES.*</code> have been explicitly listed in the
                   8009: Makefile (where any redundant filename pattern would be suspicious) or
                   8010: been generated by a shell command (in which redundant filename patterns
                   8011: are more likely and to be expected), it will complain about these
                   8012: redundant filename patterns. Therefore, SUBST blocks that use a shell
                   8013: command to generate the list of filename patterns often need to set
                   8014: <code class="varname">SUBST_NOOP_OK.*</code> to <code class="literal">yes</code>.</p>
                   8015: </div>
                   8016: <div class="sect3">
                   8017: <div class="titlepage"><div><div><h4 class="title">
                   8018: <a name="fixes.subst.what"></a>21.1.11.3. Choosing what to substitute</h4></div></div></div>
                   8019: <p>In most cases, the substitutions are given using one or more
1.311     leot     8020: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/sed.1"><span class="citerefentry"><span class="refentrytitle">sed</span>(1)</span></a> commands, like this:</p>
1.295     rillig   8021: <pre class="programlisting">
                   8022: SUBST_SED.path=         -e 's|/usr/local|${PREFIX}|g'
                   8023: </pre>
                   8024: <p>Each of the sed commands needs to be preceded by the
                   8025: <code class="literal">-e</code> option and should be specified on a line of its
                   8026: own, to avoid hiding short sed commands at the end of a line.</p>
                   8027: <p>Since the sed commands often contain shell metacharacters as the
                   8028: separator (the <code class="literal">|</code> in the above example), it is common
                   8029: to enclose them in single quotes.</p>
                   8030: <p>A common substitution is to replace placeholders of the form
                   8031: <code class="literal">@VARNAME@</code> with their pkgsrc counterpart variable
                   8032: <code class="literal">${VARNAME}</code>. A typical example is:</p>
                   8033: <pre class="programlisting">
                   8034: SUBST_VARS.path=        PREFIX
                   8035: </pre>
                   8036: <p>This type of substitutions is typically done by the GNU configure
1.296     rillig   8037: scripts during the do-configure stage, but in some cases these need to be
                   8038: overridden. The same pattern is also used when a package defines patches
                   8039: that replace previously hard-coded paths like
                   8040: <code class="literal">/usr/local</code> with a <code class="literal">@PREFIX@</code>
                   8041: placeholder first, which then gets substituted by the actual
                   8042: <code class="literal">${PREFIX}</code> in the pre-configure stage. In many of these
                   8043: cases, it works equally well to just use the SUBST framework to directly
                   8044: replace <code class="literal">/usr/local</code> with <code class="literal">${PREFIX}</code>,
                   8045: thereby omitting the intermediate patch file.</p>
1.295     rillig   8046: <p>If the above is not flexible enough, it is possible to not use sed
                   8047: at all for the substitution but to specify an entirely different command,
                   8048: like this:</p>
1.87      wiz      8049: <pre class="programlisting">
1.295     rillig   8050: SUBST_FILTER_CMD.path=  LC_ALL=C ${TR} -d '\r'
                   8051: </pre>
                   8052: <p>This is used for the few remaining packages in which the
                   8053: distributed files use Windows-style line endings that need to be
                   8054: converted to UNIX-style line endings.</p>
                   8055: </div>
                   8056: <div class="sect3">
                   8057: <div class="titlepage"><div><div><h4 class="title">
                   8058: <a name="fixes.subst.other"></a>21.1.11.4. Other SUBST variables</h4></div></div></div>
                   8059: <p>When a SUBST block is applied during a package build, a message is
                   8060: logged. The default message is fine for most purposes but can be
                   8061: overridden by setting <code class="literal">SUBST_MESSAGE.*</code> to an individual
                   8062: message.</p>
                   8063: </div>
1.79      rillig   8064: </div>
1.75      rillig   8065: </div>
1.148     asau     8066: <div class="sect1">
1.75      rillig   8067: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   8068: <a name="fixes.fetch"></a>21.2. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.148     asau     8069: <div class="sect2">
1.75      rillig   8070: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8071: <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   8072: <p>If you need to download from a dynamic URL you can set
1.110     hubertf  8073:     <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.87      wiz      8074:     fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
                   8075:     with the name of each file to download as an argument, expecting
                   8076:     it to output the URL of the directory from which to download
1.250     leot     8077:     it. <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/graphics/ns-cult3d/README.html" target="_top"><code class="filename">graphics/ns-cult3d</code></a> is an
1.87      wiz      8078:     example of this usage.</p>
1.75      rillig   8079: <p>If the download can't be automated, because the user must
1.87      wiz      8080:     submit personal information to apply for a password, or must pay
                   8081:     for the source, or whatever, you can set
                   8082:     <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
                   8083:     displayed to the user before aborting the build. Example:</p>
                   8084: <pre class="programlisting">
1.100     rillig   8085: FETCH_MESSAGE=  "Please download the files"
                   8086: FETCH_MESSAGE+= "    "${DISTFILES:Q}
                   8087: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.222     sevan    8088: </pre>
1.75      rillig   8089: </div>
1.148     asau     8090: <div class="sect2">
1.75      rillig   8091: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8092: <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   8093: <p>Sometimes authors of a software package make some
1.87      wiz      8094:     modifications after the software was released, and they put up a
                   8095:     new distfile without changing the package's version number. If a
                   8096:     package is already in pkgsrc at that time, the checksum will
                   8097:     no longer match. The contents of the new distfile should be
                   8098:     compared against the old one before changing anything, to make
                   8099:     sure the distfile was really updated on purpose, and that
                   8100:     no trojan horse or so crept in.
1.97      rillig   8101:     Please mention that the distfiles were compared and what was found
1.159     rodent   8102:     in your commit message.</p>
1.220     wiz      8103: <p>Then, the correct way to work around this is to set
                   8104:     <code class="varname">DIST_SUBDIR</code> to a unique directory name, usually
                   8105:     based on <code class="varname">PKGNAME_NOREV</code> (but take care with
                   8106:     python or ruby packages, where <code class="varname">PKGNAME</code> includes
                   8107:     a variable prefix). All <code class="varname">DISTFILES</code> and
1.93      rillig   8108:     <code class="varname">PATCHFILES</code> for this package will be put in that
1.267     rillig   8109:     subdirectory of the local distfiles directory. (See <a class="xref" href="#bumping-pkgrevision" title="21.1.10. How to handle incrementing versions when fixing an existing package">Section 21.1.10, &#8220;How to handle incrementing versions when fixing an existing package&#8221;</a> for more details.) In case this
1.87      wiz      8110:     happens more often, <code class="varname">PKGNAME</code> can be used (thus
1.220     wiz      8111:     including the <code class="filename">nbX</code> suffix) or a date stamp can
                   8112:     be appended, like
                   8113:     <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.</p>
1.284     rillig   8114: <p><code class="varname">DIST_SUBDIR</code> is also used when a distfile's
                   8115:     name does not contain a version and the distfile is apt to change. In
                   8116:     cases where the likelihood of this is very small,
                   8117:     <code class="varname">DIST_SUBDIR</code> might not be required. Additionally,
                   8118:     <code class="varname">DIST_SUBDIR</code> must not be removed unless the
                   8119:     distfile name changes, even if a package is being moved or
                   8120:     renamed.</p>
1.159     rodent   8121: <p>Do not forget regenerating the <code class="filename">distinfo</code> file
1.87      wiz      8122:     after that, since it contains the <code class="varname">DIST_SUBDIR</code>
                   8123:     path in the filenames.
1.159     rodent   8124:     Also, increase the PKGREVISION if the installed package is different.
1.87      wiz      8125:     Furthermore, a mail to the package's authors seems appropriate
                   8126:     telling them that changing distfiles after releases without
                   8127:     changing the file names is not good practice.</p>
1.75      rillig   8128: </div>
1.199     tnn      8129: <div class="sect2">
                   8130: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8131: <a name="build.fetch.github"></a>21.2.3. Packages hosted on github.com</h3></div></div></div>
1.284     rillig   8132: <p>Helper methods exist for packages hosted on github.com which
                   8133:     will often have distfile names that clash with other packages, for
                   8134:     example <code class="filename">1.0.tar.gz</code>. Use one of the three recipes
                   8135:     from below:</p>
1.199     tnn      8136: <div class="sect3">
                   8137: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   8138: <a name="build.fetch.github.tag"></a>21.2.3.1. Fetch based on a tagged release</h4></div></div></div>
1.284     rillig   8139: <p>If your distfile URL looks similar to
1.303     bacon    8140:       <code class="literal">https://github.com/username/example/archive/v1.0.zip</code>,
1.284     rillig   8141:       then you are packaging a tagged release.</p>
1.199     tnn      8142: <pre class="programlisting">
1.303     bacon    8143: DISTNAME=       example-1.0
1.200     tnn      8144: MASTER_SITES=   ${MASTER_SITE_GITHUB:=username/}
1.303     bacon    8145: #GITHUB_PROJECT= example    # can be omitted if same as DISTNAME
1.200     tnn      8146: GITHUB_TAG=     v${PKGVERSION_NOREV}
1.199     tnn      8147: EXTRACT_SUFX=   .zip
                   8148: </pre>
                   8149: </div>
                   8150: <div class="sect3">
                   8151: <div class="titlepage"><div><div><h4 class="title">
1.303     bacon    8152: <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>
                   8153: <p>If your distfile looks similar to
                   8154:       <code class="literal">https://github.com/username/example/archive/988881adc9fc3655077dc2d4d757d480b5ea0e11</code> and is from a commit before the first
                   8155:       release, then set the package version to 0.0.0.N, where N is the number
                   8156:       of commits to the repository, and set GITHUB_TAG to the commit hash.
                   8157:       This will (almost) ensure that the first tagged release will have a
                   8158:       version greater than this one so that package upgrades will function
                   8159:       properly.</p>
                   8160: <pre class="programlisting">
                   8161: DISTNAME=       example-0.0.0.347
                   8162: MASTER_SITES=   ${MASTER_SITE_GITHUB:=username/}
                   8163: #GITHUB_PROJECT= example    # can be omitted if same as DISTNAME
                   8164: GITHUB_TAG=     988881adc9fc3655077dc2d4d757d480b5ea0e11
                   8165: </pre>
                   8166: </div>
                   8167: <div class="sect3">
                   8168: <div class="titlepage"><div><div><h4 class="title">
                   8169: <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>
                   8170: <p>If your distfile looks similar to
                   8171:       <code class="literal">https://github.com/username/example/archive/988881adc9fc3655077dc2d4d757d480b5ea0e11</code> and is from a commit after a release,
                   8172:       then include the last release version and the commit count since that
                   8173:       release in the package version and set GITHUB_TAG to the commit hash.
                   8174:       The latest release and commit count are shown in the output of
                   8175:       "git describe --tags":
                   8176:       </p>
                   8177: <pre class="screen">
                   8178: # git clone https://github.com/username/example
                   8179: # cd example
                   8180: # git describe --tags
                   8181: 1.2.3-5-g988881a
                   8182: </pre>
1.199     tnn      8183: <pre class="programlisting">
1.303     bacon    8184: DISTNAME=       example-1.2.3.5
                   8185: MASTER_SITES=   ${MASTER_SITE_GITHUB:=username/}
                   8186: #GITHUB_PROJECT= example    # can be omitted if same as DISTNAME
1.200     tnn      8187: GITHUB_TAG=     988881adc9fc3655077dc2d4d757d480b5ea0e11
1.222     sevan    8188: </pre>
1.199     tnn      8189: </div>
                   8190: <div class="sect3">
                   8191: <div class="titlepage"><div><div><h4 class="title">
1.303     bacon    8192: <a name="build.fetch.github.release"></a>21.2.3.4. Fetch based on release</h4></div></div></div>
1.284     rillig   8193: <p>If your distfile URL looks similar to
1.303     bacon    8194:       <code class="literal">https://github.com/username/example/releases/download/rel-1.6/offensive-1.6.zip</code>,
1.284     rillig   8195:       then you are packaging a release.</p>
1.199     tnn      8196: <pre class="programlisting">
                   8197: DISTNAME=       offensive-1.6
1.200     tnn      8198: PKGNAME=        ${DISTNAME:S/offensive/proper/}
                   8199: MASTER_SITES=   ${MASTER_SITE_GITHUB:=username/}
1.303     bacon    8200: GITHUB_PROJECT= example
1.200     tnn      8201: GITHUB_RELEASE= rel-${PKGVERSION_NOREV} # usually just set this to ${DISTNAME}
                   8202: EXTRACT_SUFX=   .zip
1.222     sevan    8203: </pre>
1.199     tnn      8204: </div>
                   8205: </div>
1.75      rillig   8206: </div>
1.148     asau     8207: <div class="sect1">
1.75      rillig   8208: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   8209: <a name="fixes.configure"></a>21.3. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.148     asau     8210: <div class="sect2">
1.75      rillig   8211: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8212: <a name="fixes.libtool"></a>21.3.1. Shared libraries - libtool</h3></div></div></div>
1.75      rillig   8213: <p>pkgsrc supports many different machines, with different
1.87      wiz      8214:     object formats like a.out and ELF, and varying abilities to do
                   8215:     shared library and dynamic loading at all. To accompany this,
                   8216:     varying commands and options have to be passed to the
                   8217:     compiler, linker, etc. to get the Right Thing, which can be
                   8218:     pretty annoying especially if you don't have all the machines
                   8219:     at your hand to test things.  The
1.250     leot     8220:     <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/libtool/README.html" target="_top"><code class="filename">devel/libtool</code></a> pkg
1.128     wiz      8221:     can help here, as it just <span class="quote">&#8220;<span class="quote">knows</span>&#8221;</span> how to build
1.87      wiz      8222:     both static and dynamic libraries from a set of source files,
                   8223:     thus being platform-independent.</p>
                   8224: <p>Here's how to use libtool in a package in seven simple
                   8225:     steps:</p>
1.128     wiz      8226: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8227: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.87      wiz      8228:        Makefile.</p></li>
1.128     wiz      8229: <li class="listitem"><p>For library objects, use <span class="quote">&#8220;<span class="quote">${LIBTOOL} --mode=compile
                   8230:        ${CC}</span>&#8221;</span> in place of <span class="quote">&#8220;<span class="quote">${CC}</span>&#8221;</span>. You could even
1.87      wiz      8231:        add it to the definition of <code class="varname">CC</code>, if only
                   8232:        libraries are being built in a given Makefile. This one command
                   8233:        will build both PIC and non-PIC library objects, so you need not
                   8234:        have separate shared and non-shared library rules.</p></li>
1.128     wiz      8235: <li class="listitem">
1.75      rillig   8236: <p>For the linking of the library, remove any
1.128     wiz      8237:        <span class="quote">&#8220;<span class="quote">ar</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">ranlib</span>&#8221;</span>, and <span class="quote">&#8220;<span class="quote">ld
                   8238:        -Bshareable</span>&#8221;</span> commands, and instead use:</p>
1.75      rillig   8239: <pre class="programlisting">
1.100     rillig   8240: ${LIBTOOL} --mode=link \
                   8241:     ${CC} -o ${.TARGET:.a=.la} \
                   8242:         ${OBJS:.o=.lo} \
                   8243:         -rpath ${PREFIX}/lib \
                   8244:         -version-info major:minor
1.222     sevan    8245: </pre>
1.75      rillig   8246: <p>Note that the library is changed to have a
1.87      wiz      8247:        <code class="filename">.la</code> extension, and the objects are
                   8248:        changed to have a <code class="filename">.lo</code>
                   8249:        extension. Change <code class="varname">OBJS</code> as
                   8250:        necessary. This automatically creates all of the
                   8251:        <code class="filename">.a</code>,
                   8252:        <code class="filename">.so.major.minor</code>, and ELF symlinks (if
                   8253:        necessary) in the build directory. Be sure to include
1.128     wiz      8254:        <span class="quote">&#8220;<span class="quote">-version-info</span>&#8221;</span>, especially when major and
1.87      wiz      8255:        minor are zero, as libtool will otherwise strip off the
                   8256:        shared library version.</p>
1.75      rillig   8257: <p>From the libtool manual:</p>
                   8258: <pre class="programlisting">
1.100     rillig   8259: So, libtool library versions are described by three integers:
1.69      rillig   8260: 
1.100     rillig   8261: CURRENT
                   8262: The most recent interface number that this library implements.
1.69      rillig   8263: 
1.100     rillig   8264: REVISION
                   8265: The implementation number of the CURRENT interface.
1.69      rillig   8266: 
1.100     rillig   8267: AGE
                   8268: The difference between the newest and oldest interfaces that
                   8269: this library implements.  In other words, the library implements
                   8270: all the interface numbers in the range from number `CURRENT -
                   8271: AGE' to `CURRENT'.
1.1       grant    8272: 
1.100     rillig   8273: If two libraries have identical CURRENT and AGE numbers, then the
                   8274: dynamic linker chooses the library with the greater REVISION number.
1.222     sevan    8275: </pre>
1.128     wiz      8276: <p>The <span class="quote">&#8220;<span class="quote">-release</span>&#8221;</span> option will produce
1.87      wiz      8277:        different results for a.out and ELF (excluding symlinks)
                   8278:        in only one case. An ELF library of the form
1.128     wiz      8279:        <span class="quote">&#8220;<span class="quote">libfoo-release.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>&#8221;</span>
1.87      wiz      8280:        will have a symlink of
1.128     wiz      8281:        <span class="quote">&#8220;<span class="quote">libfoo.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>&#8221;</span>
1.87      wiz      8282:        on an a.out platform. This is handled
                   8283:        automatically.</p>
1.128     wiz      8284: <p>The <span class="quote">&#8220;<span class="quote">-rpath argument</span>&#8221;</span> is the install
1.87      wiz      8285:        directory of the library being built.</p>
1.76      rillig   8286: <p>In the <code class="filename">PLIST</code>, include only the
1.87      wiz      8287:        <code class="filename">.la</code> file, the other files will be
                   8288:        added automatically.</p>
1.75      rillig   8289: </li>
1.128     wiz      8290: <li class="listitem">
1.76      rillig   8291: <p>When linking shared object (<code class="filename">.so</code>)
1.311     leot     8292:        files, i.e. files that are loaded via <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/dlopen.3"><span class="citerefentry"><span class="refentrytitle">dlopen</span>(3)</span></a>, NOT
1.128     wiz      8293:        shared libraries, use <span class="quote">&#8220;<span class="quote">-module
                   8294:        -avoid-version</span>&#8221;</span> to prevent them getting version
1.87      wiz      8295:        tacked on.</p>
1.76      rillig   8296: <p>The <code class="filename">PLIST</code> file gets the
1.87      wiz      8297:        <code class="filename">foo.so</code> entry.</p>
1.75      rillig   8298: </li>
1.128     wiz      8299: <li class="listitem">
1.75      rillig   8300: <p>When linking programs that depend on these libraries
1.87      wiz      8301:        <span class="emphasis"><em>before</em></span> they are installed, preface
1.311     leot     8302:        the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/cc.1"><span class="citerefentry"><span class="refentrytitle">cc</span>(1)</span></a> or <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/ld.1"><span class="citerefentry"><span class="refentrytitle">ld</span>(1)</span></a> line with <span class="quote">&#8220;<span class="quote">${LIBTOOL}
1.128     wiz      8303:        --mode=link</span>&#8221;</span>, and it will find the correct
1.87      wiz      8304:        libraries (static or shared), but please be aware that
                   8305:        libtool will not allow you to specify a relative path in
1.128     wiz      8306:        -L (such as <span class="quote">&#8220;<span class="quote">-L../somelib</span>&#8221;</span>), because it
1.87      wiz      8307:        expects you to change that argument to be the
                   8308:        <code class="filename">.la</code> file. e.g.</p>
1.75      rillig   8309: <pre class="programlisting">
1.100     rillig   8310: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.222     sevan    8311: </pre>
1.75      rillig   8312: <p>should be changed to:</p>
                   8313: <pre class="programlisting">
1.100     rillig   8314: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.222     sevan    8315: </pre>
1.75      rillig   8316: <p>and it will do the right thing with the libraries.</p>
                   8317: </li>
1.128     wiz      8318: <li class="listitem">
1.311     leot     8319: <p>When installing libraries, preface the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/install.1"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a>
                   8320:        or <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/cp.1"><span class="citerefentry"><span class="refentrytitle">cp</span>(1)</span></a> command with <span class="quote">&#8220;<span class="quote">${LIBTOOL}
1.128     wiz      8321:        --mode=install</span>&#8221;</span>, and change the library name to
1.87      wiz      8322:        <code class="filename">.la</code>. e.g.</p>
1.75      rillig   8323: <pre class="programlisting">
1.126     jakllsch 8324: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.222     sevan    8325: </pre>
1.76      rillig   8326: <p>This will install the static <code class="filename">.a</code>,
1.87      wiz      8327:        shared library, any needed symlinks, and run
1.311     leot     8328:        <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/ldconfig.8"><span class="citerefentry"><span class="refentrytitle">ldconfig</span>(8)</span></a>.</p>
1.75      rillig   8329: </li>
1.128     wiz      8330: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.87      wiz      8331:        the <code class="filename">.la</code>
                   8332:        file (this is a change from previous behaviour).</p></li>
1.75      rillig   8333: </ol></div>
                   8334: </div>
1.148     asau     8335: <div class="sect2">
1.75      rillig   8336: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8337: <a name="using-libtool"></a>21.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.75      rillig   8338: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
1.87      wiz      8339:     package Makefile. This will override the package's own libtool
                   8340:     in most cases.  For older libtool using packages,  libtool is
                   8341:     made by ltconfig script during the do-configure step; you can
1.110     hubertf  8342:     check the libtool script location by doing <span class="command"><strong>make
1.87      wiz      8343:     configure; find work*/ -name libtool</strong></span>.</p>
1.75      rillig   8344: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
1.87      wiz      8345:     scripts, relative to <code class="varname">WRKSRC</code>, to override.  By
1.128     wiz      8346:     default, it is set to <span class="quote">&#8220;<span class="quote">libtool */libtool
                   8347:     */*/libtool</span>&#8221;</span>.  If this does not match the location of the
1.87      wiz      8348:     package's libtool script(s), set it as appropriate.</p>
1.76      rillig   8349: <p>If you do not need <code class="filename">*.a</code> static
1.87      wiz      8350:     libraries built and installed, then use
                   8351:     <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
1.75      rillig   8352: <p>If your package makes use of the platform-independent library
1.87      wiz      8353:     for loading dynamic shared objects, that comes with libtool
                   8354:     (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
                   8355: <p>Some packages use libtool incorrectly so that the package
                   8356:     may not work or build in some circumstances. Some of the more
                   8357:     common errors are:</p>
1.148     asau     8358: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      8359: <li class="listitem">
1.75      rillig   8360: <p>The inclusion of a shared object (-module) as a dependent library in an
1.87      wiz      8361:        executable or library. This in itself isn't a problem if one of two things
                   8362:        has been done:</p>
1.128     wiz      8363: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8364: <li class="listitem"><p>The shared object is named correctly, i.e.
1.87      wiz      8365:            <code class="filename">libfoo.la</code>, not
                   8366:            <code class="filename">foo.la</code></p></li>
1.128     wiz      8367: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.75      rillig   8368: </ol></div>
                   8369: </li>
1.128     wiz      8370: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.87      wiz      8371:        The function lt_dlinit() should be called and the macro
                   8372:        <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
                   8373:        executables.</p></li>
1.75      rillig   8374: </ul></div>
                   8375: </div>
1.148     asau     8376: <div class="sect2">
1.75      rillig   8377: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8378: <a name="autoconf-automake"></a>21.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.75      rillig   8379: <p>If a package needs GNU autoconf or automake to be executed
1.87      wiz      8380:     to regenerate the configure script and Makefile.in makefile
                   8381:     templates, then they should be executed in a pre-configure
                   8382:     target.</p>
1.75      rillig   8383: <p>For packages that need only autoconf:</p>
                   8384: <pre class="programlisting">
1.100     rillig   8385: AUTOCONF_REQD=  2.50            # if default version is not good enough
                   8386: USE_TOOLS+=     autoconf        # use "autoconf213" for autoconf-2.13
                   8387: ...
1.1       grant    8388: 
1.100     rillig   8389: pre-configure:
                   8390:         cd ${WRKSRC} &amp;&amp; autoconf
1.1       grant    8391: 
1.100     rillig   8392: ...
1.222     sevan    8393: </pre>
1.75      rillig   8394: <p>and for packages that need automake and autoconf:</p>
                   8395: <pre class="programlisting">
1.100     rillig   8396: AUTOMAKE_REQD=  1.7.1           # if default version is not good enough
                   8397: USE_TOOLS+=     automake        # use "automake14" for automake-1.4
                   8398: ...
                   8399: 
                   8400: pre-configure:
                   8401:         set -e; cd ${WRKSRC}; \
                   8402:         aclocal; autoheader; automake -a --foreign -i; autoconf
1.1       grant    8403: 
1.100     rillig   8404: ...
1.222     sevan    8405: </pre>
1.75      rillig   8406: <p>Packages which use GNU Automake will almost certainly
1.87      wiz      8407:     require GNU Make.</p>
1.75      rillig   8408: <p>There are times when the configure process makes
1.87      wiz      8409:     additional changes to the generated files, which then causes
                   8410:     the build process to try to re-execute the automake sequence.
                   8411:     This is prevented by touching various files in the configure
                   8412:     stage. If this causes problems with your package you can set
                   8413:     <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
                   8414:     Makefile.</p>
1.75      rillig   8415: </div>
                   8416: </div>
1.148     asau     8417: <div class="sect1">
1.75      rillig   8418: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   8419: <a name="programming-languages"></a>21.4. Programming languages</h2></div></div></div>
1.148     asau     8420: <div class="sect2">
1.87      wiz      8421: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8422: <a name="basic-programming-languages"></a>21.4.1. C, C++, and Fortran</h3></div></div></div>
1.87      wiz      8423: <p>Compilers for the C, C++, and Fortran languages comes with
                   8424:     the NetBSD base system.  By default, pkgsrc assumes that a package
                   8425:     is written in C and will hide all other compilers (via the wrapper
1.299     rillig   8426:     framework, see <a class="xref" href="#buildlink" title="Chapter 18. Buildlink methodology">Chapter 18, <i>Buildlink methodology</i></a>).</p>
1.87      wiz      8427: <p>To declare which language's compiler a package needs, set
                   8428:     the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.128     wiz      8429:     currently are <span class="quote">&#8220;<span class="quote">c</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">c++</span>&#8221;</span>, and
                   8430:     <span class="quote">&#8220;<span class="quote">fortran</span>&#8221;</span> (and any combination).  The default is
                   8431:     <span class="quote">&#8220;<span class="quote">c</span>&#8221;</span>.  Packages using GNU configure scripts, even if
1.87      wiz      8432:     written in C++, usually need a C compiler for the configure
                   8433:     phase.</p>
                   8434: </div>
1.148     asau     8435: <div class="sect2">
1.87      wiz      8436: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8437: <a name="java-programming-language"></a>21.4.2. Java</h3></div></div></div>
1.87      wiz      8438: <p>If a program is written in Java, use the Java framework in
                   8439:     pkgsrc.  The package must include
                   8440:     <code class="filename">../../mk/java-vm.mk</code>.  This Makefile fragment
                   8441:     provides the following variables:</p>
1.148     asau     8442: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      8443: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.87      wiz      8444:       dependency on the JDK is added.  If
1.128     wiz      8445:       <code class="varname">USE_JAVA</code> is set to <span class="quote">&#8220;<span class="quote">run</span>&#8221;</span>, then
1.87      wiz      8446:       there is only a runtime dependency on the JDK.  The default is
1.128     wiz      8447:       <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>, which also adds a build dependency on the
1.87      wiz      8448:       JDK.</p></li>
1.128     wiz      8449: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.87      wiz      8450:       a package needs a Java2 implementation.  The supported values
1.128     wiz      8451:       are <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">1.4</span>&#8221;</span>, and
                   8452:       <span class="quote">&#8220;<span class="quote">1.5</span>&#8221;</span>.  <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> accepts any Java2
                   8453:       implementation, <span class="quote">&#8220;<span class="quote">1.4</span>&#8221;</span> insists on versions 1.4 or
                   8454:       above, and <span class="quote">&#8220;<span class="quote">1.5</span>&#8221;</span> only accepts versions 1.5 or
1.87      wiz      8455:       above. This variable is not set by default.</p></li>
1.130     wiz      8456: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
                   8457:       automatically set to the runtime location of the used Java
                   8458:       implementation dependency. It may be used to set
                   8459:       <code class="varname">JAVA_HOME</code> to a good value if the program
                   8460:       needs this variable to be defined.
                   8461:       </p></li>
1.87      wiz      8462: </ul></div>
                   8463: </div>
1.148     asau     8464: <div class="sect2">
1.87      wiz      8465: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8466: <a name="perl-scripts"></a>21.4.3. Packages containing perl scripts</h3></div></div></div>
1.87      wiz      8467: <p>If your package contains interpreted perl scripts, add
1.128     wiz      8468:     <span class="quote">&#8220;<span class="quote">perl</span>&#8221;</span> to the <code class="varname">USE_TOOLS</code> variable
1.87      wiz      8469:     and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
                   8470:     interpreter path is set. <code class="varname">REPLACE_PERL</code> should
                   8471:     contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
1.183     wiz      8472:     that you want adjusted. Every occurrence of
                   8473:     <code class="filename">*/bin/perl</code> in a she-bang line will be
                   8474:     replaced with the full path to the perl executable.</p>
1.87      wiz      8475: <p>If a particular version of perl is needed, set the
                   8476:     <code class="varname">PERL5_REQD</code> variable to the version number.  The
1.128     wiz      8477:     default is <span class="quote">&#8220;<span class="quote">5.0</span>&#8221;</span>.</p>
1.267     rillig   8478: <p>See <a class="xref" href="#perl-modules" title="21.6.6. Packages installing perl modules">Section 21.6.6, &#8220;Packages installing perl modules&#8221;</a> for information
1.87      wiz      8479:     about handling perl modules.</p>
                   8480: </div>
1.148     asau     8481: <div class="sect2">
1.87      wiz      8482: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8483: <a name="shell-scripts"></a>21.4.4. Packages containing shell scripts</h3></div></div></div>
1.147     wiz      8484: <p><code class="varname">REPLACE_SH</code>,
                   8485:     <code class="varname">REPLACE_BASH</code>, <code class="varname">REPLACE_CSH</code>,
                   8486:     and <code class="varname">REPLACE_KSH</code> can be used to replace shell
1.309     gutterid 8487:     hash bangs in files. Please use the appropriate one, preferring
1.147     wiz      8488:     <code class="varname">REPLACE_SH</code> in case this shell is sufficient.
1.183     wiz      8489:     Each should contain a list of scripts, relative to
                   8490:     <code class="varname">WRKSRC</code>, that you want adjusted. Every
                   8491:     occurrence of the matching shell in a she-bang line will be
                   8492:     replaced with the full path to the shell executable.
1.147     wiz      8493:     When using <code class="varname">REPLACE_BASH</code>, don't forget to add
                   8494:     <code class="filename">bash</code> to <code class="varname">USE_TOOLS</code>.</p>
                   8495: </div>
1.148     asau     8496: <div class="sect2">
1.147     wiz      8497: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8498: <a name="other-programming-languages"></a>21.4.5. Other programming languages</h3></div></div></div>
1.87      wiz      8499: <p>Currently, there is no special handling for other languages
                   8500:     in pkgsrc.  If a compiler package provides a
                   8501:     <code class="filename">buildlink3.mk</code> file, include that, otherwise
                   8502:     just add a (build) dependency on the appropriate compiler
                   8503:     package.</p>
                   8504: </div>
                   8505: </div>
1.148     asau     8506: <div class="sect1">
1.87      wiz      8507: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   8508: <a name="fixes.build"></a>21.5. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.77      rillig   8509: <p>The most common failures when building a package are that
                   8510:        some platforms do not provide certain header files, functions or
                   8511:        libraries, or they provide the functions in a library that the
                   8512:        original package author didn't know. To work around this, you
                   8513:        can rewrite the source code in most cases so that it does not
                   8514:        use the missing functions or provides a replacement function.</p>
1.148     asau     8515: <div class="sect2">
1.77      rillig   8516: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8517: <a name="fixes.build.cpp"></a>21.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.77      rillig   8518: <p>If a package already comes with a GNU configure script, the
                   8519:        preferred way to fix the build failure is to change the
                   8520:        configure script, not the code. In the other cases, you can
                   8521:        utilize the C preprocessor, which defines certain macros
                   8522:        depending on the operating system and hardware architecture it
                   8523:        compiles for. These macros can be queried using for example
                   8524:        <code class="varname">#if defined(__i386)</code>. Almost every operating
                   8525:        system, hardware architecture and compiler has its own macro.
                   8526:        For example, if the macros <code class="varname">__GNUC__</code>,
                   8527:        <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
                   8528:        are all defined, you know that you are using NetBSD on an i386
                   8529:        compatible CPU, and your compiler is GCC.</p>
                   8530: <p>The list of the following macros for hardware and
                   8531:        operating system depends on the compiler that is used. For
                   8532:        example, if you want to conditionally compile code on Solaris,
                   8533:        don't use <code class="varname">__sun__</code>, as the SunPro compiler
                   8534:        does not define it. Use <code class="varname">__sun</code> instead.</p>
1.148     asau     8535: <div class="sect3">
1.75      rillig   8536: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   8537: <a name="fixes.build.cpp.os"></a>21.5.1.1. C preprocessor macros to identify the operating system</h4></div></div></div>
1.75      rillig   8538: <p>To distinguish between 4.4 BSD-derived systems and the
                   8539:         rest of the world, you should use the following code.</p>
                   8540: <pre class="programlisting">
1.100     rillig   8541: #include &lt;sys/param.h&gt;
                   8542: #if (defined(BSD) &amp;&amp; BSD &gt;= 199306)
                   8543: /* BSD-specific code goes here */
                   8544: #else
                   8545: /* non-BSD-specific code goes here */
                   8546: #endif
1.75      rillig   8547: </pre>
1.77      rillig   8548: <p>If this distinction is not fine enough, you can also test
                   8549:        for the following macros.</p>
1.75      rillig   8550: <pre class="programlisting">
1.151     obache   8551: Cygwin      __CYGWIN__
                   8552: DragonFly   __DragonFly__
1.100     rillig   8553: FreeBSD     __FreeBSD__
1.151     obache   8554: Haiku       __HAIKU__
1.100     rillig   8555: Interix     __INTERIX
                   8556: IRIX        __sgi (TODO: get a definite source for this)
                   8557: Linux       linux, __linux, __linux__
1.193     dholland 8558: Mac OS X    __APPLE__
1.151     obache   8559: MirBSD      __MirBSD__ (__OpenBSD__ is also defined)
                   8560: Minix3      __minix
1.100     rillig   8561: NetBSD      __NetBSD__
                   8562: OpenBSD     __OpenBSD__
                   8563: Solaris     sun, __sun
1.75      rillig   8564: </pre>
                   8565: </div>
1.148     asau     8566: <div class="sect3">
1.75      rillig   8567: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   8568: <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   8569: <pre class="programlisting">
1.100     rillig   8570: i386        i386, __i386, __i386__
                   8571: MIPS        __mips
                   8572: SPARC       sparc, __sparc
1.75      rillig   8573: </pre>
                   8574: </div>
1.148     asau     8575: <div class="sect3">
1.75      rillig   8576: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   8577: <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   8578: <pre class="programlisting">
1.100     rillig   8579: GCC         __GNUC__ (major version), __GNUC_MINOR__
                   8580: MIPSpro     _COMPILER_VERSION (0x741 for MIPSpro 7.41)
                   8581: SunPro      __SUNPRO_C (0x570 for Sun C 5.7)
                   8582: SunPro C++  __SUNPRO_CC (0x580 for Sun C++ 5.8)
1.75      rillig   8583: </pre>
                   8584: </div>
                   8585: </div>
1.148     asau     8586: <div class="sect2">
1.78      rillig   8587: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8588: <a name="compiler-bugs"></a>21.5.2. How to handle compiler bugs</h3></div></div></div>
1.78      rillig   8589: <p>Some source files trigger bugs in the compiler, based on
1.87      wiz      8590:         combinations of compiler version and architecture and almost
                   8591:         always relation to optimisation being enabled.  Common symptoms
                   8592:         are gcc internal errors or never finishing compiling a
1.78      rillig   8593:        file.</p>
                   8594: <p>Typically, a workaround involves testing the
                   8595:         <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
                   8596:         optimisation for that combination of file,
1.198     tnn      8597:        <code class="varname">MACHINE_ARCH</code> and compiler.</p>
                   8598: <p>This used to be a big problem in the past, but is rarely
                   8599:        needed now as compiler technology has matured. If you still need
                   8600:        to add a compiler specific workaround, please do so in the file
                   8601:        <code class="filename">hacks.mk</code> and describe the symptom and
                   8602:        compiler version as detailed as possible.</p>
1.78      rillig   8603: </div>
1.148     asau     8604: <div class="sect2">
1.78      rillig   8605: <div class="titlepage"><div><div><h3 class="title">
1.287     rillig   8606: <a name="fixes.build.header"></a>21.5.3. No such file or directory</h3></div></div></div>
                   8607: <p>Compilation sometimes fails with an error message like this:</p>
                   8608: <pre class="programlisting">
                   8609: .../x11/gtk3/work/gtk+-3.24.12/gdk/gdktypes.h:35:10:
                   8610:     fatal error: pango/pango.h: No such file or directory
                   8611: </pre>
                   8612: <p>The proper way to fix this problem depends on the type of the
                   8613: header, which is described in the following sections.</p>
                   8614: <div class="sect3">
                   8615: <div class="titlepage"><div><div><h4 class="title">
                   8616: <a name="fixes.build.header.bl3"></a>21.5.3.1. Headers from other packages</h4></div></div></div>
                   8617: <p>If the header name looks like it comes from a different package,
                   8618: that other package should be included via the buildlink3
                   8619: framework.</p>
                   8620: <p>First, look whether the header is somewhere in the buildlink3
                   8621: directory below <code class="varname">WRKDIR</code>. In the above case of
                   8622: the missing Pango header:</p>
                   8623: <pre class="programlisting">
                   8624: <code class="prompt">$</code> find work/.buildlink/ -print | grep -F pango/pango.h
                   8625: </pre>
                   8626: <p>In the case of Pango, the output is:</p>
                   8627: <pre class="programlisting">
                   8628: work/.buildlink/include/pango-1.0/pango/pango.h
                   8629: </pre>
                   8630: <p>If the <code class="filename">pango/pango.h</code> file were placed directly
                   8631: in the <code class="filename">.buildlink</code> directory, it would have been
                   8632: found automatically. There is an extra <code class="filename">pango-1.0</code>
                   8633: path component though, which means that the compiler command line must
                   8634: contain an option of the form
                   8635: <code class="literal">-I${BUILDLINK3_PREFIX.pango}/include/pango-1.0</code>. In
                   8636: most cases this option is generated by the configure script, which can be examined using:</p>
                   8637: <pre class="programlisting">
                   8638: <code class="prompt">$</code> $ grep -o '[-]I[^[:space:]]*/pango[^[:space:]]*' work/*/Makefile
                   8639: -I/usr/pkg/include/pango-1.0
                   8640: -I/usr/pkg/include/pango-1.0
                   8641: -I/usr/pkg/include/pango-1.0
                   8642: -I/usr/pkg/include/pango-1.0
                   8643: -I/usr/pkg/include/pango-1.0
                   8644: </pre>
                   8645: <p>This looks good. These options are transformed by the buildlink
                   8646: wrapper to refer to the correct path inside
                   8647: <code class="filename">work/.buildlink</code>.</p>
                   8648: <p>Since the compilation fails though, examine the compiler command
                   8649: lines in <code class="filename">work/.work.log</code> to see whether the
                   8650: <code class="literal">-I</code> option is included in the particular command
                   8651: line.</p>
                   8652: <p>To further analyze the situation, run <span class="command"><strong>bmake
                   8653: build-env</strong></span>, which sets up an interactive, realistic environment
                   8654: including all the pkgsrc wrapper commands and environment variables. From
                   8655: there, try to compile some simple example programs that use the
                   8656: header.</p>
                   8657: </div>
                   8658: <div class="sect3">
                   8659: <div class="titlepage"><div><div><h4 class="title">
                   8660: <a name="fixes.build.header.gen"></a>21.5.3.2. Headers generated during the build</h4></div></div></div>
                   8661: <p>If the name of the header seems to come from the package itself,
                   8662: and if the build is run with parallel jobs, the package may have some
                   8663: undeclared dependencies between the <code class="filename">.c</code> and the
                   8664: <code class="filename">.h</code> files, and a C file is compiled before its
                   8665: required header is generated.</p>
                   8666: <p>To see whether the build runs with parallel jobs, run
                   8667: <span class="command"><strong>bmake show-all-build | grep JOBS</strong></span>. Its output looks
                   8668: like this:</p>
                   8669: <pre class="programlisting">
                   8670:   usr   MAKE_JOBS=              7
                   8671:   pkg   MAKE_JOBS_SAFE          # undefined
                   8672:   def   _MAKE_JOBS_N=           7
                   8673: </pre>
                   8674: <p>In this case the pkgsrc user has asked pkgsrc to build packages
                   8675: with 7 jobs in parallel (<code class="varname">MAKE_JOBS</code>). The
                   8676: package could have disabled parallel builds by setting
                   8677: <code class="varname">MAKE_JOBS_SAFE</code> to <code class="literal">no</code>, but
                   8678: in this case it hasn't.</p>
                   8679: <p>To see whether the build failure is caused by parallel builds,
                   8680: first save the exact error message and a bit of context, maybe you need
                   8681: it later for reporting a bug. Next, run:</p>
                   8682: <pre class="programlisting">
                   8683: MAKE_JOBS_SAFE=no bmake clean build
                   8684: </pre>
                   8685: <p>If that succeeds, <a class="ulink" href="https://www.NetBSD.org/cgi-bin/sendpr.cgi?gndb=netbsd" target="_top">file a bug
                   8686: report</a> against the pkgsrc package, including the exact error
                   8687: message and the contents of your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file.</p>
                   8688: </div>
1.288     rillig   8689: <div class="sect3">
                   8690: <div class="titlepage"><div><div><h4 class="title">
                   8691: <a name="fixes.build.header.symlink"></a>21.5.3.3. Symlinks</h4></div></div></div>
                   8692: <p>Pkgsrc does not work reliably if any of
                   8693: <code class="varname">LOCALBASE</code>, <code class="varname">VARBASE</code> or
                   8694: <code class="varname">WRKDIR</code> contains a symlink. Since 2019Q2, the pkgsrc
                   8695: bootstrap program prevents installing pkgsrc in symlink-based
                   8696: directories. Existing pkgsrc installations are not checked for symlinks
                   8697: though.</p>
                   8698: <p>The "No such file or directory" error messages are a typical
                   8699: symptom of symlinks, and it's quite difficult to find out that this is
                   8700: the actual cause.</p>
                   8701: </div>
                   8702: <div class="sect3">
                   8703: <div class="titlepage"><div><div><h4 class="title">
                   8704: <a name="fixes.build.header.stale"></a>21.5.3.4. Stale working directories</h4></div></div></div>
                   8705: <p>When building a hierarchy of packages, it may happen that one
                   8706: package is built and then pkgsrc is updated. This situation can provoke
                   8707: various hard to diagnose build errors. To clean up the situation:</p>
                   8708: <pre class="programlisting">
                   8709: <code class="prompt">$</code> (cd ../../ &amp;&amp; test -f mk/bsd.pkg.mk &amp;&amp; rm -rf */*/work)
                   8710: </pre>
                   8711: <p>(The test for <code class="filename">bsd.pkg.mk</code> just prevents running
                   8712: this command in the wrong directory.)</p>
                   8713: <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
                   8714: that directory as well.</p>
                   8715: </div>
                   8716: <div class="sect3">
                   8717: <div class="titlepage"><div><div><h4 class="title">
                   8718: <a name="fixes.build.header.misc"></a>21.5.3.5. Other possible reasons</h4></div></div></div>
                   8719: <p>On platforms other than BSD, third-party packages are installed in
                   8720: <code class="filename">/usr/include</code>, together with the base system. This
                   8721: means that pkgsrc cannot distinguish between headers provided by the base
                   8722: system (which it needs) and headers from third-party packages (which are
                   8723: often included in pkgsrc as well). This can lead to subtle version
                   8724: mismatches.</p>
                   8725: <p>In pkgsrc installations that have been active for several years, it
                   8726: may happen that some files are manually deleted. To exclude this unlikely
                   8727: reason, run <span class="command"><strong>pkg_admin check</strong></span>.</p>
                   8728: <p>It may help to run <span class="command"><strong>pkg_admin rebuild-tree</strong></span> to
                   8729: check/fix dependencies.</p>
                   8730: <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>
                   8731: for contact information. Be prepared to describe what you have tried so
                   8732: far and what any error messages were.</p>
                   8733: </div>
1.287     rillig   8734: </div>
                   8735: <div class="sect2">
                   8736: <div class="titlepage"><div><div><h3 class="title">
                   8737: <a name="undefined-reference"></a>21.5.4. Undefined reference to <span class="quote">&#8220;<span class="quote">...</span>&#8221;</span>
1.128     wiz      8738: </h3></div></div></div>
1.92      rillig   8739: <p>This error message often means that a package did not
1.78      rillig   8740:        link to a shared library it needs. The following functions are
                   8741:        known to cause this error message over and over.</p>
                   8742: <div class="informaltable">
1.216     tnn      8743: <a name="undefined-reference-functions"></a><table class="informaltable" border="1">
1.78      rillig   8744: <colgroup>
                   8745: <col>
                   8746: <col>
                   8747: <col>
                   8748: </colgroup>
                   8749: <thead><tr>
                   8750: <th>Function</th>
                   8751: <th>Library</th>
                   8752: <th>Affected platforms</th>
                   8753: </tr></thead>
                   8754: <tbody>
                   8755: <tr>
                   8756: <td>accept, bind, connect</td>
                   8757: <td>-lsocket</td>
                   8758: <td>Solaris</td>
                   8759: </tr>
                   8760: <tr>
                   8761: <td>crypt</td>
                   8762: <td>-lcrypt</td>
                   8763: <td>DragonFly, NetBSD</td>
                   8764: </tr>
                   8765: <tr>
                   8766: <td>dlopen, dlsym</td>
                   8767: <td>-ldl</td>
                   8768: <td>Linux</td>
                   8769: </tr>
                   8770: <tr>
                   8771: <td>gethost*</td>
                   8772: <td>-lnsl</td>
                   8773: <td>Solaris</td>
                   8774: </tr>
                   8775: <tr>
                   8776: <td>inet_aton</td>
                   8777: <td>-lresolv</td>
                   8778: <td>Solaris</td>
                   8779: </tr>
                   8780: <tr>
                   8781: <td>nanosleep, sem_*, timer_*</td>
                   8782: <td>-lrt</td>
                   8783: <td>Solaris</td>
                   8784: </tr>
                   8785: <tr>
                   8786: <td>openpty</td>
                   8787: <td>-lutil</td>
                   8788: <td>Linux</td>
                   8789: </tr>
                   8790: </tbody>
                   8791: </table>
                   8792: </div>
                   8793: <p>To fix these linker errors, it is often sufficient to say
1.87      wiz      8794:     <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
                   8795:     -l<em class="replaceable"><code>foo</code></em></code> to the package
1.110     hubertf  8796:     <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
1.87      wiz      8797:     bmake</strong></span>.</p>
1.148     asau     8798: <div class="sect3">
1.92      rillig   8799: <div class="titlepage"><div><div><h4 class="title">
1.287     rillig   8800: <a name="undefined-reference-sunpro"></a>21.5.4.1. Special issue: The SunPro compiler</h4></div></div></div>
1.92      rillig   8801: <p>When you are using the SunPro compiler, there is another
                   8802: possibility. That compiler cannot handle the following code:</p>
                   8803: <pre class="programlisting">
1.100     rillig   8804: extern int extern_func(int);
1.93      rillig   8805: 
1.100     rillig   8806: static inline int
                   8807: inline_func(int x)
                   8808: {
1.92      rillig   8809:         return extern_func(x);
1.100     rillig   8810: }
1.93      rillig   8811: 
1.100     rillig   8812: int main(void)
                   8813: {
1.92      rillig   8814:         return 0;
1.100     rillig   8815: }
1.92      rillig   8816: </pre>
                   8817: <p>It generates the code for <code class="function">inline_func</code> even if
                   8818: that function is never used. This code then refers to
                   8819: <code class="function">extern_func</code>, which can usually not be resolved. To
                   8820: solve this problem you can try to tell the package to disable inlining
                   8821: of functions.</p>
                   8822: </div>
1.87      wiz      8823: </div>
1.148     asau     8824: <div class="sect2">
1.87      wiz      8825: <div class="titlepage"><div><div><h3 class="title">
1.287     rillig   8826: <a name="out-of-memory"></a>21.5.5. Running out of memory</h3></div></div></div>
1.87      wiz      8827: <p>Sometimes packages fail to build because the compiler runs
                   8828:     into an operating system specific soft limit.  With the
                   8829:     <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
1.204     wiz      8830:     to unlimit the resources.  Currently, the allowed values are any combination of
                   8831:     <span class="quote">&#8220;<span class="quote">cputime</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">datasize</span>&#8221;</span>,
                   8832:     <span class="quote">&#8220;<span class="quote">memorysize</span>&#8221;</span>, and <span class="quote">&#8220;<span class="quote">stacksize</span>&#8221;</span>.
1.87      wiz      8833:     Setting this variable is similar to running the shell builtin
1.110     hubertf  8834:     <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.87      wiz      8835:     segment size or maximum stack size of a process, respectively, to
                   8836:     their hard limits.</p>
1.78      rillig   8837: </div>
1.75      rillig   8838: </div>
1.148     asau     8839: <div class="sect1">
1.75      rillig   8840: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   8841: <a name="fixes.install"></a>21.6. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.148     asau     8842: <div class="sect2">
1.75      rillig   8843: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8844: <a name="install-scripts"></a>21.6.1. Creating needed directories</h3></div></div></div>
1.110     hubertf  8845: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.87      wiz      8846:     with some operating systems cannot create more than one
                   8847:     directory at a time. As such, you should call
                   8848:     <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
                   8849: <pre class="programlisting">
1.100     rillig   8850: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
                   8851: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.222     sevan    8852: </pre>
1.128     wiz      8853: <p>You can also just append <span class="quote">&#8220;<span class="quote"><code class="literal">dir1
                   8854:     dir2</code></span>&#8221;</span> to the
1.87      wiz      8855:     <code class="varname">INSTALLATION_DIRS</code> variable, which will
                   8856:     automatically do the right thing.</p>
1.75      rillig   8857: </div>
1.148     asau     8858: <div class="sect2">
1.75      rillig   8859: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8860: <a name="where-to-install-documentation"></a>21.6.2. Where to install documentation</h3></div></div></div>
1.83      wiz      8861: <p>In general, documentation should be installed into
1.87      wiz      8862:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
                   8863:     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
                   8864:     includes the version number of the package).</p>
1.84      wiz      8865: <p>Many modern packages using GNU autoconf allow to set the
1.87      wiz      8866:     directory where HTML documentation is installed with the
1.128     wiz      8867:     <span class="quote">&#8220;<span class="quote">--with-html-dir</span>&#8221;</span> option. Sometimes using this flag
1.87      wiz      8868:     is needed because otherwise the documentation ends up in
                   8869:     <code class="filename">${PREFIX}/share/doc/html</code> or other
                   8870:     places.</p>
                   8871: <p>An exception to the above is that library API documentation
1.250     leot     8872:     generated with the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/textproc/gtk-doc/README.html" target="_top"><code class="filename">textproc/gtk-doc</code></a> tools, for use by special
1.87      wiz      8873:     browsers (devhelp) should be left at their default location, which
                   8874:     is <code class="filename">${PREFIX}/share/gtk-doc</code>.  Such
                   8875:     documentation can be recognized from files ending in
                   8876:     <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
                   8877:     (It is also acceptable to install such files in
                   8878:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
                   8879:     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
                   8880:     <code class="filename">.devhelp*</code> file must be directly in that
                   8881:     directory then, no additional subdirectory level is allowed in
                   8882:     this case. This is usually achieved by using
1.128     wiz      8883:     <span class="quote">&#8220;<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>&#8221;</span>.
1.87      wiz      8884:     <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
                   8885:     though.)</p>
1.75      rillig   8886: </div>
1.148     asau     8887: <div class="sect2">
1.75      rillig   8888: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8889: <a name="installing-score-files"></a>21.6.3. Installing highscore files</h3></div></div></div>
1.75      rillig   8890: <p>Certain packages, most of them in the games category, install
1.87      wiz      8891:     a score file that allows all users on the system to record their
                   8892:     highscores.  In order for this to work, the binaries need to be
                   8893:     installed setgid and the score files owned by the appropriate
1.142     wiz      8894:     group and/or owner (traditionally the "games" user/group).  Set
                   8895:     <code class="varname">USE_GAMESGROUP</code> to yes to support this. The
1.87      wiz      8896:     following variables, documented in more detail in
                   8897:     <code class="filename">mk/defaults/mk.conf</code>, control this
1.142     wiz      8898:     behaviour: <code class="varname">GAMEDATAMODE</code>,
                   8899:     <code class="varname">GAMEDIRMODE</code>, <code class="varname">GAMES_GROUP</code>,
1.210     leot     8900:     <code class="varname">GAMEMODE</code>, <code class="varname">GAME_USER</code>.
                   8901:     Other useful variables are: <code class="varname">GAMEDIR_PERMS</code>,
                   8902:     <code class="varname">GAMEDATA_PERMS</code> and
                   8903:     <code class="varname">SETGID_GAMES_PERMS</code>.</p>
                   8904: <p>An example that illustrates some of the variables described above is
                   8905:     <code class="filename">games/moon-buggy</code>. <code class="varname">OWN_DIRS_PERMS</code> is
                   8906:     used to properly set directory permissions of the directory where the
                   8907:     scorefile is saved, <code class="varname">REQD_FILES_PERMS</code> is used to create a
                   8908:     dummy scorefile (<code class="filename">mbscore</code>) with the proper permissions
                   8909:     and <code class="varname">SPECIAL_PERMS</code> is used to install setgid the game
                   8910:     binary:</p>
                   8911: <pre class="programlisting">
1.223     rillig   8912: USE_GAMESGROUP=         yes
1.210     leot     8913: 
1.223     rillig   8914: BUILD_DEFS+=            VARBASE
1.210     leot     8915: 
1.223     rillig   8916: OWN_DIRS_PERMS+=        ${VARBASE}/games/moon-buggy ${GAMEDIR_PERMS}
                   8917: REQD_FILES_PERMS+=      /dev/null ${VARBASE}/games/moon-buggy/mbscore ${GAMEDATA_PERMS}
                   8918: SPECIAL_PERMS+=         ${PREFIX}/bin/moon-buggy ${SETGID_GAMES_PERMS}
1.222     sevan    8919: </pre>
1.210     leot     8920: <p>Various <code class="varname">INSTALL_*</code> variables are also available:
                   8921:     <code class="varname">INSTALL_GAME</code> to install setgid game binaries,
                   8922:     <code class="varname">INSTALL_GAME_DIR</code> to install game directories that are
                   8923:     needed to be accessed by setgid games and
                   8924:     <code class="varname">INSTALL_GAME_DATA</code> to install scorefiles.</p>
1.114     jmcneill 8925: <p>A package should therefore never hard code file ownership or
1.210     leot     8926:     access permissions but rely on <code class="varname">*_PERMS</code> as described above
                   8927:     or alternatively on <code class="varname">INSTALL_GAME</code>,
                   8928:     <code class="varname">INSTALL_GAME_DATA</code> and
                   8929:     <code class="varname">INSTALL_GAME_DIR</code> to set these correctly.</p>
1.75      rillig   8930: </div>
1.148     asau     8931: <div class="sect2">
1.75      rillig   8932: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8933: <a name="destdir-support"></a>21.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.114     jmcneill 8934: <p><code class="varname">DESTDIR</code> support means that a package
                   8935:     installs into a staging directory, not the final location of the
                   8936:     files. Then a binary package is created which can be used for
                   8937:     installation as usual. There are two ways: Either the package must
1.128     wiz      8938:     install as root (<span class="quote">&#8220;<span class="quote">destdir</span>&#8221;</span>) or the package can
                   8939:     install as non-root user (<span class="quote">&#8220;<span class="quote">user-destdir</span>&#8221;</span>).</p>
1.148     asau     8940: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      8941: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
1.224     leot     8942:       set to <span class="quote">&#8220;<span class="quote">destdir</span>&#8221;</span> or <span class="quote">&#8220;<span class="quote">user-destdir</span>&#8221;</span>.
                   8943:       By default <code class="varname">PKG_DESTDIR_SUPPORT</code>
1.145     wiz      8944:       is set to <span class="quote">&#8220;<span class="quote">user-destdir</span>&#8221;</span> to help catching more
                   8945:       potential packaging problems. If bsd.prefs.mk is included in the Makefile,
1.114     jmcneill 8946:       <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
                   8947:       the inclusion.</p></li>
1.128     wiz      8948: <li class="listitem"><p>All installation operations have to be prefixed with
1.103     wiz      8949:       <code class="filename">${DESTDIR}</code>.</p></li>
1.128     wiz      8950: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.103     wiz      8951:       automatically. Many manual rules and pre/post-install often are
                   8952:       incorrect; fix them.</p></li>
1.128     wiz      8953: <li class="listitem"><p>If files are installed with special owner/group
1.118     imil     8954:       use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.128     wiz      8955: <li class="listitem"><p>In general, packages should support
1.103     wiz      8956:       <code class="varname">UNPRIVILEGED</code> to be able to use
                   8957:       DESTDIR.</p></li>
                   8958: </ul></div>
                   8959: </div>
1.148     asau     8960: <div class="sect2">
1.103     wiz      8961: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8962: <a name="hardcoded-paths"></a>21.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.87      wiz      8963: <p>Your package may also contain scripts with hardcoded paths to
                   8964:       other interpreters besides (or as well as) perl.  To correct the
                   8965:       full pathname to the script interpreter, you need to set the
                   8966:       following definitions in your <code class="filename">Makefile</code> (we
1.110     hubertf  8967:     shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.87      wiz      8968: <pre class="programlisting">
1.100     rillig   8969: REPLACE_INTERPRETER+=   tcl
                   8970: REPLACE.tcl.old=        .*/bin/tclsh
                   8971: REPLACE.tcl.new=        ${PREFIX}/bin/tclsh
                   8972: REPLACE_FILES.tcl=      # list of tcl scripts which need to be fixed,
                   8973: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.222     sevan    8974: </pre>
1.148     asau     8975: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   8976: <h3 class="title">Note</h3>
                   8977: <p>Before March 2006, these variables were called
1.87      wiz      8978:     <code class="varname">_REPLACE.*</code> and
                   8979:     <code class="varname">_REPLACE_FILES.*</code>.</p>
1.75      rillig   8980: </div>
                   8981: </div>
1.148     asau     8982: <div class="sect2">
1.75      rillig   8983: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8984: <a name="perl-modules"></a>21.6.6. Packages installing perl modules</h3></div></div></div>
1.75      rillig   8985: <p>Makefiles of packages providing perl5 modules should include
1.87      wiz      8986:     the Makefile fragment
                   8987:     <code class="filename">../../lang/perl5/module.mk</code>.  It provides a
1.110     hubertf  8988:     <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.87      wiz      8989:     configuration for such modules as well as various hooks to tune
                   8990:     this configuration.  See comments in this file for
                   8991:     details.</p>
1.75      rillig   8992: <p>Perl5 modules will install into different places depending
1.87      wiz      8993:     on the version of perl used during the build process.  To
                   8994:     address this, pkgsrc will append lines to the
                   8995:     <code class="filename">PLIST</code> corresponding to the files listed in
                   8996:     the installed <code class="filename">.packlist</code> file generated by
                   8997:     most perl5 modules.  This is invoked by defining
                   8998:     <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
1.153     wiz      8999:     packlist files relative to <code class="varname">PERL5_PACKLIST_DIR</code>
                   9000:     (<code class="varname">PERL5_INSTALLVENDORARCH</code> by default),
                   9001:     e.g.:</p>
1.75      rillig   9002: <pre class="programlisting">
1.153     wiz      9003: PERL5_PACKLIST= auto/Pg/.packlist
1.222     sevan    9004: </pre>
1.153     wiz      9005: <p>The perl5 config variables
                   9006:     <code class="varname">installarchlib</code>,
                   9007:     <code class="varname">installscript</code>,
                   9008:     <code class="varname">installvendorbin</code>,
                   9009:     <code class="varname">installvendorscript</code>,
                   9010:     <code class="varname">installvendorarch</code>,
                   9011:     <code class="varname">installvendorlib</code>,
                   9012:     <code class="varname">installvendorman1dir</code>, and
                   9013:     <code class="varname">installvendorman3dir</code> represent those
                   9014:     locations in which components of perl5 modules may be installed,
                   9015:     provided as variable with uppercase and prefixed with
                   9016:     <code class="varname">PERL5_</code>, e.g. <code class="varname">PERL5_INSTALLARCHLIB</code>
                   9017:     and may be used by perl5 packages that don't have a packlist.
                   9018:     These variables are also substituted for in the
                   9019:     <code class="filename">PLIST</code> as uppercase prefixed with
                   9020:     <code class="varname">PERL5_SUB_</code>.</p>
1.75      rillig   9021: </div>
1.148     asau     9022: <div class="sect2">
1.75      rillig   9023: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   9024: <a name="faq.info-files"></a>21.6.7. Packages installing info files</h3></div></div></div>
1.75      rillig   9025: <p>Some packages install info files or use the
1.128     wiz      9026:     <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span>  or <span class="quote">&#8220;<span class="quote">install-info</span>&#8221;</span>
1.87      wiz      9027:     commands.  <code class="varname">INFO_FILES</code> should be defined in
                   9028:     the package Makefile so that <code class="filename">INSTALL</code> and
                   9029:     <code class="filename">DEINSTALL</code> scripts will be generated to
                   9030:     handle registration of the info files in the Info directory
1.128     wiz      9031:     file. The <span class="quote">&#8220;<span class="quote">install-info</span>&#8221;</span> command used for the info
1.87      wiz      9032:     files registration is either provided by the system, or by a
                   9033:     special purpose package automatically added as dependency if
                   9034:     needed.</p>
1.75      rillig   9035: <p><code class="varname">PKGINFODIR</code> is the directory under
1.87      wiz      9036:     <code class="filename">${PREFIX}</code> where info files are primarily
                   9037:     located. <code class="varname">PKGINFODIR</code> defaults to
1.128     wiz      9038:     <span class="quote">&#8220;<span class="quote">info</span>&#8221;</span> and can be overridden by the user.</p>
1.75      rillig   9039: <p>The info files for the package should be listed in the
1.87      wiz      9040:     package <code class="filename">PLIST</code>; however any split info files
                   9041:     need not be listed.</p>
1.128     wiz      9042: <p>A package which needs the <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> command
                   9043:     at build time must add <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> to
1.87      wiz      9044:     <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.128     wiz      9045:     version of the <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> command is needed it
1.87      wiz      9046:     should be noted with the <code class="varname">TEXINFO_REQD</code>
                   9047:     variable in the package <code class="filename">Makefile</code>. By
                   9048:     default, a minimum version of 3.12 is required. If the system
1.110     hubertf  9049:     does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.87      wiz      9050:     does not match the required minimum, a build dependency on the
1.250     leot     9051:     <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/gtexinfo/README.html" target="_top"><code class="filename">devel/gtexinfo</code></a> package will
1.87      wiz      9052:     be added automatically.</p>
1.75      rillig   9053: <p>The build and installation process of the software provided
1.87      wiz      9054:     by the package should not use the
1.110     hubertf  9055:     <span class="command"><strong>install-info</strong></span> command as the registration of
1.87      wiz      9056:     info files is the task of the package
                   9057:     <code class="filename">INSTALL</code> script, and it must use the
1.110     hubertf  9058:     appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.75      rillig   9059: <p>To achieve this goal, the pkgsrc infrastructure creates
1.110     hubertf  9060:     overriding scripts for the <span class="command"><strong>install-info</strong></span> and
                   9061:     <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.87      wiz      9062:     in <code class="varname">PATH</code>.</p>
1.110     hubertf  9063: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.87      wiz      9064:     no effect except the logging of a message. The script overriding
1.110     hubertf  9065:     <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.87      wiz      9066:     value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.110     hubertf  9067:     <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.75      rillig   9068: </div>
1.148     asau     9069: <div class="sect2">
1.75      rillig   9070: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   9071: <a name="manpages"></a>21.6.8. Packages installing man pages</h3></div></div></div>
1.81      rillig   9072: <p>All packages that install manual pages should install them
1.87      wiz      9073:     into the same directory, so that there is one common place to look
                   9074:     for them. In pkgsrc, this place is
                   9075:     <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
                   9076:     should be used in packages. The default for
                   9077:     <code class="varname">PKGMANDIR</code> is
1.128     wiz      9078:     <span class="quote">&#8220;<span class="quote"><code class="filename">man</code></span>&#8221;</span>. Another often-used value
                   9079:     is <span class="quote">&#8220;<span class="quote"><code class="filename">share/man</code></span>&#8221;</span>.</p>
1.148     asau     9080: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   9081: <h3 class="title">Note</h3>
1.87      wiz      9082: <p>The support for a custom <code class="varname">PKGMANDIR</code>
                   9083:     is far from complete.</p>
1.75      rillig   9084: </div>
1.81      rillig   9085: <p>The <code class="filename">PLIST</code> files can just use
1.87      wiz      9086:     <code class="filename">man/</code> as the top level directory for the man
                   9087:     page file entries, and the pkgsrc framework will convert as
                   9088:     needed. In all other places, the correct
                   9089:     <code class="varname">PKGMANDIR</code> must be used.</p>
                   9090: <p>Packages that are
                   9091:     configured with <code class="varname">GNU_CONFIGURE</code> set as
1.128     wiz      9092:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>, by default will use the
1.87      wiz      9093:     <code class="filename">./configure</code>
                   9094:     --mandir switch to set where the man pages should be installed.
                   9095:     The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
                   9096:     to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
                   9097: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
                   9098:     use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.128     wiz      9099:     to <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span>.
1.87      wiz      9100:     Or if the <code class="filename">./configure</code> script uses
                   9101:     a non-standard use of --mandir, you can set
                   9102:     <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.299     rillig   9103: <p>See <a class="xref" href="#manpage-compression" title="19.5. Man page compression">Section 19.5, &#8220;Man page compression&#8221;</a> for
1.87      wiz      9104:     information on installation of compressed manual pages.</p>
1.75      rillig   9105: </div>
1.148     asau     9106: <div class="sect2">
1.75      rillig   9107: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   9108: <a name="gconf-data-files"></a>21.6.9. Packages installing GConf data files</h3></div></div></div>
1.87      wiz      9109: <p>If a package installs <code class="filename">.schemas</code> or
1.107     rillig   9110:     <code class="filename">.entries</code> files, used by GConf,
1.87      wiz      9111:     you need to take some extra steps to make sure they get registered
                   9112:     in the database:</p>
1.128     wiz      9113: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9114: <li class="listitem"><p>Include <code class="filename">../../devel/GConf/schemas.mk</code>
1.87      wiz      9115:        instead of its <code class="filename">buildlink3.mk</code> file.  This
1.107     rillig   9116:        takes care of rebuilding the GConf database at installation and
1.87      wiz      9117:        deinstallation time, and tells the package where to install
1.107     rillig   9118:        GConf data files using some standard configure arguments.  It
1.87      wiz      9119:        also disallows any access to the database directly from the
                   9120:        package.</p></li>
1.128     wiz      9121: <li class="listitem"><p>Ensure that the package installs its
1.87      wiz      9122:        <code class="filename">.schemas</code> files under
                   9123:        <code class="filename">${PREFIX}/share/gconf/schemas</code>.  If they get
                   9124:        installed under <code class="filename">${PREFIX}/etc</code>, you will
                   9125:        need to manually patch the package.</p></li>
1.128     wiz      9126: <li class="listitem"><p>Check the PLIST and remove any entries under the etc/gconf
1.87      wiz      9127:        directory, as they will be handled automatically.  See
1.267     rillig   9128:        <a class="xref" href="#faq.conf" title="10.13. How do I change the location of configuration files?">Section 10.13, &#8220;How do I change the location of configuration files?&#8221;</a> for more information.</p></li>
1.128     wiz      9129: <li class="listitem"><p>Define the <code class="varname">GCONF_SCHEMAS</code> variable in
1.87      wiz      9130:        your <code class="filename">Makefile</code> with a list of all
                   9131:        <code class="filename">.schemas</code> files installed by the package, if
                   9132:        any.  Names must not contain any directories in them.</p></li>
1.128     wiz      9133: <li class="listitem"><p>Define the <code class="varname">GCONF_ENTRIES</code> variable in
1.87      wiz      9134:        your <code class="filename">Makefile</code> with a
                   9135:        list of all <code class="filename">.entries</code> files installed by the
                   9136:        package, if any. Names must not contain any directories in
                   9137:        them.</p></li>
1.75      rillig   9138: </ol></div>
                   9139: </div>
1.148     asau     9140: <div class="sect2">
1.75      rillig   9141: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   9142: <a name="scrollkeeper-data-files"></a>21.6.10. Packages installing scrollkeeper/rarian data files</h3></div></div></div>
1.87      wiz      9143: <p>If a package installs <code class="filename">.omf</code> files, used by
1.119     mishka   9144:     scrollkeeper/rarian, you need to take some extra steps to make sure they
1.87      wiz      9145:     get registered in the database:</p>
1.128     wiz      9146: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9147: <li class="listitem"><p>Include
1.119     mishka   9148:        <code class="filename">../../mk/omf-scrollkeeper.mk</code>
                   9149:        instead of rarian's <code class="filename">buildlink3.mk</code> file.  This
1.87      wiz      9150:        takes care of rebuilding the scrollkeeper database at
                   9151:        installation and deinstallation time, and disallows any access
                   9152:        to it directly from the package.</p></li>
1.128     wiz      9153: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.87      wiz      9154:        <code class="filename">libdata/scrollkeeper</code> directory, as they
                   9155:        will be handled automatically.</p></li>
1.128     wiz      9156: <li class="listitem"><p>Remove the <code class="filename">share/omf</code> directory from
1.119     mishka   9157:        the PLIST.  It will be handled by rarian. (<span class="command"><strong>make
                   9158:        print-PLIST</strong></span> does this automatically.)</p></li>
1.75      rillig   9159: </ol></div>
                   9160: </div>
1.148     asau     9161: <div class="sect2">
1.75      rillig   9162: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   9163: <a name="x11-fonts"></a>21.6.11. Packages installing X11 fonts</h3></div></div></div>
1.75      rillig   9164: <p>If a package installs font files, you will need to rebuild
1.87      wiz      9165:     the fonts database in the directory where they get installed at
                   9166:     installation and deinstallation time.  This can be automatically
                   9167:     done by using the pkginstall framework.</p>
1.75      rillig   9168: <p>You can list the directories where fonts are installed in the
1.87      wiz      9169:     <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
                   9170:     variables, where <em class="replaceable"><code>type</code></em> can be one of
1.128     wiz      9171:     <span class="quote">&#8220;<span class="quote">ttf</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">type1</span>&#8221;</span> or <span class="quote">&#8220;<span class="quote">x11</span>&#8221;</span>.
1.87      wiz      9172:     Also make sure that the database file
                   9173:     <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
1.75      rillig   9174: <p>Note that you should not create new directories for fonts;
1.87      wiz      9175:     instead use the standard ones to avoid that the user needs to
                   9176:     manually configure his X server to find them.</p>
1.75      rillig   9177: </div>
1.148     asau     9178: <div class="sect2">
1.75      rillig   9179: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   9180: <a name="gtk2-modules"></a>21.6.12. Packages installing GTK2 modules</h3></div></div></div>
1.75      rillig   9181: <p>If a package installs GTK2 immodules or loaders, you need to
1.87      wiz      9182:     take some extra steps to get them registered in the GTK2 database
                   9183:     properly:</p>
1.128     wiz      9184: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9185: <li class="listitem"><p>Include
1.87      wiz      9186:       <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
                   9187:       <code class="filename">buildlink3.mk</code> file.  This takes care of
                   9188:       rebuilding the database at installation and deinstallation time.</p></li>
1.128     wiz      9189: <li class="listitem"><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
1.87      wiz      9190:       your package installs GTK2 immodules.</p></li>
1.128     wiz      9191: <li class="listitem"><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
1.87      wiz      9192:       GTK2 loaders.</p></li>
1.128     wiz      9193: <li class="listitem">
1.87      wiz      9194: <p>Patch the package to not touch any of the GTK2
                   9195:       databases directly.  These are:</p>
1.148     asau     9196: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      9197: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
                   9198: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.75      rillig   9199: </ul></div>
                   9200: </li>
1.128     wiz      9201: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove
1.87      wiz      9202:       any entries under the <code class="filename">libdata/gtk-2.0</code>
                   9203:       directory, as they will be handled automatically.</p></li>
1.75      rillig   9204: </ol></div>
                   9205: </div>
1.148     asau     9206: <div class="sect2">
1.75      rillig   9207: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   9208: <a name="sgml-xml-data"></a>21.6.13. Packages installing SGML or XML data</h3></div></div></div>
1.75      rillig   9209: <p>If a package installs SGML or XML data files that need to be
1.87      wiz      9210:     registered in system-wide catalogs (like DTDs, sub-catalogs,
                   9211:     etc.), you need to take some extra steps:</p>
1.128     wiz      9212: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9213: <li class="listitem"><p>Include
1.87      wiz      9214:        <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
                   9215:        your <code class="filename">Makefile</code>, which takes care of
                   9216:        registering those files in system-wide catalogs at
                   9217:        installation and deinstallation time.</p></li>
1.128     wiz      9218: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.87      wiz      9219:        any SGML catalogs installed by the package.</p></li>
1.128     wiz      9220: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.87      wiz      9221:        any XML catalogs installed by the package.</p></li>
1.128     wiz      9222: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.87      wiz      9223:        to be added to the SGML catalog.  These come in groups of
                   9224:        three strings; see xmlcatmgr(1) for more information
                   9225:        (specifically, arguments recognized by the 'add' action).
                   9226:        Note that you will normally not use this variable.</p></li>
1.128     wiz      9227: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.87      wiz      9228:        to be added to the XML catalog.  These come in groups of three
                   9229:        strings; see xmlcatmgr(1) for more information (specifically,
                   9230:        arguments recognized by the 'add' action).  Note that you will
                   9231:        normally not use this variable.</p></li>
1.75      rillig   9232: </ol></div>
                   9233: </div>
1.148     asau     9234: <div class="sect2">
1.75      rillig   9235: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   9236: <a name="mime-database"></a>21.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
1.75      rillig   9237: <p>If a package provides extensions to the MIME database by
1.87      wiz      9238:     installing <code class="filename">.xml</code> files inside
                   9239:     <code class="filename">${PREFIX}/share/mime/packages</code>, you
                   9240:     need to take some extra steps to ensure that the database is kept
                   9241:     consistent with respect to these new files:</p>
1.128     wiz      9242: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9243: <li class="listitem"><p>Include
1.87      wiz      9244:        <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
                   9245:        (avoid using the <code class="filename">buildlink3.mk</code> file from
                   9246:        this same directory, which is reserved for inclusion from
                   9247:        other <code class="filename">buildlink3.mk</code> files).  It takes
                   9248:        care of rebuilding the MIME database at installation and
                   9249:        deinstallation time, and disallows any access to it directly
                   9250:        from the package.</p></li>
1.128     wiz      9251: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.87      wiz      9252:        <code class="filename">share/mime</code> directory,
                   9253:        <span class="emphasis"><em>except</em></span> for files saved under
                   9254:        <code class="filename">share/mime/packages</code>.  The former are
                   9255:        handled automatically by
                   9256:        the update-mime-database program, but the latter are
                   9257:        package-dependent and must be removed by the package that
                   9258:        installed them in the first place.</p></li>
1.128     wiz      9259: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.87      wiz      9260:        from the PLIST.  They will be handled by the shared-mime-info
                   9261:        package.</p></li>
1.75      rillig   9262: </ol></div>
                   9263: </div>
1.148     asau     9264: <div class="sect2">
1.75      rillig   9265: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   9266: <a name="intltool"></a>21.6.15. Packages using intltool</h3></div></div></div>
1.93      rillig   9267: <p>If a package uses intltool during its build, add
                   9268:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
1.87      wiz      9269:     which forces it to use the intltool package provided by pkgsrc,
                   9270:     instead of the one bundled with the distribution file.</p>
1.75      rillig   9271: <p>This tracks intltool's build-time dependencies and uses the
1.87      wiz      9272:     latest available version; this way, the package benefits of any
                   9273:     bug fixes that may have appeared since it was released.</p>
1.75      rillig   9274: </div>
1.148     asau     9275: <div class="sect2">
1.75      rillig   9276: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   9277: <a name="startup-scripts"></a>21.6.16. Packages installing startup scripts</h3></div></div></div>
1.75      rillig   9278: <p>If a package contains a rc.d script, it won't be copied into
1.87      wiz      9279:     the startup directory by default, but you can enable it, by adding
                   9280:     the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.110     hubertf  9281:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.87      wiz      9282:     into <code class="filename">/etc/rc.d</code> when a package is installed, and
                   9283:     it will automatically remove the scripts when the package is
                   9284:     deinstalled.</p>
1.75      rillig   9285: </div>
1.148     asau     9286: <div class="sect2">
1.75      rillig   9287: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   9288: <a name="tex-packages"></a>21.6.17. Packages installing TeX modules</h3></div></div></div>
1.75      rillig   9289: <p>If a package installs TeX packages into the texmf tree,
1.87      wiz      9290:     the <code class="filename">ls-R</code> database of the tree needs to be
                   9291:     updated.</p>
1.148     asau     9292: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   9293: <h3 class="title">Note</h3>
1.125     wiz      9294: <p>Except the main TeX packages such as kpathsea,
1.87      wiz      9295:     packages should install files
1.125     wiz      9296:     into <code class="filename">${PREFIX}/share/texmf-dist</code>,
                   9297:     not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.75      rillig   9298: </div>
1.128     wiz      9299: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9300: <li class="listitem"><p>Include
1.125     wiz      9301:       <code class="filename">../../print/kpathsea/texmf.mk</code>.  This
1.87      wiz      9302:       takes care of rebuilding the <code class="filename">ls-R</code>
                   9303:       database at installation and deinstallation time.</p></li>
1.128     wiz      9304: <li class="listitem">
1.75      rillig   9305: <p>If your package installs files into a texmf
1.87      wiz      9306:       tree other than the one
1.125     wiz      9307:       at <code class="filename">${PREFIX}/share/texmf-dist</code>,
                   9308:       set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.87      wiz      9309:       trees that need database update.</p>
1.75      rillig   9310: <p>If your package also installs font map files that need
1.110     hubertf  9311:       to be registered using <span class="command"><strong>updmap</strong></span>,
1.136     dholland 9312:       include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.125     wiz      9313:       set <code class="varname">TEX_MAP_FILES</code> and/or
                   9314:       <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.110     hubertf  9315:       such font map files.  Then <span class="command"><strong>updmap</strong></span> will
1.87      wiz      9316:       be run automatically at installation/deinstallation to
                   9317:       enable/disable font map files for TeX output
                   9318:       drivers.</p>
1.75      rillig   9319: </li>
1.128     wiz      9320: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.87      wiz      9321:       databases are included in <code class="filename">PLIST</code>, as
1.136     dholland 9322:       they will be removed only by the kpathsea package.</p></li>
1.75      rillig   9323: </ol></div>
                   9324: </div>
1.148     asau     9325: <div class="sect2">
1.85      jmmv     9326: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   9327: <a name="emulation-packages"></a>21.6.18. Packages supporting running binaries in
1.87      wiz      9328:     emulation</h3></div></div></div>
                   9329: <p>There are some packages that provide libraries and
                   9330:     executables for running binaries from a one operating system
                   9331:     on a different one (if the latter supports it).  One example
                   9332:     is running Linux binaries on NetBSD.</p>
1.250     leot     9333: <p>The <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/rpm2pkg/README.html" target="_top"><code class="filename">pkgtools/rpm2pkg</code></a>
1.87      wiz      9334:     helps in extracting and packaging Linux rpm packages.</p>
                   9335: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.110     hubertf  9336:     avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.87      wiz      9337:     if all libraries for each installed executable can be found by
                   9338:     the dynamic linker.  Since the standard dynamic linker is run,
                   9339:     this fails for emulation packages, because the libraries used
                   9340:     by the emulation are not in the standard directories.</p>
                   9341: </div>
1.299     rillig   9342: <div class="sect2">
                   9343: <div class="titlepage"><div><div><h3 class="title">
                   9344: <a name="hicolor-theme"></a>21.6.19. Packages installing hicolor theme icons</h3></div></div></div>
                   9345: <p>If a package installs images under the
                   9346:     <code class="filename">share/icons/hicolor</code> and/or updates the
                   9347:     <code class="filename">share/icons/hicolor/icon-theme.cache</code>
                   9348:     database, you need to take some extra steps to make sure that the
                   9349:     shared theme directory is handled appropriately and that the cache
                   9350:     database is rebuilt:</p>
                   9351: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9352: <li class="listitem"><p>Include
                   9353:        <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
                   9354: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
                   9355:        entry that refers to the theme cache.</p></li>
                   9356: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
                   9357:          directories from the <code class="filename">share/icons/hicolor</code>
                   9358:          hierarchy because they will be handled automatically.</p></li>
                   9359: </ol></div>
                   9360: <p>The best way to verify that the PLIST is correct with
                   9361:       respect to the last two points is to regenerate it using
                   9362:       <span class="command"><strong>make print-PLIST</strong></span>.</p>
                   9363: </div>
                   9364: <div class="sect2">
                   9365: <div class="titlepage"><div><div><h3 class="title">
                   9366: <a name="desktop-files"></a>21.6.20. Packages installing desktop files</h3></div></div></div>
                   9367: <p>If a package installs <code class="filename">.desktop</code> files
                   9368:       under <code class="filename">share/applications</code> and these include
                   9369:       MIME information (MimeType key), you need to take extra steps to
                   9370:       ensure that they are registered into the MIME database:</p>
                   9371: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9372: <li class="listitem"><p>Include
                   9373:          <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
                   9374: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
                   9375:          <code class="filename">share/applications/mimeinfo.cache</code> file.
                   9376:          It will be handled automatically.</p></li>
                   9377: </ol></div>
                   9378: <p>The best way to verify that the PLIST is correct with
                   9379:       respect to the last point is to regenerate it using <span class="command"><strong>make
                   9380:       print-PLIST</strong></span>.</p>
                   9381: </div>
                   9382: </div>
                   9383: <div class="sect1">
                   9384: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   9385: <a name="punting"></a>21.7. Marking packages as having problems</h2></div></div></div>
                   9386: <p>In some cases one does not have the time to solve a problem
                   9387:   immediately. In this case, one can plainly mark a package as broken.  For
                   9388:   this, one just sets the variable <code class="varname">BROKEN</code> to the
                   9389:   reason why the package is broken (similar to the
                   9390:   <code class="varname">PKG_FAIL_REASON</code> variable).  A user trying to build
                   9391:   the package will immediately be shown this message, and the build
                   9392:   will not be even tried.</p>
                   9393: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
                   9394:   intervals.</p>
                   9395: </div>
                   9396: </div>
                   9397: <div class="chapter">
                   9398: <div class="titlepage"><div><div><h2 class="title">
                   9399: <a name="gnome"></a>Chapter 22. GNOME packaging and porting</h2></div></div></div>
                   9400: <div class="toc">
                   9401: <p><b>Table of Contents</b></p>
                   9402: <dl class="toc">
                   9403: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
                   9404: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
                   9405: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
                   9406: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
                   9407: </dl>
                   9408: </div>
                   9409: <p>Quoting <a class="ulink" href="https://www.gnome.org/" target="_top">GNOME's web
                   9410: site</a>:</p>
                   9411: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
                   9412:   environment, an intuitive and attractive desktop for users, and the
                   9413:   GNOME development platform, an extensive framework for building
                   9414:   applications that integrate into the rest of the desktop.</p></blockquote></div>
                   9415: <p>pkgsrc provides a seamless way to automatically build and install
                   9416: a complete GNOME environment <span class="emphasis"><em>under many different
                   9417: platforms</em></span>.  We can say with confidence that pkgsrc is one of
                   9418: the most advanced build and packaging systems for GNOME due to its
                   9419: included technologies buildlink3, the wrappers and tools framework and
                   9420: automatic configuration file management.  Lots of efforts are put into
                   9421: achieving a completely clean deinstallation of installed software
                   9422: components.</p>
                   9423: <p>Given that pkgsrc is <a class="ulink" href="https://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
                   9424: the above also means that great efforts are put into making GNOME work
1.316     cirnatda 9425: under this operating system.</p>
1.299     rillig   9426: <p>This chapter is aimed at pkgsrc developers and other people
                   9427: interested in helping our GNOME porting and packaging efforts.  It
                   9428: provides instructions on how to manage the existing packages and some
                   9429: important information regarding their internals.</p>
                   9430: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   9431: <h3 class="title">We need your help!</h3>
                   9432: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
                   9433:   and GNOME and are willing to learn new exciting stuff, please jump
                   9434:   straight to the <a class="ulink" href="https://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
                   9435:   work</a> list!  There is still a long way to go to get a
                   9436:   fully-functional GNOME desktop under NetBSD and we need your help to
                   9437:   achieve it!</p>
                   9438: </div>
                   9439: <div class="sect1">
                   9440: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   9441: <a name="meta-packages"></a>22.1. Meta packages</h2></div></div></div>
                   9442: <p>pkgsrc includes three GNOME-related meta packages:</p>
                   9443: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   9444: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-base/README.html" target="_top"><code class="filename">meta-pkgs/gnome-base</code></a>: Provides
                   9445:     the core GNOME desktop environment.  It only includes the necessary
                   9446:     bits to get it to boot correctly, although it may lack important
                   9447:     functionality for daily operation.  The idea behind this package is
                   9448:     to let end users build their own configurations on top of this one,
                   9449:     first installing this meta package to achieve a functional setup and
                   9450:     then adding individual applications.</p></li>
                   9451: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome/README.html" target="_top"><code class="filename">meta-pkgs/gnome</code></a>: Provides a
                   9452:     complete installation of the GNOME platform and desktop as defined
                   9453:     by the GNOME project; this is based on the components distributed in
                   9454:     the <code class="filename">platform/x.y/x.y.z/sources</code> and
                   9455:     <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
                   9456:     official FTP server.  Developer-only tools found in those
                   9457:     directories are not installed unless required by some other
                   9458:     component to work properly.  Similarly, packages from the bindings
                   9459:     set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
                   9460:     in unless required as a dependency for an end-user component.  This
                   9461:     package "extends" <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-base/README.html" target="_top"><code class="filename">meta-pkgs/gnome-base</code></a>.</p></li>
                   9462: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-devel/README.html" target="_top"><code class="filename">meta-pkgs/gnome-devel</code></a>:
                   9463:     Installs all the tools required to build a GNOME component when
                   9464:     fetched from the CVS repository.  These are required to let the
                   9465:     <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
                   9466: </ul></div>
                   9467: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
                   9468: sorted in a way that eases updates: a package may depend on other
                   9469: packages listed before it but not on any listed after it.  It is very
                   9470: important to keep this order to ease updates so... <span class="emphasis"><em>do not
                   9471: change it to alphabetical sorting!</em></span></p>
                   9472: </div>
                   9473: <div class="sect1">
                   9474: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   9475: <a name="new-package"></a>22.2. Packaging a GNOME application</h2></div></div></div>
                   9476: <p>Almost all GNOME applications are written in C and use a common
                   9477: set of tools as their build system.  Things get different with the new
                   9478: bindings to other languages (such as Python), but the following will
                   9479: give you a general idea on the minimum required tools:</p>
                   9480: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   9481: <li class="listitem">
                   9482: <p>Almost all GNOME applications use the GNU Autotools as their
                   9483:     build system.  As a general rule you will need to tell this to your
                   9484:     package:</p>
                   9485: <pre class="programlisting">
                   9486: GNU_CONFIGURE=yes
                   9487: USE_LIBTOOL=yes
                   9488: USE_TOOLS+=gmake
                   9489: </pre>
                   9490: </li>
                   9491: <li class="listitem">
                   9492: <p>If the package uses pkg-config to detect dependencies, add this
                   9493:     tool to the list of required utilities:</p>
                   9494: <pre class="programlisting">
                   9495: USE_TOOLS+=pkg-config
                   9496: </pre>
                   9497: <p>Also use <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/verifypc/README.html" target="_top"><code class="filename">pkgtools/verifypc</code></a> at
                   9498:     the end of the build process to ensure that you did not miss to
                   9499:     specify any dependency in your package and that the version
                   9500:     requirements are all correct.</p>
                   9501: </li>
                   9502: <li class="listitem"><p>If the package uses intltool, be sure to add
                   9503:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
                   9504:     to handle dependencies and to force the package to use the latest
                   9505:     available version.</p></li>
                   9506: <li class="listitem">
                   9507: <p>If the package uses gtk-doc (a documentation generation
                   9508:     utility), do <span class="emphasis"><em>not</em></span> add a dependency on it.  The
                   9509:     tool is rather big and the distfile should come with pregenerated
                   9510:     documentation anyway; if it does not, it is a bug that you ought to
                   9511:     report.  For such packages you should disable gtk-doc (unless it is
                   9512:     the default):</p>
                   9513: <pre class="programlisting">
                   9514: CONFIGURE_ARGS+=--disable-gtk-doc
                   9515: </pre>
                   9516: <p>The default location of installed HTML files
                   9517:     (<code class="filename">share/gtk-doc/&lt;package-name&gt;</code>) is correct
                   9518:     and should not be changed unless the package insists on installing
                   9519:     them somewhere else.  Otherwise programs as
                   9520:     <span class="command"><strong>devhelp</strong></span> will not be able to open them.  You can
                   9521:     do that with an entry similar to:</p>
                   9522: <pre class="programlisting">
                   9523: CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...
                   9524: </pre>
                   9525: </li>
                   9526: </ul></div>
                   9527: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
                   9528: files under the installation prefix to maintain databases.  In this
                   9529: context, shared means that those exact same directories and files are
                   9530: used among several different packages, leading to conflicts in the
                   9531: <code class="filename">PLIST</code>.  pkgsrc currently includes functionality to
                   9532: handle the most common cases, so you have to forget about using
                   9533: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
                   9534: omitting shared files from them.  If you find yourself doing those,
                   9535: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
                   9536: <p>The following table lists the common situations that result in
                   9537: using shared directories or files.  For each of them, the appropriate
                   9538: solution is given.  After applying the solution be sure to
                   9539: <span class="emphasis"><em>regenerate the package's file list</em></span> with
                   9540: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
                   9541: <div class="table">
                   9542: <a name="plist-handling"></a><p class="title"><b>Table 22.1. PLIST handling for GNOME packages</b></p>
                   9543: <div class="table-contents"><table class="table" summary="PLIST handling for GNOME packages" border="1">
                   9544: <colgroup>
                   9545: <col>
                   9546: <col>
                   9547: </colgroup>
                   9548: <thead><tr>
                   9549: <th>If the package...</th>
                   9550: <th>Then...</th>
                   9551: </tr></thead>
                   9552: <tbody>
                   9553: <tr>
                   9554: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
                   9555: <td>See <a class="xref" href="#scrollkeeper-data-files" title="21.6.10. Packages installing scrollkeeper/rarian data files">Section 21.6.10, &#8220;Packages installing scrollkeeper/rarian data files&#8221;</a>.</td>
                   9556: </tr>
                   9557: <tr>
                   9558: <td>Installs icons under the
                   9559:         <code class="filename">share/icons/hicolor</code> hierarchy or updates
                   9560:         <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
                   9561: <td>See <a class="xref" href="#hicolor-theme" title="21.6.19. Packages installing hicolor theme icons">Section 21.6.19, &#8220;Packages installing hicolor theme icons&#8221;</a>.</td>
                   9562: </tr>
                   9563: <tr>
                   9564: <td>Installs files under
                   9565:         <code class="filename">share/mime/packages</code>.</td>
                   9566: <td>See <a class="xref" href="#mime-database" title="21.6.14. Packages installing extensions to the MIME database">Section 21.6.14, &#8220;Packages installing extensions to the MIME database&#8221;</a>.</td>
                   9567: </tr>
                   9568: <tr>
                   9569: <td>Installs <code class="filename">.desktop</code> files under
                   9570:         <code class="filename">share/applications</code> and these include MIME
                   9571:         information.</td>
                   9572: <td>See <a class="xref" href="#desktop-files" title="21.6.20. Packages installing desktop files">Section 21.6.20, &#8220;Packages installing desktop files&#8221;</a>.</td>
                   9573: </tr>
                   9574: </tbody>
                   9575: </table></div>
1.75      rillig   9576: </div>
1.299     rillig   9577: <br class="table-break">
1.75      rillig   9578: </div>
1.148     asau     9579: <div class="sect1">
1.87      wiz      9580: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   9581: <a name="full-update"></a>22.3. Updating GNOME to a newer version</h2></div></div></div>
                   9582: <p>When seeing GNOME as a whole, there are two kinds of
                   9583: updates:</p>
                   9584: <div class="variablelist"><dl class="variablelist">
                   9585: <dt><span class="term">Major update</span></dt>
                   9586: <dd>
                   9587: <p>Given that there is still a very long way for GNOME 3 (if it
                   9588:       ever appears), we consider a major update one that goes from a
                   9589:       <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
                   9590:       where <code class="literal">Y</code> is even and greater than
                   9591:       <code class="literal">X</code>.  These are hard to achieve because they
                   9592:       introduce lots of changes in the components' code and almost all
                   9593:       GNOME distfiles are updated to newer versions.  Some of them can
                   9594:       even break API and ABI compatibility with the previous major
                   9595:       version series.  As a result, the update needs to be done all at
                   9596:       once to minimize breakage.</p>
                   9597: <p>A major update typically consists of around 80 package
                   9598:       updates and the addition of some new ones.</p>
                   9599: </dd>
                   9600: <dt><span class="term">Minor update</span></dt>
                   9601: <dd>
                   9602: <p>We consider a minor update one that goes from a
                   9603:       <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
                   9604:       one where <code class="literal">Y</code> is greater than
                   9605:       <code class="literal">X</code>.  These are easy to achieve because they do
                   9606:       not update all GNOME components, can be done in an incremental way
                   9607:       and do not break API nor ABI compatibility.</p>
                   9608: <p>A minor update typically consists of around 50 package
                   9609:       updates, although the numbers here may vary a lot.</p>
                   9610: </dd>
                   9611: </dl></div>
                   9612: <p>In order to update the GNOME components in pkgsrc to a new stable
                   9613: release (either major or minor), the following steps should be
                   9614: followed:</p>
                   9615: <div class="orderedlist"><ol class="orderedlist" type="1">
1.128     wiz      9616: <li class="listitem">
1.299     rillig   9617: <p>Get a list of all the tarballs that form the new release by
                   9618:     using the following commands.  These will leave the full list of the
                   9619:     components' distfiles into the <code class="filename">list.txt</code>
                   9620:     file:</p>
                   9621: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
                   9622:     ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
                   9623:     awk '{ print $9 }' &gt;list.txt</code></strong>
                   9624: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
                   9625:     ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
                   9626:     awk '{ print $9 }' &gt;&gt;list.txt</code></strong></pre>
1.75      rillig   9627: </li>
1.299     rillig   9628: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
                   9629:     bump their version to the release you are updating them to.  The
                   9630:     three meta packages should be always consistent with versioning.
                   9631:     Obviously remove any <code class="varname">PKGREVISION</code>s that might be
                   9632:     in them.</p></li>
1.128     wiz      9633: <li class="listitem">
1.299     rillig   9634: <p>For each meta package, update all its
                   9635:     <code class="varname">DEPENDS</code> lines to match the latest versions as
                   9636:     shown by the above commands.  Do <span class="emphasis"><em>not</em></span> list any
                   9637:     newer version (even if found in the FTP) because the meta packages
                   9638:     are supposed to list the exact versions that form a specific GNOME
                   9639:     release.  Exceptions are permitted here if a newer version solves a
                   9640:     serious issue in the overall desktop experience; these typically
                   9641:     come in the form of a revision bump in pkgsrc, not in newer versions
                   9642:     from the developers.</p>
                   9643: <p>Packages not listed in the <code class="filename">list.txt</code> file
                   9644:     should be updated to the latest version available (if found in
                   9645:     pkgsrc).  This is the case, for example, of the dependencies on the
                   9646:     GNU Autotools in the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-devel/README.html" target="_top"><code class="filename">meta-pkgs/gnome-devel</code></a> meta package.</p>
1.75      rillig   9647: </li>
1.128     wiz      9648: <li class="listitem">
1.299     rillig   9649: <p>Generate a patch from the modified meta packages and extract the
                   9650:     list of "new" lines.  This will provide you an outline on what
                   9651:     packages need to be updated in pkgsrc and in what order:</p>
                   9652: <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   9653: </li>
1.299     rillig   9654: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
                   9655:     installed packages and start over from scratch at this point.</p></li>
                   9656: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
                   9657:     of <code class="filename">todo.txt</code> and update the packages listed in
                   9658:     it in order.  For major desktop updates none of these should be
                   9659:     committed until the entire set is completed because there are chances
                   9660:     of breaking not-yet-updated packages.</p></li>
                   9661: <li class="listitem"><p>Once the packages are up to date and working, commit them to
                   9662:     the tree one by one with appropriate log messages.  At the end,
                   9663:     commit the three meta package updates and all the corresponding
                   9664:     changes to the <code class="filename">doc/CHANGES-&lt;YEAR&gt;</code> and
                   9665:     <a href="http://cvsweb.NetBSD.org/bsdweb.cgi/pkgsrc/doc/TODO?rev=HEAD&amp;content-type=text/x-cvsweb-markup" target="_top"><code class="filename">pkgsrc/doc/TODO</code></a> files.</p></li>
                   9666: </ol></div>
                   9667: </div>
                   9668: <div class="sect1">
                   9669: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   9670: <a name="patching"></a>22.4. Patching guidelines</h2></div></div></div>
                   9671: <p>GNOME is a very big component in pkgsrc which approaches 100
                   9672: packages.  Please, it is very important that you always, always,
                   9673: <span class="strong"><strong>always</strong></span> feed back any portability
                   9674: fixes you do to a GNOME package to the mainstream developers (see <a class="xref" href="#components.patches.feedback" title="12.3.5. Feedback to the author">Section 12.3.5, &#8220;Feedback to the author&#8221;</a>).  This is the only way to get
                   9675: their attention on portability issues and to ensure that future versions
                   9676: can be built out-of-the box on NetBSD.  The less custom patches in
                   9677: pkgsrc, the easier further updates are.  Those developers in charge of
                   9678: issuing major GNOME updates will be grateful if you do that.</p>
1.315     cirnatda 9679: <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
                   9680: GitLab</a>.  Not all components use these to track bugs, but most
1.299     rillig   9681: of them do.  Do not be short on your reports: always provide detailed
                   9682: explanations of the current failure, how it can be improved to achieve
1.315     cirnatda 9683: maximum portability and, if at all possible, provide a patch against the
                   9684: main Git branch.  The more verbose you are, the higher chances of your
                   9685: patch being accepted.</p>
1.299     rillig   9686: <p>Also, please avoid using preprocessor magic to fix portability
                   9687: issues.  While the FreeBSD GNOME people are doing a great job in porting
                   9688: GNOME to their operating system, the official GNOME sources are now
                   9689: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
                   9690: and similar macros.  This hurts portability.  Please see our patching
                   9691: guidelines (<a class="xref" href="#components.patches.guidelines" title="12.3.4. Patching guidelines">Section 12.3.4, &#8220;Patching guidelines&#8221;</a>) for more
                   9692: details.</p>
                   9693: </div>
1.75      rillig   9694: </div>
1.148     asau     9695: <div class="chapter">
1.75      rillig   9696: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   9697: <a name="submit"></a>Chapter 23. Submitting and Committing</h2></div></div></div>
1.75      rillig   9698: <div class="toc">
                   9699: <p><b>Table of Contents</b></p>
1.210     leot     9700: <dl class="toc">
1.267     rillig   9701: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
                   9702: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   9703: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
                   9704: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
                   9705: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
                   9706: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
                   9707: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
                   9708: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
1.75      rillig   9709: </dl>
                   9710: </div>
1.148     asau     9711: <div class="sect1">
1.75      rillig   9712: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9713: <a name="submitting-binary-packages"></a>23.1. Submitting binary packages</h2></div></div></div>
1.75      rillig   9714: <p>Our policy is that we accept binaries only from pkgsrc
                   9715:        developers to guarantee that the packages don't contain any
                   9716:        trojan horses etc. This is not to annoy anyone but rather to
                   9717:        protect our users! You're still free to put up your home-made
                   9718:        binary packages and tell the world where to get them. NetBSD
                   9719:        developers doing bulk builds and wanting to upload them please
1.267     rillig   9720:        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     9721: builds)</i></a>.</p>
1.75      rillig   9722: </div>
1.148     asau     9723: <div class="sect1">
1.75      rillig   9724: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9725: <a name="submitting-your-package"></a>23.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.75      rillig   9726: <p>First, check that your package is complete, compiles and
1.299     rillig   9727:        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.311     leot     9728:        document. Next, generate an uuencoded gzipped <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/tar.1"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a>
1.82      rillig   9729:        archive that contains all files that make up the package.
1.87      wiz      9730:        Finally, send this package to the pkgsrc bug tracking system,
1.311     leot     9731:        either with the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/send-pr.1"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> command, or if you don't have
1.87      wiz      9732:        that, go to the web page
1.289     leot     9733:        <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      9734:        which contains some instructions and a link to a form where you
                   9735:        can submit packages.  The
1.250     leot     9736:        <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/sysutils/gtk-send-pr/README.html" target="_top"><code class="filename">sysutils/gtk-send-pr</code></a> package is
1.124     snj      9737:        also available as a substitute for either of the above two tools.
                   9738:        </p>
1.87      wiz      9739: <p>In the form of the problem report, the category should be
1.128     wiz      9740:        <span class="quote">&#8220;<span class="quote">pkg</span>&#8221;</span>, the synopsis should include the package name
1.87      wiz      9741:        and version number, and the description field should contain a
                   9742:        short description of your package (contents of the COMMENT
                   9743:        variable or DESCR file are OK). The uuencoded package data should
1.128     wiz      9744:        go into the <span class="quote">&#8220;<span class="quote">fix</span>&#8221;</span> field.</p>
1.75      rillig   9745: <p>If you want to submit several packages, please send a
                   9746:        separate PR for each one, it's easier for us to track things
                   9747:        that way.</p>
                   9748: <p>Alternatively, you can also import new packages into
1.128     wiz      9749:        pkgsrc-wip (<span class="quote">&#8220;<span class="quote">pkgsrc work-in-progress</span>&#8221;</span>); see the
1.289     leot     9750:        homepage at <a class="ulink" href="https://pkgsrc.org/wip/" target="_top">https://pkgsrc.org/wip/</a>
1.75      rillig   9751:        for details.</p>
                   9752: </div>
1.148     asau     9753: <div class="sect1">
1.75      rillig   9754: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9755: <a name="general-notes-for-changes"></a>23.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.75      rillig   9756: <p>Please note all package additions, updates, moves, and
1.93      rillig   9757:        removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
1.75      rillig   9758:        important to keep this file up to date and conforming to the
                   9759:        existing format, because it will be used by scripts to
1.289     leot     9760:        automatically update pages on <a class="ulink" href="https://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.75      rillig   9761:        sites. Additionally, check the
1.76      rillig   9762:        <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
1.75      rillig   9763:        for the package you updated or removed, in case it was mentioned
                   9764:        there.</p>
                   9765: <p>When the <code class="varname">PKGREVISION</code> of a package is
                   9766:        bumped, the change should appear in
1.93      rillig   9767:        <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
1.75      rillig   9768:        related or otherwise relevant. Mass bumps that result from a
                   9769:        dependency being updated should not be mentioned. In all other
                   9770:        cases it's the developer's decision.</p>
                   9771: <p>There is a make target that helps in creating proper
1.110     hubertf  9772:   <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries:  <span class="command"><strong>make
1.75      rillig   9773:   changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
                   9774:   and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
1.93      rillig   9775:   usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
1.75      rillig   9776:   file is up-to-date (to avoid having to resolve conflicts later-on)
1.110     hubertf  9777:   and then to <span class="command"><strong>cd</strong></span> to the package directory.  For
                   9778:   package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.75      rillig   9779:   For new packages, or package moves or removals, set the
                   9780:   <code class="varname">CTYPE</code> variable on the command line to "Added",
                   9781:   "Moved", or "Removed".  You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.110     hubertf  9782:   in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.125     wiz      9783:   not the same as your NetBSD login name. The target also automatically
                   9784:   removes possibly existing entries for the package in the
                   9785:   <code class="filename">TODO</code> file. Don't forget to commit
1.174     asau     9786:   the changes, e.g. by using <span class="command"><strong>make commit-changes-entry</strong></span>!
1.126     jakllsch 9787:   If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
1.125     wiz      9788:   a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
                   9789:   makes the cvs commands use the main repository.
                   9790:   </p>
1.75      rillig   9791: </div>
1.148     asau     9792: <div class="sect1">
1.75      rillig   9793: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9794: <a name="commit-messages"></a>23.4. Commit Messages</h2></div></div></div>
1.243     wiz      9795: <p>For several years, there have been mirrors of pkgsrc in
                   9796:   fossil, git, and hg. Standard practise when using these tools is to
                   9797:   make the first line of a commit message function as a summary that
                   9798:   can be read without the rest, such as is commonly done with "git log
                   9799:   --oneline". For this reason, we have the following guidelines for
                   9800:   pkgsrc commit messages:</p>
                   9801: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   9802: <li class="listitem"><p>Start the commit message with a line that explains the
1.244     wiz      9803:     big picture in 65 characters or less. When a commit is for one
1.243     wiz      9804:     package, include the name of the package. For updates, include the
                   9805:     version to which it is updated.</p></li>
                   9806: <li class="listitem"><p>Leave the next line empty.</p></li>
                   9807: <li class="listitem"><p>Then come the details for the commit (changes in that
                   9808:     package, reason for a change) and any relevant PRs. Wrap this
                   9809:     section.</p></li>
                   9810: </ul></div>
                   9811: <p>Here is an example:
                   9812:   </p>
                   9813: <pre class="programlisting">
                   9814:   libxslt: update to 1.0.30
                   9815: 
                   9816:   Changes since 1.0.29:
                   9817:   ...
                   9818:   </pre>
                   9819: <p>
                   9820:   </p>
                   9821: <p>Here is another example:
                   9822:   </p>
                   9823: <pre class="programlisting">
                   9824:   mk/bsd.pkg.mk: enable SSP by default on NetBSD
                   9825: 
                   9826:   (rationale)
                   9827:   </pre>
                   9828: <p>
                   9829:   </p>
                   9830: <p>Commit messages are final: no <span class="quote">&#8220;<span class="quote">cvs admin</span>&#8221;</span> is
                   9831:   allowed on the pkgsrc repository to change commit messages.</p>
                   9832: </div>
                   9833: <div class="sect1">
                   9834: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9835: <a name="committing-importing"></a>23.5. Committing: Adding a package to CVS</h2></div></div></div>
1.87      wiz      9836: <p>This section is only of interest for pkgsrc developers with write
1.140     wiz      9837:   access to the pkgsrc repository.</p>
                   9838: <p>When the package is finished, <span class="quote">&#8220;<span class="quote">cvs add</span>&#8221;</span> the files.
                   9839: Start by adding the directory and then files in the directory. Don't
                   9840: forget to add the new package to the category's
                   9841: <code class="filename">Makefile</code>. Make sure you don't forget any files;
                   9842: you can check by running <span class="quote">&#8220;<span class="quote">cvs status</span>&#8221;</span>. An example:</p>
                   9843: <pre class="programlisting">
                   9844: <code class="prompt">$</code> cd .../pkgsrc/category
                   9845: <code class="prompt">$</code> cvs add pkgname
                   9846: <code class="prompt">$</code> cd pkgname
                   9847: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
                   9848: <code class="prompt">$</code> cvs add patches/p*
                   9849: <code class="prompt">$</code> cvs status | less
1.141     wiz      9850: <code class="prompt">$</code> cvs commit
1.140     wiz      9851: <code class="prompt">$</code> cd ..
                   9852: <code class="prompt">$</code> vi Makefile # add SUBDIRS+=pkgname line
1.141     wiz      9853: <code class="prompt">$</code> cvs commit Makefile
1.174     asau     9854: <code class="prompt">$</code> cd pkgname
1.182     jnemeth  9855: <code class="prompt">$</code> make CTYPE=Added commit-changes-entry
1.140     wiz      9856: </pre>
1.87      wiz      9857: <p>The commit message of the initial import should include part of the
1.76      rillig   9858:   <code class="filename">DESCR</code> file, so people reading the mailing lists know
1.87      wiz      9859:   what the package is/does.</p>
1.140     wiz      9860: <p>Also mention the new package in
                   9861: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
                   9862: <p>Previously, <span class="quote">&#8220;<span class="quote">cvs import</span>&#8221;</span> was suggested, but it was
                   9863: much easier to get wrong than <span class="quote">&#8220;<span class="quote">cvs add</span>&#8221;</span>.</p>
1.75      rillig   9864: </div>
1.148     asau     9865: <div class="sect1">
1.75      rillig   9866: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9867: <a name="updating-package"></a>23.6. Updating a package to a newer version</h2></div></div></div>
1.87      wiz      9868: <p>Please always put a concise, appropriate and relevant summary of the
1.75      rillig   9869:   changes between old and new versions into the commit log when updating
1.87      wiz      9870:   a package. There are various reasons for this:</p>
1.148     asau     9871: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      9872: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.87      wiz      9873:   or its information may be overwritten by newer information.</p></li>
1.128     wiz      9874: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.87      wiz      9875:   repository is very useful for people who use either cvs or anoncvs.</p></li>
1.128     wiz      9876: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.75      rillig   9877:   repository is very useful for people who read the pkgsrc-changes mailing
                   9878:   list, so that they can make tactical decisions about when to upgrade
1.87      wiz      9879:   the package.</p></li>
1.75      rillig   9880: </ul></div>
1.87      wiz      9881: <p>Please also recognize that, just because a new version of a package
1.75      rillig   9882:   has been released, it should not automatically be upgraded in the CVS
                   9883:   repository.  We prefer to be conservative in the packages that are
                   9884:   included in pkgsrc - development or beta packages are not really the
                   9885:   best thing for most places in which pkgsrc is used. Please use your
                   9886:   judgement about what should go into pkgsrc, and bear in mind that
1.87      wiz      9887:   stability is to be preferred above new and possibly untested features.</p>
1.75      rillig   9888: </div>
1.148     asau     9889: <div class="sect1">
1.75      rillig   9890: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9891: <a name="renaming-package"></a>23.7. Renaming a package in pkgsrc</h2></div></div></div>
1.122     reed     9892: <p>Renaming packages is not recommended.</p>
1.290     gutterid 9893: <p>When renaming packages, be sure to fix any references to the old name
1.122     reed     9894:   in other Makefiles, options, buildlink files, etc.</p>
1.282     leot     9895: <p>
1.290     gutterid 9896:   Also, when renaming a package, please add
1.282     leot     9897:   the package name and version pattern(s) of the previous package
                   9898:   to <code class="varname">SUPERSEDES</code>.
1.122     reed     9899:   This may be repeated for multiple renames.
                   9900:   The new package would be an exact replacement.
1.282     leot     9901:   Example:
1.122     reed     9902: </p>
1.282     leot     9903: <pre class="programlisting">
                   9904: SUPERSEDES+=    p5-IO-Compress-Zlib&lt;2.017
                   9905: SUPERSEDES+=    optcomp-[0-9]*
                   9906: </pre>
1.128     wiz      9907: <p>Note that <span class="quote">&#8220;<span class="quote">successor</span>&#8221;</span> in the
1.122     reed     9908:   CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
                   9909:   mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
                   9910:   not be an exact replacement but is a suggestion for the replaced
                   9911:   functionality.</p>
                   9912: </div>
1.148     asau     9913: <div class="sect1">
1.122     reed     9914: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9915: <a name="moving-package"></a>23.8. Moving a package in pkgsrc</h2></div></div></div>
1.122     reed     9916: <p>It is preferred that packages are not renamed or moved, but if needed
                   9917:   please follow these steps.
                   9918: </p>
1.128     wiz      9919: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9920: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
                   9921: <li class="listitem">
1.75      rillig   9922: <p>Remove all CVS dirs.</p>
1.87      wiz      9923: <p>Alternatively to the first two steps you can also do:</p>
1.75      rillig   9924: <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      9925: <p>and use that for further work.</p>
1.75      rillig   9926: </li>
1.128     wiz      9927: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
                   9928: <code class="varname">DEPENDS</code> paths that just did <span class="quote">&#8220;<span class="quote">../package</span>&#8221;</span>
                   9929: instead of <span class="quote">&#8220;<span class="quote">../../category/package</span>&#8221;</span>.</p></li>
                   9930: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.122     reed     9931: <code class="varname">PREV_PKGPATH</code> to the previous category/package
                   9932: pathname.  The <code class="varname">PREV_PKGPATH</code> can be used by tools
                   9933: for doing an update using pkgsrc building; for example, it can
1.311     leot     9934: search the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/pkg_summary.5"><span class="citerefentry"><span class="refentrytitle">pkg_summary</span>(5)</span></a> database for <code class="varname">PREV_PKGPATH</code>
1.122     reed     9935: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
                   9936: new <code class="varname">PKGPATH</code> for that moved package.  Note that
                   9937: it may have multiple matches, so the tool should also check on the
                   9938: <code class="varname">PKGBASE</code> too.  The <code class="varname">PREV_PKGPATH</code>
                   9939: probably has no value unless <code class="varname">SUPERSEDES</code> is not
                   9940: set, i.e.  <code class="varname">PKGBASE</code> stays the same.  </p></li>
1.128     wiz      9941: <li class="listitem"><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.75      rillig   9942: place.</p></li>
1.128     wiz      9943: <li class="listitem">
1.75      rillig   9944: <p>Check if any package depends on it:
                   9945: </p>
                   9946: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   9947: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
                   9948: </li>
1.128     wiz      9949: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
                   9950: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
                   9951: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
                   9952: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
                   9953: <li class="listitem">
1.75      rillig   9954: <p>Commit the changed and removed files:</p>
                   9955: <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      9956: <p>(and any packages from step 5, of course).</p>
1.75      rillig   9957: </li>
                   9958: </ol></div>
                   9959: </div>
                   9960: </div>
1.148     asau     9961: <div class="chapter">
1.75      rillig   9962: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   9963: <a name="devfaq"></a>Chapter 24. Frequently Asked Questions</h2></div></div></div>
1.75      rillig   9964: <p>This section contains the answers to questions that may
                   9965:        arise when you are writing a package. If you don't find your
                   9966:        question answered here, first have a look in the other chapters,
                   9967:        and if you still don't have the answer, ask on the
                   9968:        <code class="literal">pkgsrc-users</code> mailing list.</p>
1.148     asau     9969: <div class="qandaset">
1.289     leot     9970: <a name="devfaq.qandaset"></a><dl>
1.267     rillig   9971: <dt>24.1. <a href="#devfaq.makeflags">What is the difference between
1.75      rillig   9972:        MAKEFLAGS, .MAKEFLAGS and
                   9973:        MAKE_FLAGS?</a>
                   9974: </dt>
1.267     rillig   9975: <dt>24.2. <a href="#devfaq.make">What is the difference between
1.75      rillig   9976:        MAKE, GMAKE and
                   9977:        MAKE_PROGRAM?</a>
                   9978: </dt>
1.267     rillig   9979: <dt>24.3. <a href="#devfaq.cc">What is the difference between
1.75      rillig   9980:        CC, PKG_CC and
                   9981:        PKGSRC_COMPILER?</a>
                   9982: </dt>
1.267     rillig   9983: <dt>24.4. <a href="#devfaq.bl3flags">What is the difference between
1.75      rillig   9984:        BUILDLINK_LDFLAGS,
                   9985:        BUILDLINK_LDADD and
                   9986:        BUILDLINK_LIBS?</a>
                   9987: </dt>
1.267     rillig   9988: <dt>24.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.75      rillig   9989:        VARNAME=BUILDLINK_PREFIX.foo
                   9990:        say it's empty?</a>
                   9991: </dt>
1.267     rillig   9992: <dt>24.6. <a href="#devfaq.master_sites">What does
1.78      rillig   9993:        ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
                   9994:        don't understand the := inside
                   9995:        it.</a>
                   9996: </dt>
1.267     rillig   9997: <dt>24.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.78      rillig   9998:        developers?</a>
                   9999: </dt>
1.267     rillig   10000: <dt>24.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.80      rillig   10001:        documentation?</a>
                   10002: </dt>
1.289     leot     10003: <dt>24.9. <a href="#devfaq.too-much-time">I have a little time to kill. 
                   10004: What shall I do?</a>
1.92      rillig   10005: </dt>
1.75      rillig   10006: </dl>
1.148     asau     10007: <table border="0" style="width: 100%;">
                   10008: <colgroup>
1.75      rillig   10009: <col align="left" width="1%">
1.128     wiz      10010: <col>
1.148     asau     10011: </colgroup>
1.75      rillig   10012: <tbody>
1.148     asau     10013: <tr class="question">
1.75      rillig   10014: <td align="left" valign="top">
1.289     leot     10015: <a name="devfaq.makeflags"></a><a name="devfaq.makeflags.q"></a><p><b>24.1.</b></p>
1.75      rillig   10016: </td>
                   10017: <td align="left" valign="top"><p>What is the difference between
                   10018:        <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
                   10019:        <code class="varname">MAKE_FLAGS</code>?</p></td>
                   10020: </tr>
                   10021: <tr class="answer">
1.91      rillig   10022: <td align="left" valign="top"></td>
1.75      rillig   10023: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
1.311     leot     10024:        to the pkgsrc-internal invocations of <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>, while
1.75      rillig   10025:        <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
                   10026:        the <code class="varname">MAKE_PROGRAM</code> when building the
                   10027:        package. [FIXME: What is .MAKEFLAGS for?]</p></td>
                   10028: </tr>
1.148     asau     10029: <tr class="question">
1.75      rillig   10030: <td align="left" valign="top">
1.289     leot     10031: <a name="devfaq.make"></a><a name="devfaq.make.q"></a><p><b>24.2.</b></p>
1.75      rillig   10032: </td>
                   10033: <td align="left" valign="top"><p>What is the difference between
                   10034:        <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
                   10035:        <code class="varname">MAKE_PROGRAM</code>?</p></td>
                   10036: </tr>
                   10037: <tr class="answer">
1.91      rillig   10038: <td align="left" valign="top"></td>
1.75      rillig   10039: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
1.311     leot     10040:        <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> program that is used in the pkgsrc
1.75      rillig   10041:        infrastructure. <code class="varname">GMAKE</code> is the path to GNU
                   10042:        Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
                   10043:        use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
                   10044:        Make program that is used for building the
                   10045:        package.</p></td>
                   10046: </tr>
1.148     asau     10047: <tr class="question">
1.75      rillig   10048: <td align="left" valign="top">
1.289     leot     10049: <a name="devfaq.cc"></a><a name="devfaq.cc.q"></a><p><b>24.3.</b></p>
1.75      rillig   10050: </td>
                   10051: <td align="left" valign="top"><p>What is the difference between
                   10052:        <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
                   10053:        <code class="varname">PKGSRC_COMPILER</code>?</p></td>
                   10054: </tr>
                   10055: <tr class="answer">
1.91      rillig   10056: <td align="left" valign="top"></td>
1.75      rillig   10057: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
                   10058:        compiler, which can be configured by the pkgsrc user.
                   10059:        <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
                   10060:        <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
                   10061:        path to a compiler, but the type of compiler that should be
1.76      rillig   10062:        used. See <code class="filename">mk/compiler.mk</code> for more
1.75      rillig   10063:        information about the latter variable.</p></td>
                   10064: </tr>
1.148     asau     10065: <tr class="question">
1.75      rillig   10066: <td align="left" valign="top">
1.289     leot     10067: <a name="devfaq.bl3flags"></a><a name="devfaq.bl3flags.q"></a><p><b>24.4.</b></p>
1.75      rillig   10068: </td>
                   10069: <td align="left" valign="top"><p>What is the difference between
                   10070:        <code class="varname">BUILDLINK_LDFLAGS</code>,
                   10071:        <code class="varname">BUILDLINK_LDADD</code> and
                   10072:        <code class="varname">BUILDLINK_LIBS</code>?</p></td>
                   10073: </tr>
                   10074: <tr class="answer">
1.91      rillig   10075: <td align="left" valign="top"></td>
1.75      rillig   10076: <td align="left" valign="top"><p>[FIXME]</p></td>
                   10077: </tr>
1.148     asau     10078: <tr class="question">
1.75      rillig   10079: <td align="left" valign="top">
1.289     leot     10080: <a name="devfaq.bl3prefix"></a><a name="devfaq.bl3prefix.q"></a><p><b>24.5.</b></p>
1.75      rillig   10081: </td>
1.110     hubertf  10082: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.75      rillig   10083:        VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
                   10084:        say it's empty?</p></td>
                   10085: </tr>
                   10086: <tr class="answer">
1.91      rillig   10087: <td align="left" valign="top"></td>
1.75      rillig   10088: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.128     wiz      10089:        available in the <span class="quote">&#8220;<span class="quote">wrapper</span>&#8221;</span> phase and later. To
                   10090:        <span class="quote">&#8220;<span class="quote">simulate</span>&#8221;</span> the wrapper phase, append
1.110     hubertf  10091:        <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.75      rillig   10092:        command.</p></td>
                   10093: </tr>
1.148     asau     10094: <tr class="question">
1.78      rillig   10095: <td align="left" valign="top">
1.289     leot     10096: <a name="devfaq.master_sites"></a><a name="devfaq.master_sites.q"></a><p><b>24.6.</b></p>
1.78      rillig   10097: </td>
                   10098: <td align="left" valign="top"><p>What does
1.220     wiz      10099:        <code class="code">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
                   10100:        don't understand the <code class="code">:=</code> inside
1.78      rillig   10101:        it.</p></td>
                   10102: </tr>
                   10103: <tr class="answer">
1.91      rillig   10104: <td align="left" valign="top"></td>
1.220     wiz      10105: <td align="left" valign="top"><p>The <code class="code">:=</code> is not really an
                   10106:        assignment operator, although it looks like it.
1.78      rillig   10107:        Instead, it is a degenerate form of
1.220     wiz      10108:        <code class="code">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.311     leot     10109:        which is documented in the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man page and which is
1.220     wiz      10110:        commonly used in the form <code class="code">${SRCS:.c=.o}</code>. In the
1.78      rillig   10111:        case of <code class="varname">MASTER_SITE_*</code>,
                   10112:        <em class="replaceable"><code>old_string</code></em> is the empty string and
                   10113:        <em class="replaceable"><code>new_string</code></em> is
1.220     wiz      10114:        <code class="code">package/</code>. That's where the
                   10115:        <code class="code">:</code> and the <code class="code">=</code> fall
1.78      rillig   10116:        together.</p></td>
                   10117: </tr>
1.148     asau     10118: <tr class="question">
1.78      rillig   10119: <td align="left" valign="top">
1.289     leot     10120: <a name="devfaq.mailinglists"></a><a name="devfaq.mailinglists.q"></a><p><b>24.7.</b></p>
1.78      rillig   10121: </td>
                   10122: <td align="left" valign="top"><p>Which mailing lists are there for package
                   10123:        developers?</p></td>
                   10124: </tr>
                   10125: <tr class="answer">
1.91      rillig   10126: <td align="left" valign="top"></td>
1.148     asau     10127: <td align="left" valign="top"><div class="variablelist"><dl class="variablelist">
1.289     leot     10128: <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   10129: <dd><p>This is a list for technical discussions related
                   10130:        to pkgsrc development, e.g. soliciting feedback for changes to
                   10131:        pkgsrc infrastructure, proposed new features, questions related
                   10132:        to porting pkgsrc to a new platform, advice for maintaining a
                   10133:        package, patches that affect many packages, help requests moved
                   10134:        from pkgsrc-users when an infrastructure bug is found,
                   10135:        etc.</p></dd>
1.289     leot     10136: <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   10137: <dd><p>All bug reports in category "pkg" sent with
1.311     leot     10138:        <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/send-pr.1"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> appear here. Please do not report your bugs here
1.78      rillig   10139:        directly; use one of the other mailing
                   10140:        lists.</p></dd>
                   10141: </dl></div></td>
                   10142: </tr>
1.148     asau     10143: <tr class="question">
1.80      rillig   10144: <td align="left" valign="top">
1.289     leot     10145: <a name="devfaq.documentation"></a><a name="devfaq.documentation.q"></a><p><b>24.8.</b></p>
1.80      rillig   10146: </td>
                   10147: <td align="left" valign="top"><p>Where is the pkgsrc
                   10148:        documentation?</p></td>
                   10149: </tr>
                   10150: <tr class="answer">
1.91      rillig   10151: <td align="left" valign="top"></td>
1.80      rillig   10152: <td align="left" valign="top">
                   10153: <p>There are many places where you can find
                   10154:        documentation about pkgsrc:</p>
1.148     asau     10155: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      10156: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.80      rillig   10157:        of chapters that explain large parts of pkgsrc, but some
                   10158:        chapters tend to be outdated. Which ones they are is hard to
                   10159:        say.</p></li>
1.289     leot     10160: <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   10161:        about certain features, announcements of new parts of the pkgsrc
                   10162:        infrastructure and sometimes even announcements that a certain
                   10163:        feature has been marked as obsolete. The benefit here is that
                   10164:        each message has a date appended to it.</p></li>
1.128     wiz      10165: <li class="listitem"><p>Many of the files in the
1.80      rillig   10166:        <code class="filename">mk/</code> directory start with a comment that
                   10167:        describes the purpose of the file and how it can be used by the
1.92      rillig   10168:        pkgsrc user and package authors. An easy way to find this
1.110     hubertf  10169:        documentation is to run <span class="command"><strong>bmake
1.92      rillig   10170:        help</strong></span>.</p></li>
1.128     wiz      10171: <li class="listitem"><p>The CVS log messages are a rich source of
1.80      rillig   10172:        information, but they tend to be highly abbreviated, especially
                   10173:        for actions that occur often. Some contain a detailed
                   10174:        description of what has changed, but they are geared towards the
                   10175:        other pkgsrc developers, not towards an average pkgsrc user.
                   10176:        They also only document <span class="emphasis"><em>changes</em></span>, so if you
                   10177:        don't know what has been before, these messages may not be worth
                   10178:        too much to you.</p></li>
1.128     wiz      10179: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">&#8220;<span class="quote">implicitly
                   10180:        documented</span>&#8221;</span>, that is the documentation exists only in the
1.80      rillig   10181:        mind of the developer who wrote the code. To get this
1.110     hubertf  10182:        information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.80      rillig   10183:        to see who has written it and ask on the
                   10184:        <code class="literal">tech-pkg</code> mailing list, so that others can
                   10185:        find your questions later (see above). To be sure that the
                   10186:        developer in charge reads the mail, you may CC him or
                   10187:        her.</p></li>
                   10188: </ul></div>
1.299     rillig   10189: </td>
                   10190: </tr>
                   10191: <tr class="question">
                   10192: <td align="left" valign="top">
                   10193: <a name="devfaq.too-much-time"></a><a name="devfaq.too-much-time.q"></a><p><b>24.9.</b></p>
                   10194: </td>
                   10195: <td align="left" valign="top"><p>I have a little time to kill. 
                   10196: What shall I do?</p></td>
                   10197: </tr>
                   10198: <tr class="answer">
                   10199: <td align="left" valign="top"></td>
                   10200: <td align="left" valign="top">
                   10201: <p>This is not really an FAQ yet, but here's the answer
                   10202: anyway.</p>
1.148     asau     10203: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.299     rillig   10204: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
                   10205:     <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_chk/README.html" target="_top"><code class="filename">pkgtools/pkg_chk</code></a> package).  It
                   10206:     will tell you about newer versions of installed packages that are
                   10207:     available, but not yet updated in pkgsrc.</p></li>
                   10208: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
                   10209:     &mdash; it contains a list of suggested new packages and a list of
                   10210:     cleanups and enhancements for pkgsrc that would be nice to
                   10211:     have.</p></li>
                   10212: <li class="listitem"><p>Review packages for which review was requested on
                   10213:     the <a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a>
                   10214:     mailing list.</p></li>
1.85      jmmv     10215: </ul></div>
1.299     rillig   10216: </td>
1.85      jmmv     10217: </tr>
                   10218: </tbody>
1.299     rillig   10219: </table>
1.85      jmmv     10220: </div>
                   10221: </div>
1.75      rillig   10222: </div>
1.148     asau     10223: <div class="part">
1.75      rillig   10224: <div class="titlepage"><div><div><h1 class="title">
                   10225: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.148     asau     10226: <div class="partintro">
1.75      rillig   10227: <div></div>
                   10228: <p>This part of the guide deals with everything
                   10229:        from the infrastructure that is behind the interfaces described
                   10230:        in the developer's guide. A casual package maintainer should not
                   10231:        need anything from this part.</p>
                   10232: <div class="toc">
                   10233: <p><b>Table of Contents</b></p>
1.210     leot     10234: <dl class="toc">
1.299     rillig   10235: <dt><span class="chapter"><a href="#infr.design">25. Design of the pkgsrc infrastructure</a></span></dt>
1.75      rillig   10236: <dd><dl>
1.299     rillig   10237: <dt><span class="sect1"><a href="#infr.vardef">25.1. The meaning of variable definitions</a></span></dt>
                   10238: <dt><span class="sect1"><a href="#infr.vardef.problems">25.2. Avoiding problems before they arise</a></span></dt>
                   10239: <dt><span class="sect1"><a href="#infr.var">25.3. Variable evaluation</a></span></dt>
1.75      rillig   10240: <dd><dl>
1.299     rillig   10241: <dt><span class="sect2"><a href="#infr.var.load">25.3.1. At load time</a></span></dt>
                   10242: <dt><span class="sect2"><a href="#infr.var.run">25.3.2. At runtime</a></span></dt>
1.75      rillig   10243: </dl></dd>
1.299     rillig   10244: <dt><span class="sect1"><a href="#infr.varspec">25.4. How can variables be specified?</a></span></dt>
                   10245: <dt><span class="sect1"><a href="#infr.design.intf">25.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig   10246: <dd><dl>
1.299     rillig   10247: <dt><span class="sect2"><a href="#infr.design.intf.proc">25.5.1. Procedures with parameters</a></span></dt>
                   10248: <dt><span class="sect2"><a href="#infr.design.intf.action">25.5.2. Actions taken on behalf of parameters</a></span></dt>
1.81      rillig   10249: </dl></dd>
1.299     rillig   10250: <dt><span class="sect1"><a href="#infr.order">25.6. The order in which files are loaded</a></span></dt>
1.81      rillig   10251: <dd><dl>
1.299     rillig   10252: <dt><span class="sect2"><a href="#infr.order.prefs">25.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
                   10253: <dt><span class="sect2"><a href="#infr.order.pkg">25.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.75      rillig   10254: </dl></dd>
                   10255: </dl></dd>
1.299     rillig   10256: <dt><span class="chapter"><a href="#regression">26. Regression tests</a></span></dt>
1.75      rillig   10257: <dd><dl>
1.299     rillig   10258: <dt><span class="sect1"><a href="#regression.run">26.1. Running the regression tests</a></span></dt>
                   10259: <dt><span class="sect1"><a href="#regression.new">26.2. Adding a new regression test</a></span></dt>
1.75      rillig   10260: <dd><dl>
1.299     rillig   10261: <dt><span class="sect2"><a href="#regression.fun.override">26.2.1. Overridable functions</a></span></dt>
                   10262: <dt><span class="sect2"><a href="#regression.fun.helper">26.2.2. Helper functions</a></span></dt>
1.75      rillig   10263: </dl></dd>
                   10264: </dl></dd>
1.299     rillig   10265: <dt><span class="chapter"><a href="#porting">27. Porting pkgsrc</a></span></dt>
                   10266: <dd><dl><dt><span class="sect1"><a href="#porting.opsys">27.1. Porting pkgsrc to a new operating system</a></span></dt></dl></dd>
1.75      rillig   10267: </dl>
                   10268: </div>
                   10269: </div>
1.148     asau     10270: <div class="chapter">
1.75      rillig   10271: <div class="titlepage"><div><div><h2 class="title">
1.299     rillig   10272: <a name="infr.design"></a>Chapter 25. Design of the pkgsrc infrastructure</h2></div></div></div>
1.75      rillig   10273: <div class="toc">
                   10274: <p><b>Table of Contents</b></p>
1.210     leot     10275: <dl class="toc">
1.299     rillig   10276: <dt><span class="sect1"><a href="#infr.vardef">25.1. The meaning of variable definitions</a></span></dt>
                   10277: <dt><span class="sect1"><a href="#infr.vardef.problems">25.2. Avoiding problems before they arise</a></span></dt>
                   10278: <dt><span class="sect1"><a href="#infr.var">25.3. Variable evaluation</a></span></dt>
1.81      rillig   10279: <dd><dl>
1.299     rillig   10280: <dt><span class="sect2"><a href="#infr.var.load">25.3.1. At load time</a></span></dt>
                   10281: <dt><span class="sect2"><a href="#infr.var.run">25.3.2. At runtime</a></span></dt>
1.81      rillig   10282: </dl></dd>
1.299     rillig   10283: <dt><span class="sect1"><a href="#infr.varspec">25.4. How can variables be specified?</a></span></dt>
                   10284: <dt><span class="sect1"><a href="#infr.design.intf">25.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig   10285: <dd><dl>
1.299     rillig   10286: <dt><span class="sect2"><a href="#infr.design.intf.proc">25.5.1. Procedures with parameters</a></span></dt>
                   10287: <dt><span class="sect2"><a href="#infr.design.intf.action">25.5.2. Actions taken on behalf of parameters</a></span></dt>
1.75      rillig   10288: </dl></dd>
1.299     rillig   10289: <dt><span class="sect1"><a href="#infr.order">25.6. The order in which files are loaded</a></span></dt>
1.75      rillig   10290: <dd><dl>
1.299     rillig   10291: <dt><span class="sect2"><a href="#infr.order.prefs">25.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
                   10292: <dt><span class="sect2"><a href="#infr.order.pkg">25.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.75      rillig   10293: </dl></dd>
                   10294: </dl>
                   10295: </div>
                   10296: <p>The pkgsrc infrastructure consists of many small Makefile
                   10297:        fragments. Each such fragment needs a properly specified
                   10298:        interface. This chapter explains how such an interface looks
                   10299:        like.</p>
1.148     asau     10300: <div class="sect1">
1.75      rillig   10301: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   10302: <a name="infr.vardef"></a>25.1. The meaning of variable definitions</h2></div></div></div>
1.81      rillig   10303: <p>Whenever a variable is defined in the pkgsrc
                   10304:        infrastructure, the location and the way of definition provide
                   10305:        much information about the intended use of that variable.
                   10306:        Additionally, more documentation may be found in a header
                   10307:        comment or in this pkgsrc guide.</p>
                   10308: <p>A special file is
                   10309:        <code class="filename">mk/defaults/mk.conf</code>, which lists all
                   10310:        variables that are intended to be user-defined. They are either
                   10311:        defined using the <code class="literal">?=</code> operator or they are
                   10312:        left undefined because defining them to anything would
1.128     wiz      10313:        effectively mean <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. All these variables may be
1.81      rillig   10314:        overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
                   10315:        file.</p>
                   10316: <p>Outside this file, the following conventions apply:
                   10317:        Variables that are defined using the <code class="literal">?=</code>
                   10318:        operator may be overridden by a package.</p>
                   10319: <p>Variables that are defined using the <code class="literal">=</code>
                   10320:        operator may be used read-only at run-time.</p>
                   10321: <p>Variables whose name starts with an underscore must not be
                   10322:        accessed outside the pkgsrc infrastructure at all. They may
                   10323:        change without further notice.</p>
1.148     asau     10324: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.81      rillig   10325: <h3 class="title">Note</h3>
                   10326: <p>These conventions are currently not applied
                   10327:        consistently to the complete pkgsrc
                   10328:        infrastructure.</p>
                   10329: </div>
                   10330: </div>
1.148     asau     10331: <div class="sect1">
1.81      rillig   10332: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   10333: <a name="infr.vardef.problems"></a>25.2. Avoiding problems before they arise</h2></div></div></div>
1.81      rillig   10334: <p>All variables that contain lists of things should default
                   10335:        to being empty. Two examples that do not follow this rule are
                   10336:        <code class="varname">USE_LANGUAGES</code> and
                   10337:        <code class="varname">DISTFILES</code>. These variables cannot simply be
                   10338:        modified using the <code class="literal">+=</code> operator in package
                   10339:        <code class="filename">Makefile</code>s (or other files included by
                   10340:        them), since there is no guarantee whether the variable is
                   10341:        already set or not, and what its value is. In the case of
1.128     wiz      10342:        <code class="varname">DISTFILES</code>, the packages <span class="quote">&#8220;<span class="quote">know</span>&#8221;</span>
1.81      rillig   10343:        the default value and just define it as in the following
                   10344:        example.</p>
                   10345: <pre class="programlisting">
1.100     rillig   10346: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
1.81      rillig   10347: </pre>
                   10348: <p>Because of the selection of this default value, the same
                   10349:        value appears in many package Makefiles. Similarly for
                   10350:        <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.128     wiz      10351:        value (<span class="quote">&#8220;<span class="quote"><code class="literal">c</code></span>&#8221;</span>) is so short that it
1.81      rillig   10352:        doesn't stand out. Nevertheless it is mentioned in many
                   10353:        files.</p>
                   10354: </div>
1.148     asau     10355: <div class="sect1">
1.81      rillig   10356: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   10357: <a name="infr.var"></a>25.3. Variable evaluation</h2></div></div></div>
1.148     asau     10358: <div class="sect2">
1.75      rillig   10359: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   10360: <a name="infr.var.load"></a>25.3.1. At load time</h3></div></div></div>
1.75      rillig   10361: <p>Variable evaluation takes place either at load time or at
                   10362:        runtime, depending on the context in which they occur. The
                   10363:        contexts where variables are evaluated at load time are:</p>
1.148     asau     10364: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      10365: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.75      rillig   10366:        and <code class="literal">!=</code> operators,</p></li>
1.128     wiz      10367: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.75      rillig   10368:        <code class="literal">.for</code>,</p></li>
1.128     wiz      10369: <li class="listitem"><p>Dependency lines.</p></li>
1.75      rillig   10370: </ul></div>
                   10371: <p>A special exception are references to the iteration
                   10372:        variables of <code class="literal">.for</code> loops, which are expanded
                   10373:        inline, no matter in which context they appear.</p>
                   10374: <p>As the values of variables may change during load time,
                   10375:        care must be taken not to evaluate them by accident. Typical
                   10376:        examples for variables that should not be evaluated at load time
                   10377:        are <code class="varname">DEPENDS</code> and
                   10378:        <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
                   10379:        clear, here is an example:</p>
                   10380: <pre class="programlisting">
1.100     rillig   10381: CONFIGURE_ARGS=         # none
                   10382: CFLAGS=                 -O
                   10383: CONFIGURE_ARGS+=        CFLAGS=${CFLAGS:Q}
1.1       grant    10384: 
1.100     rillig   10385: CONFIGURE_ARGS:=        ${CONFIGURE_ARGS}
1.1       grant    10386: 
1.100     rillig   10387: CFLAGS+=                -Wall
1.222     sevan    10388: </pre>
1.75      rillig   10389: <p>This code shows how the use of the <code class="literal">:=</code>
                   10390:        operator can quickly lead to unexpected results. The first
                   10391:        paragraph is fairly common code. The second paragraph evaluates
                   10392:        the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
                   10393:        <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
                   10394:        <code class="literal">-Wall</code> is appended to the
                   10395:        <code class="varname">CFLAGS</code>, but this addition will not appear in
                   10396:        <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
                   10397:        paragraphs from above typically occur in completely unrelated
                   10398:        files.</p>
                   10399: </div>
1.148     asau     10400: <div class="sect2">
1.75      rillig   10401: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   10402: <a name="infr.var.run"></a>25.3.2. At runtime</h3></div></div></div>
1.75      rillig   10403: <p>After all the files have been loaded, the values of the
                   10404:        variables cannot be changed anymore. Variables that are used in
                   10405:        the shell commands are expanded at this point.</p>
                   10406: </div>
                   10407: </div>
1.148     asau     10408: <div class="sect1">
1.75      rillig   10409: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   10410: <a name="infr.varspec"></a>25.4. How can variables be specified?</h2></div></div></div>
1.78      rillig   10411: <p>There are many ways in which the definition and use of a
1.218     rillig   10412:        variable can be restricted in order to detect bugs and violations
                   10413:        of the (mostly unwritten) policies. A package can be checked with
                   10414:        <code class="literal">pkglint -Wall</code> to see whether it meets these
                   10415:        rules.</p>
1.78      rillig   10416: </div>
1.148     asau     10417: <div class="sect1">
1.78      rillig   10418: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   10419: <a name="infr.design.intf"></a>25.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.76      rillig   10420: <p>Most of the <code class="filename">.mk</code> files fall into one
1.75      rillig   10421:        of the following classes. Cases where a file falls into more
                   10422:        than one class should be avoided as it often leads to subtle
                   10423:        bugs.</p>
1.148     asau     10424: <div class="sect2">
1.75      rillig   10425: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   10426: <a name="infr.design.intf.proc"></a>25.5.1. Procedures with parameters</h3></div></div></div>
1.75      rillig   10427: <p>In a traditional imperative programming language some of
1.76      rillig   10428:        the <code class="filename">.mk</code> files could be described as
1.126     jakllsch 10429:        procedures. They take some input parameters and&mdash;after
                   10430:        inclusion&mdash;provide a result in output parameters. Since all
1.76      rillig   10431:        variables in <code class="filename">Makefile</code>s have global scope
1.75      rillig   10432:        care must be taken not to use parameter names that have already
                   10433:        another meaning. For example, <code class="varname">PKGNAME</code> is a
                   10434:        bad choice for a parameter name.</p>
                   10435: <p>Procedures are completely evaluated at preprocessing time.
                   10436:        That is, when calling a procedure all input parameters must be
                   10437:        completely resolvable. For example,
                   10438:        <code class="varname">CONFIGURE_ARGS</code> should never be an input
                   10439:        parameter since it is very likely that further text will be
                   10440:        added after calling the procedure, which would effectively apply
                   10441:        the procedure to only a part of the variable. Also, references
1.218     rillig   10442:        to other variables will be modified after calling the
1.75      rillig   10443:        procedure.</p>
                   10444: <p>A procedure can declare its output parameters either as
                   10445:        suitable for use in preprocessing directives or as only
                   10446:        available at runtime. The latter alternative is for variables
                   10447:        that contain references to other runtime variables.</p>
                   10448: <p>Procedures shall be written such that it is possible to
                   10449:        call the procedure more than once. That is, the file must not
                   10450:        contain multiple-inclusion guards.</p>
                   10451: <p>Examples for procedures are
1.76      rillig   10452:        <code class="filename">mk/bsd.options.mk</code> and
                   10453:        <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
1.75      rillig   10454:        that the parameters are evaluated at load time, they should be
                   10455:        assigned using the <code class="literal">:=</code> operator, which should
                   10456:        be used only for this purpose.</p>
                   10457: </div>
1.148     asau     10458: <div class="sect2">
1.75      rillig   10459: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   10460: <a name="infr.design.intf.action"></a>25.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.75      rillig   10461: <p>Action files take some input parameters and may define
                   10462:        runtime variables. They shall not define loadtime variables.
                   10463:        There are action files that are included implicitly by the
                   10464:        pkgsrc infrastructure, while other must be included
                   10465:        explicitly.</p>
                   10466: <p>An example for action files is
1.76      rillig   10467:        <code class="filename">mk/subst.mk</code>.</p>
1.75      rillig   10468: </div>
                   10469: </div>
1.148     asau     10470: <div class="sect1">
1.81      rillig   10471: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   10472: <a name="infr.order"></a>25.6. The order in which files are loaded</h2></div></div></div>
1.81      rillig   10473: <p>Package <code class="filename">Makefile</code>s usually consist of
                   10474:        a set of variable definitions, and include the file
                   10475:        <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
                   10476:        Before that, they may also include various other
                   10477:        <code class="filename">*.mk</code> files if they need to query the
                   10478:        availability of certain features like the type of compiler or
                   10479:        the X11 implementation. Due to the heavy use of preprocessor
                   10480:        directives like <code class="literal">.if</code> and
                   10481:        <code class="literal">.for</code>, the order in which the files are loaded
                   10482:        matters.</p>
                   10483: <p>This section describes at which point the various files
                   10484:        are loaded and gives reasons for that order.</p>
1.148     asau     10485: <div class="sect2">
1.81      rillig   10486: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   10487: <a name="infr.order.prefs"></a>25.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.93      rillig   10488: </h3></div></div></div>
                   10489: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
1.81      rillig   10490:        is to define some essential variables like
                   10491:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
                   10492:        <code class="varname">MACHINE_ARCH</code>.</p>
                   10493: <p>Then, the user settings are loaded from the file specified
1.110     hubertf  10494:        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   10495:        After that, those variables
1.81      rillig   10496:        that have not been overridden by the user are loaded from
                   10497:        <code class="filename">mk/defaults/mk.conf</code>.</p>
                   10498: <p>After the user settings, the system settings and platform
                   10499:        settings are loaded, which may override the user
                   10500:        settings.</p>
                   10501: <p>Then, the tool definitions are loaded. The tool wrappers
                   10502:        are not yet in effect. This only happens when building a
                   10503:        package, so the proper variables must be used instead of the
                   10504:        direct tool names.</p>
                   10505: <p>As the last steps, some essential variables from the
                   10506:        wrapper and the package system flavor are loaded, as well as the
                   10507:        variables that have been cached in earlier phases of a package
                   10508:        build.</p>
                   10509: </div>
1.148     asau     10510: <div class="sect2">
1.81      rillig   10511: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   10512: <a name="infr.order.pkg"></a>25.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.93      rillig   10513: </h3></div></div></div>
1.81      rillig   10514: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
                   10515: <p>Then, the various <code class="filename">*-vars.mk</code> files are
                   10516:        loaded, which fill default values for those variables that have
1.93      rillig   10517:        not been defined by the package. These variables may later
1.81      rillig   10518:        be used even in unrelated files.</p>
                   10519: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
                   10520:        provides the target <code class="literal">error-check</code> that is added
                   10521:        as a special dependency to all other targets that use
                   10522:        <code class="varname">DELAYED_ERROR_MSG</code> or
                   10523:        <code class="varname">DELAYED_WARNING_MSG</code>.</p>
                   10524: <p>Then, the package-specific hacks from
                   10525:        <code class="filename">hacks.mk</code> are included.</p>
                   10526: <p>Then, various other files follow. Most of them don't have
                   10527:        any dependencies on what they need to have included before or
                   10528:        after them, though some do.</p>
                   10529: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
                   10530:        <code class="varname">PKG_SKIP_REASON</code> is then executed, which
                   10531:        restricts the use of these variables to all the files that have
                   10532:        been included before. Appearances in later files will be
                   10533:        silently ignored.</p>
                   10534: <p>Then, the files for the main targets are included, in the
                   10535:        order of later execution, though the actual order should not
                   10536:        matter.</p>
                   10537: <p>At last, some more files are included that don't set any
                   10538:        interesting variables but rather just define make targets to be
                   10539:        executed.</p>
                   10540: </div>
                   10541: </div>
1.75      rillig   10542: </div>
1.148     asau     10543: <div class="chapter">
1.75      rillig   10544: <div class="titlepage"><div><div><h2 class="title">
1.299     rillig   10545: <a name="regression"></a>Chapter 26. Regression tests</h2></div></div></div>
1.75      rillig   10546: <div class="toc">
                   10547: <p><b>Table of Contents</b></p>
1.210     leot     10548: <dl class="toc">
1.299     rillig   10549: <dt><span class="sect1"><a href="#regression.run">26.1. Running the regression tests</a></span></dt>
                   10550: <dt><span class="sect1"><a href="#regression.new">26.2. Adding a new regression test</a></span></dt>
1.75      rillig   10551: <dd><dl>
1.299     rillig   10552: <dt><span class="sect2"><a href="#regression.fun.override">26.2.1. Overridable functions</a></span></dt>
                   10553: <dt><span class="sect2"><a href="#regression.fun.helper">26.2.2. Helper functions</a></span></dt>
1.75      rillig   10554: </dl></dd>
                   10555: </dl>
                   10556: </div>
                   10557: <p>The pkgsrc infrastructure consists of a large codebase,
                   10558:        and there are many corners where every little bit of a file is
                   10559:        well thought out, making pkgsrc likely to fail as soon as
                   10560:        anything is changed near those parts. To prevent most changes
                   10561:        from breaking anything, a suite of regression tests should go
                   10562:        along with every important part of the pkgsrc infrastructure.
                   10563:        This chapter describes how regression tests work in pkgsrc and
                   10564:        how you can add new tests.</p>
1.148     asau     10565: <div class="sect1">
1.75      rillig   10566: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   10567: <a name="regression.run"></a>26.1. Running the regression tests</h2></div></div></div>
1.250     leot     10568: <p>You first need to install the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_regress/README.html" target="_top"><code class="filename">pkgtools/pkg_regress</code></a> package, which
1.110     hubertf  10569:        provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.75      rillig   10570:        can simply run that command, which will run all tests in the
1.283     rillig   10571:        <code class="filename">regress/</code> directory.</p>
1.75      rillig   10572: </div>
1.148     asau     10573: <div class="sect1">
1.75      rillig   10574: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   10575: <a name="regression.new"></a>26.2. Adding a new regression test</h2></div></div></div>
1.283     rillig   10576: <p>Every directory in the <code class="filename">regress/</code>
                   10577:        directory that contains a file called <code class="filename">spec</code>
1.75      rillig   10578:        is considered a regression test. This file is a shell program
1.110     hubertf  10579:        that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.75      rillig   10580:        The following functions can be overridden to suit your
                   10581:        needs.</p>
1.148     asau     10582: <div class="sect2">
1.75      rillig   10583: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   10584: <a name="regression.fun.override"></a>26.2.1. Overridable functions</h3></div></div></div>
1.218     rillig   10585: <p>These functions do not take any parameters. Although they
                   10586:        are called in <span class="quote">&#8220;<span class="quote">set -e</span>&#8221;</span> mode, they don't stop at the
1.289     leot     10587:        first failing command. See <a class="ulink" href="https://stackoverflow.com/q/4072984" target="_top">this Stack Overflow
1.218     rillig   10588:        question</a> for details.</p>
1.148     asau     10589: <div class="variablelist"><dl class="variablelist">
1.218     rillig   10590: <dt><span class="term"><code class="varname">do_setup</code></span></dt>
1.75      rillig   10591: <dd><p>This function prepares the environment for the
                   10592:        test. By default it does nothing.</p></dd>
1.218     rillig   10593: <dt><span class="term"><code class="varname">do_test</code></span></dt>
                   10594: <dd>
                   10595: <p>This function runs the actual test. By default,
1.75      rillig   10596:        it calls <code class="varname">TEST_MAKE</code> with the arguments
                   10597:        <code class="varname">MAKEARGS_TEST</code> and writes its output including
                   10598:        error messages into the file
1.218     rillig   10599:        <code class="varname">TEST_OUTFILE</code>.</p>
                   10600: <p>When defining this function, make sure that all output that
                   10601:        needs to be checked is written to the correct output file.
                   10602:        Example:</p>
                   10603: <pre class="programlisting">
                   10604: do_test() {
1.223     rillig   10605:         echo "Example output"
1.218     rillig   10606: } 1&gt;$TEST_OUTFILE 2&gt;&amp;1
                   10607: </pre>
                   10608: </dd>
                   10609: <dt><span class="term"><code class="varname">check_result</code></span></dt>
                   10610: <dd>
                   10611: <p>This function is run after the test and is
1.75      rillig   10612:        typically used to compare the actual output from the one that is
                   10613:        expected. It can make use of the various helper functions from
1.218     rillig   10614:        the next section. Example:</p>
                   10615: <pre class="programlisting">
                   10616: check_result() {
1.223     rillig   10617:         exit_status 0
                   10618:         output_require "Example"
                   10619:         output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
                   10620:         output_prohibit "no such file or directory"
1.283     rillig   10621:         regress_fail "expected $expected but got $actual for input $input"
1.218     rillig   10622: }
                   10623: </pre>
                   10624: </dd>
                   10625: <dt><span class="term"><code class="varname">do_cleanup</code></span></dt>
1.75      rillig   10626: <dd><p>This function cleans everything up after the
                   10627:        test has been run. By default it does nothing.</p></dd>
                   10628: </dl></div>
                   10629: </div>
1.148     asau     10630: <div class="sect2">
1.75      rillig   10631: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   10632: <a name="regression.fun.helper"></a>26.2.2. Helper functions</h3></div></div></div>
1.148     asau     10633: <div class="variablelist"><dl class="variablelist">
1.283     rillig   10634: <dt><span class="term"><code class="varname">regress_fail <em class="replaceable"><code>message...</code></em></code></span></dt>
                   10635: <dd><p>This function makes the test fail with the given error message.</p></dd>
1.218     rillig   10636: <dt><span class="term"><code class="varname">exit_status expected</code></span></dt>
1.75      rillig   10637: <dd><p>This function compares the exitcode of the
1.218     rillig   10638:        <span class="command"><strong>do_test</strong></span> function with its first parameter.
1.75      rillig   10639:        If they differ, the test will fail.</p></dd>
1.218     rillig   10640: <dt><span class="term"><code class="varname">output_require regex...</code></span></dt>
                   10641: <dd>
                   10642: <p>This function checks for each of its parameters
                   10643:        if the output from <span class="command"><strong>do_test</strong></span> matches the
1.75      rillig   10644:        extended regular expression. If it does not, the test will
1.218     rillig   10645:        fail. Example:</p>
                   10646: <pre class="programlisting">
1.219     rillig   10647: output_require "looks fine"
                   10648: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
1.218     rillig   10649: </pre>
                   10650: </dd>
1.292     leot     10651: <dt><span class="term"><code class="varname">output_prohibit regex...</code></span></dt>
1.75      rillig   10652: <dd><p>This function checks for each of its parameters
1.110     hubertf  10653:        if the output from <span class="command"><strong>do_test()</strong></span> does
1.75      rillig   10654:        <span class="emphasis"><em>not</em></span> match the extended regular expression.
                   10655:        If any of the regular expressions matches, the test will
                   10656:        fail.</p></dd>
                   10657: </dl></div>
                   10658: </div>
                   10659: </div>
                   10660: </div>
1.148     asau     10661: <div class="chapter">
1.75      rillig   10662: <div class="titlepage"><div><div><h2 class="title">
1.299     rillig   10663: <a name="porting"></a>Chapter 27. Porting pkgsrc</h2></div></div></div>
1.75      rillig   10664: <div class="toc">
                   10665: <p><b>Table of Contents</b></p>
1.299     rillig   10666: <dl class="toc"><dt><span class="sect1"><a href="#porting.opsys">27.1. Porting pkgsrc to a new operating system</a></span></dt></dl>
1.75      rillig   10667: </div>
                   10668: <p>The pkgsrc system has already been ported to many
                   10669:        operating systems, hardware architectures and compilers. This
                   10670:        chapter explains the necessary steps to make pkgsrc even more
                   10671:        portable.</p>
1.148     asau     10672: <div class="sect1">
1.75      rillig   10673: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   10674: <a name="porting.opsys"></a>27.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.75      rillig   10675: <p>To port pkgsrc to a new operating system (called
                   10676:        <code class="literal">MyOS</code> in this example), you need to touch the
                   10677:        following files:</p>
1.148     asau     10678: <div class="variablelist"><dl class="variablelist">
1.93      rillig   10679: <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   10680: <dd><p>This file contains some basic definitions, for
                   10681:        example the name of the C
                   10682:        compiler.</p></dd>
1.76      rillig   10683: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
1.75      rillig   10684: <dd><p>Insert code that defines the variables
                   10685:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
                   10686:        <code class="varname">LOWER_OS_VERSION</code>,
                   10687:        <code class="varname">LOWER_VENDOR</code>,
                   10688:        <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
                   10689:        <code class="varname">APPEND_ELF</code>, and the other variables that
                   10690:        appear in this file.</p></dd>
1.93      rillig   10691: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75      rillig   10692: <dd><p>This file contains the platform-specific
                   10693:        definitions that are used by pkgsrc. Start by copying one of the
                   10694:        other files and edit it to your
                   10695:        needs.</p></dd>
1.93      rillig   10696: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75      rillig   10697: <dd><p>This file defines the paths to all the tools
                   10698:        that are needed by one or the other package in pkgsrc, as well
                   10699:        as by pkgsrc itself. Find out where these tools are on your
                   10700:        platform and add them.</p></dd>
                   10701: </dl></div>
                   10702: <p>Now, you should be able to build some basic packages, like
1.250     leot     10703:        <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/perl5/README.html" target="_top"><code class="filename">lang/perl5</code></a>, <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/bash/README.html" target="_top"><code class="filename">shells/bash</code></a>.</p>
1.75      rillig   10704: </div>
                   10705: </div>
                   10706: </div>
1.148     asau     10707: <div class="appendix">
                   10708: <div class="titlepage"><div><div><h1 class="title">
                   10709: <a name="examples"></a>Appendix A. A simple example package: bison</h1></div></div></div>
1.75      rillig   10710: <div class="toc">
                   10711: <p><b>Table of Contents</b></p>
1.210     leot     10712: <dl class="toc">
1.75      rillig   10713: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
                   10714: <dd><dl>
                   10715: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
                   10716: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
                   10717: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.287     rillig   10718: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with pkglint</a></span></dt>
1.75      rillig   10719: </dl></dd>
                   10720: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
                   10721: </dl>
                   10722: </div>
                   10723: <p>We checked to find a piece of software that wasn't in the packages
                   10724:     collection, and picked GNU bison. Quite why someone would want to have
1.110     hubertf  10725:     <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.75      rillig   10726:     present in the tree is beyond us, but it's useful for the purposes of
                   10727:     this exercise.</p>
1.148     asau     10728: <div class="sect1">
1.75      rillig   10729: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10730: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.148     asau     10731: <div class="sect2">
1.75      rillig   10732: <div class="titlepage"><div><div><h3 class="title">
                   10733: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
                   10734: <pre class="programlisting">
1.100     rillig   10735: # $NetBSD$
                   10736: #
1.1       grant    10737: 
1.100     rillig   10738: DISTNAME=       bison-1.25
                   10739: CATEGORIES=     devel
1.286     rillig   10740: MASTER_SITES=   ${MASTER_SITE_GNU:=bison/}
1.1       grant    10741: 
1.136     dholland 10742: MAINTAINER=     pkgsrc-users@NetBSD.org
1.289     leot     10743: HOMEPAGE=       https://www.gnu.org/software/bison/bison.html
1.100     rillig   10744: COMMENT=        GNU yacc clone
1.1       grant    10745: 
1.100     rillig   10746: GNU_CONFIGURE=  yes
1.152     wiz      10747: INFO_FILES=     yes
1.1       grant    10748: 
1.100     rillig   10749: .include "../../mk/bsd.pkg.mk"
1.1       grant    10750: </pre>
1.75      rillig   10751: </div>
1.148     asau     10752: <div class="sect2">
1.75      rillig   10753: <div class="titlepage"><div><div><h3 class="title">
                   10754: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
                   10755: <pre class="programlisting">
1.100     rillig   10756: GNU version of yacc.  Can make re-entrant parsers, and numerous other
1.311     leot     10757: improvements.  Why you would want this when Berkeley <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/yacc.1"><span class="citerefentry"><span class="refentrytitle">yacc</span>(1)</span></a> is part
1.100     rillig   10758: of the NetBSD source tree is beyond me.
1.1       grant    10759: </pre>
1.75      rillig   10760: </div>
1.148     asau     10761: <div class="sect2">
1.75      rillig   10762: <div class="titlepage"><div><div><h3 class="title">
                   10763: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
                   10764: <pre class="programlisting">
1.100     rillig   10765: @comment $NetBSD$
                   10766: bin/bison
                   10767: man/man1/bison.1.gz
                   10768: share/bison.simple
                   10769: share/bison.hairy
1.1       grant    10770: </pre>
1.75      rillig   10771: </div>
1.148     asau     10772: <div class="sect2">
1.75      rillig   10773: <div class="titlepage"><div><div><h3 class="title">
1.287     rillig   10774: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with pkglint</h3></div></div></div>
1.75      rillig   10775: <p>The NetBSD package system comes with
1.250     leot     10776:         <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>
1.75      rillig   10777:        which helps to check the contents of these
                   10778:        files. After installation it is quite easy to use, just change to the
1.286     rillig   10779:        directory of the package you wish to examine and run
1.110     hubertf  10780:        <span class="command"><strong>pkglint</strong></span>:</p>
1.75      rillig   10781: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
1.286     rillig   10782: ERROR: Makefile: Each package must define its LICENSE.
                   10783: WARN: Makefile:9: HOMEPAGE should migrate from http to https.
                   10784: NOTE: PLIST:3: The .gz extension is unnecessary for manual pages.
                   10785: WARN: PLIST:5: "share/bison.hairy" should be sorted before "share/bison.simple".
                   10786: 1 error, 2 warnings and 1 note found.
                   10787: (Run "pkglint -e" to show explanations.)
                   10788: (Run "pkglint -fs" to show what can be fixed automatically.)
1.287     rillig   10789: (Run "pkglint -F" to automatically fix some issues.)</pre>
1.75      rillig   10790: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.285     rillig   10791:        more checks will be performed. Use e.g. <span class="command"><strong>pkglint
1.75      rillig   10792:        -Wall</strong></span> for a very thorough check.</p>
                   10793: </div>
                   10794: </div>
1.148     asau     10795: <div class="sect1">
1.75      rillig   10796: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10797: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
                   10798: <p>Create the directory where the package lives,
                   10799:       plus any auxiliary directories:</p>
                   10800: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
                   10801: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
                   10802: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
                   10803: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
1.76      rillig   10804: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.299     rillig   10805:       <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   10806:       then continue with fetching the distfile:</p>
                   10807: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
1.1       grant    10808: &gt;&gt; bison-1.25.tar.gz doesn't seem to exist on this system.
                   10809: &gt;&gt; Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
                   10810: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   10811: ftp: Error retrieving file: 500 Internal error
                   10812: 
                   10813: &gt;&gt; Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
                   10814: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   10815: ftp: Error retrieving file: 500 Internal error
                   10816: 
                   10817: &gt;&gt; Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
                   10818: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
1.75      rillig   10819: Successfully retrieved file.</pre>
                   10820: <p>Generate the checksum of the distfile into
1.76      rillig   10821:       <code class="filename">distinfo</code>:</p>
1.88      wiz      10822: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
1.75      rillig   10823: <p>Now compile:</p>
                   10824: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1       grant    10825: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10826: ===&gt;  Extracting for bison-1.25
                   10827: ===&gt;  Patching for bison-1.25
                   10828: ===&gt;   Ignoring empty patch directory
                   10829: ===&gt;  Configuring for bison-1.25
                   10830: creating cache ./config.cache
                   10831: checking for gcc... cc
                   10832: checking whether we are using GNU C... yes
                   10833: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
                   10834: checking how to run the C preprocessor... cc -E
                   10835: checking for minix/config.h... no
                   10836: checking for POSIXized ISC... no
                   10837: checking whether cross-compiling... no
                   10838: checking for ANSI C header files... yes
                   10839: checking for string.h... yes
                   10840: checking for stdlib.h... yes
                   10841: checking for memory.h... yes
                   10842: checking for working const... yes
                   10843: checking for working alloca.h... no
                   10844: checking for alloca... yes
                   10845: checking for strerror... yes
                   10846: updating cache ./config.cache
                   10847: creating ./config.status
                   10848: creating Makefile
                   10849: ===&gt;  Building for bison-1.25
                   10850: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g LR0.c
                   10851: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g allocate.c
                   10852: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g closure.c
                   10853: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g conflicts.c
                   10854: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g derives.c
1.68      rillig   10855: 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    10856: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g getargs.c
                   10857: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g gram.c
                   10858: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g lalr.c
                   10859: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g lex.c
                   10860: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g main.c
                   10861: 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
                   10862: 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
                   10863: 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
                   10864: 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
                   10865: 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
                   10866: 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
                   10867: 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
                   10868: 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
                   10869: 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
                   10870: 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
                   10871: 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
                   10872: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
                   10873: rm -f bison.s1
1.75      rillig   10874: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" &lt; ./bison.simple &gt; bison.s1</pre>
                   10875: <p>Everything seems OK, so install the files:</p>
                   10876: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1       grant    10877: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10878: ===&gt;  Installing for bison-1.25
                   10879: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share  /usr/pkg/info /usr/pkg/man/man1
                   10880: rm -f /usr/pkg/bin/bison
                   10881: cd /usr/pkg/share; rm -f bison.simple bison.hairy
                   10882: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
                   10883: install -c  -o bin -g bin -m 555 bison /usr/pkg/bin/bison
                   10884: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
                   10885: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
                   10886: cd .; for f in bison.info*;  do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
                   10887: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
1.75      rillig   10888: ===&gt;  Registering installation for bison-1.25</pre>
                   10889: <p>You can now use bison, and also - if you decide so - remove it with
1.110     hubertf  10890:       <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.75      rillig   10891:       binary package, do this now:</p>
                   10892: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1       grant    10893: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10894: ===&gt;  Building package for bison-1.25
                   10895: Creating package bison-1.25.tgz
                   10896: Registering depends:.
1.75      rillig   10897: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
                   10898: <p>Now that you don't need the source and object files
                   10899:       any more, clean up:</p>
                   10900: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
                   10901: ===&gt;  Cleaning for bison-1.25</pre>
                   10902: </div>
                   10903: </div>
1.148     asau     10904: <div class="appendix">
                   10905: <div class="titlepage"><div><div><h1 class="title">
                   10906: <a name="logs"></a>Appendix B. Build logs</h1></div></div></div>
1.75      rillig   10907: <div class="toc">
                   10908: <p><b>Table of Contents</b></p>
1.210     leot     10909: <dl class="toc">
1.75      rillig   10910: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
                   10911: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
                   10912: </dl>
                   10913: </div>
1.148     asau     10914: <div class="sect1">
1.75      rillig   10915: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10916: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
                   10917: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1       grant    10918: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10919: =&gt; figlet221.tar.gz doesn't seem to exist on this system.
                   10920: =&gt; Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
                   10921: =&gt; [172219 bytes]
                   10922: Connected to ftp.plig.net.
                   10923: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
                   10924: 331 Guest login ok, send your complete e-mail address as password.
                   10925: 230-You are user #5 of 500 simultaneous users allowed.
                   10926: 230-
1.68      rillig   10927: 230-  ___ _             _ _
                   10928: 230- |  _| |_ ___   ___| |_|___   ___ ___ ___
1.1       grant    10929: 230- |  _|  _| . |_| . | | | . |_| . |  _| . |
                   10930: 230- |_| |_| |  _|_|  _|_|_|_  |_|___|_| |_  |
                   10931: 230-         |_|   |_|     |___|         |___|
                   10932: 230-
                   10933: 230-** Welcome to ftp.plig.org **
                   10934: 230-
                   10935: 230-Please note that all transfers from this FTP site are logged. If you
                   10936: 230-do not like this, please disconnect now.
                   10937: 230-
1.120     snj      10938: 230-This archive is available via
1.1       grant    10939: 230-
                   10940: 230-HTTP:  http://ftp.plig.org/
                   10941: 230-FTP:   ftp://ftp.plig.org/     (max 500 connections)
                   10942: 230-RSYNC: rsync://ftp.plig.org/   (max  30 connections)
                   10943: 230-
                   10944: 230-Please email comments, bug reports and requests for packages to be
1.68      rillig   10945: 230-mirrored to ftp-admin@plig.org.
1.1       grant    10946: 230-
                   10947: 230-
                   10948: 230 Logged in anonymously.
                   10949: Remote system type is UNIX.
                   10950: Using binary mode to transfer files.
                   10951: 200 Type okay.
                   10952: 250 "/pub" is new cwd.
                   10953: 250-"/pub/figlet" is new cwd.
                   10954: 250-
                   10955: 250-Welcome to the figlet archive at ftp.figlet.org
1.68      rillig   10956: 250-
1.75      rillig   10957: 250-   ftp://ftp.figlet.org/pub/figlet/
1.1       grant    10958: 250-
                   10959: 250-The official FIGlet web page is:
1.75      rillig   10960: 250-   http://www.figlet.org/
1.1       grant    10961: 250-
                   10962: 250-If you have questions, please mailto:info@figlet.org. If you want to
                   10963: 250-contribute a font or something else, you can email us.
1.68      rillig   10964: 250
1.1       grant    10965: 250 "/pub/figlet/program" is new cwd.
                   10966: 250 "/pub/figlet/program/unix" is new cwd.
                   10967: local: figlet221.tar.gz remote: figlet221.tar.gz
                   10968: 502 Unimplemented command.
                   10969: 227 Entering Passive Mode (195,40,6,41,246,104)
                   10970: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
                   10971: 38% |**************                       | 65800      64.16 KB/s    00:01 ETA
                   10972: 226 Transfer completed.
                   10973: 172219 bytes received in 00:02 (75.99 KB/s)
                   10974: 221 Goodbye.
                   10975: =&gt; Checksum OK for figlet221.tar.gz.
                   10976: ===&gt; Extracting for figlet-2.2.1nb2
                   10977: ===&gt; Required installed package ccache-[0-9]*: ccache-2.3nb1 found
                   10978: ===&gt; Patching for figlet-2.2.1nb2
                   10979: ===&gt; Applying pkgsrc patches for figlet-2.2.1nb2
                   10980: ===&gt; Overriding tools for figlet-2.2.1nb2
                   10981: ===&gt; Creating toolchain wrappers for figlet-2.2.1nb2
                   10982: ===&gt; Configuring for figlet-2.2.1nb2
                   10983: ===&gt; Building for figlet-2.2.1nb2
                   10984: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\"  -DDEFAULTFONTFILE=\"standard.flf\"  figlet.c zipio.c crc.c inflate.c -o figlet
                   10985: chmod a+x figlet
                   10986: gcc -O2 -o chkfont chkfont.c
                   10987: =&gt; Unwrapping files-to-be-installed.
1.14      xtraeme  10988: <code class="prompt">#</code>
1.75      rillig   10989: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1       grant    10990: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10991: ===&gt; Installing for figlet-2.2.1nb2
                   10992: install -d -o root -g wheel -m 755 /usr/pkg/bin
                   10993: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
                   10994: mkdir -p /usr/pkg/share/figlet
                   10995: cp figlet /usr/pkg/bin
                   10996: cp chkfont /usr/pkg/bin
                   10997: chmod 555 figlist showfigfonts
                   10998: cp figlist /usr/pkg/bin
                   10999: cp showfigfonts /usr/pkg/bin
                   11000: cp fonts/*.flf /usr/pkg/share/figlet
                   11001: cp fonts/*.flc /usr/pkg/share/figlet
                   11002: cp figlet.6 /usr/pkg/man/man6
                   11003: ===&gt; Registering installation for figlet-2.2.1nb2
1.75      rillig   11004: <code class="prompt">#</code></pre>
                   11005: </div>
1.148     asau     11006: <div class="sect1">
1.75      rillig   11007: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11008: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
                   11009: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1       grant    11010: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   11011: ===&gt; Packaging figlet-2.2.1nb2
                   11012: ===&gt; Building binary package for figlet-2.2.1nb2
                   11013: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
                   11014: Using SrcDir value of /usr/pkg
1.68      rillig   11015: Registering depends:.
1.75      rillig   11016: <code class="prompt">#</code></pre>
                   11017: </div>
                   11018: </div>
1.148     asau     11019: <div class="appendix">
                   11020: <div class="titlepage"><div><div><h1 class="title">
                   11021: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h1></div></div></div>
1.76      rillig   11022: <div class="toc">
                   11023: <p><b>Table of Contents</b></p>
1.210     leot     11024: <dl class="toc">
1.128     wiz      11025: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
                   11026: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
                   11027: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
                   11028: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
                   11029: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
1.261     leot     11030: <code class="filename">stable</code>,
1.128     wiz      11031: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76      rillig   11032: source packages</a></span></dt>
                   11033: </dl>
                   11034: </div>
                   11035: <p>As in other big projects, the directory layout of pkgsrc
                   11036:        is quite complex for newbies. This chapter explains where you
                   11037:        find things on the FTP server. The base directory on
1.110     hubertf  11038:        <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>.
1.89      rillig   11039:        On other servers it may be different, but inside this directory,
                   11040:        everything should look the same, no matter on which server you
                   11041:        are. This directory contains some subdirectories, which are
                   11042:        explained below.</p>
1.148     asau     11043: <div class="sect1">
1.76      rillig   11044: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126     jakllsch 11045: <a name="ftp-distfiles"></a>C.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
1.76      rillig   11046: <p>The directory <code class="filename">distfiles</code> contains lots
                   11047:        of archive files from all pkgsrc packages, which are mirrored
                   11048:        here. The subdirectories are called after their package names
                   11049:        and are used when the distributed files have names that don't
                   11050:        explicitly contain a version number or are otherwise too generic
                   11051:        (for example <code class="filename">release.tar.gz</code>).</p>
                   11052: </div>
1.148     asau     11053: <div class="sect1">
1.76      rillig   11054: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126     jakllsch 11055: <a name="ftp-misc"></a>C.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
1.76      rillig   11056: <p>This directory contains things that individual pkgsrc
                   11057:        developers find worth publishing.</p>
                   11058: </div>
1.148     asau     11059: <div class="sect1">
1.76      rillig   11060: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126     jakllsch 11061: <a name="ftp-packages"></a>C.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
1.102     rillig   11062: <p>This directory contains binary packages for the various
                   11063:        platforms that are supported by pkgsrc.
                   11064:        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>
1.148     asau     11065: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      11066: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
1.109     rillig   11067:        operating system for which the packages have been built. The
1.110     hubertf  11068:        name is taken from the output of the <span class="command"><strong>uname</strong></span>
1.109     rillig   11069:        command, so it may differ from the one you are used to
                   11070:        hear.</p></li>
1.128     wiz      11071: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
1.108     rillig   11072:        architecture of the platform for which the packages have been
1.110     hubertf  11073:        built. It also includes the <code class="varname">ABI</code> (Application
                   11074:        Binary Interface) for platforms that have several of
                   11075:        them.</p></li>
1.128     wiz      11076: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
1.108     rillig   11077:        the operating system. For version numbers that change often (for
                   11078:        example NetBSD-current), the often-changing part should be
                   11079:        replaced with an <code class="literal">x</code>, for example
                   11080:        <code class="literal">4.99.x</code>.</p></li>
1.128     wiz      11081: <li class="listitem"><p><code class="varname">TAG</code> is either
1.126     jakllsch 11082:        <code class="literal">20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
1.108     rillig   11083:        for a stable branch, or <code class="literal">head</code> for packages
                   11084:        built from the HEAD branch. The latter should only be used when
                   11085:        the packages are updated on a regular basis. Otherwise the date
                   11086:        from checking out pkgsrc should be appended, for example
                   11087:        <code class="literal">head_20071015</code>.</p></li>
1.102     rillig   11088: </ul></div>
                   11089: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
                   11090:        can quickly click through the directories on the
                   11091:        server and find the best binary packages for their machines. Since they
                   11092:        usually know the operating system and the hardware architecture, OPSYS
                   11093:        and ARCH are placed first. After these choices, they can select the
                   11094:        best combination of OSVERSION and TAG together, since it is usually the
                   11095:        case that packages stay compatible between different version of the
                   11096:        operating system.</p>
                   11097: <p>In each of these directories, there is a
                   11098:        whole binary packages collection for a specific platform. It has a directory called
1.76      rillig   11099:        <code class="filename">All</code> which contains all binary packages.
                   11100:        Besides that, there are various category directories that
                   11101:        contain symbolic links to the real binary packages.</p>
                   11102: </div>
1.148     asau     11103: <div class="sect1">
1.76      rillig   11104: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126     jakllsch 11105: <a name="ftp-reports"></a>C.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.108     rillig   11106: <p>Here are the reports from bulk builds, for those who want
                   11107:        to fix packages that didn't build on some of the platforms. The
1.128     wiz      11108:        structure of subdirectories should look like the one in <a class="xref" href="#ftp-packages" title="C.3. packages: Binary packages">Section C.3, &#8220;<code class="filename">packages</code>: Binary packages&#8221;</a>.</p>
1.108     rillig   11109: </div>
1.148     asau     11110: <div class="sect1">
1.108     rillig   11111: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126     jakllsch 11112: <a name="ftp-source"></a>C.5. <code class="filename">current</code>,
1.261     leot     11113: <code class="filename">stable</code>,
1.126     jakllsch 11114: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76      rillig   11115: source packages</h2></div></div></div>
1.128     wiz      11116: <p>These directories contain the <span class="quote">&#8220;<span class="quote">real</span>&#8221;</span> pkgsrc,
1.76      rillig   11117:        that is the files that define how to create binary packages from
                   11118:        source archives.</p>
1.262     leot     11119: <p>Each of the <code class="filename">current</code>,
                   11120:        <code class="filename">stable</code> and
                   11121:        <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
                   11122:        directories share the same structure.  They each contain a
                   11123:        <code class="filename">pkgsrc</code> directory and
                   11124:        <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> file.</p>
1.76      rillig   11125: <p>The directory <code class="filename">pkgsrc</code> contains a
1.89      rillig   11126:        snapshot of the CVS repository, which is updated regularly. The
1.262     leot     11127:        file <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> contains the same
                   11128:        as the directory, ready to be downloaded as a whole.</p>
                   11129: <p>The <code class="filename">current</code> directory contains files
                   11130:        related to the HEAD branch of the CVS repository.
                   11131:        In this directory there is an additional file called
                   11132:        <code class="filename">pkgsrc-readmes.tar.{bz,gz,xz}</code> that contains
                   11133:        all pkgsrc <code class="filename">README</code>s with information about
                   11134:        categories and packages.
                   11135:        </p>
                   11136: <p>The <code class="filename">stable</code> directory is a symlink to
                   11137:        the latest 
                   11138:        <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
                   11139:        </p>
                   11140: <p>The
                   11141:        <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
                   11142:        directories contain files related to the 
                   11143:        <code class="filename">-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
                   11144:        stable branch of the CVS repository. In these directories there is
                   11145:        an additional file called
                   11146:        <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   11147:        which contains the state of pkgsrc when it was branched.</p>
                   11148: </div>
1.75      rillig   11149: </div>
1.148     asau     11150: <div class="appendix">
                   11151: <div class="titlepage"><div><div><h1 class="title">
1.267     rillig   11152: <a name="help-topics"></a>Appendix D. Help topics</h1></div></div></div>
                   11153: <p>
                   11154:        The following list contains all help topics that are available
                   11155:        when running <span class="command"><strong>bmake help topic=:index</strong></span>.
                   11156: </p>
1.269     leot     11157: <table border="0" summary="Simple list" class="simplelist">
                   11158: <tr>
                   11159: <td>#!</td>
                   11160: <td>-lintl</td>
                   11161: </tr>
                   11162: <tr>
                   11163: <td>64bit</td>
                   11164: <td>ABI</td>
                   11165: </tr>
                   11166: <tr>
                   11167: <td>ACCEPTABLE_LICENSES</td>
                   11168: <td>ACROREAD_FONTPATH</td>
                   11169: </tr>
                   11170: <tr>
                   11171: <td>ADDITIONAL</td>
                   11172: <td>AFAIK</td>
                   11173: </tr>
                   11174: <tr>
                   11175: <td>AIX</td>
                   11176: <td>ALLOW_VULNERABLE_PACKAGES</td>
                   11177: </tr>
                   11178: <tr>
                   11179: <td>ALL_ENV</td>
1.315     cirnatda 11180: <td>ALTERNATIVES_SRC</td>
1.311     leot     11181: </tr>
                   11182: <tr>
                   11183: <td>AMANDA_TMP</td>
1.315     cirnatda 11184: <td>AMANDA_USER</td>
1.292     leot     11185: </tr>
                   11186: <tr>
1.311     leot     11187: <td>AMANDA_VAR</td>
1.315     cirnatda 11188: <td>APACHE_GROUP</td>
1.274     rillig   11189: </tr>
                   11190: <tr>
1.311     leot     11191: <td>APACHE_MODULE_NAME</td>
1.315     cirnatda 11192: <td>APACHE_MODULE_SRC</td>
1.269     leot     11193: </tr>
                   11194: <tr>
1.311     leot     11195: <td>APACHE_MODULE_SRCDIR</td>
1.315     cirnatda 11196: <td>APACHE_PKG_PREFIX</td>
1.269     leot     11197: </tr>
                   11198: <tr>
1.311     leot     11199: <td>APACHE_SUEXEC_CONFIGURE_ARGS</td>
1.315     cirnatda 11200: <td>APACHE_SUEXEC_DOCROOT</td>
1.269     leot     11201: </tr>
                   11202: <tr>
1.311     leot     11203: <td>APACHE_USER</td>
1.315     cirnatda 11204: <td>APPEND_ABI</td>
1.269     leot     11205: </tr>
                   11206: <tr>
1.311     leot     11207: <td>APPEND_ELF</td>
1.315     cirnatda 11208: <td>ARLA_CACHE</td>
1.269     leot     11209: </tr>
                   11210: <tr>
1.311     leot     11211: <td>AUDIT_PACKAGES_FLAGS</td>
1.315     cirnatda 11212: <td>AUTOCONF_REQD</td>
1.269     leot     11213: </tr>
                   11214: <tr>
1.311     leot     11215: <td>AUTOMAKE_OVERRIDE</td>
1.315     cirnatda 11216: <td>AUTOMAKE_REQD</td>
1.269     leot     11217: </tr>
                   11218: <tr>
1.311     leot     11219: <td>AUTO_MKDIRS</td>
1.315     cirnatda 11220: <td>BDB185_DEFAULT</td>
1.269     leot     11221: </tr>
                   11222: <tr>
1.311     leot     11223: <td>BDBBASE</td>
1.315     cirnatda 11224: <td>BDB_ACCEPTED</td>
1.269     leot     11225: </tr>
                   11226: <tr>
1.311     leot     11227: <td>BDB_DEFAULT</td>
1.315     cirnatda 11228: <td>BDB_LIBS</td>
1.269     leot     11229: </tr>
                   11230: <tr>
1.311     leot     11231: <td>BDB_TYPE</td>
1.315     cirnatda 11232: <td>BINCIMAP_GROUP</td>
1.269     leot     11233: </tr>
                   11234: <tr>
1.312     gdt      11235: <td>BINCIMAP_USER</td>
1.315     cirnatda 11236: <td>BIND_DIR</td>
1.312     gdt      11237: </tr>
                   11238: <tr>
1.311     leot     11239: <td>BIND_GROUP</td>
1.315     cirnatda 11240: <td>BIND_USER</td>
1.269     leot     11241: </tr>
                   11242: <tr>
1.311     leot     11243: <td>BINOWN</td>
1.315     cirnatda 11244: <td>BINPKG_SITES</td>
1.269     leot     11245: </tr>
                   11246: <tr>
1.311     leot     11247: <td>BIN_INSTALL_FLAGS</td>
1.315     cirnatda 11248: <td>BISON_PKGDATADIR</td>
1.303     bacon    11249: </tr>
                   11250: <tr>
1.311     leot     11251: <td>BLAS_ACCEPTED</td>
1.315     cirnatda 11252: <td>BLAS_LIBS</td>
1.269     leot     11253: </tr>
                   11254: <tr>
1.311     leot     11255: <td>BLAS_TYPE</td>
1.315     cirnatda 11256: <td>BOOTSTRAP_DEPENDS</td>
1.292     leot     11257: </tr>
                   11258: <tr>
1.311     leot     11259: <td>BOOTSTRAP_SETUPTOOLS</td>
1.315     cirnatda 11260: <td>BROKEN</td>
1.269     leot     11261: </tr>
                   11262: <tr>
1.311     leot     11263: <td>BROKEN_EXCEPT_ON_PLATFORM</td>
1.315     cirnatda 11264: <td>BROKEN_ON_PLATFORM</td>
1.269     leot     11265: </tr>
                   11266: <tr>
1.311     leot     11267: <td>BSDSRCDIR</td>
1.315     cirnatda 11268: <td>BSDXSRCDIR</td>
1.269     leot     11269: </tr>
                   11270: <tr>
1.311     leot     11271: <td>BSD_MAKE_ENV</td>
1.315     cirnatda 11272: <td>BUILDLINK_AUTO_DIRS</td>
1.269     leot     11273: </tr>
                   11274: <tr>
1.311     leot     11275: <td>BUILDLINK_AUTO_VARS</td>
1.315     cirnatda 11276: <td>BUILDLINK_CFLAGS</td>
1.269     leot     11277: </tr>
                   11278: <tr>
1.311     leot     11279: <td>BUILDLINK_CONTENTS_FILTER</td>
1.269     leot     11280: <td>BUILDLINK_CPPFLAGS</td>
                   11281: </tr>
                   11282: <tr>
                   11283: <td>BUILDLINK_FILES</td>
1.303     bacon    11284: <td>BUILDLINK_FILES_CMD</td>
1.269     leot     11285: </tr>
                   11286: <tr>
                   11287: <td>BUILDLINK_FNAME_TRANSFORM</td>
1.303     bacon    11288: <td>BUILDLINK_LDFLAGS</td>
1.269     leot     11289: </tr>
                   11290: <tr>
                   11291: <td>BUILDLINK_LIBS</td>
1.303     bacon    11292: <td>BUILDLINK_OPSYS_SUPPORT_PTHREAD</td>
1.269     leot     11293: </tr>
                   11294: <tr>
                   11295: <td>BUILDLINK_PKGNAME</td>
1.303     bacon    11296: <td>BUILDLINK_PREFIX</td>
1.269     leot     11297: </tr>
                   11298: <tr>
                   11299: <td>BUILDLINK_RPATHDIRS</td>
1.303     bacon    11300: <td>BUILDLINK_TREE</td>
1.269     leot     11301: </tr>
                   11302: <tr>
                   11303: <td>BUILD_DEFS</td>
1.303     bacon    11304: <td>BUILD_DEFS_EFFECTS</td>
1.269     leot     11305: </tr>
                   11306: <tr>
                   11307: <td>BUILD_DEPENDS</td>
1.303     bacon    11308: <td>BUILD_DIRS</td>
1.269     leot     11309: </tr>
                   11310: <tr>
                   11311: <td>BUILD_ENV_SHELL</td>
1.303     bacon    11312: <td>BUILD_MAKE_CMD</td>
1.269     leot     11313: </tr>
                   11314: <tr>
                   11315: <td>BUILD_MAKE_FLAGS</td>
1.303     bacon    11316: <td>BUILD_TARGET</td>
1.269     leot     11317: </tr>
                   11318: <tr>
                   11319: <td>BUILTIN_FIND_FILES</td>
1.303     bacon    11320: <td>BUILTIN_FIND_FILES_VAR</td>
1.269     leot     11321: </tr>
                   11322: <tr>
                   11323: <td>BUILTIN_FIND_GREP</td>
1.303     bacon    11324: <td>BUILTIN_FIND_HEADERS</td>
1.269     leot     11325: </tr>
                   11326: <tr>
                   11327: <td>BUILTIN_FIND_HEADERS_VAR</td>
1.309     gutterid 11328: <td>BUILTIN_FIND_PKGCONFIG</td>
                   11329: </tr>
                   11330: <tr>
                   11331: <td>BUILTIN_FIND_PKGCONFIG_VAR</td>
1.303     bacon    11332: <td>BUILTIN_PKG</td>
1.269     leot     11333: </tr>
                   11334: <tr>
                   11335: <td>BUILTIN_TEST_CURSES_DEFINES</td>
1.303     bacon    11336: <td>BUILTIN_TEST_CURSES_FUNCS</td>
1.269     leot     11337: </tr>
                   11338: <tr>
                   11339: <td>BUILTIN_VERSION_SCRIPT</td>
1.303     bacon    11340: <td>BUILTIN_X11_TYPE</td>
1.269     leot     11341: </tr>
                   11342: <tr>
                   11343: <td>BUILTIN_X11_VERSION</td>
1.303     bacon    11344: <td>CACTI_GROUP</td>
1.269     leot     11345: </tr>
                   11346: <tr>
                   11347: <td>CACTI_USER</td>
1.303     bacon    11348: <td>CANNA_GROUP</td>
1.269     leot     11349: </tr>
                   11350: <tr>
                   11351: <td>CANNA_USER</td>
1.303     bacon    11352: <td>CAT</td>
1.269     leot     11353: </tr>
                   11354: <tr>
                   11355: <td>CCACHE_BASE</td>
1.303     bacon    11356: <td>CCACHE_DIR</td>
1.269     leot     11357: </tr>
                   11358: <tr>
                   11359: <td>CCACHE_LOGFILE</td>
1.303     bacon    11360: <td>CC_VERSION</td>
1.269     leot     11361: </tr>
                   11362: <tr>
                   11363: <td>CC_VERSION_STRING</td>
1.303     bacon    11364: <td>CDRECORD_CONF</td>
1.269     leot     11365: </tr>
                   11366: <tr>
                   11367: <td>CDROM_PKG_URL_DIR</td>
1.303     bacon    11368: <td>CDROM_PKG_URL_HOST</td>
1.269     leot     11369: </tr>
                   11370: <tr>
1.303     bacon    11371: <td>CHECK_COMPILER</td>
1.315     cirnatda 11372: <td>CHECK_FAKEHOME</td>
1.311     leot     11373: </tr>
                   11374: <tr>
                   11375: <td>CHECK_FILES</td>
1.315     cirnatda 11376: <td>CHECK_FILES_SKIP</td>
1.292     leot     11377: </tr>
                   11378: <tr>
1.311     leot     11379: <td>CHECK_FILES_STRICT</td>
1.315     cirnatda 11380: <td>CHECK_HEADERS</td>
1.274     rillig   11381: </tr>
                   11382: <tr>
1.311     leot     11383: <td>CHECK_HEADERS_SKIP</td>
1.315     cirnatda 11384: <td>CHECK_INTERPRETER</td>
1.269     leot     11385: </tr>
                   11386: <tr>
1.311     leot     11387: <td>CHECK_INTERPRETER_SKIP</td>
1.315     cirnatda 11388: <td>CHECK_PERMS</td>
1.269     leot     11389: </tr>
                   11390: <tr>
1.311     leot     11391: <td>CHECK_PERMS_AUTOFIX</td>
1.315     cirnatda 11392: <td>CHECK_PERMS_SKIP</td>
1.269     leot     11393: </tr>
                   11394: <tr>
1.311     leot     11395: <td>CHECK_PORTABILITY</td>
1.315     cirnatda 11396: <td>CHECK_PORTABILITY_EXPERIMENTAL</td>
1.269     leot     11397: </tr>
                   11398: <tr>
1.311     leot     11399: <td>CHECK_PORTABILITY_SKIP</td>
1.315     cirnatda 11400: <td>CHECK_RELRO</td>
1.269     leot     11401: </tr>
                   11402: <tr>
1.311     leot     11403: <td>CHECK_RELRO_SKIP</td>
1.315     cirnatda 11404: <td>CHECK_RELRO_SUPPORTED</td>
1.269     leot     11405: </tr>
                   11406: <tr>
1.311     leot     11407: <td>CHECK_SHLIBS</td>
1.315     cirnatda 11408: <td>CHECK_SHLIBS_BLACKLIST</td>
1.269     leot     11409: </tr>
                   11410: <tr>
1.311     leot     11411: <td>CHECK_SHLIBS_SKIP</td>
1.315     cirnatda 11412: <td>CHECK_SHLIBS_SUPPORTED</td>
1.269     leot     11413: </tr>
                   11414: <tr>
1.311     leot     11415: <td>CHECK_SSP</td>
1.315     cirnatda 11416: <td>CHECK_SSP_SKIP</td>
1.269     leot     11417: </tr>
                   11418: <tr>
1.311     leot     11419: <td>CHECK_SSP_SUPPORTED</td>
1.315     cirnatda 11420: <td>CHECK_STRIPPED</td>
1.269     leot     11421: </tr>
                   11422: <tr>
1.311     leot     11423: <td>CHECK_STRIPPED_SKIP</td>
1.315     cirnatda 11424: <td>CHECK_WRKREF</td>
1.269     leot     11425: </tr>
                   11426: <tr>
1.311     leot     11427: <td>CHECK_WRKREF_EXTRA_DIRS</td>
1.315     cirnatda 11428: <td>CHECK_WRKREF_SKIP</td>
1.269     leot     11429: </tr>
                   11430: <tr>
1.311     leot     11431: <td>CLAMAV_DBDIR</td>
1.315     cirnatda 11432: <td>CLAMAV_GROUP</td>
1.269     leot     11433: </tr>
                   11434: <tr>
1.311     leot     11435: <td>CLAMAV_USER</td>
1.315     cirnatda 11436: <td>CLANGBASE</td>
1.269     leot     11437: </tr>
                   11438: <tr>
1.311     leot     11439: <td>CLEANDEPENDS</td>
1.315     cirnatda 11440: <td>CMAKE_DEPENDENCIES_REWRITE</td>
1.269     leot     11441: </tr>
                   11442: <tr>
1.311     leot     11443: <td>CMAKE_INSTALL_NAME_DIR</td>
1.315     cirnatda 11444: <td>CMAKE_INSTALL_PREFIX</td>
1.269     leot     11445: </tr>
                   11446: <tr>
1.311     leot     11447: <td>CMAKE_MODULE_PATH_OVERRIDE</td>
1.315     cirnatda 11448: <td>CMAKE_PKGSRC_BUILD_FLAGS</td>
1.269     leot     11449: </tr>
                   11450: <tr>
1.311     leot     11451: <td>CMAKE_PREFIX_PATH</td>
1.305     bacon    11452: <td>CMAKE_USE_GNU_INSTALL_DIRS</td>
1.292     leot     11453: </tr>
                   11454: <tr>
1.305     bacon    11455: <td>COMPILER_RPATH_FLAG</td>
1.269     leot     11456: <td>COMPILER_USE_SYMLINKS</td>
                   11457: </tr>
                   11458: <tr>
1.305     bacon    11459: <td>CONFIGURE_ARGS</td>
1.269     leot     11460: <td>CONFIGURE_DIRS</td>
                   11461: </tr>
                   11462: <tr>
1.305     bacon    11463: <td>CONFIGURE_ENV</td>
1.287     rillig   11464: <td>CONFIGURE_ENV_SHELL</td>
1.269     leot     11465: </tr>
                   11466: <tr>
1.305     bacon    11467: <td>CONFIGURE_HAS_INFODIR</td>
1.269     leot     11468: <td>CONFIGURE_HAS_MANDIR</td>
                   11469: </tr>
                   11470: <tr>
1.305     bacon    11471: <td>CONFIGURE_SCRIPT</td>
1.269     leot     11472: <td>CONFIG_SHELL</td>
                   11473: </tr>
                   11474: <tr>
1.305     bacon    11475: <td>CONFIG_SHELL_FLAGS</td>
1.269     leot     11476: <td>CONF_FILES</td>
                   11477: </tr>
                   11478: <tr>
1.305     bacon    11479: <td>CONF_FILES_MODE</td>
1.269     leot     11480: <td>CONF_FILES_PERMS</td>
                   11481: </tr>
                   11482: <tr>
1.305     bacon    11483: <td>CONSERVER_DEFAULTHOST</td>
1.269     leot     11484: <td>CONSERVER_DEFAULTPORT</td>
                   11485: </tr>
                   11486: <tr>
1.305     bacon    11487: <td>CP</td>
1.269     leot     11488: <td>CPP</td>
                   11489: </tr>
                   11490: <tr>
1.305     bacon    11491: <td>CPP_PRECOMP_FLAGS</td>
1.269     leot     11492: <td>CREATE_WRKDIR_SYMLINK</td>
                   11493: </tr>
                   11494: <tr>
1.305     bacon    11495: <td>CROSSBASE</td>
1.269     leot     11496: <td>CTFCONVERT</td>
                   11497: </tr>
                   11498: <tr>
1.305     bacon    11499: <td>CTF_FILES_SKIP</td>
1.269     leot     11500: <td>CTF_SUPPORTED</td>
                   11501: </tr>
                   11502: <tr>
1.305     bacon    11503: <td>CTYPE</td>
1.269     leot     11504: <td>CUPS_GROUP</td>
                   11505: </tr>
                   11506: <tr>
1.305     bacon    11507: <td>CUPS_SYSTEM_GROUPS</td>
1.269     leot     11508: <td>CUPS_USER</td>
                   11509: </tr>
                   11510: <tr>
1.305     bacon    11511: <td>CURSES_DEFAULT</td>
1.269     leot     11512: <td>CURSES_TYPE</td>
1.292     leot     11513: </tr>
                   11514: <tr>
1.273     brook    11515: <td>CXX</td>
1.315     cirnatda 11516: <td>CYRUS_GROUP</td>
1.311     leot     11517: </tr>
                   11518: <tr>
                   11519: <td>CYRUS_IDLE</td>
1.315     cirnatda 11520: <td>CYRUS_USER</td>
1.269     leot     11521: </tr>
                   11522: <tr>
1.311     leot     11523: <td>DAEMONTOOLS_GROUP</td>
1.315     cirnatda 11524: <td>DAEMONTOOLS_LOG_USER</td>
1.269     leot     11525: </tr>
                   11526: <tr>
1.311     leot     11527: <td>DARWIN_NO_SYSTEM_LIBS</td>
1.315     cirnatda 11528: <td>DARWIN_REQUIRES_FILTER</td>
1.269     leot     11529: </tr>
                   11530: <tr>
1.311     leot     11531: <td>DBUS_GROUP</td>
1.315     cirnatda 11532: <td>DBUS_USER</td>
1.309     gutterid 11533: </tr>
                   11534: <tr>
1.311     leot     11535: <td>DEFANG_GROUP</td>
1.315     cirnatda 11536: <td>DEFANG_USER</td>
1.269     leot     11537: </tr>
                   11538: <tr>
1.311     leot     11539: <td>DEFAULT_ACCEPTABLE_LICENSES</td>
1.315     cirnatda 11540: <td>DEFAULT_DISTFILES</td>
1.269     leot     11541: </tr>
                   11542: <tr>
1.311     leot     11543: <td>DEFAULT_IRC_SERVER</td>
1.315     cirnatda 11544: <td>DEFAULT_SERIAL_DEVICE</td>
1.269     leot     11545: </tr>
                   11546: <tr>
1.311     leot     11547: <td>DEF_UMASK</td>
1.315     cirnatda 11548: <td>DEINSTALLDEPENDS</td>
1.269     leot     11549: </tr>
                   11550: <tr>
1.311     leot     11551: <td>DEINSTALL_SRC</td>
1.315     cirnatda 11552: <td>DEINSTALL_TEMPLATES</td>
1.269     leot     11553: </tr>
                   11554: <tr>
1.311     leot     11555: <td>DELAYED_ERROR_MSG</td>
1.315     cirnatda 11556: <td>DELAYED_WARNING_MSG</td>
1.269     leot     11557: </tr>
                   11558: <tr>
1.311     leot     11559: <td>DEPENDS</td>
1.315     cirnatda 11560: <td>DEPENDS_TARGET</td>
1.269     leot     11561: </tr>
                   11562: <tr>
1.311     leot     11563: <td>DEPENDS_TYPE</td>
1.315     cirnatda 11564: <td>DESTDIR</td>
1.269     leot     11565: </tr>
                   11566: <tr>
1.311     leot     11567: <td>DESTDIR_VARNAME</td>
1.315     cirnatda 11568: <td>DIALER_GROUP</td>
1.269     leot     11569: </tr>
                   11570: <tr>
1.311     leot     11571: <td>DIGEST_REQD</td>
1.315     cirnatda 11572: <td>DISTDIR</td>
1.269     leot     11573: </tr>
                   11574: <tr>
1.311     leot     11575: <td>DISTFILES</td>
1.315     cirnatda 11576: <td>DISTINFO_FILE</td>
1.269     leot     11577: </tr>
                   11578: <tr>
1.311     leot     11579: <td>DISTNAME</td>
1.315     cirnatda 11580: <td>DIST_PATH</td>
1.269     leot     11581: </tr>
                   11582: <tr>
1.311     leot     11583: <td>DIST_SUBDIR</td>
1.315     cirnatda 11584: <td>DJBDNS_AXFR_USER</td>
1.269     leot     11585: </tr>
                   11586: <tr>
1.311     leot     11587: <td>DJBDNS_CACHE_USER</td>
1.315     cirnatda 11588: <td>DJBDNS_DJBDNS_GROUP</td>
1.269     leot     11589: </tr>
                   11590: <tr>
1.311     leot     11591: <td>DJBDNS_LOG_USER</td>
1.315     cirnatda 11592: <td>DJBDNS_RBL_USER</td>
1.269     leot     11593: </tr>
                   11594: <tr>
1.311     leot     11595: <td>DJBDNS_TINY_USER</td>
1.315     cirnatda 11596: <td>DLOPEN_REQUIRE_PTHREADS</td>
1.269     leot     11597: </tr>
                   11598: <tr>
1.311     leot     11599: <td>DL_AUTO_VARS</td>
1.315     cirnatda 11600: <td>DL_CFLAGS</td>
1.269     leot     11601: </tr>
                   11602: <tr>
1.311     leot     11603: <td>DL_LDFLAGS</td>
1.315     cirnatda 11604: <td>DL_LIBS</td>
1.269     leot     11605: </tr>
                   11606: <tr>
1.311     leot     11607: <td>DNS</td>
1.315     cirnatda 11608: <td>DOCOWN</td>
1.269     leot     11609: </tr>
                   11610: <tr>
1.311     leot     11611: <td>DOWNLOADED_DISTFILE</td>
1.315     cirnatda 11612: <td>DT_LAYOUT</td>
1.269     leot     11613: </tr>
                   11614: <tr>
1.311     leot     11615: <td>DYNAMIC_SITES_CMD</td>
1.315     cirnatda 11616: <td>DYNAMIC_SITES_SCRIPT</td>
1.269     leot     11617: </tr>
                   11618: <tr>
1.311     leot     11619: <td>ECHO</td>
1.315     cirnatda 11620: <td>ECHO_N</td>
1.269     leot     11621: </tr>
                   11622: <tr>
1.311     leot     11623: <td>ELK_GUI</td>
1.315     cirnatda 11624: <td>EMACS_TYPE</td>
1.269     leot     11625: </tr>
                   11626: <tr>
1.311     leot     11627: <td>EMULDIR</td>
1.315     cirnatda 11628: <td>EMULSUBDIR</td>
1.269     leot     11629: </tr>
                   11630: <tr>
1.311     leot     11631: <td>EMULSUBDIRSLASH</td>
1.315     cirnatda 11632: <td>EMUL_ARCH</td>
1.269     leot     11633: </tr>
                   11634: <tr>
1.311     leot     11635: <td>EMUL_DISTRO</td>
1.315     cirnatda 11636: <td>EMUL_EXEC_FMT</td>
1.269     leot     11637: </tr>
                   11638: <tr>
1.311     leot     11639: <td>EMUL_IS_NATIVE</td>
1.315     cirnatda 11640: <td>EMUL_MODULES</td>
1.269     leot     11641: </tr>
                   11642: <tr>
1.311     leot     11643: <td>EMUL_OPSYS</td>
1.315     cirnatda 11644: <td>EMUL_PKG_FMT</td>
1.269     leot     11645: </tr>
                   11646: <tr>
1.311     leot     11647: <td>EMUL_PLATFORM</td>
1.315     cirnatda 11648: <td>EMUL_PLATFORMS</td>
1.269     leot     11649: </tr>
                   11650: <tr>
1.311     leot     11651: <td>EMUL_PREFER</td>
1.315     cirnatda 11652: <td>EMUL_REQD</td>
1.269     leot     11653: </tr>
                   11654: <tr>
1.311     leot     11655: <td>EMUL_TYPE</td>
1.315     cirnatda 11656: <td>ERROR_MSG</td>
1.269     leot     11657: </tr>
                   11658: <tr>
1.311     leot     11659: <td>EXIM_GROUP</td>
1.315     cirnatda 11660: <td>EXIM_USER</td>
1.269     leot     11661: </tr>
                   11662: <tr>
1.311     leot     11663: <td>EXPORT_SYMBOLS_LDFLAGS</td>
1.315     cirnatda 11664: <td>EXTRACTOR</td>
1.269     leot     11665: </tr>
                   11666: <tr>
1.311     leot     11667: <td>EXTRACT_CMD</td>
1.315     cirnatda 11668: <td>EXTRACT_CMD_DEFAULT</td>
1.269     leot     11669: </tr>
                   11670: <tr>
1.311     leot     11671: <td>EXTRACT_DIR</td>
1.315     cirnatda 11672: <td>EXTRACT_ELEMENTS</td>
1.269     leot     11673: </tr>
                   11674: <tr>
1.311     leot     11675: <td>EXTRACT_ENV</td>
1.315     cirnatda 11676: <td>EXTRACT_ONLY</td>
1.269     leot     11677: </tr>
                   11678: <tr>
1.311     leot     11679: <td>EXTRACT_OPTS</td>
1.315     cirnatda 11680: <td>EXTRACT_SUFX</td>
1.269     leot     11681: </tr>
                   11682: <tr>
1.311     leot     11683: <td>EXTRACT_USING</td>
1.315     cirnatda 11684: <td>FAIL</td>
1.269     leot     11685: </tr>
                   11686: <tr>
1.311     leot     11687: <td>FAILOVER_FETCH</td>
1.315     cirnatda 11688: <td>FAIL_MSG</td>
1.292     leot     11689: </tr>
                   11690: <tr>
1.311     leot     11691: <td>FAKE_NCURSES</td>
1.315     cirnatda 11692: <td>FAM</td>
1.269     leot     11693: </tr>
                   11694: <tr>
1.311     leot     11695: <td>FAM_ACCEPTED</td>
1.315     cirnatda 11696: <td>FAM_DEFAULT</td>
1.269     leot     11697: </tr>
                   11698: <tr>
1.311     leot     11699: <td>FAM_SERVER</td>
1.315     cirnatda 11700: <td>FCPATH</td>
1.269     leot     11701: </tr>
                   11702: <tr>
1.311     leot     11703: <td>FEATURE_CPPFLAGS</td>
1.315     cirnatda 11704: <td>FEATURE_LDFLAGS</td>
1.269     leot     11705: </tr>
                   11706: <tr>
1.311     leot     11707: <td>FEATURE_LIBS</td>
1.315     cirnatda 11708: <td>FETCH_AFTER_ARGS</td>
1.269     leot     11709: </tr>
                   11710: <tr>
1.311     leot     11711: <td>FETCH_BEFORE_ARGS</td>
1.315     cirnatda 11712: <td>FETCH_CMD</td>
1.269     leot     11713: </tr>
                   11714: <tr>
1.311     leot     11715: <td>FETCH_OUTPUT_ARGS</td>
1.315     cirnatda 11716: <td>FETCH_PROXY</td>
1.269     leot     11717: </tr>
                   11718: <tr>
1.311     leot     11719: <td>FETCH_RESUME_ARGS</td>
1.315     cirnatda 11720: <td>FETCH_TIMEOUT</td>
1.269     leot     11721: </tr>
                   11722: <tr>
1.311     leot     11723: <td>FETCH_USE_IPV4_ONLY</td>
1.315     cirnatda 11724: <td>FETCH_USING</td>
1.303     bacon    11725: </tr>
                   11726: <tr>
1.311     leot     11727: <td>FILES_SUBST</td>
1.315     cirnatda 11728: <td>FILES_SUBST_SED</td>
1.269     leot     11729: </tr>
                   11730: <tr>
1.311     leot     11731: <td>FIX_SYSTEM_HEADERS</td>
1.315     cirnatda 11732: <td>FLUXBOX_USE_GNOME</td>
1.269     leot     11733: </tr>
                   11734: <tr>
1.311     leot     11735: <td>FLUXBOX_USE_KDE</td>
1.315     cirnatda 11736: <td>FLUXBOX_USE_XFT</td>
1.269     leot     11737: </tr>
                   11738: <tr>
1.311     leot     11739: <td>FLUXBOX_USE_XINERAMA</td>
1.295     rillig   11740: <td>FONTS_DIRS</td>
1.274     rillig   11741: </tr>
                   11742: <tr>
1.305     bacon    11743: <td>FONTS_VERBOSE</td>
1.295     rillig   11744: <td>FOO_HACKS_MK</td>
1.292     leot     11745: </tr>
                   11746: <tr>
1.305     bacon    11747: <td>FOX_USE_XUNICODE</td>
1.295     rillig   11748: <td>FREEWNN_GROUP</td>
1.269     leot     11749: </tr>
                   11750: <tr>
1.305     bacon    11751: <td>FREEWNN_USER</td>
1.295     rillig   11752: <td>FTP_PKG_URL_DIR</td>
1.269     leot     11753: </tr>
                   11754: <tr>
1.305     bacon    11755: <td>FTP_PKG_URL_HOST</td>
1.295     rillig   11756: <td>GAMEDATAMODE</td>
1.269     leot     11757: </tr>
                   11758: <tr>
1.305     bacon    11759: <td>GAMEDATA_PERMS</td>
1.295     rillig   11760: <td>GAMEDIRMODE</td>
1.269     leot     11761: </tr>
                   11762: <tr>
1.305     bacon    11763: <td>GAMEDIR_PERMS</td>
1.295     rillig   11764: <td>GAMEGRP</td>
1.269     leot     11765: </tr>
                   11766: <tr>
1.305     bacon    11767: <td>GAMEMODE</td>
1.295     rillig   11768: <td>GAMEOWN</td>
1.269     leot     11769: </tr>
                   11770: <tr>
1.305     bacon    11771: <td>GAMES_GROUP</td>
1.295     rillig   11772: <td>GAMES_USER</td>
1.269     leot     11773: </tr>
                   11774: <tr>
1.305     bacon    11775: <td>GCC</td>
1.295     rillig   11776: <td>GCCBASE</td>
1.269     leot     11777: </tr>
                   11778: <tr>
1.305     bacon    11779: <td>GCC_REQD</td>
1.295     rillig   11780: <td>GCC_VERSION_SUFFIX</td>
1.269     leot     11781: </tr>
                   11782: <tr>
1.305     bacon    11783: <td>GEM_BUILD</td>
1.295     rillig   11784: <td>GEM_CLEANBUILD</td>
1.269     leot     11785: </tr>
                   11786: <tr>
1.305     bacon    11787: <td>GEM_CLEANBUILD_EXTENSIONS</td>
1.295     rillig   11788: <td>GEM_DOCDIR</td>
1.269     leot     11789: </tr>
                   11790: <tr>
1.305     bacon    11791: <td>GEM_EXTSDIR</td>
1.295     rillig   11792: <td>GEM_HOME</td>
1.292     leot     11793: </tr>
                   11794: <tr>
1.305     bacon    11795: <td>GEM_KEEPBUILD</td>
1.295     rillig   11796: <td>GEM_LIBDIR</td>
1.269     leot     11797: </tr>
                   11798: <tr>
1.305     bacon    11799: <td>GEM_NAME</td>
1.295     rillig   11800: <td>GEM_PATH</td>
1.269     leot     11801: </tr>
                   11802: <tr>
1.312     gdt      11803: <td>GEM_PLUGINSDIR</td>
1.305     bacon    11804: <td>GEM_SPECFILE</td>
1.269     leot     11805: </tr>
                   11806: <tr>
1.312     gdt      11807: <td>GENERATE_PLIST</td>
1.316     cirnatda 11808: <td>GHC</td>
1.269     leot     11809: </tr>
                   11810: <tr>
1.316     cirnatda 11811: <td>GHOSTSCRIPT_REQD</td>
1.312     gdt      11812: <td>GITHUB_PROJECT</td>
1.292     leot     11813: </tr>
                   11814: <tr>
1.316     cirnatda 11815: <td>GITHUB_RELEASE</td>
1.315     cirnatda 11816: <td>GITHUB_SUBMODULES</td>
1.311     leot     11817: </tr>
                   11818: <tr>
1.316     cirnatda 11819: <td>GITHUB_TAG</td>
1.313     leot     11820: <td>GITHUB_TYPE</td>
1.269     leot     11821: </tr>
                   11822: <tr>
1.316     cirnatda 11823: <td>GNU</td>
1.313     leot     11824: <td>GNU_CONFIGURE</td>
1.269     leot     11825: </tr>
                   11826: <tr>
1.316     cirnatda 11827: <td>GNU_CONFIGURE_INFODIR</td>
1.313     leot     11828: <td>GNU_CONFIGURE_MANDIR</td>
1.269     leot     11829: </tr>
                   11830: <tr>
1.316     cirnatda 11831: <td>GNU_CONFIGURE_QUIET</td>
1.313     leot     11832: <td>GNU_CONFIGURE_STRICT</td>
1.269     leot     11833: </tr>
                   11834: <tr>
1.316     cirnatda 11835: <td>GODEP_REDIRECTS</td>
1.313     leot     11836: <td>GO_BUILD_PATTERN</td>
1.276     leot     11837: </tr>
                   11838: <tr>
1.316     cirnatda 11839: <td>GO_DEPS</td>
1.313     leot     11840: <td>GO_DIST_BASE</td>
1.269     leot     11841: </tr>
                   11842: <tr>
1.316     cirnatda 11843: <td>GO_MODULE_FILES</td>
1.313     leot     11844: <td>GO_SRCPATH</td>
1.269     leot     11845: </tr>
                   11846: <tr>
1.316     cirnatda 11847: <td>GO_VERSION_DEFAULT</td>
1.313     leot     11848: <td>GROUP_SPECIFIC_PKGS</td>
1.269     leot     11849: </tr>
                   11850: <tr>
1.316     cirnatda 11851: <td>GRUB_NETWORK_CARDS</td>
1.313     leot     11852: <td>GRUB_PRESET_COMMAND</td>
1.311     leot     11853: </tr>
                   11854: <tr>
1.316     cirnatda 11855: <td>GRUB_SCAN_ARGS</td>
1.313     leot     11856: <td>GZIP</td>
1.269     leot     11857: </tr>
                   11858: <tr>
1.316     cirnatda 11859: <td>HASKELL_ENABLE_HADDOCK_DOCUMENTATION</td>
1.312     gdt      11860: <td>HASKELL_ENABLE_LIBRARY_PROFILING</td>
1.269     leot     11861: </tr>
                   11862: <tr>
1.316     cirnatda 11863: <td>HASKELL_ENABLE_SHARED_LIBRARY</td>
1.312     gdt      11864: <td>HASKELL_OPTIMIZATION_LEVEL</td>
1.292     leot     11865: </tr>
                   11866: <tr>
1.316     cirnatda 11867: <td>HAS_CONFIGURE</td>
1.312     gdt      11868: <td>HEADER_TEMPLATES</td>
1.269     leot     11869: </tr>
                   11870: <tr>
1.316     cirnatda 11871: <td>HOMEPAGE</td>
1.313     leot     11872: <td>HOST_PKGTOOLS_ARGS</td>
1.269     leot     11873: </tr>
                   11874: <tr>
1.316     cirnatda 11875: <td>HOST_SPECIFIC_PKGS</td>
1.313     leot     11876: <td>HOWL_GROUP</td>
1.305     bacon    11877: </tr>
                   11878: <tr>
1.316     cirnatda 11879: <td>HOWL_USER</td>
1.313     leot     11880: <td>ICCBASE</td>
1.269     leot     11881: </tr>
                   11882: <tr>
1.316     cirnatda 11883: <td>ICECAST_CHROOTDIR</td>
1.313     leot     11884: <td>ICON_THEMES</td>
1.269     leot     11885: </tr>
                   11886: <tr>
1.316     cirnatda 11887: <td>IDOBASE</td>
1.313     leot     11888: <td>IGNORE_CCACHE</td>
1.269     leot     11889: </tr>
                   11890: <tr>
1.316     cirnatda 11891: <td>IGNORE_INFO_DIRS</td>
1.313     leot     11892: <td>IGNORE_INTERACTIVE_FETCH</td>
1.269     leot     11893: </tr>
                   11894: <tr>
1.316     cirnatda 11895: <td>IMAKE</td>
1.313     leot     11896: <td>IMAKEOPTS</td>
1.269     leot     11897: </tr>
                   11898: <tr>
1.316     cirnatda 11899: <td>IMAKE_MAKE</td>
1.313     leot     11900: <td>IMAKE_MANINSTALL</td>
1.269     leot     11901: </tr>
                   11902: <tr>
1.316     cirnatda 11903: <td>IMAP_UW_CCLIENT_MBOX_FMT</td>
1.313     leot     11904: <td>IMDICTDIR</td>
1.269     leot     11905: </tr>
                   11906: <tr>
1.316     cirnatda 11907: <td>INCOMPAT_CURSES</td>
1.313     leot     11908: <td>INFO_DIR</td>
1.269     leot     11909: </tr>
                   11910: <tr>
1.316     cirnatda 11911: <td>INFO_FILES</td>
1.313     leot     11912: <td>INFO_FILES_VERBOSE</td>
1.269     leot     11913: </tr>
                   11914: <tr>
1.316     cirnatda 11915: <td>INFO_MSG</td>
1.313     leot     11916: <td>INIT_SYSTEM</td>
1.287     rillig   11917: </tr>
                   11918: <tr>
1.316     cirnatda 11919: <td>INN_DATA_DIR</td>
1.313     leot     11920: <td>INN_GROUP</td>
1.269     leot     11921: </tr>
                   11922: <tr>
1.316     cirnatda 11923: <td>INN_USER</td>
1.313     leot     11924: <td>INSTALLATION_DIRS</td>
1.269     leot     11925: </tr>
                   11926: <tr>
1.316     cirnatda 11927: <td>INSTALLATION_DIRS_FROM_PLIST</td>
1.313     leot     11928: <td>INSTALL_ENV</td>
1.269     leot     11929: </tr>
                   11930: <tr>
1.316     cirnatda 11931: <td>INSTALL_SH_OVERRIDE</td>
1.313     leot     11932: <td>INSTALL_SRC</td>
1.269     leot     11933: </tr>
                   11934: <tr>
1.316     cirnatda 11935: <td>INSTALL_TEMPLATES</td>
1.313     leot     11936: <td>INSTALL_UNSTRIPPED</td>
1.269     leot     11937: </tr>
                   11938: <tr>
1.316     cirnatda 11939: <td>IRCD_HYBRID_IRC_GROUP</td>
1.313     leot     11940: <td>IRCD_HYBRID_IRC_USER</td>
1.269     leot     11941: </tr>
                   11942: <tr>
1.316     cirnatda 11943: <td>IRCD_HYBRID_MAXCONN</td>
1.313     leot     11944: <td>IRCD_HYBRID_NICLEN</td>
1.269     leot     11945: </tr>
                   11946: <tr>
1.316     cirnatda 11947: <td>IRCD_HYBRID_SYSLOG_EVENTS</td>
1.313     leot     11948: <td>IRCD_HYBRID_SYSLOG_FACILITY</td>
1.269     leot     11949: </tr>
                   11950: <tr>
1.316     cirnatda 11951: <td>IRCD_HYBRID_TOPICLEN</td>
1.313     leot     11952: <td>IRIX</td>
1.269     leot     11953: </tr>
                   11954: <tr>
1.316     cirnatda 11955: <td>IRRD_USE_PGP</td>
1.313     leot     11956: <td>JABBERD_GROUP</td>
1.269     leot     11957: </tr>
                   11958: <tr>
1.316     cirnatda 11959: <td>JABBERD_LOGDIR</td>
1.313     leot     11960: <td>JABBERD_PIDDIR</td>
1.292     leot     11961: </tr>
                   11962: <tr>
1.316     cirnatda 11963: <td>JABBERD_SPOOLDIR</td>
1.313     leot     11964: <td>JABBERD_USER</td>
1.311     leot     11965: </tr>
                   11966: <tr>
1.316     cirnatda 11967: <td>JAKARTA_HOME</td>
1.313     leot     11968: <td>JAVA_BINPREFIX</td>
1.269     leot     11969: </tr>
                   11970: <tr>
1.316     cirnatda 11971: <td>JAVA_CLASSPATH</td>
1.313     leot     11972: <td>JAVA_HOME</td>
1.269     leot     11973: </tr>
                   11974: <tr>
1.316     cirnatda 11975: <td>JAVA_LD_LIBRARY_PATH</td>
1.313     leot     11976: <td>JAVA_NAME</td>
1.269     leot     11977: </tr>
                   11978: <tr>
1.316     cirnatda 11979: <td>JAVA_UNLIMIT</td>
1.313     leot     11980: <td>JAVA_WRAPPERS</td>
1.269     leot     11981: </tr>
                   11982: <tr>
1.316     cirnatda 11983: <td>JPEG_ACCEPTED</td>
1.313     leot     11984: <td>JPEG_DEFAULT</td>
1.269     leot     11985: </tr>
                   11986: <tr>
1.316     cirnatda 11987: <td>KERBEROS</td>
1.313     leot     11988: <td>KERMIT_SUID_UUCP</td>
1.269     leot     11989: </tr>
                   11990: <tr>
1.316     cirnatda 11991: <td>KJS_USE_PCRE</td>
1.313     leot     11992: <td>KNEWS_DOMAIN_FILE</td>
1.292     leot     11993: </tr>
                   11994: <tr>
1.316     cirnatda 11995: <td>KNEWS_DOMAIN_NAME</td>
1.313     leot     11996: <td>KRB5_ACCEPTED</td>
1.271     brook    11997: </tr>
                   11998: <tr>
1.316     cirnatda 11999: <td>KRB5_DEFAULT</td>
1.313     leot     12000: <td>LANGUAGES</td>
1.269     leot     12001: </tr>
                   12002: <tr>
1.316     cirnatda 12003: <td>LAPACK_LIBS</td>
1.313     leot     12004: <td>LATEX2HTML_ICONPATH</td>
1.269     leot     12005: </tr>
                   12006: <tr>
1.316     cirnatda 12007: <td>LDCONFIG_ADD_CMD</td>
1.313     leot     12008: <td>LDCONFIG_REMOVE_CMD</td>
1.269     leot     12009: </tr>
                   12010: <tr>
1.316     cirnatda 12011: <td>LEAFNODE_DATA_DIR</td>
1.313     leot     12012: <td>LEAFNODE_GROUP</td>
1.269     leot     12013: </tr>
                   12014: <tr>
1.316     cirnatda 12015: <td>LEAFNODE_USER</td>
1.313     leot     12016: <td>LIBDVDCSS_HOMEPAGE</td>
1.270     leot     12017: </tr>
                   12018: <tr>
1.316     cirnatda 12019: <td>LIBDVDCSS_MASTER_SITES</td>
1.313     leot     12020: <td>LIBRSVG_TYPE</td>
1.269     leot     12021: </tr>
                   12022: <tr>
1.316     cirnatda 12023: <td>LIBTOOL</td>
1.313     leot     12024: <td>LIBTOOLIZE_PLIST</td>
1.292     leot     12025: </tr>
                   12026: <tr>
1.316     cirnatda 12027: <td>LIBTOOL_M4_OVERRIDE</td>
1.313     leot     12028: <td>LIBUSB_TYPE</td>
1.269     leot     12029: </tr>
                   12030: <tr>
1.316     cirnatda 12031: <td>LICENSE</td>
1.313     leot     12032: <td>LINKER_RPATH_FLAG</td>
1.311     leot     12033: </tr>
                   12034: <tr>
1.316     cirnatda 12035: <td>LINK_RPATH_FLAG</td>
1.312     gdt      12036: <td>LINUX_LOCALES</td>
1.269     leot     12037: </tr>
                   12038: <tr>
1.316     cirnatda 12039: <td>LOCALBASE</td>
1.312     gdt      12040: <td>LOCALBASE_LOCKTYPE</td>
1.269     leot     12041: </tr>
                   12042: <tr>
1.316     cirnatda 12043: <td>LOCALPATCHES</td>
1.312     gdt      12044: <td>LOVE_DATA</td>
1.269     leot     12045: </tr>
                   12046: <tr>
1.316     cirnatda 12047: <td>LOVE_GAME</td>
1.312     gdt      12048: <td>LOVE_VERSION</td>
1.269     leot     12049: </tr>
                   12050: <tr>
1.316     cirnatda 12051: <td>LP64PLATFORMS</td>
1.312     gdt      12052: <td>MACHINE_PLATFORM</td>
1.269     leot     12053: </tr>
                   12054: <tr>
1.316     cirnatda 12055: <td>MAILAGENT_DOMAIN</td>
1.312     gdt      12056: <td>MAILAGENT_EMAIL</td>
1.269     leot     12057: </tr>
                   12058: <tr>
1.316     cirnatda 12059: <td>MAILAGENT_FQDN</td>
1.312     gdt      12060: <td>MAILAGENT_ORGANIZATION</td>
1.269     leot     12061: </tr>
                   12062: <tr>
1.316     cirnatda 12063: <td>MAJORDOMO_HOMEDIR</td>
1.313     leot     12064: <td>MAKEINFO_ARGS</td>
1.269     leot     12065: </tr>
                   12066: <tr>
1.316     cirnatda 12067: <td>MAKE_DIRS</td>
1.313     leot     12068: <td>MAKE_DIRS_PERMS</td>
1.269     leot     12069: </tr>
                   12070: <tr>
1.316     cirnatda 12071: <td>MAKE_ENV</td>
1.313     leot     12072: <td>MAKE_FILE</td>
1.269     leot     12073: </tr>
                   12074: <tr>
1.316     cirnatda 12075: <td>MAKE_FLAGS</td>
1.313     leot     12076: <td>MAKE_JOBS</td>
1.269     leot     12077: </tr>
                   12078: <tr>
1.316     cirnatda 12079: <td>MAKE_JOBS_SAFE</td>
1.313     leot     12080: <td>MAKE_PROGRAM</td>
1.303     bacon    12081: </tr>
                   12082: <tr>
1.316     cirnatda 12083: <td>MANCOMPRESSED_IF_MANZ</td>
1.313     leot     12084: <td>MANINSTALL</td>
1.269     leot     12085: </tr>
                   12086: <tr>
1.316     cirnatda 12087: <td>MANZ</td>
1.313     leot     12088: <td>MASTER_SITES</td>
1.269     leot     12089: </tr>
                   12090: <tr>
1.316     cirnatda 12091: <td>MASTER_SITE_BACKUP</td>
1.313     leot     12092: <td>MASTER_SITE_LOCAL</td>
1.269     leot     12093: </tr>
                   12094: <tr>
1.316     cirnatda 12095: <td>MASTER_SITE_MOZILLA</td>
1.313     leot     12096: <td>MASTER_SITE_OVERRIDE</td>
1.269     leot     12097: </tr>
                   12098: <tr>
1.316     cirnatda 12099: <td>MASTER_SITE_PERL_CPAN</td>
1.313     leot     12100: <td>MASTER_SORT</td>
1.269     leot     12101: </tr>
                   12102: <tr>
1.316     cirnatda 12103: <td>MASTER_SORT_RANDOM</td>
1.313     leot     12104: <td>MASTER_SORT_REGEX</td>
1.269     leot     12105: </tr>
                   12106: <tr>
1.316     cirnatda 12107: <td>MECAB_CHARSET</td>
1.313     leot     12108: <td>MEDIATOMB_GROUP</td>
1.269     leot     12109: </tr>
                   12110: <tr>
1.316     cirnatda 12111: <td>MEDIATOMB_USER</td>
1.313     leot     12112: <td>MIPSPROBASE</td>
1.269     leot     12113: </tr>
                   12114: <tr>
1.316     cirnatda 12115: <td>MIREDO_GROUP</td>
1.313     leot     12116: <td>MIREDO_USER</td>
1.269     leot     12117: </tr>
                   12118: <tr>
1.316     cirnatda 12119: <td>MISSING_FEATURES</td>
1.313     leot     12120: <td>MKDIR</td>
1.269     leot     12121: </tr>
                   12122: <tr>
1.316     cirnatda 12123: <td>MLDONKEY_GROUP</td>
1.313     leot     12124: <td>MLDONKEY_HOME</td>
1.269     leot     12125: </tr>
                   12126: <tr>
1.316     cirnatda 12127: <td>MLDONKEY_USER</td>
1.313     leot     12128: <td>MONOTONE_GROUP</td>
1.269     leot     12129: </tr>
                   12130: <tr>
1.316     cirnatda 12131: <td>MONOTONE_USER</td>
1.313     leot     12132: <td>MOTIFBASE</td>
1.269     leot     12133: </tr>
                   12134: <tr>
1.316     cirnatda 12135: <td>MOTIF_TYPE</td>
1.313     leot     12136: <td>MOTIF_TYPE_DEFAULT</td>
1.269     leot     12137: </tr>
                   12138: <tr>
1.316     cirnatda 12139: <td>MPI_TYPE</td>
1.313     leot     12140: <td>MSGFMT_STRIP_MSGCTXT</td>
1.311     leot     12141: </tr>
                   12142: <tr>
1.316     cirnatda 12143: <td>MSGFMT_STRIP_MSGID_PLURAL</td>
1.313     leot     12144: <td>MTOOLS_ENABLE_FLOPPYD</td>
1.269     leot     12145: </tr>
                   12146: <tr>
1.316     cirnatda 12147: <td>MV</td>
1.312     gdt      12148: <td>MYSQL_CHARSET</td>
1.269     leot     12149: </tr>
                   12150: <tr>
1.316     cirnatda 12151: <td>MYSQL_DATADIR</td>
1.312     gdt      12152: <td>MYSQL_EXTRA_CHARSET</td>
1.269     leot     12153: </tr>
                   12154: <tr>
1.316     cirnatda 12155: <td>MYSQL_GROUP</td>
1.315     cirnatda 12156: <td>MYSQL_USER</td>
1.269     leot     12157: </tr>
                   12158: <tr>
1.312     gdt      12159: <td>MYSQL_VERSION</td>
1.315     cirnatda 12160: <td>MYSQL_VERSIONS_ACCEPTED</td>
1.309     gutterid 12161: </tr>
                   12162: <tr>
1.316     cirnatda 12163: <td>MYSQL_VERSIONS_ALL</td>
1.312     gdt      12164: <td>MYSQL_VERSION_DEFAULT</td>
1.269     leot     12165: </tr>
                   12166: <tr>
1.316     cirnatda 12167: <td>NAGIOSCMD_GROUP</td>
1.312     gdt      12168: <td>NAGIOSDIR</td>
1.269     leot     12169: </tr>
                   12170: <tr>
1.316     cirnatda 12171: <td>NAGIOS_GROUP</td>
1.312     gdt      12172: <td>NAGIOS_USER</td>
1.269     leot     12173: </tr>
                   12174: <tr>
1.316     cirnatda 12175: <td>NATIVE_APPEND_ABI</td>
1.312     gdt      12176: <td>NATIVE_APPEND_ELF</td>
1.269     leot     12177: </tr>
                   12178: <tr>
1.316     cirnatda 12179: <td>NATIVE_EXEC_FMT</td>
1.312     gdt      12180: <td>NATIVE_MACHINE_PLATFORM</td>
1.269     leot     12181: </tr>
                   12182: <tr>
1.316     cirnatda 12183: <td>NATIVE_OBJECT_FMT</td>
1.312     gdt      12184: <td>NBPAX_PROGRAM_PREFIX</td>
1.269     leot     12185: </tr>
                   12186: <tr>
1.316     cirnatda 12187: <td>NETBSD_LOGIN_NAME</td>
1.312     gdt      12188: <td>NMH_EDITOR</td>
1.293     rillig   12189: </tr>
                   12190: <tr>
1.316     cirnatda 12191: <td>NMH_MTA</td>
1.312     gdt      12192: <td>NMH_PAGER</td>
1.269     leot     12193: </tr>
                   12194: <tr>
1.316     cirnatda 12195: <td>NOLOGIN</td>
1.312     gdt      12196: <td>NOTE</td>
1.269     leot     12197: </tr>
                   12198: <tr>
1.316     cirnatda 12199: <td>NOT_FOR_PLATFORM</td>
1.312     gdt      12200: <td>NOT_PAX_ASLR_SAFE</td>
1.269     leot     12201: </tr>
                   12202: <tr>
1.316     cirnatda 12203: <td>NOT_PAX_MPROTECT_SAFE</td>
1.312     gdt      12204: <td>NO_BUILD</td>
1.269     leot     12205: </tr>
                   12206: <tr>
1.316     cirnatda 12207: <td>NO_CHECKSUM</td>
1.312     gdt      12208: <td>NO_CONFIGURE</td>
1.269     leot     12209: </tr>
                   12210: <tr>
1.316     cirnatda 12211: <td>NO_SKIP</td>
1.312     gdt      12212: <td>NS_PREFERRED</td>
1.269     leot     12213: </tr>
                   12214: <tr>
1.316     cirnatda 12215: <td>NULLMAILER_GROUP</td>
1.312     gdt      12216: <td>NULLMAILER_USER</td>
1.269     leot     12217: </tr>
                   12218: <tr>
1.316     cirnatda 12219: <td>OASIS</td>
1.312     gdt      12220: <td>OASIS_BUILD_ARGS</td>
1.269     leot     12221: </tr>
                   12222: <tr>
1.316     cirnatda 12223: <td>OBJHOSTNAME</td>
1.312     gdt      12224: <td>OBJMACHINE</td>
1.269     leot     12225: </tr>
                   12226: <tr>
1.316     cirnatda 12227: <td>OCAML_FINDLIB_DIRS</td>
1.312     gdt      12228: <td>OCAML_FINDLIB_REGISTER</td>
1.269     leot     12229: </tr>
                   12230: <tr>
1.316     cirnatda 12231: <td>OCAML_FINDLIB_REGISTER_VERBOSE</td>
1.312     gdt      12232: <td>OCAML_SITELIBDIR</td>
1.269     leot     12233: </tr>
                   12234: <tr>
1.316     cirnatda 12235: <td>OCAML_TOPKG_DOCDIR</td>
1.312     gdt      12236: <td>OCAML_USE_DUNE</td>
1.269     leot     12237: </tr>
                   12238: <tr>
1.316     cirnatda 12239: <td>OCAML_USE_FINDLIB</td>
1.312     gdt      12240: <td>OCAML_USE_JBUILDER</td>
1.269     leot     12241: </tr>
                   12242: <tr>
1.316     cirnatda 12243: <td>OCAML_USE_OASIS</td>
1.312     gdt      12244: <td>OCAML_USE_OASIS_DYNRUN</td>
1.269     leot     12245: </tr>
                   12246: <tr>
1.316     cirnatda 12247: <td>OCAML_USE_OPAM</td>
1.312     gdt      12248: <td>OCAML_USE_OPT_COMPILER</td>
1.269     leot     12249: </tr>
                   12250: <tr>
1.316     cirnatda 12251: <td>OCAML_USE_TOPKG</td>
1.312     gdt      12252: <td>OMF</td>
1.269     leot     12253: </tr>
                   12254: <tr>
1.316     cirnatda 12255: <td>ONLY_FOR_COMPILER</td>
1.312     gdt      12256: <td>ONLY_FOR_PLATFORM</td>
1.269     leot     12257: </tr>
                   12258: <tr>
1.316     cirnatda 12259: <td>OPENSSH_CHROOT</td>
1.312     gdt      12260: <td>OPENSSH_GROUP</td>
1.269     leot     12261: </tr>
                   12262: <tr>
1.316     cirnatda 12263: <td>OPENSSH_USER</td>
1.312     gdt      12264: <td>OPSYS</td>
1.269     leot     12265: </tr>
                   12266: <tr>
1.316     cirnatda 12267: <td>OPSYS_EMULDIR</td>
1.312     gdt      12268: <td>OS</td>
                   12269: </tr>
                   12270: <tr>
1.316     cirnatda 12271: <td>OSS_TYPE</td>
1.311     leot     12272: <td>OSX</td>
1.292     leot     12273: </tr>
                   12274: <tr>
1.316     cirnatda 12275: <td>OSX_TOLERATE_SDK_SKEW</td>
1.309     gutterid 12276: <td>OS_VARIANT</td>
1.311     leot     12277: </tr>
                   12278: <tr>
1.316     cirnatda 12279: <td>OS_VERSION</td>
1.311     leot     12280: <td>OTF_FONTS_DIR</td>
1.269     leot     12281: </tr>
                   12282: <tr>
1.316     cirnatda 12283: <td>OVERRIDE_DIRDEPTH</td>
1.311     leot     12284: <td>OVERRIDE_GEMSPEC</td>
1.269     leot     12285: </tr>
                   12286: <tr>
1.316     cirnatda 12287: <td>OVERRIDE_GNU_CONFIG_SCRIPTS</td>
1.313     leot     12288: <td>OWN_DIRS</td>
1.269     leot     12289: </tr>
                   12290: <tr>
1.316     cirnatda 12291: <td>OWN_DIRS_PERMS</td>
1.313     leot     12292: <td>P4GROUP</td>
1.269     leot     12293: </tr>
                   12294: <tr>
1.316     cirnatda 12295: <td>P4PORT</td>
1.313     leot     12296: <td>P4ROOT</td>
1.269     leot     12297: </tr>
                   12298: <tr>
1.316     cirnatda 12299: <td>P4USER</td>
1.313     leot     12300: <td>PACKAGES</td>
1.269     leot     12301: </tr>
                   12302: <tr>
1.316     cirnatda 12303: <td>PALMOS_DEFAULT_SDK</td>
1.313     leot     12304: <td>PAMBASE</td>
1.269     leot     12305: </tr>
                   12306: <tr>
1.316     cirnatda 12307: <td>PAM_DEFAULT</td>
1.313     leot     12308: <td>PAPERSIZE</td>
1.269     leot     12309: </tr>
                   12310: <tr>
1.316     cirnatda 12311: <td>PASSIVE_FETCH</td>
1.313     leot     12312: <td>PATCHDIR</td>
1.269     leot     12313: </tr>
                   12314: <tr>
1.316     cirnatda 12315: <td>PATCHFILES</td>
1.313     leot     12316: <td>PATCH_ARGS</td>
1.269     leot     12317: </tr>
                   12318: <tr>
1.316     cirnatda 12319: <td>PATCH_DEBUG</td>
1.313     leot     12320: <td>PATCH_DIST_ARGS</td>
1.284     rillig   12321: </tr>
                   12322: <tr>
1.316     cirnatda 12323: <td>PATCH_DIST_CAT</td>
1.313     leot     12324: <td>PATCH_DIST_STRIP</td>
1.269     leot     12325: </tr>
                   12326: <tr>
1.316     cirnatda 12327: <td>PATCH_FUZZ_FACTOR</td>
1.313     leot     12328: <td>PATCH_STRIP</td>
1.316     cirnatda 12329: </tr>
                   12330: <tr>
1.309     gutterid 12331: <td>PATH</td>
1.316     cirnatda 12332: <td>PCCBASE</td>
1.269     leot     12333: </tr>
                   12334: <tr>
1.309     gutterid 12335: <td>PEAR_CMD</td>
1.316     cirnatda 12336: <td>PEAR_LIB</td>
1.292     leot     12337: </tr>
                   12338: <tr>
1.309     gutterid 12339: <td>PEAR_PACKAGE_XML</td>
1.316     cirnatda 12340: <td>PERL5</td>
1.274     rillig   12341: </tr>
                   12342: <tr>
1.309     gutterid 12343: <td>PERL5_CONFIGURE</td>
1.316     cirnatda 12344: <td>PERL5_CONFIGURE_DIRS</td>
1.274     rillig   12345: </tr>
                   12346: <tr>
1.309     gutterid 12347: <td>PERL5_LDFLAGS</td>
1.316     cirnatda 12348: <td>PERL5_LICENSE</td>
1.269     leot     12349: </tr>
                   12350: <tr>
1.309     gutterid 12351: <td>PERL5_MODULE_TYPE</td>
1.316     cirnatda 12352: <td>PERL5_PACKLIST</td>
1.269     leot     12353: </tr>
                   12354: <tr>
1.309     gutterid 12355: <td>PERL5_PACKLIST_DIR</td>
1.316     cirnatda 12356: <td>PERL5_PERLBASE</td>
1.269     leot     12357: </tr>
                   12358: <tr>
1.309     gutterid 12359: <td>PERL5_SITEBASE</td>
1.316     cirnatda 12360: <td>PERL5_USE_PACKLIST</td>
1.269     leot     12361: </tr>
                   12362: <tr>
1.309     gutterid 12363: <td>PERL5_VENDORBASE</td>
1.316     cirnatda 12364: <td>PFCTL</td>
1.269     leot     12365: </tr>
                   12366: <tr>
1.309     gutterid 12367: <td>PFVAR_H</td>
1.316     cirnatda 12368: <td>PF_VERSION</td>
1.269     leot     12369: </tr>
                   12370: <tr>
1.309     gutterid 12371: <td>PGGROUP</td>
1.316     cirnatda 12372: <td>PGHOME</td>
1.269     leot     12373: </tr>
                   12374: <tr>
1.309     gutterid 12375: <td>PGPKGSRCDIR</td>
1.316     cirnatda 12376: <td>PGSQL_TYPE</td>
1.269     leot     12377: </tr>
                   12378: <tr>
1.309     gutterid 12379: <td>PGSQL_VERSION</td>
1.316     cirnatda 12380: <td>PGSQL_VERSIONS_ACCEPTED</td>
1.269     leot     12381: </tr>
                   12382: <tr>
1.305     bacon    12383: <td>PGSQL_VERSION_DEFAULT</td>
1.316     cirnatda 12384: <td>PGUSER</td>
1.269     leot     12385: </tr>
                   12386: <tr>
1.305     bacon    12387: <td>PG_LIB_EXT</td>
1.316     cirnatda 12388: <td>PHP</td>
1.269     leot     12389: </tr>
                   12390: <tr>
1.305     bacon    12391: <td>PHPCOMMON_MK</td>
1.316     cirnatda 12392: <td>PHPPKGSRCDIR</td>
1.269     leot     12393: </tr>
                   12394: <tr>
1.305     bacon    12395: <td>PHP_BASE_VERS</td>
1.316     cirnatda 12396: <td>PHP_CHECK_INSTALLED</td>
1.269     leot     12397: </tr>
                   12398: <tr>
1.305     bacon    12399: <td>PHP_EXTENSION_DIR</td>
1.316     cirnatda 12400: <td>PHP_INITIAL_TEENY</td>
1.269     leot     12401: </tr>
                   12402: <tr>
1.305     bacon    12403: <td>PHP_PKG_PREFIX</td>
1.316     cirnatda 12404: <td>PHP_VERSION</td>
1.269     leot     12405: </tr>
                   12406: <tr>
1.305     bacon    12407: <td>PHP_VERSIONS_ACCEPTED</td>
1.316     cirnatda 12408: <td>PHP_VERSIONS_INCOMPATIBLE</td>
1.269     leot     12409: </tr>
                   12410: <tr>
1.305     bacon    12411: <td>PHP_VERSION_DEFAULT</td>
1.316     cirnatda 12412: <td>PHP_VERSION_REQD</td>
1.269     leot     12413: </tr>
                   12414: <tr>
1.305     bacon    12415: <td>PILRC_USE_GTK</td>
1.316     cirnatda 12416: <td>PKGCONFIG_BASE</td>
1.269     leot     12417: </tr>
                   12418: <tr>
1.305     bacon    12419: <td>PKGCONFIG_FILE</td>
1.316     cirnatda 12420: <td>PKGCONFIG_OVERRIDE</td>
1.269     leot     12421: </tr>
                   12422: <tr>
1.305     bacon    12423: <td>PKGCONFIG_OVERRIDE_STAGE</td>
1.316     cirnatda 12424: <td>PKGDIR</td>
1.269     leot     12425: </tr>
                   12426: <tr>
1.305     bacon    12427: <td>PKGGNUDIR</td>
1.316     cirnatda 12428: <td>PKGINFODIR</td>
1.269     leot     12429: </tr>
                   12430: <tr>
1.305     bacon    12431: <td>PKGLOCALEDIR</td>
1.316     cirnatda 12432: <td>PKGMANDIR</td>
1.269     leot     12433: </tr>
                   12434: <tr>
1.305     bacon    12435: <td>PKGNAME</td>
1.316     cirnatda 12436: <td>PKGNAME_REQD</td>
1.269     leot     12437: </tr>
                   12438: <tr>
1.305     bacon    12439: <td>PKGPATH</td>
1.316     cirnatda 12440: <td>PKGREVISION</td>
1.269     leot     12441: </tr>
                   12442: <tr>
1.305     bacon    12443: <td>PKGSRC_BLAS_TYPES</td>
1.316     cirnatda 12444: <td>PKGSRC_CHANGES</td>
1.292     leot     12445: </tr>
                   12446: <tr>
1.305     bacon    12447: <td>PKGSRC_COMPILER</td>
1.316     cirnatda 12448: <td>PKGSRC_KEEP_BIN_PKGS</td>
1.269     leot     12449: </tr>
                   12450: <tr>
1.305     bacon    12451: <td>PKGSRC_LOCKTYPE</td>
1.316     cirnatda 12452: <td>PKGSRC_MAKE_ENV</td>
1.274     rillig   12453: </tr>
                   12454: <tr>
1.305     bacon    12455: <td>PKGSRC_MESSAGE_RECIPIENTS</td>
1.316     cirnatda 12456: <td>PKGSRC_MKPIE</td>
1.269     leot     12457: </tr>
                   12458: <tr>
1.305     bacon    12459: <td>PKGSRC_MKREPRO</td>
1.316     cirnatda 12460: <td>PKGSRC_RUN_TEST</td>
1.269     leot     12461: </tr>
                   12462: <tr>
1.305     bacon    12463: <td>PKGSRC_SETENV</td>
1.316     cirnatda 12464: <td>PKGSRC_SLEEPSECS</td>
1.269     leot     12465: </tr>
                   12466: <tr>
1.305     bacon    12467: <td>PKGSRC_TODO</td>
1.316     cirnatda 12468: <td>PKGSRC_USE_CTF</td>
1.269     leot     12469: </tr>
                   12470: <tr>
1.305     bacon    12471: <td>PKGSRC_USE_FORTIFY</td>
1.316     cirnatda 12472: <td>PKGSRC_USE_RELRO</td>
1.269     leot     12473: </tr>
                   12474: <tr>
1.305     bacon    12475: <td>PKGSRC_USE_SSP</td>
1.316     cirnatda 12476: <td>PKGSRC_USE_STACK_CHECK</td>
1.269     leot     12477: </tr>
                   12478: <tr>
1.305     bacon    12479: <td>PKGTASKS_DATAFILE</td>
1.316     cirnatda 12480: <td>PKGTOOLS_ARGS</td>
1.269     leot     12481: </tr>
                   12482: <tr>
1.305     bacon    12483: <td>PKGTOOLS_ENV</td>
1.316     cirnatda 12484: <td>PKG_ALTERNATIVES</td>
1.269     leot     12485: </tr>
                   12486: <tr>
1.305     bacon    12487: <td>PKG_APACHE</td>
1.316     cirnatda 12488: <td>PKG_APACHE_ACCEPTED</td>
1.269     leot     12489: </tr>
                   12490: <tr>
1.305     bacon    12491: <td>PKG_APACHE_DEFAULT</td>
1.316     cirnatda 12492: <td>PKG_BEST_EXISTS</td>
1.269     leot     12493: </tr>
                   12494: <tr>
1.305     bacon    12495: <td>PKG_BUILD_OPTIONS</td>
1.316     cirnatda 12496: <td>PKG_COMPRESSION</td>
1.269     leot     12497: </tr>
                   12498: <tr>
1.305     bacon    12499: <td>PKG_CONFIG</td>
1.316     cirnatda 12500: <td>PKG_CONFIG_PERMS</td>
1.269     leot     12501: </tr>
                   12502: <tr>
1.305     bacon    12503: <td>PKG_CREATE_USERGROUP</td>
1.316     cirnatda 12504: <td>PKG_DB_TMPDIR</td>
1.269     leot     12505: </tr>
                   12506: <tr>
1.305     bacon    12507: <td>PKG_DEBUG_LEVEL</td>
1.316     cirnatda 12508: <td>PKG_DEFAULT_OPTIONS</td>
1.269     leot     12509: </tr>
                   12510: <tr>
1.305     bacon    12511: <td>PKG_DESTDIR_SUPPORT</td>
1.316     cirnatda 12512: <td>PKG_DEVELOPER</td>
1.269     leot     12513: </tr>
                   12514: <tr>
1.305     bacon    12515: <td>PKG_DISABLED_OPTIONS</td>
1.316     cirnatda 12516: <td>PKG_FATAL_ERRORS</td>
1.269     leot     12517: </tr>
                   12518: <tr>
1.305     bacon    12519: <td>PKG_FC</td>
1.316     cirnatda 12520: <td>PKG_FILELIST_CMD</td>
1.269     leot     12521: </tr>
                   12522: <tr>
1.305     bacon    12523: <td>PKG_GECOS</td>
1.316     cirnatda 12524: <td>PKG_GID</td>
1.269     leot     12525: </tr>
                   12526: <tr>
1.305     bacon    12527: <td>PKG_GROUPS</td>
1.316     cirnatda 12528: <td>PKG_GROUPS_VARS</td>
1.269     leot     12529: </tr>
                   12530: <tr>
1.305     bacon    12531: <td>PKG_HOME</td>
1.316     cirnatda 12532: <td>PKG_INIT_SCRIPTS</td>
1.269     leot     12533: </tr>
                   12534: <tr>
1.305     bacon    12535: <td>PKG_JAVA_HOME</td>
1.316     cirnatda 12536: <td>PKG_JVM</td>
1.269     leot     12537: </tr>
                   12538: <tr>
1.305     bacon    12539: <td>PKG_JVMS_ACCEPTED</td>
1.316     cirnatda 12540: <td>PKG_JVM_DEFAULT</td>
1.269     leot     12541: </tr>
                   12542: <tr>
1.305     bacon    12543: <td>PKG_LEGACY_OPTIONS</td>
1.316     cirnatda 12544: <td>PKG_LIBTOOL</td>
1.269     leot     12545: </tr>
                   12546: <tr>
1.305     bacon    12547: <td>PKG_OPTIONS</td>
1.316     cirnatda 12548: <td>PKG_OPTIONS_DEPRECATED_WARNINGS</td>
1.269     leot     12549: </tr>
                   12550: <tr>
1.305     bacon    12551: <td>PKG_OPTIONS_LEGACY_OPTS</td>
1.316     cirnatda 12552: <td>PKG_OPTIONS_LEGACY_VARS</td>
1.269     leot     12553: </tr>
                   12554: <tr>
1.305     bacon    12555: <td>PKG_OPTIONS_NONEMPTY_SETS</td>
1.316     cirnatda 12556: <td>PKG_OPTIONS_OPTIONAL_GROUPS</td>
1.269     leot     12557: </tr>
                   12558: <tr>
1.305     bacon    12559: <td>PKG_OPTIONS_REQUIRED_GROUPS</td>
1.316     cirnatda 12560: <td>PKG_OPTIONS_VAR</td>
1.269     leot     12561: </tr>
                   12562: <tr>
1.305     bacon    12563: <td>PKG_PHP</td>
1.316     cirnatda 12564: <td>PKG_PHP_MAJOR_VERS</td>
1.269     leot     12565: </tr>
                   12566: <tr>
1.305     bacon    12567: <td>PKG_PHP_VERSION</td>
1.316     cirnatda 12568: <td>PKG_RCD_SCRIPTS</td>
1.269     leot     12569: </tr>
                   12570: <tr>
1.305     bacon    12571: <td>PKG_REFCOUNT_DBDIR</td>
1.316     cirnatda 12572: <td>PKG_REGISTER_SHELLS</td>
1.269     leot     12573: </tr>
                   12574: <tr>
1.305     bacon    12575: <td>PKG_RESUME_TRANSFERS</td>
1.316     cirnatda 12576: <td>PKG_SHELL</td>
1.269     leot     12577: </tr>
                   12578: <tr>
1.305     bacon    12579: <td>PKG_SUGGESTED_OPTIONS</td>
1.316     cirnatda 12580: <td>PKG_SUPPORTED_OPTIONS</td>
1.269     leot     12581: </tr>
                   12582: <tr>
1.305     bacon    12583: <td>PKG_SYSCONFBASE</td>
1.316     cirnatda 12584: <td>PKG_SYSCONFBASEDIR</td>
1.269     leot     12585: </tr>
                   12586: <tr>
1.305     bacon    12587: <td>PKG_SYSCONFDIR</td>
1.316     cirnatda 12588: <td>PKG_SYSCONFDIR_PERMS</td>
1.269     leot     12589: </tr>
                   12590: <tr>
1.305     bacon    12591: <td>PKG_SYSCONFSUBDIR</td>
1.316     cirnatda 12592: <td>PKG_SYSCONFVAR</td>
1.269     leot     12593: </tr>
                   12594: <tr>
1.305     bacon    12595: <td>PKG_TOOLS_BIN</td>
1.316     cirnatda 12596: <td>PKG_UID</td>
1.269     leot     12597: </tr>
                   12598: <tr>
1.305     bacon    12599: <td>PKG_UPDATE_FONTS_DB</td>
1.316     cirnatda 12600: <td>PKG_USERS</td>
1.269     leot     12601: </tr>
                   12602: <tr>
1.305     bacon    12603: <td>PKG_USERS_VARS</td>
1.316     cirnatda 12604: <td>PKG_VERBOSE</td>
1.269     leot     12605: </tr>
                   12606: <tr>
1.316     cirnatda 12607: <td>PLEASE</td>
1.305     bacon    12608: <td>PLIST</td>
1.269     leot     12609: </tr>
                   12610: <tr>
1.313     leot     12611: <td>PLIST_AWK</td>
1.305     bacon    12612: <td>PLIST_AWK_ENV</td>
1.269     leot     12613: </tr>
                   12614: <tr>
1.313     leot     12615: <td>PLIST_SRC</td>
1.305     bacon    12616: <td>PLIST_SUBST</td>
1.269     leot     12617: </tr>
                   12618: <tr>
1.313     leot     12619: <td>PLIST_TYPE</td>
1.305     bacon    12620: <td>PLIST_VARS</td>
1.269     leot     12621: </tr>
                   12622: <tr>
1.313     leot     12623: <td>POPTOP_USE_MPPE</td>
1.305     bacon    12624: <td>POSSIBLE_GFORTRAN_VERSION</td>
1.269     leot     12625: </tr>
                   12626: <tr>
1.313     leot     12627: <td>POST_FETCH_HOOK</td>
1.305     bacon    12628: <td>PREFER</td>
1.269     leot     12629: </tr>
                   12630: <tr>
1.313     leot     12631: <td>PREFER_NATIVE</td>
1.305     bacon    12632: <td>PREFER_NATIVE_PTHREADS</td>
1.269     leot     12633: </tr>
                   12634: <tr>
1.313     leot     12635: <td>PREFER_PKGSRC</td>
1.305     bacon    12636: <td>PREFIX</td>
1.269     leot     12637: </tr>
                   12638: <tr>
1.313     leot     12639: <td>PREPEND_PATH</td>
1.305     bacon    12640: <td>PRE_ROOT_CMD</td>
1.269     leot     12641: </tr>
                   12642: <tr>
1.313     leot     12643: <td>PRIVILEGED_STAGES</td>
1.305     bacon    12644: <td>PS</td>
1.269     leot     12645: </tr>
                   12646: <tr>
1.313     leot     12647: <td>PTHREAD_AUTO_VARS</td>
1.305     bacon    12648: <td>PTHREAD_CFLAGS</td>
1.269     leot     12649: </tr>
                   12650: <tr>
1.313     leot     12651: <td>PTHREAD_LDFLAGS</td>
1.305     bacon    12652: <td>PTHREAD_LIBS</td>
1.269     leot     12653: </tr>
                   12654: <tr>
1.313     leot     12655: <td>PTHREAD_OPTS</td>
1.305     bacon    12656: <td>PTHREAD_TYPE</td>
1.269     leot     12657: </tr>
                   12658: <tr>
1.313     leot     12659: <td>PVM_SSH</td>
1.305     bacon    12660: <td>PYPKGPREFIX</td>
1.269     leot     12661: </tr>
                   12662: <tr>
1.313     leot     12663: <td>PYTHON_FOR_BUILD_ONLY</td>
1.305     bacon    12664: <td>PYTHON_SELF_CONFLICT</td>
1.269     leot     12665: </tr>
                   12666: <tr>
1.313     leot     12667: <td>PYTHON_VERSIONED_DEPENDENCIES</td>
1.305     bacon    12668: <td>PYTHON_VERSIONS_ACCEPTED</td>
1.269     leot     12669: </tr>
                   12670: <tr>
1.313     leot     12671: <td>PYTHON_VERSIONS_INCOMPATIBLE</td>
1.305     bacon    12672: <td>PYTHON_VERSION_DEFAULT</td>
1.269     leot     12673: </tr>
                   12674: <tr>
1.313     leot     12675: <td>PYTHON_VERSION_REQD</td>
1.305     bacon    12676: <td>PYVERSSUFFIX</td>
1.269     leot     12677: </tr>
                   12678: <tr>
1.313     leot     12679: <td>PY_NO_EGG</td>
1.305     bacon    12680: <td>QMAILDIR</td>
1.269     leot     12681: </tr>
                   12682: <tr>
1.313     leot     12683: <td>QMAIL_ALIAS_USER</td>
1.305     bacon    12684: <td>QMAIL_DAEMON_USER</td>
1.269     leot     12685: </tr>
                   12686: <tr>
1.313     leot     12687: <td>QMAIL_LOG_USER</td>
1.305     bacon    12688: <td>QMAIL_NOFILES_GROUP</td>
1.269     leot     12689: </tr>
                   12690: <tr>
1.313     leot     12691: <td>QMAIL_PASSWD_USER</td>
1.305     bacon    12692: <td>QMAIL_QMAIL_GROUP</td>
1.269     leot     12693: </tr>
                   12694: <tr>
1.313     leot     12695: <td>QMAIL_QUEUE_DIR</td>
1.305     bacon    12696: <td>QMAIL_QUEUE_EXTRA</td>
1.269     leot     12697: </tr>
                   12698: <tr>
1.313     leot     12699: <td>QMAIL_QUEUE_USER</td>
1.305     bacon    12700: <td>QMAIL_REMOTE_USER</td>
1.269     leot     12701: </tr>
                   12702: <tr>
1.313     leot     12703: <td>QMAIL_ROOT_USER</td>
1.305     bacon    12704: <td>QMAIL_SEND_USER</td>
1.269     leot     12705: </tr>
                   12706: <tr>
1.313     leot     12707: <td>QPOPPER_FAC</td>
1.305     bacon    12708: <td>QPOPPER_SPOOL_DIR</td>
1.269     leot     12709: </tr>
                   12710: <tr>
1.313     leot     12711: <td>QPOPPER_USER</td>
1.305     bacon    12712: <td>RAKE_NAME</td>
1.269     leot     12713: </tr>
                   12714: <tr>
1.313     leot     12715: <td>RASMOL_DEPTH</td>
1.305     bacon    12716: <td>RCD_SCRIPTS</td>
1.292     leot     12717: </tr>
                   12718: <tr>
1.313     leot     12719: <td>RCD_SCRIPTS_DIR</td>
1.305     bacon    12720: <td>RCD_SCRIPTS_EXAMPLEDIR</td>
1.269     leot     12721: </tr>
                   12722: <tr>
1.313     leot     12723: <td>RCD_SCRIPTS_MODE</td>
1.305     bacon    12724: <td>RCD_SCRIPTS_SHELL</td>
1.269     leot     12725: </tr>
                   12726: <tr>
1.313     leot     12727: <td>RCD_SCRIPT_SRC</td>
1.315     cirnatda 12728: <td>RDOC</td>
1.311     leot     12729: </tr>
                   12730: <tr>
                   12731: <td>READLINE_DEFAULT</td>
1.315     cirnatda 12732: <td>READLINE_TYPE</td>
1.269     leot     12733: </tr>
                   12734: <tr>
1.311     leot     12735: <td>REAL_ROOT_GROUP</td>
1.315     cirnatda 12736: <td>REAL_ROOT_USER</td>
1.269     leot     12737: </tr>
                   12738: <tr>
1.311     leot     12739: <td>RECURSIVE_MAKE</td>
1.315     cirnatda 12740: <td>RELAY_CTRL_DIR</td>
1.269     leot     12741: </tr>
                   12742: <tr>
1.311     leot     12743: <td>RELRO_SUPPORTED</td>
1.315     cirnatda 12744: <td>REPLACE_AWK</td>
1.269     leot     12745: </tr>
                   12746: <tr>
1.311     leot     12747: <td>REPLACE_BASH</td>
1.315     cirnatda 12748: <td>REPLACE_CSH</td>
1.269     leot     12749: </tr>
                   12750: <tr>
1.311     leot     12751: <td>REPLACE_KSH</td>
1.315     cirnatda 12752: <td>REPLACE_PERL</td>
1.269     leot     12753: </tr>
                   12754: <tr>
1.311     leot     12755: <td>REPLACE_PERL6</td>
1.315     cirnatda 12756: <td>REPLACE_PHP</td>
1.269     leot     12757: </tr>
                   12758: <tr>
1.311     leot     12759: <td>REPLACE_PYTHON</td>
1.315     cirnatda 12760: <td>REPLACE_RUBY</td>
1.269     leot     12761: </tr>
                   12762: <tr>
1.311     leot     12763: <td>REPLACE_RUBY_DIRS</td>
1.315     cirnatda 12764: <td>REPLACE_RUBY_PAT</td>
1.281     leot     12765: </tr>
                   12766: <tr>
1.311     leot     12767: <td>REPLACE_SH</td>
1.315     cirnatda 12768: <td>REPLACE_TEXLUA</td>
1.269     leot     12769: </tr>
                   12770: <tr>
1.311     leot     12771: <td>REQD_DIRS</td>
1.315     cirnatda 12772: <td>REQD_DIRS_PERMS</td>
1.269     leot     12773: </tr>
                   12774: <tr>
1.311     leot     12775: <td>REQD_FILES</td>
1.315     cirnatda 12776: <td>REQD_FILES_MODE</td>
1.269     leot     12777: </tr>
                   12778: <tr>
1.311     leot     12779: <td>REQD_FILES_PERMS</td>
1.315     cirnatda 12780: <td>RESOLV_AUTO_VARS</td>
1.269     leot     12781: </tr>
                   12782: <tr>
1.311     leot     12783: <td>RESOLV_LDFLAGS</td>
1.315     cirnatda 12784: <td>RESOLV_LIBS</td>
1.269     leot     12785: </tr>
                   12786: <tr>
1.311     leot     12787: <td>RM</td>
1.315     cirnatda 12788: <td>ROOT_CMD</td>
1.311     leot     12789: </tr>
                   12790: <tr>
                   12791: <td>ROOT_GROUP</td>
1.313     leot     12792: <td>ROOT_USER</td>
1.269     leot     12793: </tr>
                   12794: <tr>
1.315     cirnatda 12795: <td>RPCGEN</td>
1.313     leot     12796: <td>RPM</td>
1.269     leot     12797: </tr>
                   12798: <tr>
1.315     cirnatda 12799: <td>RPM2PKG_PLIST</td>
1.313     leot     12800: <td>RPM2PKG_PREFIX</td>
1.269     leot     12801: </tr>
                   12802: <tr>
1.315     cirnatda 12803: <td>RPM2PKG_STAGE</td>
1.313     leot     12804: <td>RPM2PKG_STRIP</td>
1.269     leot     12805: </tr>
                   12806: <tr>
1.315     cirnatda 12807: <td>RPM2PKG_SUBPREFIX</td>
1.313     leot     12808: <td>RPMFILES</td>
1.269     leot     12809: </tr>
                   12810: <tr>
1.315     cirnatda 12811: <td>RPMIGNOREPATH</td>
1.313     leot     12812: <td>RPM_DB_PREFIX</td>
1.269     leot     12813: </tr>
                   12814: <tr>
1.315     cirnatda 12815: <td>RSSH_CVS_PATH</td>
1.313     leot     12816: <td>RSSH_RDIST_PATH</td>
1.269     leot     12817: </tr>
                   12818: <tr>
1.315     cirnatda 12819: <td>RSSH_RSYNC_PATH</td>
1.313     leot     12820: <td>RSSH_SCP_PATH</td>
1.269     leot     12821: </tr>
                   12822: <tr>
1.315     cirnatda 12823: <td>RSSH_SFTP_SERVER_PATH</td>
1.313     leot     12824: <td>RUBY</td>
1.269     leot     12825: </tr>
                   12826: <tr>
1.315     cirnatda 12827: <td>RUBYGEM</td>
1.313     leot     12828: <td>RUBYGEM_NAME</td>
1.269     leot     12829: </tr>
                   12830: <tr>
1.315     cirnatda 12831: <td>RUBYGEM_OPTIONS</td>
1.313     leot     12832: <td>RUBYGEM_VERBOSE</td>
1.269     leot     12833: </tr>
                   12834: <tr>
1.315     cirnatda 12835: <td>RUBY_ABI_VERSION</td>
1.313     leot     12836: <td>RUBY_ARCH</td>
1.269     leot     12837: </tr>
                   12838: <tr>
1.315     cirnatda 12839: <td>RUBY_ARCHINC</td>
1.313     leot     12840: <td>RUBY_ARCHLIB</td>
1.269     leot     12841: </tr>
                   12842: <tr>
1.315     cirnatda 12843: <td>RUBY_BASE</td>
1.313     leot     12844: <td>RUBY_BASERIDIR</td>
1.269     leot     12845: </tr>
                   12846: <tr>
1.315     cirnatda 12847: <td>RUBY_BUILD_DOCUMENT</td>
1.313     leot     12848: <td>RUBY_DLEXT</td>
1.269     leot     12849: </tr>
                   12850: <tr>
1.315     cirnatda 12851: <td>RUBY_DOC</td>
1.313     leot     12852: <td>RUBY_DYNAMIC_DIRS</td>
1.269     leot     12853: </tr>
                   12854: <tr>
1.315     cirnatda 12855: <td>RUBY_EG</td>
1.313     leot     12856: <td>RUBY_ENCODING_ARG</td>
1.269     leot     12857: </tr>
                   12858: <tr>
1.315     cirnatda 12859: <td>RUBY_EXTCONF</td>
1.313     leot     12860: <td>RUBY_EXTCONF_CHECK</td>
1.269     leot     12861: </tr>
                   12862: <tr>
1.315     cirnatda 12863: <td>RUBY_EXTCONF_DEBUG</td>
1.313     leot     12864: <td>RUBY_EXTCONF_MAKEFILE</td>
1.269     leot     12865: </tr>
                   12866: <tr>
1.315     cirnatda 12867: <td>RUBY_GEM_BASE</td>
1.313     leot     12868: <td>RUBY_INC</td>
1.269     leot     12869: </tr>
                   12870: <tr>
1.315     cirnatda 12871: <td>RUBY_LIB</td>
1.313     leot     12872: <td>RUBY_LIB_BASE</td>
1.269     leot     12873: </tr>
                   12874: <tr>
1.315     cirnatda 12875: <td>RUBY_NAME</td>
1.313     leot     12876: <td>RUBY_NOVERSION</td>
1.269     leot     12877: </tr>
                   12878: <tr>
1.315     cirnatda 12879: <td>RUBY_PKGPREFIX</td>
1.313     leot     12880: <td>RUBY_RAILS</td>
1.269     leot     12881: </tr>
                   12882: <tr>
1.315     cirnatda 12883: <td>RUBY_RAILS52_VERSION</td>
1.313     leot     12884: <td>RUBY_RAILS60_VERSION</td>
1.312     gdt      12885: </tr>
                   12886: <tr>
1.315     cirnatda 12887: <td>RUBY_RAILS61_VERSION</td>
1.313     leot     12888: <td>RUBY_RAILS_ACCEPTED</td>
1.289     leot     12889: </tr>
                   12890: <tr>
1.315     cirnatda 12891: <td>RUBY_RAILS_DEFAULT</td>
1.313     leot     12892: <td>RUBY_RAILS_REQD</td>
1.269     leot     12893: </tr>
                   12894: <tr>
1.315     cirnatda 12895: <td>RUBY_RAILS_STRICT_DEP</td>
1.313     leot     12896: <td>RUBY_RIDIR</td>
1.269     leot     12897: </tr>
                   12898: <tr>
1.315     cirnatda 12899: <td>RUBY_SETUP</td>
1.313     leot     12900: <td>RUBY_SHLIB</td>
1.269     leot     12901: </tr>
                   12902: <tr>
1.315     cirnatda 12903: <td>RUBY_SHLIBALIAS</td>
1.313     leot     12904: <td>RUBY_SHLIBVER</td>
1.269     leot     12905: </tr>
                   12906: <tr>
1.315     cirnatda 12907: <td>RUBY_SIMPLE_INSTALL</td>
1.313     leot     12908: <td>RUBY_SITEARCHLIB</td>
1.269     leot     12909: </tr>
                   12910: <tr>
1.315     cirnatda 12911: <td>RUBY_SITELIB</td>
1.313     leot     12912: <td>RUBY_SITELIB_BASE</td>
1.269     leot     12913: </tr>
                   12914: <tr>
1.315     cirnatda 12915: <td>RUBY_SITERIDIR</td>
1.313     leot     12916: <td>RUBY_SLEXT</td>
1.269     leot     12917: </tr>
                   12918: <tr>
1.315     cirnatda 12919: <td>RUBY_SRCDIR</td>
1.313     leot     12920: <td>RUBY_STATICLIB</td>
1.269     leot     12921: </tr>
                   12922: <tr>
1.315     cirnatda 12923: <td>RUBY_SUFFIX</td>
1.313     leot     12924: <td>RUBY_SYSRIDIR</td>
1.269     leot     12925: </tr>
                   12926: <tr>
1.315     cirnatda 12927: <td>RUBY_USE_PTHREAD</td>
1.313     leot     12928: <td>RUBY_VENDORARCHLIB</td>
1.269     leot     12929: </tr>
                   12930: <tr>
1.315     cirnatda 12931: <td>RUBY_VENDORLIB</td>
1.313     leot     12932: <td>RUBY_VENDORLIB_BASE</td>
1.269     leot     12933: </tr>
                   12934: <tr>
1.315     cirnatda 12935: <td>RUBY_VER</td>
1.313     leot     12936: <td>RUBY_VERSION</td>
1.269     leot     12937: </tr>
                   12938: <tr>
1.315     cirnatda 12939: <td>RUBY_VERSIONS_ACCEPTED</td>
1.313     leot     12940: <td>RUBY_VERSIONS_INCOMPATIBLE</td>
1.269     leot     12941: </tr>
                   12942: <tr>
1.315     cirnatda 12943: <td>RUBY_VERSION_DEFAULT</td>
1.313     leot     12944: <td>RUBY_VERSION_REQD</td>
1.269     leot     12945: </tr>
                   12946: <tr>
1.315     cirnatda 12947: <td>RUBY_VER_DIR</td>
1.313     leot     12948: <td>RUN</td>
1.269     leot     12949: </tr>
                   12950: <tr>
1.315     cirnatda 12951: <td>RUN_LDCONFIG</td>
1.313     leot     12952: <td>SAWFISH_THEMES</td>
1.269     leot     12953: </tr>
                   12954: <tr>
1.315     cirnatda 12955: <td>SCO</td>
1.313     leot     12956: <td>SCREWS_GROUP</td>
1.269     leot     12957: </tr>
                   12958: <tr>
1.315     cirnatda 12959: <td>SCREWS_USER</td>
1.313     leot     12960: <td>SCRIPTS_ENV</td>
1.269     leot     12961: </tr>
                   12962: <tr>
1.315     cirnatda 12963: <td>SCROLLKEEPER_DATADIR</td>
1.313     leot     12964: <td>SCROLLKEEPER_REBUILDDB</td>
1.269     leot     12965: </tr>
                   12966: <tr>
1.315     cirnatda 12967: <td>SCROLLKEEPER_UPDATEDB</td>
1.313     leot     12968: <td>SDIST_PAWD</td>
1.269     leot     12969: </tr>
                   12970: <tr>
1.315     cirnatda 12971: <td>SERIAL_DEVICES</td>
1.313     leot     12972: <td>SETGIDGAME</td>
1.269     leot     12973: </tr>
                   12974: <tr>
1.315     cirnatda 12975: <td>SETGID_GAMES_PERMS</td>
1.313     leot     12976: <td>SETUID_ROOT_PERMS</td>
1.269     leot     12977: </tr>
                   12978: <tr>
1.315     cirnatda 12979: <td>SH</td>
1.313     leot     12980: <td>SHLIB</td>
1.292     leot     12981: </tr>
                   12982: <tr>
1.313     leot     12983: <td>SIGN_PACKAGES</td>
1.308     leot     12984: <td>SILC_CLIENT_WITH_PERL</td>
1.269     leot     12985: </tr>
                   12986: <tr>
1.313     leot     12987: <td>SITE_SPECIFIC_PKGS</td>
1.308     leot     12988: <td>SKIP_DEPENDS</td>
1.269     leot     12989: </tr>
                   12990: <tr>
1.313     leot     12991: <td>SMF_INSTANCES</td>
1.308     leot     12992: <td>SMF_MANIFEST</td>
1.274     rillig   12993: </tr>
                   12994: <tr>
1.313     leot     12995: <td>SMF_METHODS</td>
1.308     leot     12996: <td>SMF_METHOD_SHELL</td>
1.269     leot     12997: </tr>
                   12998: <tr>
1.313     leot     12999: <td>SMF_METHOD_SRC</td>
1.308     leot     13000: <td>SMF_NAME</td>
1.269     leot     13001: </tr>
                   13002: <tr>
1.313     leot     13003: <td>SMF_PREFIX</td>
1.308     leot     13004: <td>SMF_SRCDIR</td>
1.269     leot     13005: </tr>
                   13006: <tr>
1.313     leot     13007: <td>SNIPROXY_GROUP</td>
1.308     leot     13008: <td>SNIPROXY_USER</td>
1.269     leot     13009: </tr>
                   13010: <tr>
1.313     leot     13011: <td>SOURCE_BUFFSIZE</td>
1.308     leot     13012: <td>SPECIAL_PERMS</td>
1.269     leot     13013: </tr>
                   13014: <tr>
1.313     leot     13015: <td>SPECIFIC_PKGS</td>
1.308     leot     13016: <td>SSH_SUID</td>
1.269     leot     13017: </tr>
                   13018: <tr>
1.313     leot     13019: <td>SSP_SUPPORTED</td>
1.308     leot     13020: <td>SSYNC_PAWD</td>
1.269     leot     13021: </tr>
                   13022: <tr>
1.313     leot     13023: <td>STEP_MSG</td>
1.308     leot     13024: <td>STRIP</td>
1.269     leot     13025: </tr>
                   13026: <tr>
1.313     leot     13027: <td>STRIP_DBG</td>
1.308     leot     13028: <td>STRIP_DEBUG</td>
1.269     leot     13029: </tr>
                   13030: <tr>
1.313     leot     13031: <td>STRIP_DEBUG_SUPPORTED</td>
1.308     leot     13032: <td>STRIP_FILES_SKIP</td>
1.269     leot     13033: </tr>
                   13034: <tr>
1.313     leot     13035: <td>SU</td>
1.308     leot     13036: <td>SUBDIR</td>
1.269     leot     13037: </tr>
                   13038: <tr>
1.313     leot     13039: <td>SUBST</td>
1.308     leot     13040: <td>SUBST_CLASSES</td>
1.289     leot     13041: </tr>
                   13042: <tr>
1.313     leot     13043: <td>SUBST_FILES</td>
1.308     leot     13044: <td>SUBST_FILTER_CMD</td>
1.269     leot     13045: </tr>
                   13046: <tr>
1.313     leot     13047: <td>SUBST_MESSAGE</td>
1.308     leot     13048: <td>SUBST_NOOP_OK</td>
1.269     leot     13049: </tr>
                   13050: <tr>
1.313     leot     13051: <td>SUBST_SED</td>
1.308     leot     13052: <td>SUBST_SHOW_DIFF</td>
1.269     leot     13053: </tr>
                   13054: <tr>
1.313     leot     13055: <td>SUBST_SKIP_TEXT_CHECK</td>
1.308     leot     13056: <td>SUBST_STAGE</td>
1.269     leot     13057: </tr>
                   13058: <tr>
1.313     leot     13059: <td>SUBST_VARS</td>
1.308     leot     13060: <td>SUNWSPROBASE</td>
1.269     leot     13061: </tr>
                   13062: <tr>
1.313     leot     13063: <td>SUSE_PREFER</td>
1.308     leot     13064: <td>SU_CMD</td>
1.292     leot     13065: </tr>
                   13066: <tr>
1.316     cirnatda 13067: <td>SYSCONFBASE</td>
1.313     leot     13068: <td>TBL</td>
1.303     bacon    13069: </tr>
                   13070: <tr>
1.316     cirnatda 13071: <td>TERMCAP_TYPE</td>
1.313     leot     13072: <td>TERMINFO_DEFAULT</td>
1.274     rillig   13073: </tr>
                   13074: <tr>
1.316     cirnatda 13075: <td>TERMINFO_TYPE</td>
1.313     leot     13076: <td>TEST</td>
1.269     leot     13077: </tr>
                   13078: <tr>
1.316     cirnatda 13079: <td>TEST_DEPENDS</td>
1.313     leot     13080: <td>TEST_DIRS</td>
1.269     leot     13081: </tr>
                   13082: <tr>
1.316     cirnatda 13083: <td>TEST_ENV</td>
1.313     leot     13084: <td>TEST_ENV_SHELL</td>
1.269     leot     13085: </tr>
                   13086: <tr>
1.316     cirnatda 13087: <td>TEST_MAKE_CMD</td>
1.313     leot     13088: <td>TEST_MAKE_FLAGS</td>
1.269     leot     13089: </tr>
                   13090: <tr>
1.316     cirnatda 13091: <td>TEST_TARGET</td>
1.313     leot     13092: <td>TEXLIVE_IGNORE_PATTERNS</td>
1.269     leot     13093: </tr>
                   13094: <tr>
1.316     cirnatda 13095: <td>TEXLIVE_REV</td>
1.313     leot     13096: <td>TEXLIVE_UNVERSIONED</td>
1.269     leot     13097: </tr>
                   13098: <tr>
1.316     cirnatda 13099: <td>TEXMFSITE</td>
1.313     leot     13100: <td>TEX_FORMATS</td>
1.269     leot     13101: </tr>
                   13102: <tr>
1.316     cirnatda 13103: <td>TEX_HYPHEN_DAT</td>
1.313     leot     13104: <td>TEX_HYPHEN_DEF</td>
1.269     leot     13105: </tr>
                   13106: <tr>
1.316     cirnatda 13107: <td>TEX_TEXMF_DIRS</td>
1.313     leot     13108: <td>THTTPD_LOG_FACILITY</td>
1.269     leot     13109: </tr>
                   13110: <tr>
1.316     cirnatda 13111: <td>TINYDYN_USER</td>
1.313     leot     13112: <td>TO</td>
1.269     leot     13113: </tr>
                   13114: <tr>
1.316     cirnatda 13115: <td>TOOLS_ALIASES</td>
1.313     leot     13116: <td>TOOLS_ALWAYS_WRAP</td>
1.269     leot     13117: </tr>
                   13118: <tr>
1.316     cirnatda 13119: <td>TOOLS_ARGS</td>
1.313     leot     13120: <td>TOOLS_BROKEN</td>
1.269     leot     13121: </tr>
                   13122: <tr>
1.316     cirnatda 13123: <td>TOOLS_CMD</td>
1.313     leot     13124: <td>TOOLS_CMDLINE_SED</td>
1.269     leot     13125: </tr>
                   13126: <tr>
1.316     cirnatda 13127: <td>TOOLS_CREATE</td>
1.313     leot     13128: <td>TOOLS_DIR</td>
1.269     leot     13129: </tr>
                   13130: <tr>
1.316     cirnatda 13131: <td>TOOLS_FAIL</td>
1.313     leot     13132: <td>TOOLS_GNU_MISSING</td>
1.269     leot     13133: </tr>
                   13134: <tr>
1.316     cirnatda 13135: <td>TOOLS_LDCONFIG</td>
1.313     leot     13136: <td>TOOLS_NOOP</td>
1.269     leot     13137: </tr>
                   13138: <tr>
1.316     cirnatda 13139: <td>TOOLS_PATH</td>
1.313     leot     13140: <td>TOOLS_SCRIPT</td>
1.269     leot     13141: </tr>
                   13142: <tr>
1.316     cirnatda 13143: <td>TOOL_DEPENDS</td>
1.295     rillig   13144: <td>TTF_FONTS_DIR</td>
1.311     leot     13145: </tr>
                   13146: <tr>
1.316     cirnatda 13147: <td>TYPE</td>
1.311     leot     13148: <td>UAC_REQD_EXECS</td>
1.269     leot     13149: </tr>
                   13150: <tr>
1.316     cirnatda 13151: <td>UCSPI_SSL_GROUP</td>
1.311     leot     13152: <td>UCSPI_SSL_USER</td>
1.269     leot     13153: </tr>
                   13154: <tr>
1.316     cirnatda 13155: <td>UNLIMIT_RESOURCES</td>
1.311     leot     13156: <td>UNPRIVILEGED</td>
1.269     leot     13157: </tr>
                   13158: <tr>
1.316     cirnatda 13159: <td>UNPRIVILEGED_GROUP</td>
1.311     leot     13160: <td>UNPRIVILEGED_GROUPS</td>
1.269     leot     13161: </tr>
                   13162: <tr>
1.316     cirnatda 13163: <td>UNPRIVILEGED_USER</td>
1.311     leot     13164: <td>UNWRAP_FILES</td>
1.269     leot     13165: </tr>
                   13166: <tr>
1.316     cirnatda 13167: <td>UNWRAP_PATTERNS</td>
1.311     leot     13168: <td>UPDATE_GEMSPEC</td>
1.269     leot     13169: </tr>
                   13170: <tr>
1.316     cirnatda 13171: <td>UPDATE_TARGET</td>
1.311     leot     13172: <td>URI</td>
1.269     leot     13173: </tr>
                   13174: <tr>
1.316     cirnatda 13175: <td>USERGROUP_PHASE</td>
1.311     leot     13176: <td>USERPPP_GROUP</td>
1.269     leot     13177: </tr>
                   13178: <tr>
1.316     cirnatda 13179: <td>USER_SPECIFIC_PKGS</td>
1.311     leot     13180: <td>USE_ABI_DEPENDS</td>
1.269     leot     13181: </tr>
                   13182: <tr>
1.316     cirnatda 13183: <td>USE_APR</td>
1.311     leot     13184: <td>USE_BSD_MAKEFILE</td>
1.269     leot     13185: </tr>
                   13186: <tr>
1.316     cirnatda 13187: <td>USE_BUILTIN</td>
1.311     leot     13188: <td>USE_CROSS_COMPILE</td>
1.269     leot     13189: </tr>
                   13190: <tr>
1.316     cirnatda 13191: <td>USE_CURSES</td>
1.311     leot     13192: <td>USE_CWRAPPERS</td>
1.269     leot     13193: </tr>
                   13194: <tr>
1.316     cirnatda 13195: <td>USE_DB185</td>
1.311     leot     13196: <td>USE_FEATURES</td>
1.269     leot     13197: </tr>
                   13198: <tr>
1.316     cirnatda 13199: <td>USE_GAMESGROUP</td>
1.311     leot     13200: <td>USE_GCC_RUNTIME</td>
1.269     leot     13201: </tr>
                   13202: <tr>
1.316     cirnatda 13203: <td>USE_IMAKE</td>
1.311     leot     13204: <td>USE_JAVA</td>
1.269     leot     13205: </tr>
                   13206: <tr>
1.316     cirnatda 13207: <td>USE_JAVA2</td>
1.311     leot     13208: <td>USE_LANGUAGES</td>
1.269     leot     13209: </tr>
                   13210: <tr>
1.316     cirnatda 13211: <td>USE_LIBTOOL</td>
1.311     leot     13212: <td>USE_NATIVE_GCC</td>
1.269     leot     13213: </tr>
                   13214: <tr>
1.316     cirnatda 13215: <td>USE_NETBSD_REPO</td>
1.311     leot     13216: <td>USE_PKGSRC_GCC</td>
1.269     leot     13217: </tr>
                   13218: <tr>
1.316     cirnatda 13219: <td>USE_PKGSRC_GCC_RUNTIME</td>
1.311     leot     13220: <td>USE_PKGTASKS</td>
1.269     leot     13221: </tr>
                   13222: <tr>
1.316     cirnatda 13223: <td>USE_PKG_ADMIN_DIGEST</td>
1.311     leot     13224: <td>USE_RUBY_EXTCONF</td>
1.269     leot     13225: </tr>
                   13226: <tr>
1.316     cirnatda 13227: <td>USE_RUBY_INSTALL</td>
1.311     leot     13228: <td>USE_RUBY_SETUP</td>
1.269     leot     13229: </tr>
                   13230: <tr>
1.316     cirnatda 13231: <td>USE_RUBY_SETUP_PKG</td>
1.311     leot     13232: <td>USE_TOOLS</td>
1.269     leot     13233: </tr>
                   13234: <tr>
1.316     cirnatda 13235: <td>UUCP_GROUP</td>
1.311     leot     13236: <td>UUCP_USER</td>
1.269     leot     13237: </tr>
                   13238: <tr>
1.316     cirnatda 13239: <td>VARBASE</td>
1.311     leot     13240: <td>VARNAME</td>
1.269     leot     13241: </tr>
                   13242: <tr>
1.316     cirnatda 13243: <td>VIM_EXTRA_OPTS</td>
1.311     leot     13244: <td>WARNING_MSG</td>
1.269     leot     13245: </tr>
                   13246: <tr>
1.316     cirnatda 13247: <td>WCALC_CGIDIR</td>
1.311     leot     13248: <td>WCALC_CGIPATH</td>
1.269     leot     13249: </tr>
                   13250: <tr>
1.316     cirnatda 13251: <td>WCALC_HTMLDIR</td>
1.311     leot     13252: <td>WCALC_HTMLPATH</td>
1.269     leot     13253: </tr>
                   13254: <tr>
1.316     cirnatda 13255: <td>WDM_MANAGERS</td>
1.311     leot     13256: <td>WRAPPER_CC</td>
1.269     leot     13257: </tr>
                   13258: <tr>
1.316     cirnatda 13259: <td>WRAPPER_REORDER_CMDS</td>
1.311     leot     13260: <td>WRKDIR</td>
1.303     bacon    13261: </tr>
                   13262: <tr>
1.316     cirnatda 13263: <td>WRKDIR_BASENAME</td>
1.311     leot     13264: <td>WRKDIR_LOCKTYPE</td>
1.269     leot     13265: </tr>
                   13266: <tr>
1.316     cirnatda 13267: <td>WRKLOG</td>
1.311     leot     13268: <td>WRKOBJDIR</td>
1.269     leot     13269: </tr>
                   13270: <tr>
1.316     cirnatda 13271: <td>WRKSRC</td>
1.311     leot     13272: <td>X10_PORT</td>
1.269     leot     13273: </tr>
                   13274: <tr>
1.316     cirnatda 13275: <td>X11</td>
1.311     leot     13276: <td>X11BASE</td>
1.269     leot     13277: </tr>
                   13278: <tr>
1.316     cirnatda 13279: <td>X11_PKGSRCDIR</td>
1.311     leot     13280: <td>X11_TYPE</td>
1.269     leot     13281: </tr>
                   13282: <tr>
1.316     cirnatda 13283: <td>X509_CERTIFICATE</td>
1.311     leot     13284: <td>X509_KEY</td>
1.269     leot     13285: </tr>
                   13286: <tr>
1.316     cirnatda 13287: <td>XAW_TYPE</td>
1.311     leot     13288: <td>XLOCK_DEFAULT_MODE</td>
1.269     leot     13289: </tr>
                   13290: <tr>
1.316     cirnatda 13291: <td>XMKMF</td>
1.311     leot     13292: <td>XMKMF_FLAGS</td>
1.274     rillig   13293: </tr>
                   13294: <tr>
1.316     cirnatda 13295: <td>XXX</td>
1.313     leot     13296: <td>YES</td>
1.269     leot     13297: </tr>
                   13298: <tr>
1.316     cirnatda 13299: <td>ZSH_STATIC</td>
1.313     leot     13300: <td>__stdc__</td>
1.316     cirnatda 13301: </tr>
                   13302: <tr>
1.295     rillig   13303: <td>_vargroups</td>
1.316     cirnatda 13304: <td>accept</td>
1.289     leot     13305: </tr>
                   13306: <tr>
1.295     rillig   13307: <td>acquire-localbase-lock</td>
1.316     cirnatda 13308: <td>acquire-lock</td>
1.269     leot     13309: </tr>
                   13310: <tr>
1.295     rillig   13311: <td>add</td>
1.316     cirnatda 13312: <td>administrator</td>
1.269     leot     13313: </tr>
                   13314: <tr>
1.295     rillig   13315: <td>alloca</td>
1.316     cirnatda 13316: <td>alternatives</td>
1.289     leot     13317: </tr>
                   13318: <tr>
1.295     rillig   13319: <td>aslr</td>
1.316     cirnatda 13320: <td>asprintf</td>
1.269     leot     13321: </tr>
                   13322: <tr>
1.295     rillig   13323: <td>atlas</td>
1.316     cirnatda 13324: <td>autoconf</td>
1.269     leot     13325: </tr>
                   13326: <tr>
1.295     rillig   13327: <td>automake</td>
1.316     cirnatda 13328: <td>autoreconf</td>
1.269     leot     13329: </tr>
                   13330: <tr>
1.295     rillig   13331: <td>awk</td>
1.316     cirnatda 13332: <td>bash</td>
1.271     brook    13333: </tr>
                   13334: <tr>
1.295     rillig   13335: <td>big-endian</td>
1.316     cirnatda 13336: <td>bin-install</td>
1.269     leot     13337: </tr>
                   13338: <tr>
1.295     rillig   13339: <td>bind</td>
1.316     cirnatda 13340: <td>binpkg-list</td>
1.292     leot     13341: </tr>
                   13342: <tr>
1.295     rillig   13343: <td>blas</td>
1.316     cirnatda 13344: <td>bootstrap-depends</td>
1.274     rillig   13345: </tr>
                   13346: <tr>
1.295     rillig   13347: <td>broken</td>
1.316     cirnatda 13348: <td>broken_on_platform</td>
1.269     leot     13349: </tr>
                   13350: <tr>
1.295     rillig   13351: <td>bsd</td>
1.316     cirnatda 13352: <td>bsd.prog.mk</td>
1.289     leot     13353: </tr>
                   13354: <tr>
1.295     rillig   13355: <td>build</td>
1.316     cirnatda 13356: <td>build-env</td>
1.269     leot     13357: </tr>
                   13358: <tr>
1.295     rillig   13359: <td>buildlink-directories</td>
1.316     cirnatda 13360: <td>buildlink-oss-soundcard-h</td>
1.269     leot     13361: </tr>
                   13362: <tr>
1.295     rillig   13363: <td>c</td>
1.316     cirnatda 13364: <td>c++</td>
1.269     leot     13365: </tr>
                   13366: <tr>
1.295     rillig   13367: <td>ccache</td>
1.316     cirnatda 13368: <td>cce</td>
1.269     leot     13369: </tr>
                   13370: <tr>
1.295     rillig   13371: <td>cdefs</td>
1.316     cirnatda 13372: <td>ceil</td>
1.289     leot     13373: </tr>
                   13374: <tr>
1.295     rillig   13375: <td>changes</td>
1.316     cirnatda 13376: <td>changes-entry</td>
1.269     leot     13377: </tr>
                   13378: <tr>
1.295     rillig   13379: <td>changes-entry-noupdate</td>
1.316     cirnatda 13380: <td>check</td>
1.269     leot     13381: </tr>
                   13382: <tr>
1.295     rillig   13383: <td>check-clean</td>
1.316     cirnatda 13384: <td>check-files</td>
1.269     leot     13385: </tr>
                   13386: <tr>
1.295     rillig   13387: <td>check-files-clean</td>
1.316     cirnatda 13388: <td>check-vulnerable</td>
1.269     leot     13389: </tr>
                   13390: <tr>
1.295     rillig   13391: <td>checksum</td>
1.316     cirnatda 13392: <td>checksum-phase</td>
1.269     leot     13393: </tr>
                   13394: <tr>
1.295     rillig   13395: <td>clean</td>
1.316     cirnatda 13396: <td>clean-depends</td>
1.269     leot     13397: </tr>
                   13398: <tr>
1.295     rillig   13399: <td>cleandir</td>
1.316     cirnatda 13400: <td>commit</td>
1.269     leot     13401: </tr>
                   13402: <tr>
1.295     rillig   13403: <td>commit-changes-entry</td>
1.316     cirnatda 13404: <td>compact</td>
1.269     leot     13405: </tr>
                   13406: <tr>
1.295     rillig   13407: <td>compiler</td>
1.316     cirnatda 13408: <td>conf</td>
1.269     leot     13409: </tr>
                   13410: <tr>
1.295     rillig   13411: <td>config.guess</td>
1.316     cirnatda 13412: <td>config.sub</td>
1.269     leot     13413: </tr>
                   13414: <tr>
1.295     rillig   13415: <td>configuration</td>
1.316     cirnatda 13416: <td>configure</td>
1.269     leot     13417: </tr>
                   13418: <tr>
1.295     rillig   13419: <td>configure-env</td>
1.316     cirnatda 13420: <td>configure-help</td>
1.269     leot     13421: </tr>
                   13422: <tr>
1.295     rillig   13423: <td>configure_args</td>
1.316     cirnatda 13424: <td>connect</td>
1.269     leot     13425: </tr>
                   13426: <tr>
1.295     rillig   13427: <td>cos</td>
1.316     cirnatda 13428: <td>cputime</td>
1.289     leot     13429: </tr>
                   13430: <tr>
1.295     rillig   13431: <td>create-usergroup</td>
1.316     cirnatda 13432: <td>csh</td>
1.269     leot     13433: </tr>
                   13434: <tr>
1.295     rillig   13435: <td>ctf</td>
1.316     cirnatda 13436: <td>debug</td>
1.269     leot     13437: </tr>
                   13438: <tr>
1.315     cirnatda 13439: <td>declaration</td>
1.316     cirnatda 13440: <td>declare</td>
1.311     leot     13441: </tr>
                   13442: <tr>
1.315     cirnatda 13443: <td>defined</td>
1.316     cirnatda 13444: <td>depend</td>
1.269     leot     13445: </tr>
                   13446: <tr>
1.315     cirnatda 13447: <td>dependencies</td>
1.316     cirnatda 13448: <td>depends</td>
1.269     leot     13449: </tr>
                   13450: <tr>
1.315     cirnatda 13451: <td>depends-checksum</td>
1.316     cirnatda 13452: <td>depends-fetch</td>
1.269     leot     13453: </tr>
                   13454: <tr>
1.315     cirnatda 13455: <td>deps</td>
1.316     cirnatda 13456: <td>describe</td>
1.269     leot     13457: </tr>
                   13458: <tr>
1.315     cirnatda 13459: <td>destdir</td>
1.316     cirnatda 13460: <td>disable</td>
1.269     leot     13461: </tr>
                   13462: <tr>
1.315     cirnatda 13463: <td>distclean</td>
1.316     cirnatda 13464: <td>distinfo</td>
1.269     leot     13465: </tr>
                   13466: <tr>
1.315     cirnatda 13467: <td>dl</td>
1.316     cirnatda 13468: <td>dlopen</td>
1.277     rillig   13469: </tr>
                   13470: <tr>
1.315     cirnatda 13471: <td>do-build</td>
1.316     cirnatda 13472: <td>do-buildlink</td>
1.269     leot     13473: </tr>
                   13474: <tr>
1.315     cirnatda 13475: <td>do-clean</td>
1.316     cirnatda 13476: <td>do-configure</td>
1.269     leot     13477: </tr>
                   13478: <tr>
1.315     cirnatda 13479: <td>do-configure-post-hook</td>
1.316     cirnatda 13480: <td>do-extract</td>
1.269     leot     13481: </tr>
                   13482: <tr>
1.313     leot     13483: <td>do-fetch</td>
1.316     cirnatda 13484: <td>emul</td>
1.289     leot     13485: </tr>
                   13486: <tr>
1.295     rillig   13487: <td>emul-distinfo</td>
1.316     cirnatda 13488: <td>emul-fetch</td>
1.269     leot     13489: </tr>
                   13490: <tr>
1.295     rillig   13491: <td>emulation</td>
1.316     cirnatda 13492: <td>emulator</td>
1.274     rillig   13493: </tr>
                   13494: <tr>
1.295     rillig   13495: <td>enable</td>
1.316     cirnatda 13496: <td>endian</td>
1.269     leot     13497: </tr>
                   13498: <tr>
1.315     cirnatda 13499: <td>enomem</td>
1.316     cirnatda 13500: <td>err</td>
1.311     leot     13501: </tr>
                   13502: <tr>
1.315     cirnatda 13503: <td>errx</td>
1.316     cirnatda 13504: <td>etc</td>
1.269     leot     13505: </tr>
                   13506: <tr>
1.315     cirnatda 13507: <td>exp</td>
1.316     cirnatda 13508: <td>extract-rpm</td>
1.269     leot     13509: </tr>
                   13510: <tr>
1.315     cirnatda 13511: <td>fabs</td>
1.316     cirnatda 13512: <td>feature</td>
1.289     leot     13513: </tr>
                   13514: <tr>
1.315     cirnatda 13515: <td>features</td>
1.316     cirnatda 13516: <td>fetch</td>
1.269     leot     13517: </tr>
                   13518: <tr>
1.315     cirnatda 13519: <td>fetch-list</td>
1.316     cirnatda 13520: <td>follows</td>
1.269     leot     13521: </tr>
                   13522: <tr>
1.315     cirnatda 13523: <td>forbids</td>
1.316     cirnatda 13524: <td>form</td>
1.269     leot     13525: </tr>
                   13526: <tr>
1.315     cirnatda 13527: <td>format</td>
1.316     cirnatda 13528: <td>fortify</td>
1.269     leot     13529: </tr>
                   13530: <tr>
1.313     leot     13531: <td>fortify_source</td>
1.316     cirnatda 13532: <td>friend</td>
1.269     leot     13533: </tr>
                   13534: <tr>
1.295     rillig   13535: <td>fts</td>
1.316     cirnatda 13536: <td>fts_close</td>
1.269     leot     13537: </tr>
                   13538: <tr>
1.295     rillig   13539: <td>fts_open</td>
1.316     cirnatda 13540: <td>fts_read</td>
1.269     leot     13541: </tr>
                   13542: <tr>
1.295     rillig   13543: <td>fts_set</td>
1.316     cirnatda 13544: <td>gcc</td>
1.289     leot     13545: </tr>
                   13546: <tr>
1.295     rillig   13547: <td>gethostbyaddr</td>
1.316     cirnatda 13548: <td>gethostbyname</td>
1.269     leot     13549: </tr>
                   13550: <tr>
1.295     rillig   13551: <td>gethostbyname2</td>
1.316     cirnatda 13552: <td>getopt_long</td>
1.269     leot     13553: </tr>
                   13554: <tr>
1.295     rillig   13555: <td>getprogname</td>
1.316     cirnatda 13556: <td>getservbyname</td>
1.289     leot     13557: </tr>
                   13558: <tr>
1.295     rillig   13559: <td>getservbyport</td>
1.316     cirnatda 13560: <td>getservent</td>
1.289     leot     13561: </tr>
                   13562: <tr>
1.295     rillig   13563: <td>gettext</td>
1.316     cirnatda 13564: <td>github</td>
1.269     leot     13565: </tr>
                   13566: <tr>
1.295     rillig   13567: <td>glob</td>
1.316     cirnatda 13568: <td>gnu</td>
1.274     rillig   13569: </tr>
                   13570: <tr>
1.295     rillig   13571: <td>gnu_configure_strict</td>
1.316     cirnatda 13572: <td>go</td>
1.269     leot     13573: </tr>
                   13574: <tr>
1.295     rillig   13575: <td>go-deps</td>
1.316     cirnatda 13576: <td>golang</td>
1.269     leot     13577: </tr>
                   13578: <tr>
1.295     rillig   13579: <td>guess-license</td>
1.316     cirnatda 13580: <td>hashbang</td>
1.269     leot     13581: </tr>
                   13582: <tr>
1.295     rillig   13583: <td>heimdal</td>
1.316     cirnatda 13584: <td>help</td>
1.269     leot     13585: </tr>
                   13586: <tr>
1.315     cirnatda 13587: <td>imake</td>
1.316     cirnatda 13588: <td>increment</td>
1.311     leot     13589: </tr>
                   13590: <tr>
1.315     cirnatda 13591: <td>inet_aton</td>
1.316     cirnatda 13592: <td>interp</td>
1.269     leot     13593: </tr>
                   13594: <tr>
1.315     cirnatda 13595: <td>interpreter</td>
1.316     cirnatda 13596: <td>intl</td>
1.269     leot     13597: </tr>
                   13598: <tr>
1.315     cirnatda 13599: <td>ip4</td>
1.316     cirnatda 13600: <td>ip6</td>
1.269     leot     13601: </tr>
                   13602: <tr>
1.315     cirnatda 13603: <td>ipv4</td>
1.316     cirnatda 13604: <td>ipv6</td>
1.269     leot     13605: </tr>
                   13606: <tr>
1.315     cirnatda 13607: <td>iso</td>
1.316     cirnatda 13608: <td>kerberos</td>
1.303     bacon    13609: </tr>
                   13610: <tr>
1.315     cirnatda 13611: <td>krb</td>
1.316     cirnatda 13612: <td>krb5</td>
1.303     bacon    13613: </tr>
                   13614: <tr>
1.315     cirnatda 13615: <td>ksh</td>
1.316     cirnatda 13616: <td>lapack</td>
1.269     leot     13617: </tr>
                   13618: <tr>
1.315     cirnatda 13619: <td>latex</td>
1.316     cirnatda 13620: <td>libintl_bindtextdomain</td>
1.292     leot     13621: </tr>
                   13622: <tr>
1.315     cirnatda 13623: <td>libintl_gettext</td>
1.316     cirnatda 13624: <td>libintl_textdomain</td>
1.269     leot     13625: </tr>
                   13626: <tr>
1.315     cirnatda 13627: <td>libnbcompat</td>
1.316     cirnatda 13628: <td>libs</td>
1.289     leot     13629: </tr>
                   13630: <tr>
1.315     cirnatda 13631: <td>libtool</td>
1.316     cirnatda 13632: <td>licence</td>
1.274     rillig   13633: </tr>
                   13634: <tr>
1.315     cirnatda 13635: <td>license</td>
1.316     cirnatda 13636: <td>lintl</td>
1.271     brook    13637: </tr>
                   13638: <tr>
1.315     cirnatda 13639: <td>little-endian</td>
1.316     cirnatda 13640: <td>lock</td>
1.269     leot     13641: </tr>
                   13642: <tr>
1.315     cirnatda 13643: <td>locking</td>
1.316     cirnatda 13644: <td>lvalue</td>
1.269     leot     13645: </tr>
                   13646: <tr>
1.315     cirnatda 13647: <td>make</td>
1.316     cirnatda 13648: <td>makesum</td>
1.269     leot     13649: </tr>
                   13650: <tr>
1.313     leot     13651: <td>memory</td>
1.316     cirnatda 13652: <td>meta</td>
1.269     leot     13653: </tr>
                   13654: <tr>
1.295     rillig   13655: <td>meta-package</td>
1.316     cirnatda 13656: <td>meta_package</td>
1.269     leot     13657: </tr>
                   13658: <tr>
1.295     rillig   13659: <td>mit-krb5</td>
1.316     cirnatda 13660: <td>mk.conf</td>
1.292     leot     13661: </tr>
                   13662: <tr>
1.295     rillig   13663: <td>mkl</td>
1.316     cirnatda 13664: <td>mount</td>
1.274     rillig   13665: </tr>
                   13666: <tr>
1.295     rillig   13667: <td>mprotect</td>
1.316     cirnatda 13668: <td>mremap</td>
1.269     leot     13669: </tr>
                   13670: <tr>
1.295     rillig   13671: <td>nb</td>
1.316     cirnatda 13672: <td>nbcompat</td>
1.269     leot     13673: </tr>
                   13674: <tr>
1.295     rillig   13675: <td>obstack</td>
1.316     cirnatda 13676: <td>obstack_ptr_grow</td>
1.269     leot     13677: </tr>
                   13678: <tr>
1.295     rillig   13679: <td>occurs</td>
1.316     cirnatda 13680: <td>only</td>
1.269     leot     13681: </tr>
                   13682: <tr>
1.295     rillig   13683: <td>openblas</td>
1.316     cirnatda 13684: <td>options</td>
1.269     leot     13685: </tr>
                   13686: <tr>
1.295     rillig   13687: <td>options.mk</td>
1.316     cirnatda 13688: <td>order</td>
1.271     brook    13689: </tr>
                   13690: <tr>
1.295     rillig   13691: <td>override</td>
1.316     cirnatda 13692: <td>override-intltool</td>
1.269     leot     13693: </tr>
                   13694: <tr>
1.295     rillig   13695: <td>override-message-intltool</td>
1.316     cirnatda 13696: <td>package</td>
1.269     leot     13697: </tr>
                   13698: <tr>
1.295     rillig   13699: <td>parallel</td>
1.316     cirnatda 13700: <td>path</td>
1.269     leot     13701: </tr>
                   13702: <tr>
1.295     rillig   13703: <td>pax</td>
1.316     cirnatda 13704: <td>paxctl</td>
1.269     leot     13705: </tr>
                   13706: <tr>
1.295     rillig   13707: <td>pbulk-index</td>
1.316     cirnatda 13708: <td>pc</td>
1.269     leot     13709: </tr>
                   13710: <tr>
1.295     rillig   13711: <td>perl</td>
1.316     cirnatda 13712: <td>perl5</td>
1.269     leot     13713: </tr>
                   13714: <tr>
1.295     rillig   13715: <td>perms</td>
1.316     cirnatda 13716: <td>php</td>
1.269     leot     13717: </tr>
                   13718: <tr>
1.295     rillig   13719: <td>pkg-build-options</td>
1.316     cirnatda 13720: <td>pkg-config</td>
1.269     leot     13721: </tr>
                   13722: <tr>
1.295     rillig   13723: <td>pkg_build_options</td>
1.316     cirnatda 13724: <td>platform</td>
1.269     leot     13725: </tr>
                   13726: <tr>
1.295     rillig   13727: <td>plist</td>
1.316     cirnatda 13728: <td>post-extract</td>
1.269     leot     13729: </tr>
                   13730: <tr>
1.295     rillig   13731: <td>post-fetch</td>
1.316     cirnatda 13732: <td>post-wrapper</td>
1.269     leot     13733: </tr>
                   13734: <tr>
1.295     rillig   13735: <td>pre-build-checks-hook</td>
1.316     cirnatda 13736: <td>pre-configure</td>
1.289     leot     13737: </tr>
                   13738: <tr>
1.295     rillig   13739: <td>pre-configure-checks-hook</td>
1.316     cirnatda 13740: <td>pre-extract</td>
1.269     leot     13741: </tr>
                   13742: <tr>
1.295     rillig   13743: <td>pre-fetch</td>
1.316     cirnatda 13744: <td>print-go-deps</td>
1.269     leot     13745: </tr>
                   13746: <tr>
1.295     rillig   13747: <td>print-plist</td>
1.316     cirnatda 13748: <td>print-summary-data</td>
1.269     leot     13749: </tr>
                   13750: <tr>
1.295     rillig   13751: <td>privileged-install-hook</td>
1.316     cirnatda 13752: <td>pypi</td>
1.269     leot     13753: </tr>
                   13754: <tr>
1.295     rillig   13755: <td>python</td>
1.316     cirnatda 13756: <td>readme-all</td>
1.269     leot     13757: </tr>
                   13758: <tr>
1.295     rillig   13759: <td>recv</td>
1.316     cirnatda 13760: <td>recvfrom</td>
1.289     leot     13761: </tr>
                   13762: <tr>
1.295     rillig   13763: <td>regcomp</td>
1.316     cirnatda 13764: <td>release-localbase-lock</td>
1.289     leot     13765: </tr>
                   13766: <tr>
1.295     rillig   13767: <td>release-lock</td>
1.316     cirnatda 13768: <td>relro</td>
1.269     leot     13769: </tr>
                   13770: <tr>
1.295     rillig   13771: <td>rename</td>
1.316     cirnatda 13772: <td>reorder</td>
1.269     leot     13773: </tr>
                   13774: <tr>
1.295     rillig   13775: <td>replace</td>
1.316     cirnatda 13776: <td>replace_interpreter</td>
1.269     leot     13777: </tr>
                   13778: <tr>
1.295     rillig   13779: <td>reproducible</td>
1.316     cirnatda 13780: <td>resolv</td>
1.269     leot     13781: </tr>
                   13782: <tr>
1.295     rillig   13783: <td>root</td>
1.316     cirnatda 13784: <td>ruby</td>
1.289     leot     13785: </tr>
                   13786: <tr>
1.295     rillig   13787: <td>send</td>
1.316     cirnatda 13788: <td>sendfile</td>
1.269     leot     13789: </tr>
                   13790: <tr>
1.295     rillig   13791: <td>sendto</td>
1.316     cirnatda 13792: <td>setenv</td>
1.269     leot     13793: </tr>
                   13794: <tr>
1.295     rillig   13795: <td>setgid</td>
1.316     cirnatda 13796: <td>setprogname</td>
1.269     leot     13797: </tr>
                   13798: <tr>
1.295     rillig   13799: <td>setuid</td>
1.316     cirnatda 13800: <td>sh</td>
1.269     leot     13801: </tr>
                   13802: <tr>
1.296     rillig   13803: <td>shebang</td>
1.316     cirnatda 13804: <td>show</td>
1.296     rillig   13805: </tr>
                   13806: <tr>
1.273     brook    13807: <td>show-all</td>
1.316     cirnatda 13808: <td>show-build-defs</td>
1.269     leot     13809: </tr>
                   13810: <tr>
1.273     brook    13811: <td>show-depends</td>
1.316     cirnatda 13812: <td>show-deps</td>
1.269     leot     13813: </tr>
                   13814: <tr>
1.273     brook    13815: <td>show-distfiles</td>
1.316     cirnatda 13816: <td>show-downlevel</td>
1.269     leot     13817: </tr>
                   13818: <tr>
1.273     brook    13819: <td>show-subdir-var</td>
1.316     cirnatda 13820: <td>show-tools</td>
1.269     leot     13821: </tr>
                   13822: <tr>
1.273     brook    13823: <td>show-var</td>
1.316     cirnatda 13824: <td>show-vars</td>
1.269     leot     13825: </tr>
                   13826: <tr>
1.273     brook    13827: <td>snprintf</td>
1.316     cirnatda 13828: <td>socket</td>
1.289     leot     13829: </tr>
                   13830: <tr>
1.285     rillig   13831: <td>ssp</td>
1.316     cirnatda 13832: <td>st_mode</td>
1.269     leot     13833: </tr>
                   13834: <tr>
1.285     rillig   13835: <td>stage-install</td>
1.316     cirnatda 13836: <td>strcasestr</td>
1.269     leot     13837: </tr>
                   13838: <tr>
1.277     rillig   13839: <td>strict</td>
1.316     cirnatda 13840: <td>strip</td>
1.277     rillig   13841: </tr>
                   13842: <tr>
1.289     leot     13843: <td>strndup</td>
1.316     cirnatda 13844: <td>strnlen</td>
1.269     leot     13845: </tr>
                   13846: <tr>
1.289     leot     13847: <td>strsep</td>
1.316     cirnatda 13848: <td>subst</td>
1.289     leot     13849: </tr>
                   13850: <tr>
                   13851: <td>substitutions</td>
1.316     cirnatda 13852: <td>sun</td>
1.292     leot     13853: </tr>
                   13854: <tr>
1.315     cirnatda 13855: <td>sunpro</td>
1.316     cirnatda 13856: <td>sunwspro</td>
1.311     leot     13857: </tr>
                   13858: <tr>
1.276     leot     13859: <td>symlink</td>
1.316     cirnatda 13860: <td>test</td>
1.269     leot     13861: </tr>
                   13862: <tr>
1.289     leot     13863: <td>test-env</td>
1.316     cirnatda 13864: <td>tex</td>
1.269     leot     13865: </tr>
                   13866: <tr>
1.289     leot     13867: <td>texlive</td>
1.316     cirnatda 13868: <td>tmp</td>
1.269     leot     13869: </tr>
                   13870: <tr>
1.289     leot     13871: <td>tool</td>
1.316     cirnatda 13872: <td>tools</td>
1.269     leot     13873: </tr>
                   13874: <tr>
1.289     leot     13875: <td>tools-libtool-m4-override</td>
1.316     cirnatda 13876: <td>type</td>
1.269     leot     13877: </tr>
                   13878: <tr>
1.289     leot     13879: <td>ulimit</td>
1.316     cirnatda 13880: <td>undefined</td>
1.269     leot     13881: </tr>
                   13882: <tr>
1.289     leot     13883: <td>undo-replace</td>
1.316     cirnatda 13884: <td>unlimit</td>
1.269     leot     13885: </tr>
                   13886: <tr>
1.289     leot     13887: <td>unprivileged</td>
1.316     cirnatda 13888: <td>unprivileged-install-hook</td>
1.269     leot     13889: </tr>
                   13890: <tr>
1.289     leot     13891: <td>unstripped</td>
1.316     cirnatda 13892: <td>update</td>
1.269     leot     13893: </tr>
                   13894: <tr>
1.289     leot     13895: <td>upload</td>
1.316     cirnatda 13896: <td>upload-distfiles</td>
1.269     leot     13897: </tr>
                   13898: <tr>
1.270     leot     13899: <td>use_tools</td>
1.316     cirnatda 13900: <td>user</td>
1.269     leot     13901: </tr>
                   13902: <tr>
1.270     leot     13903: <td>utimes</td>
1.316     cirnatda 13904: <td>vasprintf</td>
1.269     leot     13905: </tr>
                   13906: <tr>
1.270     leot     13907: <td>verbose</td>
1.316     cirnatda 13908: <td>vsnprintf</td>
1.269     leot     13909: </tr>
                   13910: <tr>
1.270     leot     13911: <td>warn</td>
1.316     cirnatda 13912: <td>warning</td>
1.269     leot     13913: </tr>
                   13914: <tr>
1.270     leot     13915: <td>warnings</td>
1.316     cirnatda 13916: <td>warnx</td>
1.269     leot     13917: </tr>
                   13918: <tr>
1.289     leot     13919: <td>wattr_off</td>
1.316     cirnatda 13920: <td>wattr_on</td>
1.269     leot     13921: </tr>
                   13922: <tr>
1.289     leot     13923: <td>work</td>
1.316     cirnatda 13924: <td>wrapper</td>
1.269     leot     13925: </tr>
                   13926: <tr>
1.289     leot     13927: <td>wrkdir</td>
1.316     cirnatda 13928: <td> </td>
1.269     leot     13929: </tr>
                   13930: </table>
1.267     rillig   13931: </div>
                   13932: <div class="appendix">
                   13933: <div class="titlepage"><div><div><h1 class="title">
                   13934: <a name="editing"></a>Appendix E. Editing guidelines for the pkgsrc guide</h1></div></div></div>
1.75      rillig   13935: <div class="toc">
                   13936: <p><b>Table of Contents</b></p>
1.210     leot     13937: <dl class="toc">
1.267     rillig   13938: <dt><span class="sect1"><a href="#targets">E.1. Make targets</a></span></dt>
                   13939: <dt><span class="sect1"><a href="#procedure">E.2. Procedure</a></span></dt>
1.75      rillig   13940: </dl>
                   13941: </div>
1.79      rillig   13942: <p>This section contains information on editing the pkgsrc
                   13943:        guide itself.</p>
1.148     asau     13944: <div class="sect1">
1.75      rillig   13945: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   13946: <a name="targets"></a>E.1. Make targets</h2></div></div></div>
1.79      rillig   13947: <p>The pkgsrc guide's source code is stored in
                   13948:        <code class="filename">pkgsrc/doc/guide/files</code>, and several files
                   13949:        are created from it:</p>
1.148     asau     13950: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      13951: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
                   13952: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
1.289     leot     13953: <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>
                   13954: <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   13955:        The PDF version of the pkgsrc guide.</p></li>
1.289     leot     13956: <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   13957:        PostScript version of the pkgsrc guide.</p></li>
1.75      rillig   13958: </ul></div>
                   13959: </div>
1.148     asau     13960: <div class="sect1">
1.75      rillig   13961: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   13962: <a name="procedure"></a>E.2. Procedure</h2></div></div></div>
1.79      rillig   13963: <p>The procedure to edit the pkgsrc guide is:</p>
1.128     wiz      13964: <div class="procedure"><ol class="procedure" type="1">
1.304     bacon    13965: <li class="step"><p>Make sure you have checked out the htdocs repository
                   13966:        into a sibling directory of your pkgsrc directory.  You will need
                   13967:        the ability to commit from both pkgsrc and htdocs.</p></li>
1.148     asau     13968: <li class="step"><p>Make sure you have the packages needed to
1.83      wiz      13969:        regenerate the pkgsrc guide (and other XML-based NetBSD
1.151     obache   13970:        documentation) installed. These are automatically installed when
1.250     leot     13971:        you install the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/pkgsrc-guide-tools/README.html" target="_top"><code class="filename">meta-pkgs/pkgsrc-guide-tools</code></a> package.</p></li>
1.148     asau     13972: <li class="step"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.79      rillig   13973:        right directory. All further steps will take place
                   13974:        here.</p></li>
1.148     asau     13975: <li class="step"><p>Edit the XML file(s) in
1.79      rillig   13976:        <code class="filename">files/</code>.</p></li>
1.148     asau     13977: <li class="step"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.79      rillig   13978:        guide for valid XML and to build the final output files. If you
                   13979:        get any errors at this stage, you can just edit the files, as
                   13980:        there are only symbolic links in the working directory, pointing
                   13981:        to the files in <code class="filename">files/</code>.</p></li>
1.148     asau     13982: <li class="step"><p><span class="command"><strong>(cd files &amp;&amp; cvs
1.79      rillig   13983:        commit)</strong></span></p></li>
1.148     asau     13984: <li class="step"><p>Run <span class="command"><strong>bmake clean &amp;&amp; bmake</strong></span> to
1.79      rillig   13985:        regenerate the output files with the proper RCS
                   13986:        Ids.</p></li>
1.148     asau     13987: <li class="step">
1.110     hubertf  13988: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.91      rillig   13989:        commit the files in both <code class="filename">pkgsrc/doc</code> and
                   13990:        <code class="filename">htdocs</code>.</p>
1.148     asau     13991: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.91      rillig   13992: <h3 class="title">Note</h3>
                   13993: <p>If you have added, removed or renamed some chapters,
1.110     hubertf  13994:        you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
                   13995:        <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.91      rillig   13996:        directory.</p>
                   13997: </div>
                   13998: </li>
1.79      rillig   13999: </ol></div>
1.75      rillig   14000: </div>
                   14001: </div>
                   14002: </div></body>
1.1       grant    14003: </html>

CVSweb <webmaster@jp.NetBSD.org>