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

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.281     leot       33: <div><p class="copyright">Copyright © 1994-2020 The NetBSD Foundation, Inc</p></div>
1.299     rillig     34: <div><p class="pubdate">$NetBSD: pkgsrc.xml,v 1.38 2020/06/20 05:31:10 rillig 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>
                     88: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.3. Deinstalling packages</a></span></dt>
                     89: <dt><span class="sect2"><a href="#using.pkg_info">5.1.4. Getting information about installed packages</a></span></dt>
                     90: <dt><span class="sect2"><a href="#vulnerabilities">5.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                     91: <dt><span class="sect2"><a href="#pkg_versions">5.1.6. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
                     92: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.7. Other administrative functions</a></span></dt>
1.75      rillig     93: </dl></dd>
1.267     rillig     94: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1.75      rillig     95: <dd><dl>
1.267     rillig     96: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
                     97: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
                     98: <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     99: </dl></dd>
                    100: </dl></dd>
1.267     rillig    101: <dt><span class="chapter"><a href="#configuring">6. Configuring pkgsrc</a></span></dt>
1.75      rillig    102: <dd><dl>
1.267     rillig    103: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
                    104: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
                    105: <dt><span class="sect1"><a href="#variables-affecting-installation">6.3. Variables affecting the installation process</a></span></dt>
                    106: <dt><span class="sect1"><a href="#conf.compiler">6.4. Selecting and configuring the compiler</a></span></dt>
1.88      wiz       107: <dd><dl>
1.267     rillig    108: <dt><span class="sect2"><a href="#selecting-the-compiler">6.4.1. Selecting the compiler</a></span></dt>
                    109: <dt><span class="sect2"><a href="#conf.cflags">6.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                    110: <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       111: </dl></dd>
1.267     rillig    112: <dt><span class="sect1"><a href="#developer-advanced-settings">6.5. Developer/advanced settings</a></span></dt>
                    113: <dt><span class="sect1"><a href="#selecting-build-options">6.6. Selecting Build Options</a></span></dt>
1.75      rillig    114: </dl></dd>
1.267     rillig    115: <dt><span class="chapter"><a href="#binary">7. Creating binary packages</a></span></dt>
1.75      rillig    116: <dd><dl>
1.267     rillig    117: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
                    118: <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    119: </dl></dd>
1.267     rillig    120: <dt><span class="chapter"><a href="#bulk">8. Creating binary packages for everything in pkgsrc (bulk
1.106     rillig    121: builds)</a></span></dt>
1.75      rillig    122: <dd><dl>
1.267     rillig    123: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
1.295     rillig    124: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a bulk build</a></span></dt>
1.267     rillig    125: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
                    126: <dt><span class="sect1"><a href="#bulk.req">8.3. Requirements of a full bulk build</a></span></dt>
1.293     rillig    127: <dt><span class="sect1"><a href="#bulk.var">8.4. Bulk build variants</a></span></dt>
                    128: <dd><dl>
1.294     rillig    129: <dt><span class="sect2"><a href="#bulk.var.confopt">8.4.1. Detect unknown configure options</a></span></dt>
                    130: <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    131: <dt><span class="sect2"><a href="#bulk.var.builderr">8.4.3. Force compiler options only in the build phase</a></span></dt>
                    132: <dt><span class="sect2"><a href="#bulk.var.dirs">8.4.4. Use custom directories</a></span></dt>
                    133: <dt><span class="sect2"><a href="#bulk.var.warn">8.4.5. Turn warnings into errors</a></span></dt>
                    134: <dt><span class="sect2"><a href="#bulk.var.pkglint">8.4.6. Reject packages for which pkglint reports errors</a></span></dt>
                    135: <dt><span class="sect2"><a href="#bulk.var.strings">8.4.7. Reject packages that contain forbidden strings</a></span></dt>
                    136: <dt><span class="sect2"><a href="#bulk.var.test">8.4.8. Reject packages whose self-test fails</a></span></dt>
                    137: <dt><span class="sect2"><a href="#bulk.var.shvar">8.4.9. Reject packages that use undefined shell variables</a></span></dt>
                    138: <dt><span class="sect2"><a href="#bulk.var.quiet">8.4.10. Turn off verbose logging</a></span></dt>
1.293     rillig    139: </dl></dd>
                    140: <dt><span class="sect1"><a href="#creating-cdroms">8.5. Creating a multiple CD-ROM packages collection</a></span></dt>
                    141: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.5.1. Example of cdpack</a></span></dt></dl></dd>
1.267     rillig    142: </dl></dd>
                    143: <dt><span class="chapter"><a href="#files">9. Directory layout of the installed files</a></span></dt>
                    144: <dd><dl>
                    145: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
                    146: <dt><span class="sect1"><a href="#files.varbase">9.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
                    147: </dl></dd>
                    148: <dt><span class="chapter"><a href="#faq">10. Frequently Asked Questions</a></span></dt>
                    149: <dd><dl>
                    150: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                    151: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
                    152: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
                    153: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
                    154: <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>
                    155: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
                    156: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
                    157: <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>
                    158: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
                    159: <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       160: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</a></span></dt>
1.267     rillig    161: <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>
                    162: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' with pkgsrc</a></span></dt>
                    163: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
                    164: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
                    165: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
                    166: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build.  What shall I do?</a></span></dt>
                    167: <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    168: </dl></dd>
                    169: </dl></dd>
                    170: <dt><span class="part"><a href="#developers-guide">II. The pkgsrc developer's guide</a></span></dt>
                    171: <dd><dl>
1.267     rillig    172: <dt><span class="chapter"><a href="#help-devel">11. Getting help</a></span></dt>
1.299     rillig    173: <dt><span class="chapter"><a href="#components">12. Package components - files, directories and contents</a></span></dt>
1.91      rillig    174: <dd><dl>
1.299     rillig    175: <dt><span class="sect1"><a href="#components.Makefile">12.1. <code class="filename">Makefile</code></a></span></dt>
                    176: <dt><span class="sect1"><a href="#components.distinfo">12.2. <code class="filename">distinfo</code></a></span></dt>
                    177: <dt><span class="sect1"><a href="#components.patches">12.3. <code class="filename">patches/*</code></a></span></dt>
1.91      rillig    178: <dd><dl>
1.299     rillig    179: <dt><span class="sect2"><a href="#components.patch.structure">12.3.1. Structure of a single patch file</a></span></dt>
                    180: <dt><span class="sect2"><a href="#components.patches.caveats">12.3.2. Creating patch files</a></span></dt>
                    181: <dt><span class="sect2"><a href="#components.patches.sources">12.3.3. Sources where the patch files come from</a></span></dt>
                    182: <dt><span class="sect2"><a href="#components.patches.guidelines">12.3.4. Patching guidelines</a></span></dt>
                    183: <dt><span class="sect2"><a href="#components.patches.feedback">12.3.5. Feedback to the author</a></span></dt>
1.91      rillig    184: </dl></dd>
1.299     rillig    185: <dt><span class="sect1"><a href="#other-mandatory-files">12.4. Other mandatory files</a></span></dt>
                    186: <dt><span class="sect1"><a href="#components.optional">12.5. Optional files</a></span></dt>
                    187: <dd><dl>
                    188: <dt><span class="sect2"><a href="#components.optional.bin">12.5.1. Files affecting the binary package</a></span></dt>
                    189: <dt><span class="sect2"><a href="#components.optional.build">12.5.2. Files affecting the build process</a></span></dt>
                    190: <dt><span class="sect2"><a href="#components.optional.none">12.5.3. Files affecting nothing at all</a></span></dt>
                    191: </dl></dd>
                    192: <dt><span class="sect1"><a href="#work-dir">12.6. <code class="filename">work*</code></a></span></dt>
                    193: <dt><span class="sect1"><a href="#files-dir">12.7. <code class="filename">files/*</code></a></span></dt>
1.106     rillig    194: </dl></dd>
1.299     rillig    195: <dt><span class="chapter"><a href="#build">13. The build process</a></span></dt>
1.106     rillig    196: <dd><dl>
1.299     rillig    197: <dt><span class="sect1"><a href="#build.intro">13.1. Introduction</a></span></dt>
                    198: <dt><span class="sect1"><a href="#build.prefix">13.2. Program location</a></span></dt>
                    199: <dt><span class="sect1"><a href="#build.builddirs">13.3. Directories used during the build process</a></span></dt>
                    200: <dt><span class="sect1"><a href="#build.running">13.4. Running a phase</a></span></dt>
                    201: <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    202: <dd><dl>
1.299     rillig    203: <dt><span class="sect2"><a href="#build.fetch.what">13.5.1. What to fetch and where to get it from</a></span></dt>
                    204: <dt><span class="sect2"><a href="#build.fetch.how">13.5.2. How are the files fetched?</a></span></dt>
1.106     rillig    205: </dl></dd>
1.299     rillig    206: <dt><span class="sect1"><a href="#build.checksum">13.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                    207: <dt><span class="sect1"><a href="#build.extract">13.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                    208: <dt><span class="sect1"><a href="#build.patch">13.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                    209: <dt><span class="sect1"><a href="#build.tools">13.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                    210: <dt><span class="sect1"><a href="#build.wrapper">13.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                    211: <dt><span class="sect1"><a href="#build.configure">13.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                    212: <dt><span class="sect1"><a href="#build.build">13.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                    213: <dt><span class="sect1"><a href="#build.test">13.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                    214: <dt><span class="sect1"><a href="#build.install">13.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                    215: <dt><span class="sect1"><a href="#build.package">13.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
                    216: <dt><span class="sect1"><a href="#build.clean">13.16. Cleaning up</a></span></dt>
                    217: <dt><span class="sect1"><a href="#build.helpful-targets">13.17. Other helpful targets</a></span></dt>
                    218: </dl></dd>
                    219: <dt><span class="chapter"><a href="#creating">14. Creating a new pkgsrc package from scratch</a></span></dt>
                    220: <dd><dl>
                    221: <dt><span class="sect1"><a href="#creating.common">14.1. Common types of packages</a></span></dt>
1.106     rillig    222: <dd><dl>
1.299     rillig    223: <dt><span class="sect2"><a href="#creating.perl-module">14.1.1. Perl modules</a></span></dt>
                    224: <dt><span class="sect2"><a href="#creating.python-module">14.1.2. Python modules and programs</a></span></dt>
                    225: <dt><span class="sect2"><a href="#creating.R-package">14.1.3. R packages</a></span></dt>
                    226: <dt><span class="sect2"><a href="#creating.TeX-package">14.1.4. TeXlive packages</a></span></dt>
1.106     rillig    227: </dl></dd>
1.299     rillig    228: <dt><span class="sect1"><a href="#creating.examples">14.2. Examples</a></span></dt>
                    229: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">14.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
1.106     rillig    230: </dl></dd>
1.299     rillig    231: <dt><span class="chapter"><a href="#makefile">15. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.106     rillig    232: <dd><dl>
1.299     rillig    233: <dt><span class="sect1"><a href="#makefile.style">15.1. Caveats</a></span></dt>
                    234: <dt><span class="sect1"><a href="#makefile.variables">15.2. <code class="filename">Makefile</code> variables</a></span></dt>
                    235: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">15.2.1. Naming conventions</a></span></dt></dl></dd>
                    236: <dt><span class="sect1"><a href="#makefile.code">15.3. Code snippets</a></span></dt>
1.106     rillig    237: <dd><dl>
1.299     rillig    238: <dt><span class="sect2"><a href="#adding-to-list">15.3.1. Adding things to a list</a></span></dt>
                    239: <dt><span class="sect2"><a href="#echo-literal">15.3.2. Echoing a string exactly as-is</a></span></dt>
                    240: <dt><span class="sect2"><a href="#cflags-gnu-configure">15.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</a></span></dt>
                    241: <dt><span class="sect2"><a href="#empty-variables">15.3.4. Handling possibly empty variables</a></span></dt>
1.106     rillig    242: </dl></dd>
                    243: </dl></dd>
1.299     rillig    244: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
1.106     rillig    245: <dd><dl>
1.299     rillig    246: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
                    247: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
                    248: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
                    249: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106     rillig    250: </dl></dd>
1.299     rillig    251: <dt><span class="chapter"><a href="#tools">17. Tools needed for building or running</a></span></dt>
1.106     rillig    252: <dd><dl>
1.299     rillig    253: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
                    254: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
                    255: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
                    256: </dl></dd>
                    257: <dt><span class="chapter"><a href="#buildlink">18. Buildlink methodology</a></span></dt>
                    258: <dd><dl>
                    259: <dt><span class="sect1"><a href="#converting-to-buildlink3">18.1. Converting packages to use buildlink3</a></span></dt>
                    260: <dt><span class="sect1"><a href="#creating-buildlink3.mk">18.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106     rillig    261: <dd><dl>
1.299     rillig    262: <dt><span class="sect2"><a href="#anatomy-of-bl3">18.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
                    263: <dt><span class="sect2"><a href="#updating-buildlink-depends">18.2.2. Updating
1.133     wiz       264:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                    265:       and
                    266:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                    267:       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106     rillig    268: </dl></dd>
1.299     rillig    269: <dt><span class="sect1"><a href="#writing-builtin.mk">18.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
                    270: <dd><dl>
                    271: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">18.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
                    272: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">18.3.2. Global preferences for native or pkgsrc software</a></span></dt>
                    273: </dl></dd>
                    274: </dl></dd>
                    275: <dt><span class="chapter"><a href="#plist">19. PLIST issues</a></span></dt>
1.106     rillig    276: <dd><dl>
1.299     rillig    277: <dt><span class="sect1"><a href="#rcs-id">19.1. RCS ID</a></span></dt>
                    278: <dt><span class="sect1"><a href="#automatic-plist-generation">19.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                    279: <dt><span class="sect1"><a href="#print-PLIST">19.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
                    280: <dt><span class="sect1"><a href="#plist.misc">19.4. Variable substitution in PLIST</a></span></dt>
                    281: <dt><span class="sect1"><a href="#manpage-compression">19.5. Man page compression</a></span></dt>
                    282: <dt><span class="sect1"><a href="#using-PLIST_SRC">19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
                    283: <dt><span class="sect1"><a href="#platform-specific-plist">19.7. Platform-specific and differing PLISTs</a></span></dt>
                    284: <dt><span class="sect1"><a href="#build-plist">19.8. Build-specific PLISTs</a></span></dt>
                    285: <dt><span class="sect1"><a href="#faq.common-dirs">19.9. Sharing directories between packages</a></span></dt>
1.106     rillig    286: </dl></dd>
1.299     rillig    287: <dt><span class="chapter"><a href="#pkginstall">20. The pkginstall framework</a></span></dt>
                    288: <dd><dl>
                    289: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">20.1. Files and directories outside the installation prefix</a></span></dt>
                    290: <dd><dl>
                    291: <dt><span class="sect2"><a href="#dirs-outside-prefix">20.1.1. Directory manipulation</a></span></dt>
                    292: <dt><span class="sect2"><a href="#files-outside-prefix">20.1.2. File manipulation</a></span></dt>
1.106     rillig    293: </dl></dd>
1.299     rillig    294: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
1.106     rillig    295: <dd><dl>
1.299     rillig    296: <dt><span class="sect2"><a href="#conf-files-sysconfdir">20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
                    297: <dt><span class="sect2"><a href="#conf-files-configure">20.2.2. Telling the software where configuration files are</a></span></dt>
                    298: <dt><span class="sect2"><a href="#conf-files-patching">20.2.3. Patching installations</a></span></dt>
                    299: <dt><span class="sect2"><a href="#conf-files-disable">20.2.4. Disabling handling of configuration files</a></span></dt>
                    300: </dl></dd>
                    301: <dt><span class="sect1"><a href="#rcd-scripts">20.3. System startup scripts</a></span></dt>
                    302: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">20.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
                    303: <dt><span class="sect1"><a href="#users-and-groups">20.4. System users and groups</a></span></dt>
                    304: <dt><span class="sect1"><a href="#shells">20.5. System shells</a></span></dt>
                    305: <dd><dl><dt><span class="sect2"><a href="#shells-disable">20.5.1. Disabling shell registration</a></span></dt></dl></dd>
                    306: <dt><span class="sect1"><a href="#fonts">20.6. Fonts</a></span></dt>
                    307: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">20.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
1.267     rillig    308: </dl></dd>
                    309: <dt><span class="chapter"><a href="#fixes">21. Making your package work</a></span></dt>
                    310: <dd><dl>
                    311: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
                    312: <dd><dl>
                    313: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">21.1.1. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
                    314: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
                    315: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
                    316: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
                    317: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
                    318: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
                    319: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
                    320: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
                    321: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
                    322: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
                    323: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                    324: </dl></dd>
                    325: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                    326: <dd><dl>
                    327: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                    328: <dt><span class="sect2"><a href="#modified-distfiles-same-name">21.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
                    329: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
                    330: </dl></dd>
                    331: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                    332: <dd><dl>
                    333: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
                    334: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                    335: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
                    336: </dl></dd>
                    337: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
                    338: <dd><dl>
                    339: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
                    340: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
                    341: <dt><span class="sect2"><a href="#perl-scripts">21.4.3. Packages containing perl scripts</a></span></dt>
                    342: <dt><span class="sect2"><a href="#shell-scripts">21.4.4. Packages containing shell scripts</a></span></dt>
                    343: <dt><span class="sect2"><a href="#other-programming-languages">21.4.5. Other programming languages</a></span></dt>
                    344: </dl></dd>
                    345: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                    346: <dd><dl>
                    347: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
                    348: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.287     rillig    349: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
                    350: <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>
                    351: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.267     rillig    352: </dl></dd>
                    353: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                    354: <dd><dl>
                    355: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
                    356: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
                    357: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
                    358: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
                    359: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
                    360: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing perl modules</a></span></dt>
                    361: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
                    362: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
                    363: <dt><span class="sect2"><a href="#gconf-data-files">21.6.9. Packages installing GConf data files</a></span></dt>
                    364: <dt><span class="sect2"><a href="#scrollkeeper-data-files">21.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
                    365: <dt><span class="sect2"><a href="#x11-fonts">21.6.11. Packages installing X11 fonts</a></span></dt>
                    366: <dt><span class="sect2"><a href="#gtk2-modules">21.6.12. Packages installing GTK2 modules</a></span></dt>
                    367: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.13. Packages installing SGML or XML data</a></span></dt>
                    368: <dt><span class="sect2"><a href="#mime-database">21.6.14. Packages installing extensions to the MIME database</a></span></dt>
                    369: <dt><span class="sect2"><a href="#intltool">21.6.15. Packages using intltool</a></span></dt>
                    370: <dt><span class="sect2"><a href="#startup-scripts">21.6.16. Packages installing startup scripts</a></span></dt>
                    371: <dt><span class="sect2"><a href="#tex-packages">21.6.17. Packages installing TeX modules</a></span></dt>
                    372: <dt><span class="sect2"><a href="#emulation-packages">21.6.18. Packages supporting running binaries in
1.87      wiz       373:     emulation</a></span></dt>
1.267     rillig    374: <dt><span class="sect2"><a href="#hicolor-theme">21.6.19. Packages installing hicolor theme icons</a></span></dt>
                    375: <dt><span class="sect2"><a href="#desktop-files">21.6.20. Packages installing desktop files</a></span></dt>
1.77      rillig    376: </dl></dd>
1.267     rillig    377: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.77      rillig    378: </dl></dd>
1.299     rillig    379: <dt><span class="chapter"><a href="#gnome">22. GNOME packaging and porting</a></span></dt>
                    380: <dd><dl>
                    381: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
                    382: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
                    383: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
                    384: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
                    385: </dl></dd>
1.267     rillig    386: <dt><span class="chapter"><a href="#submit">23. Submitting and Committing</a></span></dt>
1.77      rillig    387: <dd><dl>
1.267     rillig    388: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
                    389: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                    390: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
                    391: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
                    392: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
                    393: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
                    394: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
                    395: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
                    396: </dl></dd>
                    397: <dt><span class="chapter"><a href="#devfaq">24. Frequently Asked Questions</a></span></dt>
1.75      rillig    398: </dl></dd>
                    399: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
                    400: <dd><dl>
1.299     rillig    401: <dt><span class="chapter"><a href="#infr.design">25. Design of the pkgsrc infrastructure</a></span></dt>
1.75      rillig    402: <dd><dl>
1.299     rillig    403: <dt><span class="sect1"><a href="#infr.vardef">25.1. The meaning of variable definitions</a></span></dt>
                    404: <dt><span class="sect1"><a href="#infr.vardef.problems">25.2. Avoiding problems before they arise</a></span></dt>
                    405: <dt><span class="sect1"><a href="#infr.var">25.3. Variable evaluation</a></span></dt>
1.81      rillig    406: <dd><dl>
1.299     rillig    407: <dt><span class="sect2"><a href="#infr.var.load">25.3.1. At load time</a></span></dt>
                    408: <dt><span class="sect2"><a href="#infr.var.run">25.3.2. At runtime</a></span></dt>
1.81      rillig    409: </dl></dd>
1.299     rillig    410: <dt><span class="sect1"><a href="#infr.varspec">25.4. How can variables be specified?</a></span></dt>
                    411: <dt><span class="sect1"><a href="#infr.design.intf">25.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig    412: <dd><dl>
1.299     rillig    413: <dt><span class="sect2"><a href="#infr.design.intf.proc">25.5.1. Procedures with parameters</a></span></dt>
                    414: <dt><span class="sect2"><a href="#infr.design.intf.action">25.5.2. Actions taken on behalf of parameters</a></span></dt>
1.75      rillig    415: </dl></dd>
1.299     rillig    416: <dt><span class="sect1"><a href="#infr.order">25.6. The order in which files are loaded</a></span></dt>
1.75      rillig    417: <dd><dl>
1.299     rillig    418: <dt><span class="sect2"><a href="#infr.order.prefs">25.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
                    419: <dt><span class="sect2"><a href="#infr.order.pkg">25.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.75      rillig    420: </dl></dd>
                    421: </dl></dd>
1.299     rillig    422: <dt><span class="chapter"><a href="#regression">26. Regression tests</a></span></dt>
1.75      rillig    423: <dd><dl>
1.299     rillig    424: <dt><span class="sect1"><a href="#regression.run">26.1. Running the regression tests</a></span></dt>
                    425: <dt><span class="sect1"><a href="#regression.new">26.2. Adding a new regression test</a></span></dt>
1.75      rillig    426: <dd><dl>
1.299     rillig    427: <dt><span class="sect2"><a href="#regression.fun.override">26.2.1. Overridable functions</a></span></dt>
                    428: <dt><span class="sect2"><a href="#regression.fun.helper">26.2.2. Helper functions</a></span></dt>
1.75      rillig    429: </dl></dd>
                    430: </dl></dd>
1.299     rillig    431: <dt><span class="chapter"><a href="#porting">27. Porting pkgsrc</a></span></dt>
                    432: <dd><dl><dt><span class="sect1"><a href="#porting.opsys">27.1. Porting pkgsrc to a new operating system</a></span></dt></dl></dd>
1.75      rillig    433: </dl></dd>
                    434: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
                    435: <dd><dl>
                    436: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
                    437: <dd><dl>
                    438: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
                    439: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
                    440: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.287     rillig    441: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with pkglint</a></span></dt>
1.75      rillig    442: </dl></dd>
                    443: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
                    444: </dl></dd>
                    445: <dt><span class="appendix"><a href="#logs">B. Build logs</a></span></dt>
                    446: <dd><dl>
                    447: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
                    448: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
                    449: </dl></dd>
1.76      rillig    450: <dt><span class="appendix"><a href="#ftp-layout">C. Directory layout of the pkgsrc FTP server</a></span></dt>
                    451: <dd><dl>
1.128     wiz       452: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
                    453: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
                    454: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
                    455: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
                    456: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
1.261     leot      457: <code class="filename">stable</code>,
1.128     wiz       458: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76      rillig    459: source packages</a></span></dt>
                    460: </dl></dd>
1.267     rillig    461: <dt><span class="appendix"><a href="#help-topics">D. Help topics</a></span></dt>
                    462: <dt><span class="appendix"><a href="#editing">E. Editing guidelines for the pkgsrc guide</a></span></dt>
1.75      rillig    463: <dd><dl>
1.267     rillig    464: <dt><span class="sect1"><a href="#targets">E.1. Make targets</a></span></dt>
                    465: <dt><span class="sect1"><a href="#procedure">E.2. Procedure</a></span></dt>
1.75      rillig    466: </dl></dd>
                    467: </dl>
                    468: </div>
1.82      rillig    469: <div class="list-of-tables">
                    470: <p><b>List of Tables</b></p>
                    471: <dl>
                    472: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
                    473: </dt>
1.299     rillig    474: <dt>12.1. <a href="#patch-examples">Patching examples</a>
1.85      jmmv      475: </dt>
1.299     rillig    476: <dt>22.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.85      jmmv      477: </dt>
1.82      rillig    478: </dl>
                    479: </div>
1.148     asau      480: <div class="chapter">
                    481: <div class="titlepage"><div><div><h1 class="title">
                    482: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h1></div></div></div>
1.75      rillig    483: <div class="toc">
                    484: <p><b>Table of Contents</b></p>
1.210     leot      485: <dl class="toc">
1.75      rillig    486: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82      rillig    487: <dd><dl>
                    488: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
                    489: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
                    490: </dl></dd>
1.75      rillig    491: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
                    492: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88      wiz       493: <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    494: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
                    495: </dl>
                    496: </div>
1.148     asau      497: <div class="sect1">
1.75      rillig    498: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    499: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
1.82      rillig    500: <p>There is a lot of software freely available for Unix-based
                    501: systems, which is usually available in form of the source code. Before
                    502: such software can be used, it needs to be configured to the local
                    503: system, compiled and installed, and this is exactly what The NetBSD
                    504: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
                    505: to handle binary packages, so that not every user has to build the
                    506: packages for himself, which is a time-costly task.</p>
1.75      rillig    507: <p>pkgsrc currently contains several thousand packages,
                    508:       including:</p>
1.148     asau      509: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.250     leot      510: <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    511:          web server</p></li>
1.250     leot      512: <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    513:          web browser</p></li>
1.250     leot      514: <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    515:          Desktop Environment</p></li>
1.250     leot      516: <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    517:          Desktop Environment</p></li>
                    518: </ul></div>
1.219     rillig    519: <p>&#8230; just to name a few.</p>
1.75      rillig    520: <p>pkgsrc has built-in support for handling varying dependencies,
                    521:       such as pthreads and X11, and extended features such as IPv6 support on
                    522:       a range of platforms.</p>
1.148     asau      523: <div class="sect2">
1.82      rillig    524: <div class="titlepage"><div><div><h3 class="title">
                    525: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
                    526: <p>
                    527: pkgsrc provides the following key features:
                    528: </p>
1.148     asau      529: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz       530: <li class="listitem"><p>Easy building of software from source as well as the creation
1.82      rillig    531:   and installation of binary packages. The source and latest
                    532:   patches are retrieved from a master or mirror download site, checksum
                    533:   verified, then built on your system. Support for binary-only
                    534:   distributions is available for both native platforms and NetBSD
                    535:   emulated platforms.</p></li>
1.128     wiz       536: <li class="listitem"><p>All packages are installed in a consistent directory tree,
1.82      rillig    537:   including binaries, libraries, man pages and other
                    538:   documentation.</p></li>
1.214     sevan     539: <li class="listitem"><p>Tracking of package dependencies automatically, including when
                    540:   performing updates, to ensure required packages are installed. The
                    541:   configuration files of various packages are handled automatically during
                    542:   updates, so local changes are preserved.</p></li>
1.128     wiz       543: <li class="listitem"><p>Like NetBSD, pkgsrc is designed with portability in mind and
1.82      rillig    544:   consists of highly portable code. This allows the greatest speed of
1.132     spz       545:   development when porting to a new platform. This portability also
1.82      rillig    546:   ensures that pkgsrc is <span class="emphasis"><em>consistent across all
                    547:   platforms</em></span>.</p></li>
1.128     wiz       548: <li class="listitem"><p>The installation prefix, acceptable software licenses,
1.82      rillig    549:   international encryption requirements and build-time options for a
                    550:   large number of packages are all set in a simple, central
                    551:   configuration file.</p></li>
1.128     wiz       552: <li class="listitem"><p>The entire source (not including the distribution files) is
1.82      rillig    553:   freely available under a BSD license, so you may extend and adapt
                    554:   pkgsrc to your needs. Support for local packages and patches is
                    555:   available right out of the box, so you can configure it specifically
                    556:   for your environment.</p></li>
                    557: </ul></div>
1.91      rillig    558: <p>The following principles are basic to pkgsrc:</p>
1.148     asau      559: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz       560: <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  561: &mdash; That means, if a package contains bugs, it's better to find
1.91      rillig    562: them and to complain about them rather than to just install the package
                    563: and hope that it works. There are numerous checks in pkgsrc that try to
1.290     gutterid  564: 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    565: of shell scripts), and post-installation checks (installed files,
                    566: references to shared libraries, script interpreters).</p></li>
1.128     wiz       567: <li class="listitem"><p><span class="quote">&#8220;<span class="quote">If it works, it should work everywhere</span>&#8221;</span>
1.126     jakllsch  568: &mdash; Like NetBSD has been ported to many hardware architectures,
1.91      rillig    569: pkgsrc has been ported to many operating systems. Care is taken that
                    570: packages behave the same on all platforms.</p></li>
                    571: </ul></div>
1.82      rillig    572: </div>
1.148     asau      573: <div class="sect2">
1.82      rillig    574: <div class="titlepage"><div><div><h3 class="title">
                    575: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
                    576: <p>pkgsrc consists of both a source distribution and a binary
                    577: distribution for these operating systems. After retrieving the required
                    578: source or binaries, you can be up and running with pkgsrc in just
                    579: minutes!</p>
1.75      rillig    580: <p>pkgsrc was derived from FreeBSD's ports system, and
                    581:       initially developed for NetBSD only. Since then, pkgsrc has
                    582:       grown a lot, and now supports the following platforms:</p>
1.82      rillig    583: <div class="table">
                    584: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.216     tnn       585: <div class="table-contents"><table class="table" summary="Platforms supported by pkgsrc" border="1">
1.82      rillig    586: <colgroup>
                    587: <col>
                    588: <col>
1.202     sevan     589: <col>
1.82      rillig    590: </colgroup>
                    591: <thead><tr>
                    592: <th>Platform</th>
                    593: <th>Date Support Added</th>
1.202     sevan     594: <th>Notes</th>
1.82      rillig    595: </tr></thead>
                    596: <tbody>
                    597: <tr>
1.289     leot      598: <td><a class="ulink" href="https://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.82      rillig    599: <td align="center">Aug 1997</td>
1.202     sevan     600: <td class="auto-generated"> </td>
1.82      rillig    601: </tr>
                    602: <tr>
1.110     hubertf   603: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.82      rillig    604: <td align="center">Mar 1999</td>
1.264     sevan     605: <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    606: </tr>
                    607: <tr>
1.289     leot      608: <td><a class="ulink" href="https://www.kernel.org/" target="_top">Linux</a></td>
1.82      rillig    609: <td align="center">Jun 1999</td>
1.264     sevan     610: <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    611: </tr>
                    612: <tr>
                    613: <td>
1.230     sevan     614:           <a class="ulink" href="https://developer.apple.com/macos/" target="_top">Darwin / Mac OS X / OS X / macOS</a>
1.82      rillig    615:         </td>
                    616: <td align="center">Oct 2001</td>
1.264     sevan     617: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.MacOSX" target="_top">README.MacOSX</a></td>
1.82      rillig    618: </tr>
                    619: <tr>
1.289     leot      620: <td><a class="ulink" href="https://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.82      rillig    621: <td align="center">Nov 2002</td>
1.264     sevan     622: <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    623: </tr>
                    624: <tr>
1.289     leot      625: <td><a class="ulink" href="https://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.82      rillig    626: <td align="center">Nov 2002</td>
1.264     sevan     627: <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    628: </tr>
                    629: <tr>
1.289     leot      630: <td><a class="ulink" href="https://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.82      rillig    631: <td align="center">Dec 2002</td>
1.202     sevan     632: <td>
1.264     sevan     633:        <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.IRIX" target="_top">README.IRIX</a>
                    634:        <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     635:        </td>
1.82      rillig    636: </tr>
                    637: <tr>
                    638: <td>BSD/OS</td>
                    639: <td align="center">Dec 2003</td>
1.202     sevan     640: <td class="auto-generated"> </td>
1.82      rillig    641: </tr>
                    642: <tr>
1.289     leot      643: <td><a class="ulink" href="https://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.82      rillig    644: <td align="center">Dec 2003</td>
1.264     sevan     645: <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    646: </tr>
                    647: <tr>
                    648: <td>
1.289     leot      649:           <a class="ulink" href="https://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.82      rillig    650:           (Microsoft Windows Services for Unix)
                    651:         </td>
                    652: <td align="center">Mar 2004</td>
1.264     sevan     653: <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    654: </tr>
                    655: <tr>
1.289     leot      656: <td><a class="ulink" href="https://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.82      rillig    657: <td align="center">Oct 2004</td>
1.202     sevan     658: <td class="auto-generated"> </td>
1.82      rillig    659: </tr>
                    660: <tr>
1.110     hubertf   661: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.82      rillig    662: <td align="center">Nov 2004</td>
1.264     sevan     663: <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    664: </tr>
1.98      wiz       665: <tr>
1.289     leot      666: <td><a class="ulink" href="https://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.98      wiz       667: <td align="center">Apr 2007</td>
1.264     sevan     668: <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       669: </tr>
1.128     wiz       670: <tr>
1.289     leot      671: <td><a class="ulink" href="https://www.haiku-os.org/" target="_top">Haiku</a></td>
1.128     wiz       672: <td align="center">Sep 2010</td>
1.264     sevan     673: <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       674: </tr>
1.151     obache    675: <tr>
1.289     leot      676: <td><a class="ulink" href="https://www.mirbsd.org/" target="_top">MirBSD</a></td>
1.163     bsiegert  677: <td align="center">Jan 2011</td>
1.202     sevan     678: <td class="auto-generated"> </td>
1.151     obache    679: </tr>
                    680: <tr>
1.289     leot      681: <td><a class="ulink" href="https://www.minix3.org/" target="_top">Minix3</a></td>
1.151     obache    682: <td align="center">Nov 2011</td>
1.264     sevan     683: <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    684: </tr>
                    685: <tr>
1.289     leot      686: <td><a class="ulink" href="https://cygwin.com/" target="_top">Cygwin</a></td>
1.151     obache    687: <td align="center">Mar 2013</td>
1.264     sevan     688: <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    689: </tr>
1.166     jnemeth   690: <tr>
1.289     leot      691: <td><a class="ulink" href="https://www.debian.org/ports/kfreebsd-gnu/" target="_top">GNU/kFreeBSD</a></td>
1.166     jnemeth   692: <td align="center">Jul 2013</td>
1.264     sevan     693: <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   694: </tr>
1.214     sevan     695: <tr>
1.289     leot      696: <td><a class="ulink" href="https://www.bitrig.org/" target="_top">Bitrig</a></td>
1.214     sevan     697: <td align="center">Jun 2014</td>
1.264     sevan     698: <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     699: </tr>
1.82      rillig    700: </tbody>
1.91      rillig    701: </table></div>
1.82      rillig    702: </div>
1.91      rillig    703: <br class="table-break">
1.82      rillig    704: </div>
1.75      rillig    705: </div>
1.148     asau      706: <div class="sect1">
1.75      rillig    707: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    708: <a name="overview"></a>1.2. Overview</h2></div></div></div>
                    709: <p>This document is divided into three parts. The first,
1.110     hubertf   710:        <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.75      rillig    711:        describes how one can use one of the packages in the Package
                    712:        Collection, either by installing a precompiled binary package,
1.93      rillig    713:        or by building one's own copy using the NetBSD package system.
1.110     hubertf   714:        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    715:        package so it can be easily built by other NetBSD users without
                    716:        knowing about the package's building details. The third part,
1.110     hubertf   717:        <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.75      rillig    718:        is intended for those who want to understand how pkgsrc is
                    719:        implemented.</p>
                    720: <p>This document is available in various formats:
1.110     hubertf   721:        <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    722: </div>
1.148     asau      723: <div class="sect1">
1.75      rillig    724: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    725: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
1.128     wiz       726: <p>There has been a lot of talk about <span class="quote">&#8220;<span class="quote">ports</span>&#8221;</span>,
                    727:       <span class="quote">&#8220;<span class="quote">packages</span>&#8221;</span>, etc. so far. Here is a description of all the
1.75      rillig    728:       terminology used within this document.</p>
1.148     asau      729: <div class="variablelist"><dl class="variablelist">
1.75      rillig    730: <dt><span class="term">Package</span></dt>
                    731: <dd><p>A set of files and building instructions
                    732:            that describe what's necessary
                    733:            to build a certain piece of software using
                    734:             pkgsrc. Packages are traditionally stored under
1.236     wiz       735:            <code class="filename">/usr/pkgsrc</code>,
                    736:            but may be stored in any location,
                    737:            referred to as <code class="varname">PKGSRCDIR</code>.</p></dd>
1.75      rillig    738: <dt><span class="term">The NetBSD package system</span></dt>
1.128     wiz       739: <dd><p>This is the former name of <span class="quote">&#8220;<span class="quote">pkgsrc</span>&#8221;</span>.  It
1.87      wiz       740:          is part of the NetBSD operating system and can be bootstrapped
                    741:          to run on non-NetBSD operating systems as well.  It handles
                    742:          building (compiling), installing, and removing of
                    743:          packages.</p></dd>
1.75      rillig    744: <dt><span class="term">Distfile</span></dt>
                    745: <dd><p>This term describes the file or files that are
                    746:            provided by the author of the piece of software to
                    747:            distribute his work. All the changes necessary to build on
                    748:            NetBSD are reflected in the corresponding package. Usually
                    749:            the distfile is in the form of a compressed tar-archive,
                    750:            but other types are possible, too. Distfiles are usually
                    751:            stored below
1.76      rillig    752:            <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
1.75      rillig    753: <dt><span class="term">Port</span></dt>
                    754: <dd><p>This is the term used by FreeBSD and OpenBSD people
                    755:            for what we call a package.
1.128     wiz       756:            In NetBSD terminology, <span class="quote">&#8220;<span class="quote">port</span>&#8221;</span> refers to a different
1.75      rillig    757:            architecture.</p></dd>
                    758: <dt><span class="term">Precompiled/binary package</span></dt>
                    759: <dd>
                    760: <p>A set of binaries built with pkgsrc from a distfile
1.76      rillig    761:            and stuffed together in a single <code class="filename">.tgz</code>
1.75      rillig    762:            file so it can be installed on machines of the same
                    763:            machine architecture without the need to
                    764:            recompile. Packages are usually generated in
1.76      rillig    765:            <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.132     spz       766:            an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.128     wiz       767: <p>Sometimes, this is referred to by the term <span class="quote">&#8220;<span class="quote">package</span>&#8221;</span> too,
1.75      rillig    768:            especially in the context of precompiled packages.</p>
                    769: </dd>
                    770: <dt><span class="term">Program</span></dt>
1.88      wiz       771: <dd><p>The piece of software to be installed which will be
                    772:          constructed from all the files in the distfile by the
                    773:          actions defined in the corresponding package.</p></dd>
1.75      rillig    774: </dl></div>
1.148     asau      775: <div class="sect2">
1.75      rillig    776: <div class="titlepage"><div><div><h3 class="title">
1.88      wiz       777: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.148     asau      778: <div class="variablelist"><dl class="variablelist">
1.75      rillig    779: <dt><span class="term">pkgsrc users</span></dt>
                    780: <dd>
                    781: <p>The
                    782:        pkgsrc users are people who use the packages provided by pkgsrc.
                    783:        Typically they are system administrators. The people using the
1.128     wiz       784:        software that is inside the packages (maybe called <span class="quote">&#8220;<span class="quote">end
                    785:        users</span>&#8221;</span>) are not covered by the pkgsrc guide.</p>
1.75      rillig    786: <p>There are two kinds of pkgsrc users: Some only want to
                    787:        install pre-built binary packages. Others build the pkgsrc
                    788:        packages from source, either for installing them directly or for
1.110     hubertf   789:        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    790:        documentation.</p>
                    791: </dd>
                    792: <dt><span class="term">package maintainers</span></dt>
                    793: <dd><p>A
1.110     hubertf   794:        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    795: <dt><span class="term">infrastructure developers</span></dt>
                    796: <dd><p>These people are involved in all those files
1.76      rillig    797:        that live in the <code class="filename">mk/</code> directory and below.
1.110     hubertf   798:        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    799:        too.</p></dd>
                    800: </dl></div>
                    801: </div>
                    802: </div>
1.148     asau      803: <div class="sect1">
1.75      rillig    804: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    805: <a name="typography"></a>1.4. Typography</h2></div></div></div>
                    806: <p>When giving examples for commands, shell prompts are used to
                    807:       show if the command should/can be issued as root, or if
1.128     wiz       808:       <span class="quote">&#8220;<span class="quote">normal</span>&#8221;</span> user privileges are sufficient. We use a
1.226     sevan     809:       <code class="prompt">#</code> for root's shell prompt, a <code class="prompt">%</code> for users'
                    810:       shell prompt, assuming they use the C-shell or tcsh and a <code class="prompt">$</code> for
                    811:       bourne shell and derivatives.</p>
1.75      rillig    812: </div>
                    813: </div>
1.148     asau      814: <div class="part">
1.75      rillig    815: <div class="titlepage"><div><div><h1 class="title">
                    816: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
                    817: <div class="toc">
                    818: <p><b>Table of Contents</b></p>
1.210     leot      819: <dl class="toc">
1.267     rillig    820: <dt><span class="chapter"><a href="#help-user">2. Getting help</a></span></dt>
                    821: <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    822: <dd><dl>
1.267     rillig    823: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.75      rillig    824: <dd><dl>
1.267     rillig    825: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
                    826: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.75      rillig    827: </dl></dd>
1.267     rillig    828: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.75      rillig    829: <dd><dl>
1.267     rillig    830: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
                    831: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.75      rillig    832: </dl></dd>
                    833: </dl></dd>
1.267     rillig    834: <dt><span class="chapter"><a href="#platforms">4. Using pkgsrc on systems other than NetBSD</a></span></dt>
1.75      rillig    835: <dd><dl>
1.267     rillig    836: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
                    837: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.75      rillig    838: </dl></dd>
1.267     rillig    839: <dt><span class="chapter"><a href="#using">5. Using pkgsrc</a></span></dt>
1.75      rillig    840: <dd><dl>
1.267     rillig    841: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.75      rillig    842: <dd><dl>
1.267     rillig    843: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
                    844: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
                    845: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.3. Deinstalling packages</a></span></dt>
                    846: <dt><span class="sect2"><a href="#using.pkg_info">5.1.4. Getting information about installed packages</a></span></dt>
                    847: <dt><span class="sect2"><a href="#vulnerabilities">5.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                    848: <dt><span class="sect2"><a href="#pkg_versions">5.1.6. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
                    849: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.7. Other administrative functions</a></span></dt>
1.75      rillig    850: </dl></dd>
1.267     rillig    851: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1.75      rillig    852: <dd><dl>
1.267     rillig    853: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
                    854: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
                    855: <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    856: </dl></dd>
                    857: </dl></dd>
1.267     rillig    858: <dt><span class="chapter"><a href="#configuring">6. Configuring pkgsrc</a></span></dt>
1.75      rillig    859: <dd><dl>
1.267     rillig    860: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
                    861: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
                    862: <dt><span class="sect1"><a href="#variables-affecting-installation">6.3. Variables affecting the installation process</a></span></dt>
                    863: <dt><span class="sect1"><a href="#conf.compiler">6.4. Selecting and configuring the compiler</a></span></dt>
1.88      wiz       864: <dd><dl>
1.267     rillig    865: <dt><span class="sect2"><a href="#selecting-the-compiler">6.4.1. Selecting the compiler</a></span></dt>
                    866: <dt><span class="sect2"><a href="#conf.cflags">6.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                    867: <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       868: </dl></dd>
1.267     rillig    869: <dt><span class="sect1"><a href="#developer-advanced-settings">6.5. Developer/advanced settings</a></span></dt>
                    870: <dt><span class="sect1"><a href="#selecting-build-options">6.6. Selecting Build Options</a></span></dt>
1.75      rillig    871: </dl></dd>
1.267     rillig    872: <dt><span class="chapter"><a href="#binary">7. Creating binary packages</a></span></dt>
1.75      rillig    873: <dd><dl>
1.267     rillig    874: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
                    875: <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    876: </dl></dd>
1.267     rillig    877: <dt><span class="chapter"><a href="#bulk">8. Creating binary packages for everything in pkgsrc (bulk
1.106     rillig    878: builds)</a></span></dt>
1.75      rillig    879: <dd><dl>
1.267     rillig    880: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
1.295     rillig    881: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a bulk build</a></span></dt>
1.267     rillig    882: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
                    883: <dt><span class="sect1"><a href="#bulk.req">8.3. Requirements of a full bulk build</a></span></dt>
1.293     rillig    884: <dt><span class="sect1"><a href="#bulk.var">8.4. Bulk build variants</a></span></dt>
                    885: <dd><dl>
1.294     rillig    886: <dt><span class="sect2"><a href="#bulk.var.confopt">8.4.1. Detect unknown configure options</a></span></dt>
                    887: <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    888: <dt><span class="sect2"><a href="#bulk.var.builderr">8.4.3. Force compiler options only in the build phase</a></span></dt>
                    889: <dt><span class="sect2"><a href="#bulk.var.dirs">8.4.4. Use custom directories</a></span></dt>
                    890: <dt><span class="sect2"><a href="#bulk.var.warn">8.4.5. Turn warnings into errors</a></span></dt>
                    891: <dt><span class="sect2"><a href="#bulk.var.pkglint">8.4.6. Reject packages for which pkglint reports errors</a></span></dt>
                    892: <dt><span class="sect2"><a href="#bulk.var.strings">8.4.7. Reject packages that contain forbidden strings</a></span></dt>
                    893: <dt><span class="sect2"><a href="#bulk.var.test">8.4.8. Reject packages whose self-test fails</a></span></dt>
                    894: <dt><span class="sect2"><a href="#bulk.var.shvar">8.4.9. Reject packages that use undefined shell variables</a></span></dt>
                    895: <dt><span class="sect2"><a href="#bulk.var.quiet">8.4.10. Turn off verbose logging</a></span></dt>
1.293     rillig    896: </dl></dd>
                    897: <dt><span class="sect1"><a href="#creating-cdroms">8.5. Creating a multiple CD-ROM packages collection</a></span></dt>
                    898: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.5.1. Example of cdpack</a></span></dt></dl></dd>
1.267     rillig    899: </dl></dd>
                    900: <dt><span class="chapter"><a href="#files">9. Directory layout of the installed files</a></span></dt>
                    901: <dd><dl>
                    902: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
                    903: <dt><span class="sect1"><a href="#files.varbase">9.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
                    904: </dl></dd>
                    905: <dt><span class="chapter"><a href="#faq">10. Frequently Asked Questions</a></span></dt>
                    906: <dd><dl>
                    907: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                    908: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
                    909: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
                    910: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
                    911: <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>
                    912: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
                    913: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
                    914: <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>
                    915: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
                    916: <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       917: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</a></span></dt>
1.267     rillig    918: <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>
                    919: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' with pkgsrc</a></span></dt>
                    920: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
                    921: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
                    922: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
                    923: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build.  What shall I do?</a></span></dt>
                    924: <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    925: </dl></dd>
                    926: </dl>
                    927: </div>
1.148     asau      928: <div class="chapter">
1.75      rillig    929: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig    930: <a name="help-user"></a>Chapter 2. Getting help</h2></div></div></div>
                    931: <p>
                    932:        To get help when using pkgsrc, the definitive source is this
                    933:        document, the pkgsrc guide. If you don't find anything here,
                    934:        there are alternatives:
                    935: </p>
                    936: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                    937: <li class="listitem">
                    938: <p>
                    939:        The built-in pkgsrc help, which is available after bootstrapping
                    940:        pkgsrc. Run <span class="command"><strong>bmake help topic=&#8230;</strong></span> to get
                    941:        help for any topic, such as a variable name like
                    942:        <code class="varname">BUILD_DEFS</code>, a make target like
                    943:        <span class="command"><strong>do-build</strong></span>, a missing C or C++ function like
                    944:        <span class="command"><strong>strcasecmp</strong></span> or any other topic.</p>
                    945: <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>
                    946: </li>
                    947: <li class="listitem"><p>
1.278     rillig    948:        To see the value of a single variable, run <span class="command"><strong>bmake
                    949:        show-var VARNAME=<em class="replaceable"><code>X</code></em></strong></span>.
                    950: </p></li>
                    951: <li class="listitem"><p>
                    952:        To see the values of the most common variables, run
                    953:        <span class="command"><strong>bmake show-all</strong></span>. These variables are grouped by
                    954:        topic. To see the variables for a single topic, run
                    955:        <span class="command"><strong>bmake
                    956:        show-all-<em class="replaceable"><code>topic</code></em></strong></span>, for example
                    957:        <span class="command"><strong>bmake show-all-fetch</strong></span>.
                    958: </p></li>
                    959: <li class="listitem"><p>
1.267     rillig    960:        The pkgsrc-users mailing list, to which
                    961:        <a class="ulink" href="https://www.NetBSD.org/mailinglists/#pkgsrc-users" target="_top">you
                    962:        can subscribe</a> and then <a class="ulink" href="mailto:pkgsrc-users@NetBSD.org" target="_top">ask your
                    963:        questions</a>.</p></li>
                    964: <li class="listitem"><p>The #pkgsrc IRC channel, which is accessible
                    965:        <a class="ulink" href="https://webchat.freenode.net/" target="_top">via a web browser</a>
                    966:        or by using a specialized chat program such as
                    967:        <a class="ulink" href="http://xchat.org/" target="_top">XChat</a>.
                    968:        Pick any user name and join the channel #pkgsrc.</p></li>
                    969: </ul></div>
                    970: </div>
                    971: <div class="chapter">
                    972: <div class="titlepage"><div><div><h2 class="title">
                    973: <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    974: <div class="toc">
                    975: <p><b>Table of Contents</b></p>
1.210     leot      976: <dl class="toc">
1.267     rillig    977: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.75      rillig    978: <dd><dl>
1.267     rillig    979: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
                    980: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.75      rillig    981: </dl></dd>
1.267     rillig    982: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.75      rillig    983: <dd><dl>
1.267     rillig    984: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
                    985: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.75      rillig    986: </dl></dd>
                    987: </dl>
                    988: </div>
1.91      rillig    989: <p>Before you download and extract the files, you need to decide
                    990: where you want to extract them. When using pkgsrc as root user, pkgsrc
                    991: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
                    992: free to install the sources and binary packages wherever you want in
                    993: your filesystem, provided that the pathname does not contain white-space
                    994: or other characters that are interpreted specially by the shell and some
                    995: other programs. A safe bet is to use only letters, digits, underscores
                    996: and dashes.</p>
1.148     asau      997: <div class="sect1">
1.75      rillig    998: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig    999: <a name="getting-first"></a>3.1. Getting pkgsrc for the first time</h2></div></div></div>
1.75      rillig   1000: <p>Before you download any pkgsrc files, you should decide
                   1001:        whether you want the <span class="emphasis"><em>current</em></span> branch or the
                   1002:        <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
                   1003:        quarterly basis from the current branch and only gets modified
                   1004:        for security updates. The names of the stable branches are built
                   1005:        from the year and the quarter, for example
1.289     leot     1006:        <code class="literal">2020Q1</code>.</p>
1.75      rillig   1007: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
1.128     wiz      1008:        want to download pkgsrc. You can get it as a tar file or via CVS.
                   1009:        Both ways are described here.</p>
1.157     asau     1010: <p>Note that tar archive contains CVS working copy.
                   1011:        Thus you can switch to using CVS at any later time.</p>
1.148     asau     1012: <div class="sect2">
1.75      rillig   1013: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1014: <a name="getting-via-tar"></a>3.1.1. As tar archive</h3></div></div></div>
1.75      rillig   1015: <p>The primary download location for all pkgsrc files is
1.264     sevan    1016:        <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/" target="_top">https://cdn.NetBSD.org/pub/pkgsrc/</a> or
1.157     asau     1017:        <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>
                   1018:        (it points to the same location).
                   1019:        There are a number of subdirectories for different purposes,
                   1020:        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>
                   1021: <p>The tar archive for the current branch is in the directory
1.264     sevan    1022:        <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    1023:        It is autogenerated weekly.</p>
1.157     asau     1024: <p>To save download time we provide bzip2- and
                   1025:        xz-compressed archives which are published at
1.264     sevan    1026:        <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     1027:        and
1.264     sevan    1028:        <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     1029:        respectively.
                   1030:        </p>
                   1031: <p>You can fetch the same files using FTP.</p>
1.289     leot     1032: <p>The tar file for the stable branch 2020Q1 is in the
                   1033:        directory <code class="filename">pkgsrc-2020Q1</code> and is also called <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/pkgsrc-2020Q1/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.</p>
1.249     leot     1034: <p>To download the latest pkgsrc stable tarball, run:</p>
1.112     weinem   1035: <pre class="screen">
1.289     leot     1036: <code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2020Q1/pkgsrc.tar.gz</code></strong></pre>
1.188     snj      1037: <p>If you prefer, you can also fetch it using "wget", "curl",
1.157     asau     1038:        or your web browser.</p>
1.112     weinem   1039: <p>Then, extract it with:</p>
1.188     snj      1040: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf pkgsrc.tar.gz -C /usr</code></strong></pre>
1.112     weinem   1041: <p>This will create the directory <code class="filename">pkgsrc/</code>
                   1042:        in <code class="filename">/usr/</code> and all the package source will be 
                   1043:        stored under <code class="filename">/usr/pkgsrc/</code>.</p>
                   1044: <p>To download pkgsrc-current, run:</p>
                   1045: <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   1046: </div>
1.148     asau     1047: <div class="sect2">
1.75      rillig   1048: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1049: <a name="getting-via-cvs"></a>3.1.2. Via anonymous CVS</h3></div></div></div>
1.128     wiz      1050: <p>To fetch a specific pkgsrc stable branch, run:</p>
1.289     leot     1051: <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-2020Q1 -P pkgsrc</code></strong>
1.128     wiz      1052: </pre>
                   1053: <p>This will create the directory <code class="filename">pkgsrc/</code> 
                   1054:        in your <code class="filename">/usr/</code> directory and all the package source 
                   1055:        will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
                   1056: <p>To fetch the pkgsrc current branch, run:</p>
1.146     wiz      1057: <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    1058: </pre>
1.289     leot     1059: <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      1060: <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      1061: <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      1062: </pre>
                   1063: <p>Refer to documentation on your command shell how to set CVS_RSH=ssh permanently.
                   1064:        For Bourne shells, you can set it in your <code class="filename">.profile</code>
                   1065:        or better globally in <code class="filename">/etc/profile</code>:</p>
                   1066: <pre class="programlisting">
                   1067: # set CVS remote shell command
                   1068: CVS_RSH=ssh
                   1069: export CVS_RSH
                   1070: </pre>
                   1071: <p>By default, CVS doesn't do things like most people would expect it to do.
                   1072:        But there is a way to convince CVS, by creating a file called <code class="filename">.cvsrc</code>
                   1073:        in your home directory and saving the following lines to it.
                   1074:        This file will save you lots of headache and some bug reports, so we strongly recommend it.
                   1075:        You can find an explanation of this file in the CVS documentation.</p>
1.101     rillig   1076: <pre class="programlisting">
                   1077: # recommended CVS configuration file from the pkgsrc guide
1.268     sevan    1078: cvs -q
1.101     rillig   1079: checkout -P
1.103     wiz      1080: update -dP
                   1081: diff -upN
1.101     rillig   1082: rdiff -u
1.128     wiz      1083: release -d
1.101     rillig   1084: </pre>
1.75      rillig   1085: </div>
                   1086: </div>
1.148     asau     1087: <div class="sect1">
1.75      rillig   1088: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1089: <a name="uptodate"></a>3.2. Keeping pkgsrc up-to-date</h2></div></div></div>
1.75      rillig   1090: <p>The preferred way to keep pkgsrc up-to-date is via CVS
                   1091:        (which also works if you have first installed it via a tar
                   1092:        file). It saves bandwidth and hard disk activity, compared to
                   1093:        downloading the tar file again.</p>
1.148     asau     1094: <div class="sect2">
1.75      rillig   1095: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1096: <a name="uptodate-tar"></a>3.2.1. Via tar files</h3></div></div></div>
1.148     asau     1097: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   1098: <h3 class="title">Warning</h3>
1.77      rillig   1099: <p>When updating from a tar file, you first need to
                   1100:        completely remove the old pkgsrc directory. Otherwise those
                   1101:        files that have been removed from pkgsrc in the mean time will
                   1102:        not be removed on your local disk, resulting in inconsistencies.
                   1103:        When removing the old files, any changes that you have done to
                   1104:        the pkgsrc files will be lost after updating. Therefore updating
                   1105:        via CVS is strongly recommended.</p>
1.75      rillig   1106: </div>
1.82      rillig   1107: <p>Note that by default the distfiles and the binary packages
                   1108:        are saved in the pkgsrc tree, so don't forget to rescue them
1.188     snj      1109:        before updating. You can also configure pkgsrc to store distfiles
                   1110:         and packages in directories outside the pkgsrc tree by setting the
1.82      rillig   1111:        <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.267     rillig   1112:        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   1113: <p>To update pkgsrc from a tar file, download the tar file as
                   1114:        explained above. Then, make sure that you have not made any
                   1115:        changes to the files in the pkgsrc directory. Remove the pkgsrc
                   1116:        directory and extract the new tar file. Done.</p>
                   1117: </div>
1.148     asau     1118: <div class="sect2">
1.75      rillig   1119: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1120: <a name="uptodate-cvs"></a>3.2.2. Via CVS</h3></div></div></div>
1.132     spz      1121: <p>To update pkgsrc via CVS, change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
                   1122: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc &amp;&amp; cvs update -dP</code></strong>
                   1123: </pre>
                   1124: <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>
                   1125: <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>
                   1126: </pre>
1.148     asau     1127: <div class="sect3">
1.75      rillig   1128: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   1129: <a name="uptodate-cvs-switch"></a>3.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1.75      rillig   1130: <p>When updating pkgsrc, the CVS program keeps track of the
                   1131:        branch you selected. But if you, for whatever reason, want to
                   1132:        switch from the stable branch to the current one, you can do it
1.128     wiz      1133:        by adding the option <span class="quote">&#8220;<span class="quote">-A</span>&#8221;</span> after the
                   1134:        <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> keyword. To switch from the current branch
1.75      rillig   1135:        back to the stable branch, add the
1.289     leot     1136:        <span class="quote">&#8220;<span class="quote">-rpkgsrc-2020Q1</span>&#8221;</span> option.</p>
1.75      rillig   1137: </div>
1.148     asau     1138: <div class="sect3">
1.75      rillig   1139: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   1140: <a name="uptodate-cvs-changes"></a>3.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1.75      rillig   1141: <p>When you update pkgsrc, the CVS program will only touch
                   1142:        those files that are registered in the CVS repository. That
                   1143:        means that any packages that you created on your own will stay
                   1144:        unmodified. If you change files that are managed by CVS, later
                   1145:        updates will try to merge your changes with those that have been
                   1146:        done by others. See the CVS manual, chapter
1.128     wiz      1147:        <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> for details.</p>
1.75      rillig   1148: </div>
                   1149: </div>
                   1150: </div>
                   1151: </div>
1.148     asau     1152: <div class="chapter">
1.75      rillig   1153: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   1154: <a name="platforms"></a>Chapter 4. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1.75      rillig   1155: <div class="toc">
                   1156: <p><b>Table of Contents</b></p>
1.210     leot     1157: <dl class="toc">
1.267     rillig   1158: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
                   1159: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.75      rillig   1160: </dl>
                   1161: </div>
1.148     asau     1162: <div class="sect1">
1.75      rillig   1163: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1164: <a name="binarydist"></a>4.1. Binary distribution</h2></div></div></div>
                   1165: <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   1166: </div>
1.148     asau     1167: <div class="sect1">
1.82      rillig   1168: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1169: <a name="bootstrapping-pkgsrc"></a>4.2. Bootstrapping pkgsrc</h2></div></div></div>
1.149     asau     1170: <p>pkgsrc can be bootstrapped for use in two different modes:
                   1171:     privileged and unprivileged one. In unprivileged mode in contrast
1.150     asau     1172:     to privileged one all programs are installed under one particular user
1.149     asau     1173:     and cannot utilise privileged operations (packages don't create
                   1174:     special users and all special file permissions like setuid are ignored).
                   1175:     </p>
1.82      rillig   1176: <p>Installing the bootstrap kit from source should be as simple as:</p>
1.75      rillig   1177: <pre class="screen">
1.167     asau     1178: <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   1179: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.87      wiz      1180: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
                   1181:     </pre>
1.149     asau     1182: <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>
                   1183: <p>By default, in privileged mode pkgsrc uses
                   1184:     <code class="filename">/usr/pkg</code> for <span class="emphasis"><em>prefix</em></span>
                   1185:     where programs will be installed in,
1.230     sevan    1186:     and <code class="filename">/usr/pkg/pkgdb</code> for the package database
1.149     asau     1187:     directory where pkgsrc will do its internal bookkeeping,
                   1188:     <code class="filename">/var</code> is used as <span class="emphasis"><em>varbase</em></span>,
                   1189:     where packages install their persistent data.
                   1190:     In unprivileged mode pkgsrc uses
                   1191:     <code class="filename">~/pkg</code> for <span class="emphasis"><em>prefix</em></span>,
1.230     sevan    1192:     <code class="filename">~/pkg/pkgdb</code> for the package database,
1.149     asau     1193:     and <code class="filename">~/pkg/var</code> for <span class="emphasis"><em>varbase</em></span>.
                   1194:     </p>
                   1195: <p>You can change default layout using command-line arguments.
                   1196:     Run <span class="quote">&#8220;<span class="quote">./bootstrap --help</span>&#8221;</span> to get details.
                   1197:     </p>
1.148     asau     1198: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   1199: <h3 class="title">Note</h3>
1.110     hubertf  1200: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
                   1201:       Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
                   1202:       For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.128     wiz      1203:       instead of <span class="quote">&#8220;<span class="quote">make</span>&#8221;</span>.</p>
1.75      rillig   1204: </div>
1.149     asau     1205: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1206: <h3 class="title">Note</h3>
                   1207: <p>It is possible to bootstrap multiple instances of pkgsrc
                   1208:       using non-intersecting directories. Use <span class="command"><strong>bmake</strong></span>
                   1209:       corresponding to the installation you're working with to build
                   1210:       and install packages.
                   1211:       </p>
                   1212: </div>
1.75      rillig   1213: </div>
                   1214: </div>
1.148     asau     1215: <div class="chapter">
1.75      rillig   1216: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   1217: <a name="using"></a>Chapter 5. Using pkgsrc</h2></div></div></div>
1.75      rillig   1218: <div class="toc">
                   1219: <p><b>Table of Contents</b></p>
1.210     leot     1220: <dl class="toc">
1.267     rillig   1221: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.75      rillig   1222: <dd><dl>
1.267     rillig   1223: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
                   1224: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
                   1225: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.3. Deinstalling packages</a></span></dt>
                   1226: <dt><span class="sect2"><a href="#using.pkg_info">5.1.4. Getting information about installed packages</a></span></dt>
                   1227: <dt><span class="sect2"><a href="#vulnerabilities">5.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                   1228: <dt><span class="sect2"><a href="#pkg_versions">5.1.6. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
                   1229: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.7. Other administrative functions</a></span></dt>
                   1230: </dl></dd>
                   1231: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
                   1232: <dd><dl>
                   1233: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
                   1234: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
                   1235: <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   1236: </dl></dd>
                   1237: </dl>
                   1238: </div>
                   1239: <p>Basically, there are two ways of using pkgsrc. The first
1.88      wiz      1240: is to only install the package tools and to use binary packages
1.128     wiz      1241: that someone else has prepared. This is the <span class="quote">&#8220;<span class="quote">pkg</span>&#8221;</span>
                   1242: in pkgsrc. The second way is to install the <span class="quote">&#8220;<span class="quote">src</span>&#8221;</span>
1.88      wiz      1243: of pkgsrc, too. Then you are able to build your own packages,
                   1244: and you can still use binary packages from someone else.</p>
1.148     asau     1245: <div class="sect1">
1.75      rillig   1246: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1247: <a name="using-pkg"></a>5.1. Using binary packages</h2></div></div></div>
1.294     rillig   1248: <p>On the <a class="ulink" href="http://cdn.NetBSD.org/" target="_top">cdn.NetBSD.org</a>
1.264     sevan    1249:   site and mirrors, there are collections of binary packages,
1.109     rillig   1250:   ready to be installed. These binary packages have been built using the
                   1251:   default settings for the directories, that is:</p>
1.148     asau     1252: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1253: <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>
                   1254: <li class="listitem"><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
                   1255: <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   1256: </ul></div>
                   1257: <p>If you cannot use these directories for whatever reasons (maybe
                   1258:   because you're not root), you cannot use these binary packages, but
1.267     rillig   1259:   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     1260: <div class="sect2">
1.75      rillig   1261: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1262: <a name="finding-binary-packages"></a>5.1.1. Finding binary packages</h3></div></div></div>
1.105     weinem   1263: <p>To install binary packages, you first need to know from where
                   1264:     to get them. The first place where you should look is on the main
1.294     rillig   1265:     
                   1266:     pkgsrc FTP server in the directory <a class="ulink" href="http://cdn.NetBSD.org/pub/pkgsrc/packages/" target="_top"><code class="filename">/pub/pkgsrc/packages</code></a>.</p>
1.105     weinem   1267: <p>This directory contains binary packages for multiple
                   1268:     platforms. First, select your operating system. (Ignore the
                   1269:     directories with version numbers attached to it, they just exist for
                   1270:     legacy reasons.) Then, select your hardware architecture, and in the
1.128     wiz      1271:     third step, the OS version and the <span class="quote">&#8220;<span class="quote">version</span>&#8221;</span> of pkgsrc.</p>
1.109     rillig   1272: <p>In this directory, you often find a file called
                   1273:     <code class="filename">bootstrap.tar.gz</code> which contains the package
                   1274:     management tools. If the file is missing, it is likely that your
                   1275:     operating system already provides those tools. Download the file and
                   1276:     extract it in the <code class="filename">/</code> directory. It will create
                   1277:     the directories <code class="filename">/usr/pkg</code> (containing the tools
1.230     sevan    1278:     for managing binary packages and the database of installed packages).</p>
1.75      rillig   1279: </div>
1.148     asau     1280: <div class="sect2">
1.75      rillig   1281: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1282: <a name="installing-binary-packages"></a>5.1.2. Installing binary packages</h3></div></div></div>
1.109     rillig   1283: <p>In the directory from the last section, there is a
1.196     wiz      1284:     subdirectory called <code class="filename">All/</code>, which contains all the
1.109     rillig   1285:     binary packages that are available for the platform, excluding those
                   1286:     that may not be distributed via FTP or CDROM (depending on which
1.128     wiz      1287:     medium you are using).</p>
1.109     rillig   1288: <p>To install packages directly from an FTP or HTTP server, run
                   1289:     the following commands in a Bourne-compatible shell (be sure to
1.110     hubertf  1290:     <span class="command"><strong>su</strong></span> to root first):</p>
1.109     rillig   1291: <pre class="screen">
                   1292: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:$PATH"</code></strong>
1.294     rillig   1293: 
                   1294: <code class="prompt">#</code> <strong class="userinput"><code>PKG_PATH="http://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>
                   1297: </pre>
                   1298: <p>Instead of URLs, you can also use local paths, for example if
                   1299:     you are installing from a set of CDROMs, DVDs or an NFS-mounted
                   1300:     repository. If you want to install packages from multiple sources,
                   1301:     you can separate them by a semicolon in
                   1302:     <code class="varname">PKG_PATH</code>.</p>
                   1303: <p>After these preparations, installing a package is very
                   1304:     easy:</p>
                   1305: <pre class="screen">
1.230     sevan    1306: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add libreoffice</code></strong>
                   1307: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add ap24-php71-*</code></strong>
1.109     rillig   1308: </pre>
1.75      rillig   1309: <p>Note that any prerequisite packages needed to run the
1.88      wiz      1310:     package in question will be installed, too, assuming they are
                   1311:     present where you install from.</p>
1.128     wiz      1312: <p>Adding packages might install vulnerable packages.
                   1313:     Thus you should run <span class="command"><strong>pkg_admin audit</strong></span>
                   1314:     regularly, especially after installing new packages, and verify
                   1315:     that the vulnerabilities are acceptable for your configuration.</p>
1.75      rillig   1316: <p>After you've installed packages, be sure to have
1.88      wiz      1317:     <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
                   1318:     <code class="varname">PATH</code> so you can actually start the just
                   1319:     installed program.</p>
1.75      rillig   1320: </div>
1.148     asau     1321: <div class="sect2">
1.75      rillig   1322: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1323: <a name="using.pkg_delete"></a>5.1.3. Deinstalling packages</h3></div></div></div>
1.82      rillig   1324: <p>To deinstall a package, it does not matter whether it was
1.88      wiz      1325:     installed from source code or from a binary package. The
1.110     hubertf  1326:     <span class="command"><strong>pkg_delete</strong></span> command does not know it anyway.
                   1327:     To delete a package, you can just run <span class="command"><strong>pkg_delete
1.88      wiz      1328:     <em class="replaceable"><code>package-name</code></em></strong></span>. The package
                   1329:     name can be given with or without version number. Wildcards can
                   1330:     also be used to deinstall a set of packages, for example
                   1331:     <code class="literal">*emacs*</code>. Be sure to include them in quotes,
                   1332:     so that the shell does not expand them before
                   1333:     <code class="literal">pkg_delete</code> sees them.</p>
1.82      rillig   1334: <p>The <code class="option">-r</code> option is very powerful: it
1.88      wiz      1335:     removes all the packages that require the package in question
                   1336:     and then removes the package itself. For example:
1.82      rillig   1337: 
1.88      wiz      1338:     </p>
1.82      rillig   1339: <pre class="screen">
1.88      wiz      1340: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
                   1341:     </pre>
1.82      rillig   1342: <p>
                   1343: 
1.88      wiz      1344:     will remove jpeg and all the packages that used it; this allows
                   1345:     upgrading the jpeg package.</p>
1.82      rillig   1346: </div>
1.148     asau     1347: <div class="sect2">
1.82      rillig   1348: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1349: <a name="using.pkg_info"></a>5.1.4. Getting information about installed packages</h3></div></div></div>
1.110     hubertf  1350: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.88      wiz      1351:     installed packages or binary package files.</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.267     rillig   1355: <a name="vulnerabilities"></a>5.1.5. 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.88      wiz      1358:       known security vulnerabilities to packages which are (or have been)
                   1359:       included in pkgsrc.  The list is available from the NetBSD
1.294     rillig   1360:       
                   1361:       FTP site at <a class="ulink" href="http://ftp.NetBSD.org/pub/NetBSD/packages/vulns/pkg-vulnerabilities" target="_top">http://ftp.NetBSD.org/pub/NetBSD/packages/vulns/pkg-vulnerabilities</a>.
1.88      wiz      1362:     </p>
1.82      rillig   1363: <p>
1.125     wiz      1364:       Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.88      wiz      1365:       this list can be downloaded
                   1366:       automatically, and a security audit of all packages installed on a system
                   1367:       can take place.
                   1368:     </p>
1.82      rillig   1369: <p>
1.125     wiz      1370:       There are two components to auditing.  The first
                   1371:       step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
                   1372:       is for downloading
1.88      wiz      1373:       the list of vulnerabilities from the NetBSD FTP site.  The second
1.125     wiz      1374:       step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.88      wiz      1375:       installed packages are vulnerable.  If a package is vulnerable, you
                   1376:       will see output similar to the following:
                   1377:     </p>
1.82      rillig   1378: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1.289     leot     1379:     https://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1.82      rillig   1380: <p>
1.125     wiz      1381:       You may wish to have the
1.294     rillig   1382:       
                   1383:       <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.125     wiz      1384:       file downloaded daily so that
                   1385:       it remains current.  This may be done by adding an appropriate entry
1.289     leot     1386:       to the root users <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?crontab+5.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">crontab</span>(5)</span></a> entry.  For example the entry
1.125     wiz      1387:       </p>
                   1388: <pre class="screen">
1.233     sevan    1389: # Download vulnerabilities file
1.230     sevan    1390: 0 3 * * * /usr/pkg/sbin/pkg_admin fetch-pkg-vulnerabilities &gt;/dev/null 2&gt;&amp;1
1.233     sevan    1391: # Audit the installed packages and email results to root
                   1392: 9 3 * * * /usr/pkg/sbin/pkg_admin audit |mail -s "Installed package audit result" \
                   1393:            root &gt;/dev/null 2&gt;&amp;1
1.125     wiz      1394:       </pre>
                   1395: <p>
1.230     sevan    1396:       will update the vulnerability list every day at 3AM, followed by an audit
                   1397:       at 3:09AM. The result of the audit are then emailed to root.
1.125     wiz      1398: 
1.230     sevan    1399:       On NetBSD this may be accomplished instead by adding the following
                   1400:       line to <code class="filename">/etc/daily.conf</code>:
                   1401:       </p>
                   1402: <pre class="screen">
                   1403: fetch_pkg_vulnerabilities=YES
                   1404:       </pre>
                   1405: <p>
                   1406:       to fetch the vulnerability list from the daily security script. The system
                   1407:       is set to audit the packages by default but can be set explicitly, if
1.235     yyamano  1408:       desired (not required), by adding the following line to
1.230     sevan    1409: <code class="filename">/etc/security.conf</code>:
1.125     wiz      1410:       </p>
                   1411: <pre class="screen">
1.230     sevan    1412: check_pkg_vulnerabilities=YES
1.125     wiz      1413:       </pre>
                   1414: <p>
1.289     leot     1415:       see <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?daily.conf+5.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">daily.conf</span>(5)</span></a> and <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?security.conf+5.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">security.conf</span>(5)</span></a> for more details.
1.88      wiz      1416:     </p>
1.82      rillig   1417: </div>
1.148     asau     1418: <div class="sect2">
1.82      rillig   1419: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1420: <a name="pkg_versions"></a>5.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
1.82      rillig   1421: <p>
1.250     leot     1422:       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      1423:       <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">&#8220;<span class="quote">-i</span>&#8221;</span>
1.88      wiz      1424:       argument to check if your packages are up-to-date, e.g.
                   1425:     </p>
                   1426: <pre class="screen">
                   1427: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1.82      rillig   1428: ...
1.88      wiz      1429: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
                   1430:     </pre>
1.110     hubertf  1431: <p>You can then use <span class="command"><strong>make update</strong></span> to update the
1.88      wiz      1432:     package on your system and rebuild any dependencies.
                   1433:     </p>
1.82      rillig   1434: </div>
1.148     asau     1435: <div class="sect2">
1.82      rillig   1436: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1437: <a name="using.pkg_admin"></a>5.1.7. Other administrative functions</h3></div></div></div>
1.110     hubertf  1438: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.88      wiz      1439:     administrative functions on the package system.</p>
1.82      rillig   1440: </div>
1.75      rillig   1441: </div>
1.148     asau     1442: <div class="sect1">
1.75      rillig   1443: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1444: <a name="building-packages-from-source"></a>5.2. Building packages from source</h2></div></div></div>
1.88      wiz      1445: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
                   1446:   directory now contains a set of packages, organized into
                   1447:   categories. You can browse the online index of packages, or run
1.110     hubertf  1448:   <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.88      wiz      1449:   directory to build local <code class="filename">README.html</code> files for
1.250     leot     1450:   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      1451: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
                   1452:   is <code class="filename">/usr/pkg</code>. If you wish to change this, you
                   1453:   should do so by setting <code class="varname">LOCALBASE</code> in
1.110     hubertf  1454:   <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.88      wiz      1455:   different <code class="varname">LOCALBASE</code> definitions on the same
                   1456:   system (inside a chroot is an exception). </p>
                   1457: <p>The rest of this chapter assumes that the package is already
1.110     hubertf  1458:   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      1459:   instructions how to create your own packages.</p>
1.148     asau     1460: <div class="sect2">
1.75      rillig   1461: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1462: <a name="requirements"></a>5.2.1. Requirements</h3></div></div></div>
1.82      rillig   1463: <p>To build packages from source, you need a working C
1.88      wiz      1464:     compiler. On NetBSD, you need to install the
1.128     wiz      1465:     <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      1466:     sets. If you want to build X11-related packages, the
1.128     wiz      1467:     <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      1468:     sets are required, too.</p>
1.75      rillig   1469: </div>
1.148     asau     1470: <div class="sect2">
1.75      rillig   1471: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1472: <a name="fetching-distfiles"></a>5.2.2. Fetching distfiles</h3></div></div></div>
1.75      rillig   1473: <p>The first step for building a package is downloading the
1.88      wiz      1474:     distfiles (i.e. the unmodified source). If they have not yet been
                   1475:     downloaded, pkgsrc will fetch them automatically.</p>
                   1476: <p>If you have all files that you need in the
                   1477:     <code class="filename">distfiles</code> directory,
                   1478:     you don't need to connect. If the distfiles are on CD-ROM, you can
                   1479:     mount the CD-ROM on <code class="filename">/cdrom</code> and add:
                   1480:     </p>
1.82      rillig   1481: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
                   1482: <p>
1.110     hubertf  1483:     to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.91      rillig   1484: <p>By default a list of distribution sites will be randomly
                   1485:     intermixed to prevent huge load on servers which holding popular
                   1486:     packages (for example, SourceForge.net mirrors). Thus, every
                   1487:     time when you need to fetch yet another distfile all the mirrors
                   1488:     will be tried in new (random) order. You can turn this feature
                   1489:     off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
                   1490:     <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1.88      wiz      1491: <p>You can overwrite some of the major distribution sites to
                   1492:     fit to sites that are close to your own.  By setting one or two
                   1493:     variables you can modify the order in which the master sites are
                   1494:     accessed.  <code class="varname">MASTER_SORT</code> contains a whitespace
                   1495:     delimited list of domain suffixes.
                   1496:     <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
                   1497:     contains a whitespace delimited list of regular expressions.  It
                   1498:     has higher priority than <code class="varname">MASTER_SORT</code>.  Have a
                   1499:     look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
                   1500:     some examples.  This may save some of your bandwidth and
                   1501:     time.</p>
1.75      rillig   1502: <p>You can change these settings either in your shell's environment, or,
1.88      wiz      1503:     if you want to keep the settings, by editing the
1.110     hubertf  1504:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.88      wiz      1505:     and adding the definitions there.</p>
1.82      rillig   1506: <p>
1.88      wiz      1507:       If a package depends on many other packages (such as
1.250     leot     1508:       <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      1509:       alternate between periods of
                   1510:       downloading source, and compiling. To ensure you have all the source
                   1511:       downloaded initially you can run the command:
                   1512:       </p>
1.82      rillig   1513: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
                   1514: <p>
1.88      wiz      1515:       which will output and run a set of shell commands to fetch the
                   1516:       necessary files into the <code class="filename">distfiles</code> directory.  You can
                   1517:       also choose to download the files manually.
                   1518:     </p>
1.75      rillig   1519: </div>
1.148     asau     1520: <div class="sect2">
1.75      rillig   1521: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1522: <a name="how-to-build-and-install"></a>5.2.3. How to build and install</h3></div></div></div>
1.82      rillig   1523: <p>
1.88      wiz      1524:       Once the software has downloaded, any patches will be applied, then it
                   1525:       will be compiled for you. This may take some time depending on your
                   1526:       computer, and how many other packages the software depends on and their
                   1527:       compile time.
                   1528:     </p>
1.148     asau     1529: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   1530: <h3 class="title">Note</h3>
                   1531: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.110     hubertf  1532:     use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.128     wiz      1533:     <span class="quote">&#8220;<span class="quote">make</span>&#8221;</span> in the examples in this guide.</p>
1.75      rillig   1534: </div>
1.87      wiz      1535: <p>For example, type</p>
1.88      wiz      1536: <pre class="screen">
                   1537: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
                   1538: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   1539:     </pre>
1.75      rillig   1540: <p>at the shell prompt to build the various components of the
1.88      wiz      1541:     package.</p>
1.82      rillig   1542: <p>The next stage is to actually install the newly compiled
1.88      wiz      1543:     program onto your system. Do this by entering:
1.82      rillig   1544: 
1.88      wiz      1545:     </p>
1.82      rillig   1546: <pre class="screen">
1.88      wiz      1547: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
                   1548:     </pre>
1.82      rillig   1549: <p>
                   1550: 
1.88      wiz      1551:     while you are still in the directory for whatever package you
                   1552:     are installing.</p>
1.82      rillig   1553: <p>Installing the package on your system may require you to
1.88      wiz      1554:     be root.  However, pkgsrc has a
                   1555:     <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
                   1556:     to only become root for the actual installation step.</p>
1.82      rillig   1557: <p>That's it, the software should now be installed and setup for use.
1.88      wiz      1558:     You can now enter:
1.82      rillig   1559: 
1.88      wiz      1560:     </p>
1.82      rillig   1561: <pre class="screen">
1.88      wiz      1562: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
                   1563:     </pre>
1.82      rillig   1564: <p>
                   1565: 
1.88      wiz      1566:     to remove the compiled files in the work directory, as you shouldn't need
                   1567:     them any more. If other packages were also added to your system
                   1568:     (dependencies) to allow your program to compile, you can tidy these up
                   1569:     also with the command:</p>
1.82      rillig   1570: <pre class="screen">
1.88      wiz      1571: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
                   1572:     </pre>
1.75      rillig   1573: <p>Taking the figlet utility as an example, we can install it on our
1.110     hubertf  1574:     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      1575: <p>The program is installed under the default root of the
                   1576:     packages tree - <code class="filename">/usr/pkg</code>. Should this not
                   1577:     conform to your tastes, set the <code class="varname">LOCALBASE</code>
                   1578:     variable in your environment, and it will use that value as the
                   1579:     root of your packages tree. So, to use
                   1580:     <code class="filename">/usr/local</code>, set
                   1581:     <code class="varname">LOCALBASE=/usr/local</code> in your environment.
                   1582:     Please note that you should use a directory which is dedicated to
                   1583:     packages and not shared with other programs (i.e., do not try and
                   1584:     use <code class="varname">LOCALBASE=/usr</code>).  Also, you should not try
                   1585:     to add any of your own files or directories (such as
                   1586:     <code class="filename">src/</code>, <code class="filename">obj/</code>, or
                   1587:     <code class="filename">pkgsrc/</code>) below the
                   1588:     <code class="varname">LOCALBASE</code> tree.  This is to prevent possible
                   1589:     conflicts between programs and other files installed by the
                   1590:     package system and whatever else may have been installed
                   1591:     there.</p>
1.110     hubertf  1592: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.88      wiz      1593:     alter some configuration options at build time.  Have a look at
                   1594:     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
                   1595:     of what will be set there by default.  Environment variables such
                   1596:     as <code class="varname">LOCALBASE</code> can be set in
1.110     hubertf  1597:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.88      wiz      1598:     set them each time you want to use pkgsrc.</p>
1.128     wiz      1599: <p>Occasionally, people want to <span class="quote">&#8220;<span class="quote">look under the
                   1600:     covers</span>&#8221;</span> to see what is going on when a package is building
1.88      wiz      1601:     or being installed. This may be for debugging purposes, or out of
                   1602:     simple curiosity. A number of utility values have been added to
                   1603:     help with this.</p>
1.128     wiz      1604: <div class="orderedlist"><ol class="orderedlist" type="1">
                   1605: <li class="listitem">
1.289     leot     1606: <p>If you invoke the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> command with
1.88      wiz      1607:        <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
                   1608:        information will be displayed. For example,</p>
1.75      rillig   1609: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1.88      wiz      1610: <p>will show all the commands that are invoked, up to and
1.128     wiz      1611:        including the <span class="quote">&#8220;<span class="quote">patch</span>&#8221;</span> stage.</p>
1.75      rillig   1612: </li>
1.128     wiz      1613: <li class="listitem">
1.289     leot     1614: <p>If you want to know the value of a certain <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88      wiz      1615:        definition, then the <code class="varname">VARNAME</code> definition
                   1616:        should be used, in conjunction with the show-var
1.289     leot     1617:        target. e.g. to show the expansion of the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88      wiz      1618:        variable <code class="varname">LOCALBASE</code>:</p>
                   1619: <pre class="screen">
                   1620: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1.75      rillig   1621: /usr/pkg
                   1622: <code class="prompt">%</code>
1.88      wiz      1623:        </pre>
1.75      rillig   1624: </li>
                   1625: </ol></div>
                   1626: <p>If you want to install a binary package that you've either
1.88      wiz      1627:     created yourself (see next section), that you put into
                   1628:     pkgsrc/packages manually or that is located on a remote FTP
                   1629:     server, you can use the "bin-install" target. This target will
1.289     leot     1630:     install a binary package - if available - via <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>,
1.110     hubertf  1631:     else do a <span class="command"><strong>make package</strong></span>.  The list of remote FTP
1.88      wiz      1632:     sites searched is kept in the variable
                   1633:     <code class="varname">BINPKG_SITES</code>, which defaults to
1.289     leot     1634:     ftp.NetBSD.org. Any flags that should be added to <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>
1.88      wiz      1635:     can be put into <code class="varname">BIN_INSTALL_FLAGS</code>.  See
                   1636:     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
                   1637:     details.</p>
                   1638: <p>A final word of warning: If you set up a system that has a
                   1639:     non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
                   1640:     set that before any packages are installed, as you cannot use
                   1641:     several directories for the same purpose. Doing so will result in
                   1642:     pkgsrc not being able to properly detect your installed packages,
                   1643:     and fail miserably. Note also that precompiled binary packages are
                   1644:     usually built with the default <code class="varname">LOCALBASE</code> of
                   1645:     <code class="filename">/usr/pkg</code>, and that you should
                   1646:     <span class="emphasis"><em>not</em></span> install any if you use a non-standard
                   1647:     <code class="varname">LOCALBASE</code>.</p>
1.75      rillig   1648: </div>
                   1649: </div>
                   1650: </div>
1.148     asau     1651: <div class="chapter">
1.75      rillig   1652: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   1653: <a name="configuring"></a>Chapter 6. Configuring pkgsrc</h2></div></div></div>
1.75      rillig   1654: <div class="toc">
                   1655: <p><b>Table of Contents</b></p>
1.210     leot     1656: <dl class="toc">
1.267     rillig   1657: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
                   1658: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
                   1659: <dt><span class="sect1"><a href="#variables-affecting-installation">6.3. Variables affecting the installation process</a></span></dt>
                   1660: <dt><span class="sect1"><a href="#conf.compiler">6.4. Selecting and configuring the compiler</a></span></dt>
                   1661: <dd><dl>
                   1662: <dt><span class="sect2"><a href="#selecting-the-compiler">6.4.1. Selecting the compiler</a></span></dt>
                   1663: <dt><span class="sect2"><a href="#conf.cflags">6.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                   1664: <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      1665: </dl></dd>
1.267     rillig   1666: <dt><span class="sect1"><a href="#developer-advanced-settings">6.5. Developer/advanced settings</a></span></dt>
                   1667: <dt><span class="sect1"><a href="#selecting-build-options">6.6. Selecting Build Options</a></span></dt>
1.75      rillig   1668: </dl>
                   1669: </div>
1.104     rillig   1670: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.89      rillig   1671: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
                   1672: that file depends on the installation. On NetBSD, when you use
1.289     leot     1673: <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> from the base system, it is in the directory
1.89      rillig   1674: <code class="filename">/etc/</code>. In all other cases the default location is
                   1675: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
                   1676: bootstrap program to install the binary packages.</p>
                   1677: <p>The format of the configuration file is that of the usual
                   1678: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
                   1679: is done by setting variables in this file. Note that you can define all
                   1680: kinds of variables, and no special error checking (for example for
1.223     rillig   1681: spelling mistakes) takes place.</p>
1.148     asau     1682: <div class="sect1">
1.75      rillig   1683: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1684: <a name="general-configuration"></a>6.1. General configuration</h2></div></div></div>
1.223     rillig   1685: <p>The following variables apply to all
1.89      rillig   1686:     pkgsrc packages. A complete list of the variables that can be
                   1687:     configured by the user is available in
                   1688:     <code class="filename">mk/defaults/mk.conf</code>, together with some
                   1689:     comments that describe each variable's intent.</p>
1.148     asau     1690: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1691: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.75      rillig   1692:            packages will be installed. The default is
1.76      rillig   1693:            <code class="filename">/usr/pkg</code>. Do not mix binary packages
1.75      rillig   1694:            with different <code class="varname">LOCALBASE</code>s!</p></li>
1.128     wiz      1695: <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
                   1696:            <span class="quote">&#8220;<span class="quote">cross</span>&#8221;</span> category packages will be
1.75      rillig   1697:            installed. The default is
1.76      rillig   1698:            <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.128     wiz      1699: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.75      rillig   1700:            X11 is installed on the system. The default is
1.194     bsiegert 1701:            <code class="filename">/usr/X11R7</code>.</p></li>
1.128     wiz      1702: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.75      rillig   1703:            downloaded copies of the original source distributions used
                   1704:            for building pkgsrc packages. The default is
1.76      rillig   1705:            <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.128     wiz      1706: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.97      rillig   1707:            database about installed packages is stored.  The default is
1.230     sevan    1708:            <code class="filename">/usr/pkg/pkgdb</code>.</p></li>
1.128     wiz      1709: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.75      rillig   1710:            If set, override the packages'
                   1711:            <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.128     wiz      1712: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.75      rillig   1713:            Backup location(s) for distribution files and patch files
                   1714:            if not found locally or in
1.76      rillig   1715:            <code class="filename">${MASTER_SITES}</code> or
                   1716:            <code class="filename">${PATCH_SITES}</code> respectively.
1.230     sevan    1717:            The defaults is
                   1718:            <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.128     wiz      1719: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.93      rillig   1720:            List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
                   1721:            <em class="replaceable"><code>arch</code></em> are replaced with OS
1.128     wiz      1722:            release (<span class="quote">&#8220;<span class="quote">2.0</span>&#8221;</span>, etc.) and architecture
                   1723:            (<span class="quote">&#8220;<span class="quote">mipsel</span>&#8221;</span>, etc.).</p></li>
                   1724: <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.125     wiz      1725:            List of acceptable licenses. License names are case-sensitive.
                   1726:            Whenever you try to build a package whose license is not in this
                   1727:            list, you will get an error message. If the license condition is
                   1728:            simple enough, the error message will include specific
                   1729:            instructions on how to change this variable.</p></li>
1.75      rillig   1730: </ul></div>
                   1731: </div>
1.148     asau     1732: <div class="sect1">
1.75      rillig   1733: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1734: <a name="variables-affecting-build"></a>6.2. Variables affecting the build process</h2></div></div></div>
1.219     rillig   1735: <p>
1.75      rillig   1736:       </p>
1.148     asau     1737: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1738: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.75      rillig   1739:            directory for the binary packages. The default is
1.76      rillig   1740:            <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.128     wiz      1741: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.75      rillig   1742:            The top level directory where, if defined, the separate
                   1743:            working directories will get created, and symbolically
1.76      rillig   1744:            linked to from <code class="filename">${WRKDIR}</code> (see below).
1.75      rillig   1745:            This is useful for building packages on several
1.76      rillig   1746:            architectures, then <code class="filename">${PKGSRCDIR}</code>
                   1747:            can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1.75      rillig   1748:            is local to every architecture. (It should be noted that
                   1749:            <code class="varname">PKGSRCDIR</code> should not be set by the user
1.126     jakllsch 1750:            &mdash; it is an internal definition which refers to the
1.75      rillig   1751:            root of the pkgsrc tree. It is possible to have many
                   1752:            pkgsrc tree instances.)</p></li>
1.128     wiz      1753: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.75      rillig   1754:            Directory for local patches that aren't part of pkgsrc.
1.299     rillig   1755:            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   1756:            information.</p></li>
1.128     wiz      1757: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.110     hubertf  1758:            the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.75      rillig   1759:            BSD-style Makefile. If this is not set,
                   1760:            <code class="varname">MAKECONF</code> is set to
1.76      rillig   1761:            <code class="filename">/dev/null</code> to avoid picking up
                   1762:            settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.75      rillig   1763: </ul></div>
                   1764: </div>
1.148     asau     1765: <div class="sect1">
1.75      rillig   1766: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1767: <a name="variables-affecting-installation"></a>6.3. Variables affecting the installation process</h2></div></div></div>
1.256     maya     1768: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><code class="varname">PKGSRC_KEEP_BIN_PKGSRC</code>:
                   1769:                 By default, binary packages of built packages are
1.263     leot     1770:                 preserved in <code class="filename">${PACKAGES}/All</code>. Setting
1.256     maya     1771:                this variable to "no" prevents this.</p></li></ul></div>
1.217     jnemeth  1772: <p>Packages have to support installation into a
1.103     wiz      1773:     subdirectory of <code class="varname">WRKDIR</code>. This allows a package
                   1774:     to be built, before the actual filesystem is touched. DESTDIR
                   1775:     support exists in two variations:</p>
1.148     asau     1776: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1777: <li class="listitem"><p>Basic DESTDIR support means that the package
1.131     wiz      1778:       installation and packaging is still run as root.</p></li>
                   1779: <li class="listitem"><p>Full DESTDIR support can run the complete
                   1780:       build, installation and packaging as normal user. Root
                   1781:       privileges are only needed to add packages.</p></li>
                   1782: </ul></div>
1.103     wiz      1783: <p>With basic DESTDIR support, <strong class="userinput"><code>make
                   1784:     clean</code></strong> needs to be run as root.</p>
1.118     imil     1785: <p>Considering the <code class="filename">foo/bar</code> package,
                   1786:     DESTDIR full support can be tested using the following commands
                   1787: 
                   1788: </p>
                   1789: <pre class="programlisting">
                   1790: <code class="prompt">$</code> id
                   1791: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
                   1792: <code class="prompt">$</code> mkdir $HOME/packages
                   1793: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
                   1794: </pre>
                   1795: <p>
                   1796: 
                   1797:     Verify <code class="varname">DESTDIR</code> full support, no root privileges
                   1798:     should be needed
                   1799: 
                   1800: </p>
                   1801: <pre class="programlisting">
1.174     asau     1802: <code class="prompt">$</code> make stage-install
1.118     imil     1803: </pre>
                   1804: <p>
                   1805: 
                   1806:     Create a package without root privileges
                   1807: 
                   1808: </p>
                   1809: <pre class="programlisting">
1.174     asau     1810: <code class="prompt">$</code> make PACKAGES=$HOME/packages package
1.118     imil     1811: </pre>
                   1812: <p>
                   1813: 
                   1814:     For the following command, you must be able to gain root
1.289     leot     1815:     privileges using <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?su+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a>
1.118     imil     1816: 
                   1817: </p>
                   1818: <pre class="programlisting">
1.174     asau     1819: <code class="prompt">$</code> make PACKAGES=$HOME/packages install
1.118     imil     1820: </pre>
                   1821: <p>
                   1822: 
                   1823:     Then, as a simple user
                   1824: 
                   1825: </p>
                   1826: <pre class="programlisting">
                   1827: <code class="prompt">$</code> make clean
                   1828: </pre>
                   1829: <p>
                   1830: 
                   1831:     </p>
1.103     wiz      1832: </div>
1.148     asau     1833: <div class="sect1">
1.103     wiz      1834: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1835: <a name="conf.compiler"></a>6.4. Selecting and configuring the compiler</h2></div></div></div>
1.148     asau     1836: <div class="sect2">
1.78      rillig   1837: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1838: <a name="selecting-the-compiler"></a>6.4.1. Selecting the compiler</h3></div></div></div>
1.89      rillig   1839: <p>By default, pkgsrc will use GCC to build packages.  This may be
                   1840:     overridden by setting the following variables in /etc/mk.conf:</p>
1.148     asau     1841: <div class="variablelist"><dl class="variablelist">
1.89      rillig   1842: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
                   1843: <dd>
                   1844: <p>This is a list of values specifying the chain of
                   1845:          compilers to invoke when building packages.  Valid values
                   1846:          are:</p>
1.148     asau     1847: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.174     asau     1848: <li class="listitem"><p><code class="varname">ccc</code>:
                   1849:            Compaq C Compilers (Tru64)</p></li>
                   1850: <li class="listitem"><p><code class="varname">ccache</code>:
                   1851:            compiler cache (chainable)</p></li>
                   1852: <li class="listitem"><p><code class="varname">clang</code>:
                   1853:            Clang C and Objective-C compiler</p></li>
1.128     wiz      1854: <li class="listitem"><p><code class="varname">distcc</code>:
1.89      rillig   1855:            distributed C/C++ (chainable)</p></li>
1.174     asau     1856: <li class="listitem"><p><code class="varname">f2c</code>:
                   1857:            Fortran 77 to C compiler (chainable)</p></li>
                   1858: <li class="listitem"><p><code class="varname">icc</code>:
                   1859:            Intel C++ Compiler (Linux)</p></li>
                   1860: <li class="listitem"><p><code class="varname">ido</code>:
                   1861:            SGI IRIS Development Option cc (IRIX 5)</p></li>
1.128     wiz      1862: <li class="listitem"><p><code class="varname">gcc</code>:
1.89      rillig   1863:            GNU C/C++ Compiler</p></li>
1.174     asau     1864: <li class="listitem"><p><code class="varname">hp</code>:
                   1865:            HP-UX C/aC++ compilers</p></li>
1.128     wiz      1866: <li class="listitem"><p><code class="varname">mipspro</code>:
1.89      rillig   1867:            Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.174     asau     1868: <li class="listitem"><p><code class="varname">mipspro-ucode</code>:
1.89      rillig   1869:            Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.128     wiz      1870: <li class="listitem"><p><code class="varname">sunpro</code>:
1.89      rillig   1871:            Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
1.174     asau     1872: <li class="listitem"><p><code class="varname">xlc</code>:
1.230     sevan    1873:            IBM's XL C/C++ compiler suite</p></li>
1.89      rillig   1874: </ul></div>
                   1875: <p>The default is
1.128     wiz      1876:          <span class="quote">&#8220;<span class="quote"><code class="varname">gcc</code></span>&#8221;</span>.  You can use
1.89      rillig   1877:          <code class="varname">ccache</code> and/or
                   1878:          <code class="varname">distcc</code> with an appropriate
                   1879:          <code class="varname">PKGSRC_COMPILER</code> setting,
1.128     wiz      1880:          e.g. <span class="quote">&#8220;<span class="quote"><code class="varname">ccache gcc</code></span>&#8221;</span>.  This
1.94      dmcmahil 1881:          variable should always be terminated with a value for
                   1882:          a real compiler.  Note that only one real compiler
1.128     wiz      1883:          should be listed (e.g. <span class="quote">&#8220;<span class="quote"><code class="varname">sunpro gcc</code></span>&#8221;</span>
1.94      dmcmahil 1884:          is not allowed).</p>
1.89      rillig   1885: </dd>
                   1886: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
                   1887: <dd><p>This specifies the minimum version of GCC to use
                   1888:          when building packages.  If the system GCC doesn't
                   1889:          satisfy this requirement, then pkgsrc will build and
                   1890:          install one of the GCC packages to use instead.</p></dd>
1.266     leot     1891: <dt><span class="term"><code class="varname">PYTHON_VERSION_DEFAULT</code>:</span></dt>
1.225     maya     1892: <dd><p>Specifies which version of python to use when several
                   1893:          options are available.</p></dd>
                   1894: <dt><span class="term"><code class="varname">PKGSRC_FORTRAN</code>:</span></dt>
1.291     gutterid 1895: <dd><p>Specifies the Fortran compiler to use.
                   1896:          The default is <code class="varname">gfortran</code>.</p></dd>
1.225     maya     1897: <dt><span class="term"><code class="varname">GFORTRAN_VERSION</code>:</span></dt>
                   1898: <dd><p>If <code class="varname">PKGSRC_FORTRAN</code><code class="literal">=</code>
                   1899:          <code class="varname">gfortran</code> is used, this option specifies which
                   1900:          version to use.</p></dd>
1.89      rillig   1901: </dl></div>
                   1902: </div>
1.148     asau     1903: <div class="sect2">
1.89      rillig   1904: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1905: <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   1906: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
                   1907:        please make sure to use the <code class="literal">+=</code> operator
                   1908:        instead of the <code class="literal">=</code> operator:</p>
                   1909: <pre class="programlisting">
1.100     rillig   1910: CFLAGS+=        -your -flags
1.78      rillig   1911: </pre>
                   1912: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.128     wiz      1913:        <span class="quote">&#8220;<span class="quote">+</span>&#8221;</span>) may lead to problems with packages that
1.117     jnemeth  1914:        need to add their own flags.  You may want to take a look
1.250     leot     1915:        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      1916:        package if you're interested in optimization specifically
                   1917:        for the current CPU. </p>
1.78      rillig   1918: </div>
1.148     asau     1919: <div class="sect2">
1.88      wiz      1920: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1921: <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      1922: <p>If you want to pass flags to the linker, both in the configure
                   1923: step and the build step, you can do this in two ways.  Either set
                   1924: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>.  The difference
                   1925: between the two is that <code class="varname">LIBS</code> will be appended to
                   1926: the command line, while <code class="varname">LDFLAGS</code> come earlier.
                   1927: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
                   1928: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
                   1929: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>.  As with
                   1930: <code class="varname">CFLAGS</code>, if you do not wish to override these
                   1931: settings, use the <code class="literal">+=</code> operator:</p>
                   1932: <pre class="programlisting">
1.100     rillig   1933: LDFLAGS+=        -your -linkerflags
1.88      wiz      1934: </pre>
                   1935: </div>
1.78      rillig   1936: </div>
1.148     asau     1937: <div class="sect1">
1.78      rillig   1938: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1939: <a name="developer-advanced-settings"></a>6.5. Developer/advanced settings</h2></div></div></div>
1.194     bsiegert 1940: <p>
1.75      rillig   1941:       </p>
1.148     asau     1942: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1943: <li class="listitem">
1.75      rillig   1944: <p><code class="varname">PKG_DEVELOPER</code>:
                   1945:            Run some sanity checks that package developers want:
                   1946:            </p>
1.148     asau     1947: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.128     wiz      1948: <li class="listitem"><p>make sure patches apply with zero
1.88      wiz      1949:              fuzz</p></li>
1.128     wiz      1950: <li class="listitem"><p>run check-shlibs to see that all
1.88      wiz      1951:              binaries will find their shared libs.</p></li>
1.75      rillig   1952: </ul></div>
                   1953: <p>
1.87      wiz      1954:        </p>
1.75      rillig   1955: </li>
1.128     wiz      1956: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.88      wiz      1957:        of debugging output which is displayed whilst making and
                   1958:        installing the package.  The default value for this is 0,
                   1959:        which will not display the commands as they are executed
                   1960:        (normal, default, quiet operation); the value 1 will display
                   1961:        all shell commands before their invocation, and the value 2
                   1962:        will display both the shell commands before their invocation,
1.223     rillig   1963:        as well as their actual execution progress with <span class="command"><strong>set
                   1964:        -x</strong></span>.</p></li>
1.75      rillig   1965: </ul></div>
                   1966: <p>
                   1967:     </p>
                   1968: </div>
1.148     asau     1969: <div class="sect1">
1.75      rillig   1970: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1971: <a name="selecting-build-options"></a>6.6. Selecting Build Options</h2></div></div></div>
1.88      wiz      1972: <p>Some packages have build time options, usually to select
                   1973:     between different dependencies, enable optional support for big
                   1974:     dependencies or enable experimental features.</p>
1.75      rillig   1975: <p>To see which options, if any, a package supports, and which
1.110     hubertf  1976:     options are mutually exclusive, run <span class="command"><strong>make
1.88      wiz      1977:     show-options</strong></span>, for example:</p>
1.75      rillig   1978: <pre class="programlisting">
                   1979:     The following options are supported by this package:
                   1980:         ssl      Enable SSL support.
                   1981:     Exactly one of the following gecko options is required:
                   1982:         firefox  Use firefox as gecko rendering engine.
                   1983:         mozilla  Use mozilla as gecko rendering engine.
                   1984:     At most one of the following database options may be selected:
                   1985:         mysql    Enable support for MySQL database.
                   1986:         pgsql    Enable support for PostgreSQL database.
1.1       grant    1987: 
1.75      rillig   1988:     These options are enabled by default: firefox
                   1989:     These options are currently enabled: mozilla ssl
1.1       grant    1990: </pre>
1.75      rillig   1991: <p>The following variables can be defined in
1.110     hubertf  1992:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.88      wiz      1993:     enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
                   1994:     which can be used to select or disable options for all packages
                   1995:     that support them, and
                   1996:     <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
                   1997:     which can be used to select or disable options specifically for
                   1998:     package <em class="replaceable"><code>pkgbase</code></em>.  Options listed in
1.128     wiz      1999:     these variables are selected, options preceded by <span class="quote">&#8220;<span class="quote">-</span>&#8221;</span>
1.88      wiz      2000:     are disabled. A few examples:</p>
1.75      rillig   2001: <pre class="screen">
1.110     hubertf  2002: <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   2003: PKG_DEFAULT_OPTIONS=    -arts -dvdread -esound
                   2004: PKG_OPTIONS.kdebase=    debug -sasl
                   2005: PKG_OPTIONS.apache=     suexec </pre>
1.111     rillig   2006: <p>It is important to note that options that were specifically
1.120     snj      2007:     suggested by the package maintainer must be explicitly removed if
1.111     rillig   2008:     you do not wish to include the option.  If you are unsure you can view
                   2009:     the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.88      wiz      2010: <p>The following settings are consulted in the order given, and
                   2011:     the last setting that selects or disables an option is
                   2012:     used:</p>
1.128     wiz      2013: <div class="orderedlist"><ol class="orderedlist" type="1">
                   2014: <li class="listitem"><p>the default options as suggested by the package
1.88      wiz      2015:       maintainer</p></li>
1.128     wiz      2016: <li class="listitem"><p>the options implied by the settings of legacy
1.88      wiz      2017:       variables (see below)</p></li>
1.128     wiz      2018: <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
                   2019: <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
1.75      rillig   2020: </ol></div>
                   2021: <p>For groups of mutually exclusive options, the last option
1.88      wiz      2022:     selected is used, all others are automatically disabled.  If an
                   2023:     option of the group is explicitly disabled, the previously
                   2024:     selected option, if any, is used.  It is an error if no option
                   2025:     from a required group of options is selected, and building the
                   2026:     package will fail.</p>
                   2027: <p>Before the options framework was introduced, build options
                   2028:     were selected by setting a variable (often named
                   2029:     <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.110     hubertf  2030:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option.  To ease
1.88      wiz      2031:     transition to the options framework for the user, these legacy
                   2032:     variables are converted to the appropriate options setting
                   2033:     (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
                   2034:     automatically.  A warning is issued to prompt the user to update
1.110     hubertf  2035:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.88      wiz      2036:     directly.  Support for the legacy variables will be removed
                   2037:     eventually.</p>
1.75      rillig   2038: </div>
                   2039: </div>
1.148     asau     2040: <div class="chapter">
1.75      rillig   2041: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   2042: <a name="binary"></a>Chapter 7. Creating binary packages</h2></div></div></div>
1.75      rillig   2043: <div class="toc">
                   2044: <p><b>Table of Contents</b></p>
1.210     leot     2045: <dl class="toc">
1.267     rillig   2046: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
                   2047: <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   2048: </dl>
                   2049: </div>
1.148     asau     2050: <div class="sect1">
1.75      rillig   2051: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2052: <a name="building-a-single-binary-package"></a>7.1. Building a single binary package</h2></div></div></div>
1.87      wiz      2053: <p>Once you have built and installed a package, you can create
                   2054:     a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.289     leot     2055:     another system with <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. This saves having to build
1.87      wiz      2056:     the same package on a group of hosts and wasting CPU time. It also
                   2057:     provides a simple means for others to install your package, should
                   2058:     you distribute it.</p>
                   2059: <p>To create a binary package, change into the appropriate
1.110     hubertf  2060:     directory in pkgsrc, and run <span class="command"><strong>make
1.87      wiz      2061:     package</strong></span>:</p>
                   2062: <pre class="screen">
1.223     rillig   2063: <code class="prompt">$</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
                   2064: <code class="prompt">$</code> <strong class="userinput"><code>make package</code></strong>
                   2065: </pre>
1.87      wiz      2066: <p>This will build and install your package (if not already done),
                   2067:     and then build a binary package from what was installed. You can
1.110     hubertf  2068:     then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.87      wiz      2069:     it. Binary packages are created by default in
                   2070:     <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.110     hubertf  2071:     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     2072:     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   2073: <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      2074:     such a binary package.</p>
1.75      rillig   2075: </div>
1.148     asau     2076: <div class="sect1">
1.75      rillig   2077: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2078: <a name="settings-for-creationg-of-binary-packages"></a>7.2. Settings for creation of binary packages</h2></div></div></div>
1.299     rillig   2079: <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   2080: </div>
                   2081: </div>
1.148     asau     2082: <div class="chapter">
1.106     rillig   2083: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   2084: <a name="bulk"></a>Chapter 8. Creating binary packages for everything in pkgsrc (bulk
1.106     rillig   2085: builds)</h2></div></div></div>
                   2086: <div class="toc">
                   2087: <p><b>Table of Contents</b></p>
1.210     leot     2088: <dl class="toc">
1.267     rillig   2089: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
1.295     rillig   2090: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a bulk build</a></span></dt>
1.267     rillig   2091: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
                   2092: <dt><span class="sect1"><a href="#bulk.req">8.3. Requirements of a full bulk build</a></span></dt>
1.293     rillig   2093: <dt><span class="sect1"><a href="#bulk.var">8.4. Bulk build variants</a></span></dt>
                   2094: <dd><dl>
1.294     rillig   2095: <dt><span class="sect2"><a href="#bulk.var.confopt">8.4.1. Detect unknown configure options</a></span></dt>
                   2096: <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   2097: <dt><span class="sect2"><a href="#bulk.var.builderr">8.4.3. Force compiler options only in the build phase</a></span></dt>
                   2098: <dt><span class="sect2"><a href="#bulk.var.dirs">8.4.4. Use custom directories</a></span></dt>
                   2099: <dt><span class="sect2"><a href="#bulk.var.warn">8.4.5. Turn warnings into errors</a></span></dt>
                   2100: <dt><span class="sect2"><a href="#bulk.var.pkglint">8.4.6. Reject packages for which pkglint reports errors</a></span></dt>
                   2101: <dt><span class="sect2"><a href="#bulk.var.strings">8.4.7. Reject packages that contain forbidden strings</a></span></dt>
                   2102: <dt><span class="sect2"><a href="#bulk.var.test">8.4.8. Reject packages whose self-test fails</a></span></dt>
                   2103: <dt><span class="sect2"><a href="#bulk.var.shvar">8.4.9. Reject packages that use undefined shell variables</a></span></dt>
                   2104: <dt><span class="sect2"><a href="#bulk.var.quiet">8.4.10. Turn off verbose logging</a></span></dt>
1.293     rillig   2105: </dl></dd>
                   2106: <dt><span class="sect1"><a href="#creating-cdroms">8.5. Creating a multiple CD-ROM packages collection</a></span></dt>
                   2107: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.5.1. Example of cdpack</a></span></dt></dl></dd>
1.106     rillig   2108: </dl>
                   2109: </div>
1.290     gutterid 2110: <p>For a number of reasons, you may want to build binary packages
                   2111: for a large selected set of packages in pkgsrc, or even for all pkgsrc packages.
1.180     wiz      2112: For instance, when you have multiple machines that should run the same software,
                   2113: it is wasted time if they all build their packages themselves from source.
                   2114: Or you may want to build a list of packages you want and check them before
1.290     gutterid 2115: deploying onto production systems.
1.180     wiz      2116: There is a way of getting a set of binary packages:
1.290     gutterid 2117: the bulk build system, or pbulk ("p" stands for "parallel").
1.223     rillig   2118: This chapter describes how to set it up.</p>
1.148     asau     2119: <div class="sect1">
1.106     rillig   2120: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2121: <a name="bulk.pre"></a>8.1. Preparations</h2></div></div></div>
1.180     wiz      2122: <p>First of all, you have to decide whether you build all packages
                   2123: or a limited set of them. Full bulk builds usually consume a lot more resources,
                   2124: both space and time, than builds for some practical sets of packages.
1.290     gutterid 2125: A number of particularly heavy packages exist that are not actually
                   2126: interesting to a wide audience. (The approximate resource consumption for a
                   2127: 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>.)
                   2128: For limited bulk builds you need to make a list of packages you want to build.
1.223     rillig   2129: Note that all their dependencies will be built, so you don't need to track them manually.
1.180     wiz      2130: </p>
                   2131: <p>During bulk builds various packages are installed and deinstalled
                   2132: in <code class="filename">/usr/pkg</code> (or whatever <code class="filename">LOCALBASE</code> is),
                   2133: so make sure that you don't need any package during the builds.
1.223     rillig   2134: Essentially, you should provide a fresh system, either a chroot environment
1.180     wiz      2135: or something even more restrictive, depending on what the operating system provides,
                   2136: or dedicate the whole physical machine.
                   2137: As a useful side effect this makes sure that bulk builds cannot
                   2138: break anything in your system. There have been numerous cases where
1.106     rillig   2139: certain packages tried to install files outside the
                   2140: <code class="filename">LOCALBASE</code> or wanted to edit some files in
1.180     wiz      2141: <code class="filename">/etc</code>.
                   2142: </p>
1.106     rillig   2143: </div>
1.148     asau     2144: <div class="sect1">
1.106     rillig   2145: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.295     rillig   2146: <a name="bulk.pbulk"></a>8.2. Running a bulk build</h2></div></div></div>
                   2147: <p>Running a bulk build works roughly as follows:</p>
1.148     asau     2148: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2149: <li class="listitem"><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
                   2150: <li class="listitem"><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
1.116     rillig   2151: </ul></div>
1.148     asau     2152: <div class="sect2">
1.116     rillig   2153: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   2154: <a name="bulk.pbulk.conf"></a>8.2.1. Configuration</h3></div></div></div>
1.223     rillig   2155: <p>To simplify configuration, we provide the helper script <code class="filename">mk/pbulk/pbulk.sh</code>.</p>
1.178     asau     2156: <p>In order to use it, prepare a clear system (real one, chroot environment, jail, zone, virtual machine).
                   2157: Configure network access to fetch distribution files.
1.223     rillig   2158: Create a user with name "pbulk".</p>
1.178     asau     2159: <p>Fetch and extract pkgsrc. Use a command like one of these:</p>
                   2160: <pre class="screen">
1.264     sevan    2161: <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>
                   2162: <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      2163: <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     2164: </pre>
                   2165: <p>Or any other way that fits (e.g., curl, wget).</p>
                   2166: <p>Deploy and configure pbulk tools, e.g.:</p>
                   2167: <pre class="screen">
1.230     sevan    2168: <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     2169: <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>
                   2170: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -nlc mk.conf.frag # native, apply settings, configure for limited build</code></strong>
                   2171: </pre>
                   2172: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2173: <h3 class="title">Note</h3>
                   2174: <p><code class="filename">mk.conf.frag</code> is a fragment of
                   2175: <code class="filename">mk.conf</code> that contains settings you want to
                   2176: apply to packages you build. For instance,</p>
                   2177: <pre class="programlisting">
1.223     rillig   2178: PKG_DEVELOPER=          yes     # perform more checks
                   2179: X11_TYPE=               modular # use pkgsrc X11
                   2180: SKIP_LICENSE_CHECK=     yes     # accept all licences (useful
                   2181:                                 # when building all packages)
1.178     asau     2182: </pre>
                   2183: </div>
                   2184: <p>If configured for limited list, replace the list in <code class="filename">/usr/pbulk/etc/pbulk.list</code>
1.223     rillig   2185: with your list of packages, one per line without empty lines or comments. E.g.:</p>
1.178     asau     2186: <pre class="programlisting">
                   2187: www/firefox
                   2188: mail/thunderbird
                   2189: misc/libreoffice4
                   2190: </pre>
1.179     asau     2191: <p>At this point you can also review configuration in <code class="filename">/usr/pbulk/etc</code>
                   2192: and make final amendments, if wanted.</p>
1.178     asau     2193: <p>Start it:</p>
                   2194: <pre class="screen">
                   2195: <code class="prompt">#</code> <strong class="userinput"><code>/usr/pbulk/bin/bulkbuild</code></strong>
                   2196: </pre>
                   2197: <p>After it finishes, you'll have <code class="filename">/mnt</code> filled with distribution files, binary packages, and reports,
                   2198: plain text summary in <code class="filename">/mnt/bulklog/meta/report.txt</code>
                   2199: </p>
                   2200: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2201: <h3 class="title">Note</h3>
                   2202: <p>The <code class="filename">pbulk.sh</code> script does not cover all possible use cases.
                   2203: While being ready to run, it serves as a good starting point to understand and build more complex setups.
                   2204: The script is kept small enough for better understanding.</p>
                   2205: </div>
                   2206: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2207: <h3 class="title">Note</h3>
                   2208: <p>The <code class="filename">pbulk.sh</code> script supports running
                   2209: unprivileged bulk build and helps configuring distributed bulk builds.</p>
                   2210: </div>
1.106     rillig   2211: </div>
                   2212: </div>
1.148     asau     2213: <div class="sect1">
1.106     rillig   2214: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2215: <a name="bulk.req"></a>8.3. Requirements of a full bulk build</h2></div></div></div>
1.180     wiz      2216: <p>A complete bulk build requires lots of disk space. Some of the
                   2217: disk space can be read-only, some other must be writable. Some can be on
                   2218: remote filesystems (such as NFS) and some should be local. Some can be
                   2219: temporary filesystems, others must survive a sudden reboot.</p>
                   2220: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   2221: <li class="listitem"><p>40 GB for the distfiles (read-write, remote, temporary)</p></li>
                   2222: <li class="listitem"><p>30 GB for the binary packages (read-write, remote, permanent)</p></li>
                   2223: <li class="listitem"><p>1 GB for the pkgsrc tree (read-only, remote, permanent)</p></li>
                   2224: <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary)</p></li>
                   2225: <li class="listitem"><p>10 GB for the log files (read-write, remote, permanent)</p></li>
                   2226: <li class="listitem"><p>5 GB for temporary files (read-write, local, temporary)</p></li>
                   2227: </ul></div>
                   2228: </div>
                   2229: <div class="sect1">
                   2230: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.293     rillig   2231: <a name="bulk.var"></a>8.4. Bulk build variants</h2></div></div></div>
                   2232: <p>To ensure that pkgsrc packages work in different configurations, it
                   2233: makes sense to run non-default bulk builds from time to time. This
                   2234: section lists some ideas for bulk builds that intentionally let packages
                   2235: fail if they don't follow the pkgsrc style.</p>
                   2236: <div class="sect2">
                   2237: <div class="titlepage"><div><div><h3 class="title">
1.294     rillig   2238: <a name="bulk.var.confopt"></a>8.4.1. Detect unknown configure options</h3></div></div></div>
1.293     rillig   2239: <p>Add the following line to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
                   2240: <pre class="programlisting">
                   2241: GNU_CONFIGURE_STRICT=   yes
                   2242: </pre>
                   2243: <p>When a package fails this additional check, the most common cause
                   2244: is that the configure option was valid for an older version of the
                   2245: package but does not apply anymore. In that case, just remove it.</p>
                   2246: </div>
                   2247: <div class="sect2">
                   2248: <div class="titlepage"><div><div><h3 class="title">
1.294     rillig   2249: <a name="bulk.var.comperr"></a>8.4.2. Detect classes of bugs by forcing compiler warnings</h3></div></div></div>
1.293     rillig   2250: <p>The job of a compiler is not restricted to producing executable
1.294     rillig   2251: code, most compilers also detect typical programming mistakes. The pkgsrc
                   2252: compiler wrappers make it easy to force compiler options when the package
                   2253: is built. This can be used to find typical bugs across all packages that
                   2254: are in pkgsrc. By reporting these bugs upstream, the packages will be
                   2255: more reliable with the next updates.</p>
                   2256: <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   2257: <pre class="programlisting">
                   2258: CFLAGS+=        -Werror=char-subscripts
1.294     rillig   2259: CFLAGS+=        -Werror=implicit-function-declaration
1.293     rillig   2260: </pre>
1.294     rillig   2261: <p>When a package fails to build using these stricter compiler
                   2262: options, document the circumstances in which the compiler produced the
                   2263: error message. This includes:</p>
1.293     rillig   2264: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   2265: <li class="listitem"><p>The platform
                   2266: (<code class="varname">MACHINE_PLATFORM</code>)</p></li>
                   2267: <li class="listitem"><p>The source file</p></li>
                   2268: <li class="listitem"><p>An excerpt of the code. GCC and Clang already do this as
                   2269: part of the diagnostic.</p></li>
1.294     rillig   2270: <li class="listitem"><p>The exact error message from the compiler.</p></li>
1.293     rillig   2271: </ul></div>
                   2272: <p>If a package produces these error messages, but the package is
1.294     rillig   2273: 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
                   2274: in the next builds:</p>
1.293     rillig   2275: <pre class="programlisting">
1.294     rillig   2276: .if ${PKGPATH} == category/package
1.293     rillig   2277: # Version ${VERSION} failed on ${MACHINE_PLATFORM}:
                   2278: # error message
                   2279: # code
1.294     rillig   2280: # Reason why the code does not need to be fixed.
1.293     rillig   2281: BUILDLINK_TRANSFORM+=   rm:-Werror=char-subscripts
1.294     rillig   2282: .endif
1.293     rillig   2283: </pre>
                   2284: <p>If the error messages from the compiler are valid and the code
1.294     rillig   2285: needs to be fixed, prepare a local patch (see
                   2286: <code class="varname">LOCALPATCHES</code>) and report the bug to the upstream
                   2287: authors of the package, providing them with the information you collected
                   2288: above.</p>
                   2289: <p>Patches that are not essential for the package to work should only
                   2290: be reported upstream but not committed to pkgsrc, to make future updates
                   2291: easier.</p>
1.293     rillig   2292: </div>
                   2293: <div class="sect2">
                   2294: <div class="titlepage"><div><div><h3 class="title">
1.296     rillig   2295: <a name="bulk.var.builderr"></a>8.4.3. Force compiler options only in the build phase</h3></div></div></div>
                   2296: <p>When adding custom compiler flags via <code class="varname">CFLAGS</code>,
                   2297: these apply to all phases of the package build process. Especially in the
                   2298: configure phase, adding <code class="literal">-Werror</code> leads to wrong
                   2299: decisions. The GNU configure scripts feed many small test programs to the
                   2300: C compiler to see whether certain headers are available, functions are
                   2301: defined in a library and programs can be run. In many cases these
                   2302: programs would not survive a strict compiler run with <code class="literal">-Wall
                   2303: -Wextra -Werror</code>.</p>
                   2304: <p>The pkgsrc infrastructure is flexible enough to support compiler
                   2305: options being added between the <code class="literal">configure</code> and
                   2306: <code class="literal">build</code> phases. It's a little more complicated than the
                   2307: other examples in this section but still easy enough.</p>
                   2308: <p>The basic idea is to use the pkgsrc compiler wrapper to inject the
                   2309: desired compiler options. The compiler wrapper's original task is to hide
                   2310: unwanted directories of include files and to normalize compiler options.
                   2311: It does this by wrapping the compiler command and rewriting the command
                   2312: line. To see this in action, run <span class="command"><strong>bmake patch</strong></span> in a
                   2313: package directory and examine the
                   2314: <code class="filename">work/.cwrappers/config</code> directory. It contains
                   2315: individual configurations for the C compiler and the related tools. The
                   2316: plan is to find a hook between the configure and build phases, and to
                   2317: modify these configuration files at that point.</p>
                   2318: <p>To find this hook, have a look at
                   2319: <code class="filename">mk/build/build.mk</code>, which contains among others the
                   2320: <code class="literal">pre-build-checks-hook</code>. The word
                   2321: <code class="literal">checks</code> doesn't quite fit, but the
                   2322: <code class="literal">pre-build-hook</code> sounds good enough.</p>
                   2323: <p>The code to be included in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> is:</p>
                   2324: <pre class="programlisting">
                   2325: # Just a few example options.
                   2326: BUILD_ONLY_CFLAGS=      -Wall -Werror -O2 -DTEMPDIR='"/tmp"'
                   2327: 
                   2328: .if ${BUILD_ONLY_CFLAGS:U:M*}
                   2329: pre-build-checks-hook: add-build-only-cflags
                   2330: 
                   2331: add-build-only-cflags: .PHONY
                   2332:         ${RUN} cd ${CWRAPPERS_CONFIG_DIR};      \
                   2333:         ${TEST} ! -f ${.TARGET} || exit 0;      \
                   2334:         for flag in ${BUILD_ONLY_CFLAGS}; do    \
                   2335:                 ${ECHO} "append=$$flag" &gt;&gt; cc;  \
                   2336:         done;                                   \
                   2337:         &gt; ${.TARGET}
                   2338: .endif
                   2339: </pre>
                   2340: <p>(When editing the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, make sure that the commands of the
                   2341: <code class="literal">add-build-only-cflags</code> target are indented with a tab,
                   2342: not with spaces.)</p>
                   2343: <p>The condition in the <code class="literal">.if</code> statement contains the
                   2344: <code class="literal">:U</code> modifier to prevent parse errors if the variable
                   2345: should be undefined, possibly because it is only defined for a subset of
                   2346: the packages. The <code class="literal">:M*</code> modifier ensures that there is
                   2347: at least one compiler option, to prevent a syntax error in the shell
                   2348: parser.</p>
                   2349: <p>The code around the <code class="literal">${.TARGET}</code> variable ensures
                   2350: that the additional compiler options are only appended once, even if
                   2351: <span class="command"><strong>bmake build</strong></span> is run multiple times. To do this, it
                   2352: creates a marker file.</p>
                   2353: <p>To verify that this setup works, run <span class="command"><strong>bmake
                   2354: configure</strong></span> in a package directory. Up to now, everything works
                   2355: as usual. Examine the directory
                   2356: <code class="filename">work/.cwrappers/config</code> to see that the compiler
                   2357: options from <code class="varname">BUILD_ONLY_CFLAGS</code> are not yet added to
                   2358: the file <code class="filename">cc</code>. Examine the tail of the
                   2359: <code class="filename">work/.work.log</code> file to see that the normal compiler
                   2360: options are used.</p>
                   2361: <p>Now run <span class="command"><strong>bmake build</strong></span>. This will append the
                   2362: options to the file <code class="filename">cc</code> and will create the marker
                   2363: file in the same directory. After that, the build starts as usual, but
                   2364: with the added compiler options. Examine the tail of the file
                   2365: <code class="filename">work/.work.log</code> to see that the lines starting with
                   2366: <code class="literal">[*]</code> don't contain the compiler options, but the
                   2367: corresponding lines starting with <code class="literal">&lt;.&gt;</code> do end
                   2368: with these options.</p>
                   2369: <p>Building packages using this setup variant and fixing the resulting
                   2370: 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>
                   2371: </div>
                   2372: <div class="sect2">
                   2373: <div class="titlepage"><div><div><h3 class="title">
                   2374: <a name="bulk.var.dirs"></a>8.4.4. Use custom directories</h3></div></div></div>
1.293     rillig   2375: <p>Some directories like <code class="varname">PREFIX</code>,
                   2376: <code class="varname">VARBASE</code>, <code class="varname">PKG_SYSCONFDIR</code>,
                   2377: <code class="varname">PKGMANDIR</code>, <code class="varname">PKG_INFODIR</code> can be
                   2378: configured in pkgsrc. Set these to arbitrary paths during bootstrap or
                   2379: afterwards in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
                   2380: <pre class="programlisting">
                   2381: PREFIX=         /a-random-uuid
                   2382: PKG_SYSCONFDIR= /a-random-uuid
                   2383: VARBASE=        /a-random-uuid
                   2384: PKGMANDIR=     a-random-uuid
                   2385: PKG_INFODIR=   a-random-uuid
                   2386: </pre>
                   2387: </div>
                   2388: <div class="sect2">
                   2389: <div class="titlepage"><div><div><h3 class="title">
1.296     rillig   2390: <a name="bulk.var.warn"></a>8.4.5. Turn warnings into errors</h3></div></div></div>
1.293     rillig   2391: <p>When building a package, warnings are typically ignored since they
                   2392: just flow by and do not cause the build to fail immediately. To find
                   2393: these warnings, redefine them to errors in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
                   2394: <pre class="programlisting">
                   2395: DELAYED_WARNING_MSG=    ${DELAYED_ERROR_MSG} "(was warning)"
                   2396: WARNING_MSG=            ${FAIL_MSG} "(was warning)"
                   2397: </pre>
                   2398: <p>(There are many more classes of warnings in pkgsrc, and most of
                   2399: them can be redefined with a simple definition like above.</p>
1.294     rillig   2400: <p>If a package suggests to add <code class="varname">USE_TOOLS+=perl</code> to
1.293     rillig   2401: the package Makefile, research whether the package actually needs Perl.
                   2402: If it does, add <code class="varname">USE_TOOLS+=perl</code> to the package
                   2403: Makefile, and if it doesn't, add
                   2404: <code class="varname">TOOLS_BROKEN+=perl</code>.</p>
                   2405: </div>
                   2406: <div class="sect2">
                   2407: <div class="titlepage"><div><div><h3 class="title">
1.296     rillig   2408: <a name="bulk.var.pkglint"></a>8.4.6. Reject packages for which pkglint reports errors</h3></div></div></div>
1.293     rillig   2409: <p>Using pkglint as part of the regular build process is mostly a
                   2410: waste of time. If you want to fix some of the warnings, just run pkglint
                   2411: recursively on the whole pkgsrc tree. This will take a few minutes (up to
                   2412: 10), which is much faster than a complete bulk build.</p>
                   2413: </div>
                   2414: <div class="sect2">
                   2415: <div class="titlepage"><div><div><h3 class="title">
1.296     rillig   2416: <a name="bulk.var.strings"></a>8.4.7. Reject packages that contain forbidden strings</h3></div></div></div>
1.293     rillig   2417: <p>To ensure that the binary packages don't contain references to the
                   2418: build directory, there is already <code class="varname">CHECK_WRKREF</code>. If
                   2419: that variable includes the item <code class="literal">extra</code>, it is
                   2420: possible to define additional patterns that must not appear in any
                   2421: installed file. This is specified in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
                   2422: <pre class="programlisting">
                   2423: CHECK_WRKREF=                   extra
                   2424: CHECK_WRKREF_EXTRA_DIRS+=       /usr/local
                   2425: CHECK_WRKREF_EXTRA_DIRS+=       /usr/pkg
                   2426: CHECK_WRKREF_EXTRA_DIRS+=      @[A-Z][A-Z]*@
                   2427: </pre>
                   2428: <p>The above patterns will probably generate many false positives,
                   2429: therefore the results need to be taken with a grain of salt.</p>
                   2430: </div>
                   2431: <div class="sect2">
                   2432: <div class="titlepage"><div><div><h3 class="title">
1.296     rillig   2433: <a name="bulk.var.test"></a>8.4.8. Reject packages whose self-test fails</h3></div></div></div>
1.293     rillig   2434: <p>To run the test suites that come with each package, add this line
                   2435: to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
                   2436: <pre class="programlisting">
                   2437: PKGSRC_RUN_TEST=        yes
                   2438: </pre>
                   2439: <p>Be prepared that even the most basic packages fail this test. When
                   2440: doing a bulk build with this, it will often abort in the early phase
                   2441: where the packages are scanned for their dependencies since there are
                   2442: cyclic dependencies. There is still a lot to do in this area.</p>
                   2443: </div>
                   2444: <div class="sect2">
                   2445: <div class="titlepage"><div><div><h3 class="title">
1.296     rillig   2446: <a name="bulk.var.shvar"></a>8.4.9. Reject packages that use undefined shell variables</h3></div></div></div>
1.293     rillig   2447: <p>To catch typos in the shell snippets from the Makefile fragments,
                   2448: add the <code class="literal">-u</code> flag to most of the commands by adding this
                   2449: line to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
                   2450: <pre class="programlisting">
                   2451: RUN=    @set -eu;
                   2452: </pre>
1.296     rillig   2453: <p>After that, ensure that none of the bulk build log files (even
                   2454: those for successfully built packages) contains the string
                   2455: <code class="literal">parameter not set</code> or whatever error message the
                   2456: command <span class="command"><strong>sh -ceu '$undefined'</strong></span> outputs.</p>
1.293     rillig   2457: <p>See <code class="filename">mk/misc/common.mk</code> for the existing
                   2458: definition.</p>
                   2459: </div>
                   2460: <div class="sect2">
                   2461: <div class="titlepage"><div><div><h3 class="title">
1.296     rillig   2462: <a name="bulk.var.quiet"></a>8.4.10. Turn off verbose logging</h3></div></div></div>
1.293     rillig   2463: <p>The build logs of a package are often quite long. This allows error
                   2464: messages or other interesting details to hide between the noise. To make
                   2465: the actual error message stand out more, add these lines to
                   2466: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
                   2467: <pre class="programlisting">
                   2468: GNU_CONFIGURE_QUIET=    yes
                   2469: MAKE_FLAGS+=            -s
                   2470: </pre>
                   2471: <p>The <code class="literal">-s</code> option works for both GNU Make and BSD
                   2472: Make. On exotic platforms with their own make, it may be a little
                   2473: different.</p>
                   2474: </div>
                   2475: </div>
                   2476: <div class="sect1">
                   2477: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   2478: <a name="creating-cdroms"></a>8.5. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.87      wiz      2479: <p>After your pkgsrc bulk-build has completed, you may wish to
                   2480:     create a CD-ROM set of the resulting binary packages to assist
                   2481:     in installing packages on other machines.  The
1.250     leot     2482:     <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      2483:     a simple tool for creating the ISO 9660 images.
1.110     hubertf  2484:     <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.87      wiz      2485:     way that keeps all the dependencies for a given package on the same
                   2486:     CD as that package.</p>
1.148     asau     2487: <div class="sect2">
1.75      rillig   2488: <div class="titlepage"><div><div><h3 class="title">
1.293     rillig   2489: <a name="cdpack-example"></a>8.5.1. Example of cdpack</h3></div></div></div>
1.87      wiz      2490: <p>Complete documentation for cdpack is found in the cdpack(1)
                   2491:       man page. The following short example assumes that the binary
                   2492:       packages are left in
                   2493:       <code class="filename">/usr/pkgsrc/packages/All</code> and that
                   2494:       sufficient disk space exists in <code class="filename">/u2</code> to
                   2495:       hold the ISO 9660 images.</p>
                   2496: <pre class="screen">
                   2497: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
1.75      rillig   2498: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
1.87      wiz      2499: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
                   2500:       </pre>
                   2501: <p>If you wish to include a common set of files
                   2502:       (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
                   2503:       etc.) on each CD in the collection, then you need to create a
1.290     gutterid 2504:       directory which contains these files, e.g.:</p>
1.87      wiz      2505: <pre class="screen">
                   2506: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
1.75      rillig   2507: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" &gt; /tmp/common/README</code></strong>
                   2508: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" &gt; /tmp/common/COPYING</code></strong>
                   2509: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
                   2510: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" &gt; /tmp/common/bin/myscript</code></strong>
                   2511: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" &gt;&gt; /tmp/common/bin/myscript</code></strong>
1.87      wiz      2512: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
                   2513:       </pre>
1.75      rillig   2514: <p>Now create the images:</p>
                   2515: <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   2516: <p>Each image will contain <code class="filename">README</code>,
1.87      wiz      2517:       <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
                   2518:       in their root directories.</p>
1.75      rillig   2519: </div>
                   2520: </div>
                   2521: </div>
1.148     asau     2522: <div class="chapter">
1.75      rillig   2523: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   2524: <a name="files"></a>Chapter 9. Directory layout of the installed files</h2></div></div></div>
1.90      rillig   2525: <div class="toc">
                   2526: <p><b>Table of Contents</b></p>
1.210     leot     2527: <dl class="toc">
1.267     rillig   2528: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
                   2529: <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   2530: </dl>
                   2531: </div>
                   2532: <p>The files that are installed by pkgsrc are organized in a way that
                   2533: is similar to what you find in the <code class="filename">/usr</code> directory
                   2534: of the base system. But some details are different. This is because
                   2535: pkgsrc initially came from FreeBSD and had adopted its file system
                   2536: hierarchy. Later it was largely influenced by NetBSD. But no matter
                   2537: which operating system you are using pkgsrc with, you can expect the
                   2538: same layout for pkgsrc.</p>
1.91      rillig   2539: <p>There are mainly four root directories for pkgsrc, which are all
                   2540: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
                   2541: When pkgsrc has been installed as root, the default locations
                   2542: are:</p>
                   2543: <pre class="programlisting">
1.100     rillig   2544: LOCALBASE=              /usr/pkg
                   2545: PKG_SYSCONFBASE=        /usr/pkg/etc
                   2546: VARBASE=                /var
1.231     sevan    2547: PKG_DBDIR=              /usr/pkg/pkgdb
1.91      rillig   2548: </pre>
                   2549: <p>In unprivileged mode (when pkgsrc has been installed as any other
                   2550: user), the default locations are:</p>
                   2551: <pre class="programlisting">
1.100     rillig   2552: LOCALBASE=              ${HOME}/pkg
                   2553: PKG_SYSCONFBASE=        ${HOME}/pkg/etc
                   2554: VARBASE=                ${HOME}/pkg/var
1.231     sevan    2555: PKG_DBDIR=              ${HOME}/pkg/pkgdb
1.91      rillig   2556: </pre>
                   2557: <p>What these four directories are for, and what they look like is
                   2558: explained below.</p>
1.148     asau     2559: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2560: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.90      rillig   2561: <code class="filename">/usr</code> directory in the base system. It is the
1.128     wiz      2562: <span class="quote">&#8220;<span class="quote">main</span>&#8221;</span> directory where the files are installed and contains
1.90      rillig   2563: the well-known subdirectories like <code class="filename">bin</code>,
                   2564: <code class="filename">include</code>, <code class="filename">lib</code>,
                   2565: <code class="filename">share</code> and
                   2566: <code class="filename">sbin</code>.</p></li>
1.128     wiz      2567: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.90      rillig   2568: <code class="filename">/var</code> in the base system. Some programs (especially
                   2569: games, network daemons) need write access to it during normal
                   2570: operation.</p></li>
1.128     wiz      2571: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.90      rillig   2572: <code class="filename">/etc</code> in the base system. It contains configuration
1.110     hubertf  2573: 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   2574: itself.</p></li>
                   2575: </ul></div>
1.148     asau     2576: <div class="sect1">
1.90      rillig   2577: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2578: <a name="files.localbase"></a>9.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.93      rillig   2579: </h2></div></div></div>
1.90      rillig   2580: <p>The following directories exist in a typical pkgsrc installation
1.91      rillig   2581: in <code class="filename">${LOCALBASE}</code>.</p>
1.148     asau     2582: <div class="variablelist"><dl class="variablelist">
1.90      rillig   2583: <dt><span class="term"><code class="filename">bin</code></span></dt>
                   2584: <dd><p>Contains executable programs that are intended to be
                   2585: directly used by the end user.</p></dd>
                   2586: <dt><span class="term"><code class="filename">emul</code></span></dt>
                   2587: <dd><p>Contains files for the emulation layers of various other
                   2588: operating systems, especially for
                   2589: NetBSD.</p></dd>
                   2590: <dt><span class="term"><code class="filename">etc</code> (the usual location of
                   2591: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
                   2592: <dd><p>Contains
                   2593: the configuration files.</p></dd>
                   2594: <dt><span class="term"><code class="filename">include</code></span></dt>
                   2595: <dd><p>Contains headers for the C and C++ programming
                   2596: languages.</p></dd>
                   2597: <dt><span class="term"><code class="filename">info</code></span></dt>
                   2598: <dd><p>Contains GNU info files of various
                   2599: packages.</p></dd>
                   2600: <dt><span class="term"><code class="filename">lib</code></span></dt>
                   2601: <dd><p>Contains shared and static
                   2602: libraries.</p></dd>
                   2603: <dt><span class="term"><code class="filename">libdata</code></span></dt>
                   2604: <dd><p>Contains data files that don't change after
                   2605: installation. Other data files belong into
                   2606: <code class="filename">${VARBASE}</code>.</p></dd>
                   2607: <dt><span class="term"><code class="filename">libexec</code></span></dt>
                   2608: <dd><p>Contains programs that are not intended to be used by
                   2609: end users, such as helper programs or network
                   2610: daemons.</p></dd>
                   2611: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
                   2612: <dd><p>Contains programs that are intended to be executed as
                   2613: CGI scripts by a web server.</p></dd>
                   2614: <dt><span class="term"><code class="filename">man</code> (the usual value of
                   2615: <code class="filename">${PKGMANDIR}</code>)</span></dt>
                   2616: <dd><p>Contains brief
                   2617: documentation in form of manual pages.</p></dd>
                   2618: <dt><span class="term"><code class="filename">sbin</code></span></dt>
                   2619: <dd><p>Contains programs that are intended to be used only by
                   2620: the super-user.</p></dd>
                   2621: <dt><span class="term"><code class="filename">share</code></span></dt>
                   2622: <dd><p>Contains platform-independent data files that don't
                   2623: change after installation.</p></dd>
                   2624: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
                   2625: <dd><p>Contains documentation files provided by the
                   2626: packages.</p></dd>
                   2627: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
                   2628: <dd><p>Contains example files provided by the packages. Among
                   2629: others, the original configuration files are saved here and copied to
                   2630: <code class="filename">${PKG_SYSCONFDIR}</code> during
                   2631: installation.</p></dd>
                   2632: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
                   2633: <dd><p>Contains the original files for rc.d
                   2634: scripts.</p></dd>
                   2635: <dt><span class="term"><code class="filename">var</code> (the usual location of
                   2636: <code class="filename">${VARBASE}</code>)</span></dt>
                   2637: <dd><p>Contains files
                   2638: that may be modified after
                   2639: installation.</p></dd>
                   2640: </dl></div>
                   2641: </div>
1.148     asau     2642: <div class="sect1">
1.90      rillig   2643: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2644: <a name="files.varbase"></a>9.2. File system layout in <code class="literal">${VARBASE}</code>
1.93      rillig   2645: </h2></div></div></div>
1.148     asau     2646: <div class="variablelist"><dl class="variablelist">
1.90      rillig   2647: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
                   2648: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
                   2649: <dd><p>Contains
                   2650: information about the currently installed
                   2651: packages.</p></dd>
                   2652: <dt><span class="term"><code class="filename">games</code></span></dt>
                   2653: <dd><p>Contains highscore
                   2654: files.</p></dd>
                   2655: <dt><span class="term"><code class="filename">log</code></span></dt>
                   2656: <dd><p>Contains log files.</p></dd>
                   2657: <dt><span class="term"><code class="filename">run</code></span></dt>
                   2658: <dd><p>Contains informational files about daemons that are
                   2659: currently running.</p></dd>
                   2660: </dl></div>
                   2661: </div>
                   2662: </div>
1.148     asau     2663: <div class="chapter">
1.90      rillig   2664: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   2665: <a name="faq"></a>Chapter 10. Frequently Asked Questions</h2></div></div></div>
1.75      rillig   2666: <div class="toc">
                   2667: <p><b>Table of Contents</b></p>
1.210     leot     2668: <dl class="toc">
1.267     rillig   2669: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                   2670: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
                   2671: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
                   2672: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
                   2673: <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>
                   2674: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
                   2675: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
                   2676: <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>
                   2677: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
                   2678: <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      2679: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</a></span></dt>
1.267     rillig   2680: <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>
                   2681: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' with pkgsrc</a></span></dt>
                   2682: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
                   2683: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
                   2684: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
                   2685: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build.  What shall I do?</a></span></dt>
                   2686: <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   2687: </dl>
                   2688: </div>
                   2689: <p>This section contains hints, tips &amp; tricks on special things in
                   2690: pkgsrc that we didn't find a better place for in the previous chapters, and
                   2691: it contains items for both pkgsrc users and developers.</p>
1.148     asau     2692: <div class="sect1">
1.75      rillig   2693: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2694: <a name="mailing-list-pointers"></a>10.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.75      rillig   2695: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.148     asau     2696: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2697: <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   2698:          This is a general purpose list for most issues regarding
                   2699:          pkgsrc, regardless of platform, e.g. soliciting user help
                   2700:          for pkgsrc configuration, unexpected build failures, using
                   2701:          particular packages, upgrading pkgsrc installations,
                   2702:          questions regarding the pkgsrc release branches, etc.  General announcements or
                   2703:          proposals for changes that impact the pkgsrc user community,
                   2704:          e.g. major infrastructure changes, new features, package
                   2705:          removals, etc., may also be posted.</p></li>
1.289     leot     2706: <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   2707:          A list where the results of pkgsrc bulk builds are sent and
                   2708:          discussed.</p></li>
1.289     leot     2709: <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   2710:          This list is for those who are interested in getting a
                   2711:          commit message for every change committed to pkgsrc. It is
                   2712:          also available in digest form, meaning one daily message
                   2713:          containing all commit messages for changes to the package
                   2714:          source tree in that 24 hour period.</p></li>
                   2715: </ul></div>
                   2716: <p>To subscribe, do:</p>
                   2717: <pre class="programlisting">
1.100     rillig   2718: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
1.75      rillig   2719: </pre>
                   2720: <p>Archives for all these mailing lists are available from
1.289     leot     2721: <a class="ulink" href="https://mail-index.NetBSD.org/" target="_top">https://mail-index.NetBSD.org/</a>.</p>
1.75      rillig   2722: </div>
1.148     asau     2723: <div class="sect1">
1.75      rillig   2724: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2725: <a name="faq-pkgtools"></a>10.2. Utilities for package management (pkgtools)</h2></div></div></div>
1.80      rillig   2726: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
1.75      rillig   2727: a number of useful utilities for both users and developers of pkgsrc.  This
1.233     sevan    2728: section attempts only to make the reader aware of some of the utilities and when
1.75      rillig   2729: they might be useful, and not to duplicate the documentation that comes
                   2730: with each package.</p>
                   2731: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.250     leot     2732: <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   2733:       Symlinks for use by buildlink.</p></li></ul></div>
                   2734: <p>OS tool augmentation (automatically installed when needed):</p>
1.148     asau     2735: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.250     leot     2736: <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    2737:       Calculates various kinds of checksums (including SHA3).</p></li>
1.250     leot     2738: <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   2739:       Compatibility library for pkgsrc tools.</p></li>
1.250     leot     2740: <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      2741:       non-BSD systems due to lack of native mtree.</p></li>
1.250     leot     2742: <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   2743:       Up-to-date replacement for
1.76      rillig   2744:       <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
1.75      rillig   2745:       systems where pkg_install is not present.</p></li>
                   2746: </ul></div>
                   2747: <p>Utilities used by pkgsrc (not automatically installed):</p>
1.148     asau     2748: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.250     leot     2749: <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   2750:       Create a binary package from an
1.110     hubertf  2751:       already-installed package.  Used by <span class="command"><strong>make replace</strong></span> to
1.75      rillig   2752:       save the old package.</p></li>
1.250     leot     2753: <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   2754:       Adds extra functionality to pkgsrc, allowing it to fetch distfiles
                   2755:       from multiple locations. It currently supports the following
                   2756:       methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.250     leot     2757: <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  2758:       the best compiler flags to optimise code for your current
1.128     wiz      2759:       CPU and compiler. </p></li>
1.75      rillig   2760: </ul></div>
                   2761: <p>Utilities for keeping track of installed packages, being up to date,
                   2762: etc:</p>
1.148     asau     2763: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.250     leot     2764: <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      2765:     update tool similar to apt(1). Download, install, and upgrade
                   2766:     binary packages easily.</p></li>
1.250     leot     2767: <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   2768:       packages whose installed versions do not match the latest pkgsrc
                   2769:       entries.</p></li>
1.250     leot     2770: <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   2771:       dependency graphs of packages, to aid in choosing a strategy for
                   2772:       updating.</p></li>
1.250     leot     2773: <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
                   2774:       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>
                   2775: <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   2776:       pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.250     leot     2777: <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   2778:       does various checks on the complete pkgsrc system.</p></li>
1.250     leot     2779: <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   2780:       packages you have installed.</p></li>
                   2781: </ul></div>
                   2782: <p>Utilities for people maintaining or creating individual packages:</p>
1.148     asau     2783: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.250     leot     2784: <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   2785:       making and maintaining patches for a package (includes pkgdiff,
                   2786:       pkgvi, mkpatches, etc.).</p></li>
1.250     leot     2787: <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   2788:       converting to pkgsrc.</p></li>
                   2789: </ul></div>
                   2790: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
                   2791: utilities)</p>
1.148     asau     2792: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.250     leot     2793: <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   2794:       packages in a chrooted area.</p></li>
1.250     leot     2795: <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   2796:       kernel version for chrooted cross builds.</p></li>
                   2797: </ul></div>
                   2798: </div>
1.148     asau     2799: <div class="sect1">
1.75      rillig   2800: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2801: <a name="non-root-pkgsrc"></a>10.3. How to use pkgsrc as non-root</h2></div></div></div>
1.219     rillig   2802: <p>To install packages from source as a non-root user, download
1.267     rillig   2803: 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   2804: directory and run the command <span class="command"><strong>./bootstrap/bootstrap
                   2805: --unprivileged</strong></span>.</p>
                   2806: <p>This will install the binary part of pkgsrc to
                   2807: <code class="filename">~/pkg</code> and put the pkgsrc configuration <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
                   2808: into <code class="filename">~/pkg/etc</code>.</p>
                   2809: <p>For more details, see <code class="filename">mk/unprivileged.mk</code>.</p>
1.75      rillig   2810: </div>
1.148     asau     2811: <div class="sect1">
1.75      rillig   2812: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2813: <a name="resume-transfers"></a>10.4. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.75      rillig   2814: <p>By default, resuming transfers in pkgsrc is disabled, but you can
                   2815: enable this feature by adding the option
                   2816: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.110     hubertf  2817: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  If, during a fetch step, an incomplete
1.75      rillig   2818: distfile is found, pkgsrc will try to resume it.</p>
                   2819: <p>You can also
1.168     wiz      2820: use a different program than the platform default program by changing the
1.117     jnemeth  2821: <code class="varname">FETCH_USING</code> variable.  You can specify the program by
                   2822: using of ftp, fetch, wget or curl.  Alternatively, fetching can be disabled
                   2823: by using the value manual.  A value of custom disables the system defaults
                   2824: and dependency tracking for the fetch program.  In that case you have to
                   2825: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
                   2826: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
                   2827: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.75      rillig   2828: <p>For example, if you want to use
1.117     jnemeth  2829: <code class="filename">wget</code> to download, you'll have to use something
1.75      rillig   2830: like:</p>
                   2831: <pre class="programlisting">
1.223     rillig   2832: FETCH_USING=    wget
1.1       grant    2833: </pre>
1.75      rillig   2834: </div>
1.148     asau     2835: <div class="sect1">
1.75      rillig   2836: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2837: <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      2838: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.76      rillig   2839: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
1.75      rillig   2840: you will have to add the following line into
1.110     hubertf  2841: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75      rillig   2842: <pre class="programlisting">
1.103     wiz      2843: X11_TYPE=modular
1.1       grant    2844: </pre>
1.75      rillig   2845: </div>
1.148     asau     2846: <div class="sect1">
1.75      rillig   2847: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2848: <a name="fetch-behind-firewall"></a>10.6. How to fetch files from behind a firewall</h2></div></div></div>
1.75      rillig   2849: <p>If you are sitting behind a firewall which does not allow direct
                   2850: connections to Internet hosts (i.e. non-NAT), you may specify the
                   2851: relevant proxy hosts.  This is done using an environment variable in the
                   2852: form of a URL, e.g. in Amdahl, the machine
1.128     wiz      2853: <span class="quote">&#8220;<span class="quote">orpheus.amdahl.com</span>&#8221;</span> is one of the firewalls, and it uses
1.75      rillig   2854: port 80 as the proxy port number.  So the proxy environment variables
                   2855: are:</p>
                   2856: <pre class="programlisting">
1.100     rillig   2857: ftp_proxy=ftp://orpheus.amdahl.com:80/
                   2858: http_proxy=http://orpheus.amdahl.com:80/
1.1       grant    2859: </pre>
1.75      rillig   2860: </div>
1.148     asau     2861: <div class="sect1">
1.75      rillig   2862: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2863: <a name="fetch-https"></a>10.7. How to fetch files from HTTPS sites</h2></div></div></div>
1.173     wiz      2864: <p>Some fetch tools are not prepared to support HTTPS by default
                   2865: (for example, the one in NetBSD 6.0), or the one installed by the
                   2866: pkgsrc bootstrap (to avoid an openssl dependency that low in the
                   2867: dependency graph).</p>
                   2868: <p>Usually you won't notice, because distribution files are
                   2869: mirrored weekly to <span class="quote">&#8220;<span class="quote">ftp.NetBSD.org</span>&#8221;</span>, but that might not
                   2870: be often enough if you are following pkgsrc-current. In that case, set
                   2871: <code class="varname">FETCH_USING</code> in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file to
                   2872: <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
                   2873: with HTTPS support by default. Of course, these tools need to be
                   2874: installed before you can use them this way.</p>
                   2875: </div>
                   2876: <div class="sect1">
                   2877: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2878: <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   2879: <p>This depends on which utility is used to retrieve distfiles.  From
1.76      rillig   2880: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
1.75      rillig   2881: the first available command from the following list:</p>
1.148     asau     2882: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2883: <li class="listitem"><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
                   2884: <li class="listitem"><p><code class="filename">/usr/bin/ftp</code></p></li>
1.75      rillig   2885: </ul></div>
                   2886: <p>On a default NetBSD installation, this will be
1.76      rillig   2887: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
1.75      rillig   2888: connections first, and falls back to active connections if the server
                   2889: refuses to do passive.  For the other tools, add the following to your
1.110     hubertf  2890: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.75      rillig   2891: <code class="varname">PASSIVE_FETCH=1</code>.</p>
                   2892: <p>Having that option present will prevent
1.76      rillig   2893: <code class="filename">/usr/bin/ftp</code> from falling back to active
1.75      rillig   2894: transfers.</p>
                   2895: </div>
1.148     asau     2896: <div class="sect1">
1.75      rillig   2897: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2898: <a name="fetching-all-distfiles"></a>10.9. How to fetch all distfiles at once</h2></div></div></div>
1.88      wiz      2899: <p>You would like to download all the distfiles in a single batch
1.110     hubertf  2900: from work or university, where you can't run a <span class="command"><strong>make
1.132     spz      2901: 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   2902: but downloading the entire directory may not be appropriate.</p>
1.110     hubertf  2903: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.76      rillig   2904: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
1.75      rillig   2905: resulting list to your machine at work/school and use it there.  If you
1.289     leot     2906: don't have a NetBSD-compatible <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?ftp+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">ftp</span>(1)</span></a> (like tnftp) at work, don't
1.75      rillig   2907: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
                   2908: URL:</p>
                   2909: <p>At home:</p>
                   2910: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   2911: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles &gt;/tmp/fetch.sh</code></strong>
                   2912: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
                   2913: <p>At work:</p>
                   2914: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
1.76      rillig   2915: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
1.75      rillig   2916: home.</p>
                   2917: <p>If you have a machine running NetBSD, and you want to get
1.88      wiz      2918: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
                   2919: machine architecture), you can do so by using the above-mentioned
1.110     hubertf  2920: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.88      wiz      2921: directly by running:</p>
1.75      rillig   2922: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
                   2923: <p>If you even decide to ignore
                   2924: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
                   2925: by running:</p>
                   2926: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
                   2927: </div>
1.148     asau     2928: <div class="sect1">
1.75      rillig   2929: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2930: <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      2931: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</h2></div></div></div>
1.250     leot     2932: <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   2933: package, you get the error from make that it doesn't know how to make
1.76      rillig   2934: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.128     wiz      2935: you don't have installed the <span class="quote">&#8220;<span class="quote">text</span>&#8221;</span> set (nroff, ...) from
1.75      rillig   2936: the NetBSD base distribution on your machine.  It is recommended to do
                   2937: that to format man pages.</p>
1.250     leot     2938: <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   2939: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.110     hubertf  2940: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75      rillig   2941: </div>
1.148     asau     2942: <div class="sect1">
1.75      rillig   2943: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2944: <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      2945: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
1.75      rillig   2946: when you installed your NetBSD machine.  Please get and install it, by
1.76      rillig   2947: extracting it in <code class="filename">/</code>:</p>
1.75      rillig   2948: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
                   2949: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
1.76      rillig   2950: <p><code class="filename">comp.tgz</code> is part of every NetBSD release.  Get
1.110     hubertf  2951: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.75      rillig   2952: -r</strong></span>).</p>
                   2953: </div>
1.148     asau     2954: <div class="sect1">
1.75      rillig   2955: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2956: <a name="using-sudo-with-pkgsrc"></a>10.12. Using 'sudo' with pkgsrc</h2></div></div></div>
1.75      rillig   2957: <p>When installing packages as non-root user and using the just-in-time
1.289     leot     2958: <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?su+1.i386+NetBSD-9.0"><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   2959: password for each required package installed.  To avoid this, the sudo
                   2960: package can be used, which does password caching over a limited time.  To
                   2961: use it, install sudo (either as binary package or from
1.250     leot     2962: <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  2963: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.98      wiz      2964: <span class="emphasis"><em>after</em></span> the definition of the
                   2965: <code class="varname">LOCALBASE</code> variable:</p>
1.75      rillig   2966: <pre class="programlisting">
1.100     rillig   2967: .if exists(${LOCALBASE}/bin/sudo)
                   2968: SU_CMD=        ${LOCALBASE}/bin/sudo /bin/sh -c
                   2969: .endif
1.1       grant    2970: </pre>
1.75      rillig   2971: </div>
1.148     asau     2972: <div class="sect1">
1.75      rillig   2973: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2974: <a name="faq.conf"></a>10.13. How do I change the location of configuration files?</h2></div></div></div>
1.75      rillig   2975: <p>As the system administrator, you can choose where configuration files
                   2976: are installed.  The default settings make all these files go into
1.76      rillig   2977: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
1.75      rillig   2978: be suboptimal depending on your expectations (e.g., a read-only,
                   2979: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
                   2980: configuration of the provided packages).</p>
                   2981: <p>In order to change the defaults, you can modify the
                   2982: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.110     hubertf  2983: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.76      rillig   2984: directory; some common examples include <code class="filename">/etc</code> or
                   2985: <code class="filename">/etc/pkg</code>.</p>
1.75      rillig   2986: <p>Furthermore, you can change this value on a per-package basis by
                   2987: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
                   2988: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
                   2989: package you would like to modify, that is, the contents of
                   2990: <code class="varname">PKGBASE</code>.</p>
                   2991: <p>Note that after changing these settings, you must rebuild and
                   2992: reinstall any affected packages.</p>
                   2993: </div>
1.148     asau     2994: <div class="sect1">
1.75      rillig   2995: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2996: <a name="audit-packages"></a>10.14. Automated security checks</h2></div></div></div>
1.75      rillig   2997: <p>Please be aware that there can often be bugs in third-party software,
                   2998: and some of these bugs can leave a machine vulnerable to exploitation by
                   2999: attackers.  In an effort to lessen the exposure, the NetBSD packages team
                   3000: maintains a database of known-exploits to packages which have at one time
                   3001: been included in pkgsrc.  The database can be downloaded automatically, and
                   3002: a security audit of all packages installed on a system can take place.  To
1.114     jmcneill 3003: do this, refer to the following two tools (installed as part of the
1.250     leot     3004: <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      3005: <div class="orderedlist"><ol class="orderedlist" type="1">
                   3006: <li class="listitem">
1.122     reed     3007: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.75      rillig   3008:     download a list of the security vulnerabilities information.  This list
1.132     spz      3009:     is kept up to date by the pkgsrc security team, and is distributed
                   3010:     from the NetBSD ftp server:</p>
1.292     leot     3011: <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   3012: </li>
1.128     wiz      3013: <li class="listitem"><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
                   3014:     current machine, checking each known vulnerability.  If a
1.75      rillig   3015:     vulnerable package is installed, it will be shown by output to stdout,
                   3016:     including a description of the type of vulnerability, and a URL
                   3017:     containing more information.</p></li>
                   3018: </ol></div>
1.233     sevan    3019: <p>Use of these tools is strongly recommended!
1.267     rillig   3020: See <a class="xref" href="#vulnerabilities" title="5.1.5. Checking for security vulnerabilities in installed packages">Section 5.1.5, &#8220;Checking for security vulnerabilities in installed packages&#8221;</a> for instructions on how to automate checking and
1.233     sevan    3021: reporting.</p>
                   3022: <p>If this database is installed, pkgsrc builds will use it to
                   3023: perform a security check before building any package.</p>
1.75      rillig   3024: </div>
1.148     asau     3025: <div class="sect1">
1.75      rillig   3026: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   3027: <a name="ufaq-cflags"></a>10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</h2></div></div></div>
1.75      rillig   3028: <p>When you add your own preferences to the
                   3029:        <code class="varname">CFLAGS</code> variable in your
1.110     hubertf  3030:        <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.76      rillig   3031:        environment variables to the <code class="filename">./configure</code>
1.289     leot     3032:        scripts and to <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>. Some package authors ignore the
1.75      rillig   3033:        <code class="varname">CFLAGS</code> from the environment variable by
1.76      rillig   3034:        overriding them in the <code class="filename">Makefile</code>s of their
1.75      rillig   3035:        package.</p>
                   3036: <p>Currently there is no solution to this problem. If you
                   3037:        really need the package to use your <code class="varname">CFLAGS</code>
1.110     hubertf  3038:        you should run <span class="command"><strong>make patch</strong></span> in the package
1.76      rillig   3039:        directory and then inspect any <code class="filename">Makefile</code> and
                   3040:        <code class="filename">Makefile.in</code> for whether they define
1.75      rillig   3041:        <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.128     wiz      3042:        these lines. But be aware that some <span class="quote">&#8220;<span class="quote">smart</span>&#8221;</span>
1.75      rillig   3043:        programmers write so bad code that it only works for the
                   3044:        specific combination of <code class="varname">CFLAGS</code> they have
                   3045:        chosen.</p>
1.287     rillig   3046: <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>
                   3047: <pre class="programlisting">
                   3048: CPPFLAGS+=              -Dpkgsrc___CPPFLAGS
                   3049: CFLAGS+=                -Dpkgsrc___CFLAGS
                   3050: CXXFLAGS+=              -Dpkgsrc___CXXFLAGS
                   3051: </pre>
                   3052: <p>Then run <span class="command"><strong>bmake show-all-configure show-all-build</strong></span>
                   3053: to see whether the above flags are passed to the actual build
                   3054: commands in general.</p>
                   3055: <p>To find out whether the flags are passed to individual compiler
                   3056: commands, have a look at the file <code class="filename">work/.work.log</code>. In
                   3057: most cases, the flags from the original command lines (the lines starting
                   3058: with <code class="literal">[*]</code>) are passed unmodified to the actual compiler
                   3059: (the lines starting with <code class="literal">&lt;.&gt;</code>). If the flag is
                   3060: missing from the actual compiler command, it must have been removed by
1.299     rillig   3061: the <a class="link" href="#build.wrapper" title="13.10. The wrapper phase">pkgsrc compiler wrappers</a>.</p>
1.75      rillig   3062: </div>
1.148     asau     3063: <div class="sect1">
1.80      rillig   3064: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   3065: <a name="ufaq-fail"></a>10.16. A package does not build.  What shall I do?</h2></div></div></div>
1.128     wiz      3066: <div class="procedure"><ol class="procedure" type="1">
1.148     asau     3067: <li class="step"><p>Make sure that your copy of pkgsrc is consistent. A
1.80      rillig   3068:        case that occurs often is that people only update pkgsrc in
                   3069:        parts, because of performance reasons. Since pkgsrc is one large
                   3070:        system, not a collection of many small systems, there are
                   3071:        sometimes changes that only work when the whole pkgsrc tree is
                   3072:        updated.</p></li>
1.148     asau     3073: <li class="step"><p>Make sure that you don't have any CVS conflicts.
1.128     wiz      3074:        Search for <span class="quote">&#8220;<span class="quote">&lt;&lt;&lt;&lt;&lt;&lt;</span>&#8221;</span> or
                   3075:        <span class="quote">&#8220;<span class="quote">&gt;&gt;&gt;&gt;&gt;&gt;</span>&#8221;</span> in all your pkgsrc
1.80      rillig   3076:        files.</p></li>
1.148     asau     3077: <li class="step"><p>Make sure that you don't have old copies of the packages
1.110     hubertf  3078:        extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.80      rillig   3079:        verify this.</p></li>
1.218     rillig   3080: <li class="step"><p>If you are a package developer who wants to invest
1.267     rillig   3081:        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     3082: <li class="step"><p>If the problem still exists, write a mail to the
1.80      rillig   3083:        <code class="literal">pkgsrc-users</code> mailing list.</p></li>
                   3084: </ol></div>
                   3085: </div>
1.148     asau     3086: <div class="sect1">
1.88      wiz      3087: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   3088: <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   3089: <p>You have modified a file from pkgsrc, and someone else has
                   3090: modified that same file afterwards in the CVS repository. Both changes
                   3091: are in the same region of the file, so when you updated pkgsrc, the
                   3092: <code class="literal">cvs</code> command marked the conflicting changes in the
                   3093: file. Because of these markers, the file is no longer a valid
                   3094: <code class="filename">Makefile</code>.</p>
                   3095: <p>Have a look at that file, and if you don't need your local changes
1.110     hubertf  3096: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.89      rillig   3097: -dP</strong></span> in that directory to download the current version.</p>
                   3098: </div>
1.75      rillig   3099: </div>
                   3100: </div>
1.148     asau     3101: <div class="part">
1.75      rillig   3102: <div class="titlepage"><div><div><h1 class="title">
                   3103: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.148     asau     3104: <div class="partintro">
1.77      rillig   3105: <div></div>
                   3106: <p>This part of the book deals with creating and
1.128     wiz      3107:        modifying packages. It starts with a <span class="quote">&#8220;<span class="quote">HOWTO</span>&#8221;</span>-like
1.77      rillig   3108:        guide on creating a new package. The remaining chapters are more
                   3109:        like a reference manual for pkgsrc.</p>
1.75      rillig   3110: <div class="toc">
                   3111: <p><b>Table of Contents</b></p>
1.210     leot     3112: <dl class="toc">
1.267     rillig   3113: <dt><span class="chapter"><a href="#help-devel">11. Getting help</a></span></dt>
1.299     rillig   3114: <dt><span class="chapter"><a href="#components">12. Package components - files, directories and contents</a></span></dt>
1.91      rillig   3115: <dd><dl>
1.299     rillig   3116: <dt><span class="sect1"><a href="#components.Makefile">12.1. <code class="filename">Makefile</code></a></span></dt>
                   3117: <dt><span class="sect1"><a href="#components.distinfo">12.2. <code class="filename">distinfo</code></a></span></dt>
                   3118: <dt><span class="sect1"><a href="#components.patches">12.3. <code class="filename">patches/*</code></a></span></dt>
1.91      rillig   3119: <dd><dl>
1.299     rillig   3120: <dt><span class="sect2"><a href="#components.patch.structure">12.3.1. Structure of a single patch file</a></span></dt>
                   3121: <dt><span class="sect2"><a href="#components.patches.caveats">12.3.2. Creating patch files</a></span></dt>
                   3122: <dt><span class="sect2"><a href="#components.patches.sources">12.3.3. Sources where the patch files come from</a></span></dt>
                   3123: <dt><span class="sect2"><a href="#components.patches.guidelines">12.3.4. Patching guidelines</a></span></dt>
                   3124: <dt><span class="sect2"><a href="#components.patches.feedback">12.3.5. Feedback to the author</a></span></dt>
1.91      rillig   3125: </dl></dd>
1.299     rillig   3126: <dt><span class="sect1"><a href="#other-mandatory-files">12.4. Other mandatory files</a></span></dt>
                   3127: <dt><span class="sect1"><a href="#components.optional">12.5. Optional files</a></span></dt>
                   3128: <dd><dl>
                   3129: <dt><span class="sect2"><a href="#components.optional.bin">12.5.1. Files affecting the binary package</a></span></dt>
                   3130: <dt><span class="sect2"><a href="#components.optional.build">12.5.2. Files affecting the build process</a></span></dt>
                   3131: <dt><span class="sect2"><a href="#components.optional.none">12.5.3. Files affecting nothing at all</a></span></dt>
                   3132: </dl></dd>
                   3133: <dt><span class="sect1"><a href="#work-dir">12.6. <code class="filename">work*</code></a></span></dt>
                   3134: <dt><span class="sect1"><a href="#files-dir">12.7. <code class="filename">files/*</code></a></span></dt>
1.106     rillig   3135: </dl></dd>
1.299     rillig   3136: <dt><span class="chapter"><a href="#build">13. The build process</a></span></dt>
1.106     rillig   3137: <dd><dl>
1.299     rillig   3138: <dt><span class="sect1"><a href="#build.intro">13.1. Introduction</a></span></dt>
                   3139: <dt><span class="sect1"><a href="#build.prefix">13.2. Program location</a></span></dt>
                   3140: <dt><span class="sect1"><a href="#build.builddirs">13.3. Directories used during the build process</a></span></dt>
                   3141: <dt><span class="sect1"><a href="#build.running">13.4. Running a phase</a></span></dt>
                   3142: <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   3143: <dd><dl>
1.299     rillig   3144: <dt><span class="sect2"><a href="#build.fetch.what">13.5.1. What to fetch and where to get it from</a></span></dt>
                   3145: <dt><span class="sect2"><a href="#build.fetch.how">13.5.2. How are the files fetched?</a></span></dt>
1.106     rillig   3146: </dl></dd>
1.299     rillig   3147: <dt><span class="sect1"><a href="#build.checksum">13.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                   3148: <dt><span class="sect1"><a href="#build.extract">13.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                   3149: <dt><span class="sect1"><a href="#build.patch">13.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                   3150: <dt><span class="sect1"><a href="#build.tools">13.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                   3151: <dt><span class="sect1"><a href="#build.wrapper">13.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                   3152: <dt><span class="sect1"><a href="#build.configure">13.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   3153: <dt><span class="sect1"><a href="#build.build">13.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   3154: <dt><span class="sect1"><a href="#build.test">13.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                   3155: <dt><span class="sect1"><a href="#build.install">13.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   3156: <dt><span class="sect1"><a href="#build.package">13.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
                   3157: <dt><span class="sect1"><a href="#build.clean">13.16. Cleaning up</a></span></dt>
                   3158: <dt><span class="sect1"><a href="#build.helpful-targets">13.17. Other helpful targets</a></span></dt>
                   3159: </dl></dd>
                   3160: <dt><span class="chapter"><a href="#creating">14. Creating a new pkgsrc package from scratch</a></span></dt>
                   3161: <dd><dl>
                   3162: <dt><span class="sect1"><a href="#creating.common">14.1. Common types of packages</a></span></dt>
1.106     rillig   3163: <dd><dl>
1.299     rillig   3164: <dt><span class="sect2"><a href="#creating.perl-module">14.1.1. Perl modules</a></span></dt>
                   3165: <dt><span class="sect2"><a href="#creating.python-module">14.1.2. Python modules and programs</a></span></dt>
                   3166: <dt><span class="sect2"><a href="#creating.R-package">14.1.3. R packages</a></span></dt>
                   3167: <dt><span class="sect2"><a href="#creating.TeX-package">14.1.4. TeXlive packages</a></span></dt>
1.106     rillig   3168: </dl></dd>
1.299     rillig   3169: <dt><span class="sect1"><a href="#creating.examples">14.2. Examples</a></span></dt>
                   3170: <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   3171: </dl></dd>
1.299     rillig   3172: <dt><span class="chapter"><a href="#makefile">15. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.106     rillig   3173: <dd><dl>
1.299     rillig   3174: <dt><span class="sect1"><a href="#makefile.style">15.1. Caveats</a></span></dt>
                   3175: <dt><span class="sect1"><a href="#makefile.variables">15.2. <code class="filename">Makefile</code> variables</a></span></dt>
                   3176: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">15.2.1. Naming conventions</a></span></dt></dl></dd>
                   3177: <dt><span class="sect1"><a href="#makefile.code">15.3. Code snippets</a></span></dt>
1.106     rillig   3178: <dd><dl>
1.299     rillig   3179: <dt><span class="sect2"><a href="#adding-to-list">15.3.1. Adding things to a list</a></span></dt>
                   3180: <dt><span class="sect2"><a href="#echo-literal">15.3.2. Echoing a string exactly as-is</a></span></dt>
                   3181: <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>
                   3182: <dt><span class="sect2"><a href="#empty-variables">15.3.4. Handling possibly empty variables</a></span></dt>
1.106     rillig   3183: </dl></dd>
                   3184: </dl></dd>
1.299     rillig   3185: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
1.106     rillig   3186: <dd><dl>
1.299     rillig   3187: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
                   3188: <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>
                   3189: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
                   3190: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.106     rillig   3191: </dl></dd>
1.299     rillig   3192: <dt><span class="chapter"><a href="#tools">17. Tools needed for building or running</a></span></dt>
1.106     rillig   3193: <dd><dl>
1.299     rillig   3194: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
                   3195: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
                   3196: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
                   3197: </dl></dd>
                   3198: <dt><span class="chapter"><a href="#buildlink">18. Buildlink methodology</a></span></dt>
                   3199: <dd><dl>
                   3200: <dt><span class="sect1"><a href="#converting-to-buildlink3">18.1. Converting packages to use buildlink3</a></span></dt>
                   3201: <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   3202: <dd><dl>
1.299     rillig   3203: <dt><span class="sect2"><a href="#anatomy-of-bl3">18.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
                   3204: <dt><span class="sect2"><a href="#updating-buildlink-depends">18.2.2. Updating
1.133     wiz      3205:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   3206:       and
                   3207:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   3208:       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106     rillig   3209: </dl></dd>
1.299     rillig   3210: <dt><span class="sect1"><a href="#writing-builtin.mk">18.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
                   3211: <dd><dl>
                   3212: <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>
                   3213: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">18.3.2. Global preferences for native or pkgsrc software</a></span></dt>
                   3214: </dl></dd>
                   3215: </dl></dd>
                   3216: <dt><span class="chapter"><a href="#plist">19. PLIST issues</a></span></dt>
1.106     rillig   3217: <dd><dl>
1.299     rillig   3218: <dt><span class="sect1"><a href="#rcs-id">19.1. RCS ID</a></span></dt>
                   3219: <dt><span class="sect1"><a href="#automatic-plist-generation">19.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                   3220: <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>
                   3221: <dt><span class="sect1"><a href="#plist.misc">19.4. Variable substitution in PLIST</a></span></dt>
                   3222: <dt><span class="sect1"><a href="#manpage-compression">19.5. Man page compression</a></span></dt>
                   3223: <dt><span class="sect1"><a href="#using-PLIST_SRC">19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
                   3224: <dt><span class="sect1"><a href="#platform-specific-plist">19.7. Platform-specific and differing PLISTs</a></span></dt>
                   3225: <dt><span class="sect1"><a href="#build-plist">19.8. Build-specific PLISTs</a></span></dt>
                   3226: <dt><span class="sect1"><a href="#faq.common-dirs">19.9. Sharing directories between packages</a></span></dt>
1.106     rillig   3227: </dl></dd>
1.299     rillig   3228: <dt><span class="chapter"><a href="#pkginstall">20. The pkginstall framework</a></span></dt>
                   3229: <dd><dl>
                   3230: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">20.1. Files and directories outside the installation prefix</a></span></dt>
                   3231: <dd><dl>
                   3232: <dt><span class="sect2"><a href="#dirs-outside-prefix">20.1.1. Directory manipulation</a></span></dt>
                   3233: <dt><span class="sect2"><a href="#files-outside-prefix">20.1.2. File manipulation</a></span></dt>
1.106     rillig   3234: </dl></dd>
1.299     rillig   3235: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
1.106     rillig   3236: <dd><dl>
1.299     rillig   3237: <dt><span class="sect2"><a href="#conf-files-sysconfdir">20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
                   3238: <dt><span class="sect2"><a href="#conf-files-configure">20.2.2. Telling the software where configuration files are</a></span></dt>
                   3239: <dt><span class="sect2"><a href="#conf-files-patching">20.2.3. Patching installations</a></span></dt>
                   3240: <dt><span class="sect2"><a href="#conf-files-disable">20.2.4. Disabling handling of configuration files</a></span></dt>
                   3241: </dl></dd>
                   3242: <dt><span class="sect1"><a href="#rcd-scripts">20.3. System startup scripts</a></span></dt>
                   3243: <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>
                   3244: <dt><span class="sect1"><a href="#users-and-groups">20.4. System users and groups</a></span></dt>
                   3245: <dt><span class="sect1"><a href="#shells">20.5. System shells</a></span></dt>
                   3246: <dd><dl><dt><span class="sect2"><a href="#shells-disable">20.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   3247: <dt><span class="sect1"><a href="#fonts">20.6. Fonts</a></span></dt>
                   3248: <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   3249: </dl></dd>
                   3250: <dt><span class="chapter"><a href="#fixes">21. Making your package work</a></span></dt>
                   3251: <dd><dl>
                   3252: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
                   3253: <dd><dl>
                   3254: <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>
                   3255: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
                   3256: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
                   3257: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
                   3258: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
                   3259: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
                   3260: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
                   3261: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
                   3262: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
                   3263: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
                   3264: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                   3265: </dl></dd>
                   3266: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                   3267: <dd><dl>
                   3268: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   3269: <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>
                   3270: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
                   3271: </dl></dd>
                   3272: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   3273: <dd><dl>
                   3274: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
                   3275: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   3276: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
                   3277: </dl></dd>
                   3278: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
                   3279: <dd><dl>
                   3280: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
                   3281: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
                   3282: <dt><span class="sect2"><a href="#perl-scripts">21.4.3. Packages containing perl scripts</a></span></dt>
                   3283: <dt><span class="sect2"><a href="#shell-scripts">21.4.4. Packages containing shell scripts</a></span></dt>
                   3284: <dt><span class="sect2"><a href="#other-programming-languages">21.4.5. Other programming languages</a></span></dt>
                   3285: </dl></dd>
                   3286: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   3287: <dd><dl>
                   3288: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   3289: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.287     rillig   3290: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
                   3291: <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>
                   3292: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.267     rillig   3293: </dl></dd>
                   3294: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   3295: <dd><dl>
                   3296: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
                   3297: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
                   3298: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
                   3299: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
                   3300: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
                   3301: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing perl modules</a></span></dt>
                   3302: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
                   3303: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
                   3304: <dt><span class="sect2"><a href="#gconf-data-files">21.6.9. Packages installing GConf data files</a></span></dt>
                   3305: <dt><span class="sect2"><a href="#scrollkeeper-data-files">21.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
                   3306: <dt><span class="sect2"><a href="#x11-fonts">21.6.11. Packages installing X11 fonts</a></span></dt>
                   3307: <dt><span class="sect2"><a href="#gtk2-modules">21.6.12. Packages installing GTK2 modules</a></span></dt>
                   3308: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.13. Packages installing SGML or XML data</a></span></dt>
                   3309: <dt><span class="sect2"><a href="#mime-database">21.6.14. Packages installing extensions to the MIME database</a></span></dt>
                   3310: <dt><span class="sect2"><a href="#intltool">21.6.15. Packages using intltool</a></span></dt>
                   3311: <dt><span class="sect2"><a href="#startup-scripts">21.6.16. Packages installing startup scripts</a></span></dt>
                   3312: <dt><span class="sect2"><a href="#tex-packages">21.6.17. Packages installing TeX modules</a></span></dt>
                   3313: <dt><span class="sect2"><a href="#emulation-packages">21.6.18. Packages supporting running binaries in
1.87      wiz      3314:     emulation</a></span></dt>
1.267     rillig   3315: <dt><span class="sect2"><a href="#hicolor-theme">21.6.19. Packages installing hicolor theme icons</a></span></dt>
                   3316: <dt><span class="sect2"><a href="#desktop-files">21.6.20. Packages installing desktop files</a></span></dt>
1.77      rillig   3317: </dl></dd>
1.267     rillig   3318: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.77      rillig   3319: </dl></dd>
1.299     rillig   3320: <dt><span class="chapter"><a href="#gnome">22. GNOME packaging and porting</a></span></dt>
                   3321: <dd><dl>
                   3322: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
                   3323: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
                   3324: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
                   3325: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
                   3326: </dl></dd>
1.267     rillig   3327: <dt><span class="chapter"><a href="#submit">23. Submitting and Committing</a></span></dt>
1.77      rillig   3328: <dd><dl>
1.267     rillig   3329: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
                   3330: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   3331: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
                   3332: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
                   3333: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
                   3334: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
                   3335: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
                   3336: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
                   3337: </dl></dd>
                   3338: <dt><span class="chapter"><a href="#devfaq">24. Frequently Asked Questions</a></span></dt>
1.75      rillig   3339: </dl>
                   3340: </div>
1.77      rillig   3341: </div>
1.148     asau     3342: <div class="chapter">
1.77      rillig   3343: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   3344: <a name="help-devel"></a>Chapter 11. Getting help</h2></div></div></div>
                   3345: <p>
                   3346:        To get help when developing pkgsrc, the definitive source is this
                   3347:        document, the pkgsrc guide. If you don't find anything here,
                   3348:        there are alternatives:
                   3349: </p>
                   3350: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   3351: <li class="listitem">
                   3352: <p>
                   3353:        The built-in pkgsrc help, which is available after bootstrapping
                   3354:        pkgsrc. Run <span class="command"><strong>bmake help topic=&#8230;</strong></span> to get
                   3355:        help for any topic, such as a variable name like
                   3356:        <code class="varname">BUILD_DEFS</code>, a make target like
                   3357:        <span class="command"><strong>do-build</strong></span>, a missing C or C++ function like
                   3358:        <span class="command"><strong>strcasecmp</strong></span> or any other topic.</p>
                   3359: <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>
                   3360: </li>
                   3361: <li class="listitem"><p>
1.278     rillig   3362:        To see the value of a single variable, run <span class="command"><strong>bmake
                   3363:        show-var VARNAME=<em class="replaceable"><code>X</code></em></strong></span>.
                   3364: </p></li>
                   3365: <li class="listitem"><p>
                   3366:        To see the values of the most common variables, run
                   3367:        <span class="command"><strong>bmake show-all</strong></span>. These variables are grouped by
                   3368:        topic. To see the variables for a single topic, run
                   3369:        <span class="command"><strong>bmake
                   3370:        show-all-<em class="replaceable"><code>topic</code></em></strong></span>, for example
                   3371:        <span class="command"><strong>bmake show-all-fetch</strong></span>.
                   3372: </p></li>
                   3373: <li class="listitem"><p>
1.267     rillig   3374:        The tech-pkg mailing list, to which
                   3375:        <a class="ulink" href="https://www.NetBSD.org/mailinglists/#tech-pkg" target="_top">you
                   3376:        can subscribe</a> and then <a class="ulink" href="mailto:tech-pkg@NetBSD.org" target="_top">ask your
                   3377:        questions</a>.</p></li>
                   3378: <li class="listitem"><p>The #pkgsrc IRC channel, which is accessible
                   3379:        <a class="ulink" href="https://webchat.freenode.net/" target="_top">via a web browser</a>
                   3380:        or by using a specialized chat program such as
                   3381:        <a class="ulink" href="http://xchat.org/" target="_top">XChat</a>.
                   3382:        Pick any user name and join the channel #pkgsrc.</p></li>
                   3383: </ul></div>
                   3384: </div>
                   3385: <div class="chapter">
                   3386: <div class="titlepage"><div><div><h2 class="title">
1.299     rillig   3387: <a name="components"></a>Chapter 12. Package components - files, directories and contents</h2></div></div></div>
1.91      rillig   3388: <div class="toc">
                   3389: <p><b>Table of Contents</b></p>
1.210     leot     3390: <dl class="toc">
1.299     rillig   3391: <dt><span class="sect1"><a href="#components.Makefile">12.1. <code class="filename">Makefile</code></a></span></dt>
                   3392: <dt><span class="sect1"><a href="#components.distinfo">12.2. <code class="filename">distinfo</code></a></span></dt>
                   3393: <dt><span class="sect1"><a href="#components.patches">12.3. <code class="filename">patches/*</code></a></span></dt>
                   3394: <dd><dl>
                   3395: <dt><span class="sect2"><a href="#components.patch.structure">12.3.1. Structure of a single patch file</a></span></dt>
                   3396: <dt><span class="sect2"><a href="#components.patches.caveats">12.3.2. Creating patch files</a></span></dt>
                   3397: <dt><span class="sect2"><a href="#components.patches.sources">12.3.3. Sources where the patch files come from</a></span></dt>
                   3398: <dt><span class="sect2"><a href="#components.patches.guidelines">12.3.4. Patching guidelines</a></span></dt>
                   3399: <dt><span class="sect2"><a href="#components.patches.feedback">12.3.5. Feedback to the author</a></span></dt>
                   3400: </dl></dd>
                   3401: <dt><span class="sect1"><a href="#other-mandatory-files">12.4. Other mandatory files</a></span></dt>
                   3402: <dt><span class="sect1"><a href="#components.optional">12.5. Optional files</a></span></dt>
                   3403: <dd><dl>
                   3404: <dt><span class="sect2"><a href="#components.optional.bin">12.5.1. Files affecting the binary package</a></span></dt>
                   3405: <dt><span class="sect2"><a href="#components.optional.build">12.5.2. Files affecting the build process</a></span></dt>
                   3406: <dt><span class="sect2"><a href="#components.optional.none">12.5.3. Files affecting nothing at all</a></span></dt>
1.91      rillig   3407: </dl></dd>
1.299     rillig   3408: <dt><span class="sect1"><a href="#work-dir">12.6. <code class="filename">work*</code></a></span></dt>
                   3409: <dt><span class="sect1"><a href="#files-dir">12.7. <code class="filename">files/*</code></a></span></dt>
1.91      rillig   3410: </dl>
                   3411: </div>
1.299     rillig   3412: <p>Whenever you're preparing a package, there are a number of
                   3413: files involved which are described in the following
                   3414: sections.</p>
                   3415: <div class="sect1">
                   3416: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   3417: <a name="components.Makefile"></a>12.1. <code class="filename">Makefile</code>
                   3418: </h2></div></div></div>
                   3419: <p>Building, installation and creation of a binary package are all
                   3420:   controlled by the package's <code class="filename">Makefile</code>.
                   3421:   The <code class="filename">Makefile</code> describes various things about
                   3422:   a package, for example from where to get it, how to configure,
                   3423:   build, and install it.</p>
                   3424: <p>A package <code class="filename">Makefile</code> contains several
                   3425:   sections that describe the package.</p>
                   3426: <p>In the first section there are the following variables, which
                   3427:   should appear exactly in the order given here.  The order and
                   3428:   grouping of the variables is mostly historical and has no further
                   3429:   meaning.</p>
                   3430: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   3431: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
                   3432:     distribution file to be downloaded from the package's
                   3433:     website.</p></li>
                   3434: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
                   3435:     package, as used by pkgsrc. You need to provide it if
                   3436:     <code class="varname">DISTNAME</code> (which is the default) is not a good
                   3437:     name for the package in pkgsrc or <code class="varname">DISTNAME</code> is not
                   3438:     provided (no distribution file is required).  Usually it is the pkgsrc
                   3439:     directory name together with the version number. It must match the
                   3440:     regular expression
                   3441:     <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
                   3442:     starts with a letter or digit, and contains only letters, digits,
                   3443:     dashes, underscores, dots and plus signs.</p></li>
                   3444: <li class="listitem">
                   3445: <p><code class="varname">CATEGORIES</code> is a list of categories
                   3446:     which the package fits in. You can choose any of the top-level
                   3447:     directories of pkgsrc for it.</p>
                   3448: <p>Currently the following values are available for
                   3449:     <code class="varname">CATEGORIES</code>. If more than
                   3450:     one is used, they need to be separated by spaces:</p>
1.77      rillig   3451: <pre class="programlisting">
1.299     rillig   3452: archivers     cross         geography     meta-pkgs     security
                   3453: audio         databases     graphics      misc          shells
                   3454: benchmarks    devel         ham           multimedia    sysutils
                   3455: biology       editors       inputmethod   net           textproc
                   3456: cad           emulators     lang          news          time
                   3457: chat          finance       mail          parallel      wm
                   3458: comms         fonts         math          pkgtools      www
                   3459: converters    games         mbone         print         x11
1.77      rillig   3460: </pre>
                   3461: </li>
1.299     rillig   3462: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
                   3463:     <code class="varname">DYNAMIC_MASTER_SITES</code>,
                   3464:     <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
                   3465:     and <code class="varname">DISTFILES</code> are discussed in detail in
                   3466:     <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>
                   3467: </ul></div>
                   3468: <p>The second section contains information about separately
                   3469:   downloaded patches, if any.
                   3470:   </p>
                   3471: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   3472: <li class="listitem"><p><code class="varname">PATCHFILES</code>:
                   3473:     Name(s) of additional files that contain distribution patches.
                   3474:     There is no default. pkgsrc will look for them at
                   3475:     <code class="varname">PATCH_SITES</code>.
                   3476:     They will automatically be uncompressed before patching if
                   3477:     the names end with <code class="filename">.gz</code> or
                   3478:     <code class="filename">.Z</code>.</p></li>
                   3479: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
                   3480:     Primary location(s) for distribution patch files (see
                   3481:     <code class="varname">PATCHFILES</code> above) if not found locally.</p></li>
                   3482: <li class="listitem"><p><code class="varname">PATCH_DIST_STRIP</code>:
                   3483:     an argument to <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?patch+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> that sets the pathname strip count to
                   3484:     help find the correct files to patch. It defaults to
                   3485:     <span class="command"><strong>-p0</strong></span>.</p></li>
                   3486: </ul></div>
                   3487: <p>The third section contains the following variables.
                   3488:   </p>
                   3489: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   3490: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email
                   3491:     address of the person who feels responsible for this package,
                   3492:     and who is most likely to look at problems or questions regarding
                   3493:     this package which have been reported with <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a>.
                   3494:     Other developers may contact the <code class="varname">MAINTAINER</code>
                   3495:     before making changes to the package, but are not required to
                   3496:     do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
                   3497:     to yourself. If you really can't maintain the package for future
                   3498:     updates, set it to
                   3499:     <code class="email">&lt;<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>&gt;</code>.</p></li>
                   3500: <li class="listitem"><p><code class="varname">OWNER</code> should be used instead
                   3501:     of <code class="varname">MAINTAINER</code> when you do not want other
                   3502:     developers to update or change the package without contacting
                   3503:     you first. A package Makefile should contain one of
                   3504:     <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
                   3505:     not both.  </p></li>
                   3506: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
                   3507:     find more information about the package.</p></li>
                   3508: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
                   3509:     description of the package (should not include the package
                   3510:     name).</p></li>
                   3511: <li class="listitem"><p><code class="varname">LICENSE</code> indicates the license(s)
                   3512:     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>
                   3513: </ul></div>
                   3514: <p>Other variables that affect the build:
                   3515:   </p>
                   3516: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
                   3517: <p><code class="varname">WRKSRC</code>: The directory where the
                   3518:       interesting distribution files of the package are found. The
                   3519:       default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
                   3520:       works for most packages.</p>
                   3521: <p>If a package doesn't create a subdirectory for itself
                   3522:       (most GNU software does, for instance), but extracts itself in
                   3523:       the current directory, you should set
                   3524:       <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
                   3525: <p>If a package doesn't create a subdirectory with the
                   3526:       name of <code class="varname">DISTNAME</code> but some different name,
                   3527:       set <code class="varname">WRKSRC</code> to point to the proper name in
                   3528:       <code class="filename">${WRKDIR}</code>, for example
                   3529:       <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
                   3530:       <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>
                   3531: <p>The name of the working directory created by pkgsrc is
                   3532:       taken from the <code class="varname">WRKDIR_BASENAME</code>
                   3533:       variable. By default, its value is
                   3534:       <code class="filename">work</code>. If you want to use the same
                   3535:       pkgsrc tree for building different kinds of binary packages,
                   3536:       you can change the variable according to your needs. Two
                   3537:       other variables handle common cases of setting
                   3538:       <code class="varname">WRKDIR_BASENAME</code> individually. If
                   3539:       <code class="varname">OBJHOSTNAME</code> is defined in
                   3540:       <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
                   3541:       the host's name is attached to the directory name. If
                   3542:       <code class="varname">OBJMACHINE</code> is defined, the platform name
                   3543:       is attached, which might look like
                   3544:       <code class="filename">work.i386</code> or
                   3545:       <code class="filename">work.sparc</code>.</p>
                   3546: </li></ul></div>
                   3547: <p>Please pay attention to the following gotchas:</p>
                   3548: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   3549: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
                   3550:       installed in compressed form by the package.  For packages using
                   3551:       BSD-style makefiles which honor MANZ, there is
                   3552:       <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
                   3553: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
                   3554:       <span class="quote">&#8220;<span class="quote">${PREFIX}</span>&#8221;</span> in all files (see patches,
                   3555:       below).</p></li>
                   3556: <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>
                   3557: </ul></div>
                   3558: </div>
1.148     asau     3559: <div class="sect1">
1.91      rillig   3560: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   3561: <a name="components.distinfo"></a>12.2. <code class="filename">distinfo</code>
                   3562: </h2></div></div></div>
                   3563: <p>The <code class="filename">distinfo</code> file contains the message
                   3564:   digest, or checksum, of each distfile needed for the package. This
                   3565:   ensures that the distfiles retrieved from the Internet have not been
                   3566:   corrupted during transfer or altered by a malign force to introduce
                   3567:   a security hole. To provide maximum security, all distfiles are
                   3568:   protected using three different message digest algorithms (SHA1,
                   3569:   RMD160, SHA512), as well as the file size.</p>
                   3570: <p>The <code class="filename">distinfo</code> file also contains the
                   3571:   checksums for all the patches found in the
                   3572:   <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
                   3573:   are only applied intentionally and that they don't accidentally change,
                   3574:   e.g. when merging different changes together. They also make sure that
                   3575:   new patches are actually added to CVS and old ones are removed.
                   3576:   Too see whether the patches and the <code class="filename">distinfo</code> file
                   3577:   match, run <span class="command"><strong>pkglint</strong></span> after changing the patches.</p>
                   3578: <p>To regenerate the <code class="filename">distinfo</code> file, use the
                   3579:   <span class="command"><strong>make distinfo</strong></span> command.</p>
                   3580: <p>Some packages have different sets of distfiles depending on
                   3581:   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
                   3582:   <code class="filename">distinfo</code> file and care should be taken when
                   3583:   upgrading such a package to ensure distfile information is not
                   3584:   lost.</p>
                   3585: </div>
                   3586: <div class="sect1">
                   3587: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   3588: <a name="components.patches"></a>12.3. <code class="filename">patches/*</code>
                   3589: </h2></div></div></div>
                   3590: <p>Some packages don't work out-of-the box on the various
                   3591:   platforms that are supported by pkgsrc. These packages need
                   3592:   to be patched to make them work. The patch files can be
                   3593:   found in the <code class="filename">patches/</code> directory.</p>
                   3594: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
                   3595:   applied to the files in <code class="varname">WRKSRC</code> directory after
                   3596:   extracting them, in alphabetic order.</p>
1.148     asau     3597: <div class="sect2">
1.91      rillig   3598: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   3599: <a name="components.patch.structure"></a>12.3.1. Structure of a single patch file</h3></div></div></div>
                   3600: <p>The <code class="filename">patch-*</code> files should be in
                   3601:   <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
                   3602:   problems. (To force patches to apply with fuzz you can set
                   3603:   <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
                   3604:   should contain only changes for a single file, and no file should be
                   3605:   patched by more than one patch file. This helps to keep future
                   3606:   modifications simple.</p>
                   3607: <p>Each patch file is structured as follows: In the first line,
                   3608:   there is the RCS Id of the patch itself. The second line should be
                   3609:   empty for aesthetic reasons. After that, there should be a comment for
                   3610:   each change that the patch does. There are a number of standard
                   3611:   cases:</p>
                   3612: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   3613: <li class="listitem"><p>Patches for commonly known vulnerabilities should
                   3614:   mention the vulnerability ID (CAN, CVE).</p></li>
                   3615: <li class="listitem"><p>Patches that change source code should mention the
                   3616:   platform and other environment (for example, the compiler) that the
                   3617:   patch is needed for.</p></li>
                   3618: </ul></div>
                   3619: <p>The patch should be commented so that any
                   3620:   developer who knows the code of the application can make some use of
                   3621:   the patch. Special care should be taken for the upstream developers,
                   3622:   since we generally want that they accept our patches, so we have less
                   3623:   work in the future.</p>
1.91      rillig   3624: </div>
1.148     asau     3625: <div class="sect2">
1.91      rillig   3626: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   3627: <a name="components.patches.caveats"></a>12.3.2. Creating patch files</h3></div></div></div>
                   3628: <p>One important thing to mention is to pay attention that no RCS
                   3629:   IDs get stored in the patch files, as these will cause problems when
                   3630:   later checked into the NetBSD CVS tree. Use the
                   3631:   <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
                   3632:   problems.</p>
                   3633: <p>For even more automation, we recommend using
                   3634:   <span class="command"><strong>mkpatches</strong></span> from the same package to make a
                   3635:   whole set of patches. You just have to backup files before you
                   3636:   edit them to <code class="filename">filename.orig</code>, e.g. with
                   3637:   <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
                   3638:   using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
                   3639:   you upgrade a package this way, you can easily compare the new
                   3640:   set of patches with the previously existing one with
                   3641:   <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
                   3642:   are replaced by new files, so carefully check if you want to take all
                   3643:   the changes.</p>
                   3644: <p>When you have finished a package, remember to generate
                   3645:   the checksums for the patch files by using the <span class="command"><strong>make
                   3646:   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>
                   3647: <p>When adding a patch that corrects a problem in the
                   3648:   distfile (rather than e.g. enforcing pkgsrc's view of where
                   3649:   man pages should go), send the patch as a bug report to the
                   3650:   maintainer.  This benefits non-pkgsrc users of the package,
                   3651:   and usually makes it possible to remove the patch in future
                   3652:   version.</p>
                   3653: <p>The file names of the patch files are usually of the form
                   3654:   <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
                   3655:   Many packages still use the previous convention
                   3656:   <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
                   3657:   but new patches should be of the form containing the filename.
                   3658:   <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
                   3659:   automatically.</p>
1.118     imil     3660: </div>
1.275     brook    3661: <div class="sect2">
                   3662: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   3663: <a name="components.patches.sources"></a>12.3.3. Sources where the patch files come from</h3></div></div></div>
                   3664: <p>If you want to share patches between multiple packages
                   3665:   in pkgsrc, e.g. because they use the same distfiles, set
                   3666:   <code class="varname">PATCHDIR</code> to the path where the patch files
                   3667:   can be found, e.g.:</p>
                   3668: <pre class="programlisting">
                   3669: PATCHDIR=       ../../editors/xemacs/patches
                   3670: </pre>
                   3671: <p>Patch files that are distributed by the author or other
                   3672:     maintainers can be listed in
                   3673:     <code class="varname">PATCHFILES</code>.</p>
                   3674: <p>If it is desired to store any patches that should not be
                   3675:     committed into pkgsrc, they can be kept outside the pkgsrc
                   3676:     tree in the <code class="filename">$LOCALPATCHES</code> directory. The
                   3677:     directory tree there is expected to have the same
                   3678:     <span class="quote">&#8220;<span class="quote">category/package</span>&#8221;</span> structure as pkgsrc, and
                   3679:     patches are expected to be stored inside these dirs (also
                   3680:     known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
                   3681:     example, if you want to keep a private patch for
                   3682:     <code class="filename">pkgsrc/graphics/png</code>, keep it in
                   3683:     <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
                   3684:     files in the named directory are expected to be patch files,
                   3685:     and <span class="emphasis"><em>they are applied after pkgsrc patches are
                   3686:     applied</em></span>.</p>
1.275     brook    3687: </div>
                   3688: <div class="sect2">
                   3689: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   3690: <a name="components.patches.guidelines"></a>12.3.4. Patching guidelines</h3></div></div></div>
                   3691: <p>When fixing a portability issue in the code do not use
                   3692:       preprocessor magic to check for the current operating system nor
                   3693:       platform.  Doing so hurts portability to other platforms because
                   3694:       the OS-specific details are not abstracted appropriately.</p>
                   3695: <p>The general rule to follow is: instead of checking for the
                   3696:       operating system the application is being built on, check for the
                   3697:       specific <span class="emphasis"><em>features</em></span> you need.  For example,
                   3698:       instead of assuming that kqueue is available under NetBSD and
                   3699:       using the <code class="varname">__NetBSD__</code> macro to conditionalize
                   3700:       kqueue support, add a check that detects kqueue itself &mdash;
                   3701:       yes, this generally involves patching the
                   3702:       <span class="command"><strong>configure</strong></span> script.  There is absolutely nothing
                   3703:       that prevents some OSes from adopting interfaces from other OSes
                   3704:       (e.g. Linux implementing kqueue), something that the above checks
                   3705:       cannot take into account.</p>
                   3706: <p>Of course, checking for features generally involves more
                   3707:       work on the developer's side, but the resulting changes are
                   3708:       cleaner and there are chances they will work on many other
                   3709:       platforms.  Not to mention that there are higher chances of being
                   3710:       later integrated into the mainstream sources.  Remember:
                   3711:       <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
                   3712: <p>Some typical examples:</p>
                   3713: <div class="table">
                   3714: <a name="patch-examples"></a><p class="title"><b>Table 12.1. Patching examples</b></p>
                   3715: <div class="table-contents"><table class="table" summary="Patching examples" border="1">
                   3716: <colgroup>
                   3717: <col>
                   3718: <col>
                   3719: <col>
                   3720: </colgroup>
                   3721: <thead><tr>
                   3722: <th>Where</th>
                   3723: <th>Incorrect</th>
                   3724: <th>Correct</th>
                   3725: </tr></thead>
                   3726: <tbody>
                   3727: <tr>
                   3728: <td>configure script</td>
                   3729: <td>
1.275     brook    3730: <pre class="programlisting">
1.299     rillig   3731: case ${target_os} in
                   3732: netbsd*) have_kvm=yes ;;
                   3733: *)       have_kvm=no  ;;
                   3734: esac
1.275     brook    3735: </pre>
1.299     rillig   3736:              </td>
                   3737: <td>
1.275     brook    3738: <pre class="programlisting">
1.299     rillig   3739: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
1.275     brook    3740: </pre>
1.299     rillig   3741:              </td>
                   3742: </tr>
                   3743: <tr>
                   3744: <td>C source file</td>
                   3745: <td>
1.91      rillig   3746: <pre class="programlisting">
1.299     rillig   3747: #if defined(__NetBSD__)
                   3748: #  include &lt;sys/event.h&gt;
                   3749: #endif
1.91      rillig   3750: </pre>
1.299     rillig   3751:              </td>
                   3752: <td>
1.91      rillig   3753: <pre class="programlisting">
1.299     rillig   3754: #if defined(HAVE_SYS_EVENT_H)
                   3755: #  include &lt;sys/event.h&gt;
                   3756: #endif
1.91      rillig   3757: </pre>
1.299     rillig   3758:              </td>
                   3759: </tr>
                   3760: <tr>
                   3761: <td>C source file</td>
                   3762: <td>
1.91      rillig   3763: <pre class="programlisting">
1.299     rillig   3764: int
                   3765: monitor_file(...)
                   3766: {
                   3767: #if defined(__NetBSD__)
                   3768:         int fd = kqueue();
                   3769:         ...
                   3770: #else
                   3771:         ...
                   3772: #endif
                   3773: }
1.91      rillig   3774: </pre>
1.299     rillig   3775:              </td>
                   3776: <td>
1.91      rillig   3777: <pre class="programlisting">
1.299     rillig   3778: int
                   3779: monitor_file(...)
                   3780: {
                   3781: #if defined(HAVE_KQUEUE)
                   3782:         int fd = kqueue();
                   3783:         ...
                   3784: #else
                   3785:         ...
                   3786: #endif
                   3787: }
1.91      rillig   3788: </pre>
1.299     rillig   3789:              </td>
                   3790: </tr>
                   3791: </tbody>
                   3792: </table></div>
                   3793: </div>
                   3794: <br class="table-break">
                   3795: </div>
                   3796: <div class="sect2">
                   3797: <div class="titlepage"><div><div><h3 class="title">
                   3798: <a name="components.patches.feedback"></a>12.3.5. Feedback to the author</h3></div></div></div>
                   3799: <p>Always, always, <span class="strong"><strong>always</strong></span>
                   3800:       feed back any <span class="emphasis"><em>portability fixes</em></span> or
                   3801:       improvements you do to a package to the mainstream developers.
                   3802:       This is the only way to get their attention on portability issues
                   3803:       and to ensure that future versions can be built out-of-the box on
                   3804:       NetBSD.  Furthermore, any user that gets newer distfiles will get
                   3805:       the fixes straight from the packaged code.</p>
                   3806: <p>This generally involves cleaning up the patches
                   3807:       (because sometimes the patches that are
                   3808:       added to pkgsrc are quick hacks), filing bug reports in the
                   3809:       appropriate trackers for the projects and working with the
                   3810:       mainstream authors to accept your changes.  It is
                   3811:       <span class="emphasis"><em>extremely important</em></span> that you do it so that
                   3812:       the packages in pkgsrc are kept simple and thus further changes
                   3813:       can be done without much hassle.</p>
                   3814: <p>When you have done this, please add a URL to the upstream
                   3815:       bug report to the patch comment.</p>
                   3816: <p>Support the idea of free software!</p>
                   3817: </div>
1.91      rillig   3818: </div>
1.299     rillig   3819: <div class="sect1">
                   3820: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   3821: <a name="other-mandatory-files"></a>12.4. Other mandatory files</h2></div></div></div>
                   3822: <div class="variablelist"><dl class="variablelist">
                   3823: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
                   3824: <dd><p>A multi-line description of the piece of software.  This should include
                   3825:          any credits where they are due.  Please bear in mind that others do not
                   3826:          share your sense of humour (or spelling idiosyncrasies), and that others
                   3827:          will read everything that you write here.</p></dd>
                   3828: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
                   3829: <dd><p>This file governs the files that are installed on your
                   3830:          system: all the binaries, manual pages, etc. There are other
                   3831:          directives which may be entered in this file, to control the
                   3832:          creation and deletion of directories, and the location of
                   3833:          inserted files.  See <a class="xref" href="#plist" title="Chapter 19. PLIST issues">Chapter 19, <i>PLIST issues</i></a> for more
                   3834:          information.</p></dd>
                   3835: </dl></div>
                   3836: </div>
                   3837: <div class="sect1">
                   3838: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   3839: <a name="components.optional"></a>12.5. Optional files</h2></div></div></div>
                   3840: <div class="sect2">
                   3841: <div class="titlepage"><div><div><h3 class="title">
                   3842: <a name="components.optional.bin"></a>12.5.1. Files affecting the binary package</h3></div></div></div>
                   3843: <div class="variablelist"><dl class="variablelist">
                   3844: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
                   3845: <dd>
                   3846: <p>This shell script is invoked twice by <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>.
                   3847:            First time after package extraction and before files are
                   3848:            moved in place, the second time after the files to install
                   3849:            are moved in place. This can be used to do any custom
                   3850:            procedures not possible with @exec commands in
                   3851:            <code class="filename">PLIST</code>. See <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> and
                   3852:            <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1.i386+NetBSD-9.0"><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>.
                   3853:            Please note that you can modify variables in it easily by using
                   3854:            <code class="varname">FILES_SUBST</code> in the package's
                   3855:            <code class="filename">Makefile</code>:</p>
1.91      rillig   3856: <pre class="programlisting">
1.299     rillig   3857: FILES_SUBST+=  SOMEVAR="somevalue"
1.91      rillig   3858: </pre>
1.299     rillig   3859: <p>replaces "@SOMEVAR@" with <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span> in the
                   3860:            <code class="filename">INSTALL</code>.  By default, substitution is
                   3861:            performed for <code class="varname">PREFIX</code>,
                   3862:            <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
                   3863:            <code class="varname">VARBASE</code>, and a few others, type
                   3864:            <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
                   3865:            complete list.</p>
                   3866: </dd>
                   3867: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
                   3868: <dd><p>This script is executed before and after any files are removed.  It is
                   3869:            this script's responsibility to clean up any additional messy details
                   3870:            around the package's installation, since all pkg_delete knows is how to
                   3871:            delete the files created in the original distribution.
                   3872:            See <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
                   3873:            and <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information.
                   3874:            The same methods to replace variables can be used as for
                   3875:            the <code class="filename">INSTALL</code> file.</p></dd>
                   3876: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
                   3877: <dd>
                   3878: <p>This file is displayed after installation of the package.
                   3879:            Useful for things like legal notices on almost-free
                   3880:            software and hints for updating config files after
                   3881:            installing modules for apache, PHP etc.
                   3882:            Please note that you can modify variables in it easily by using
                   3883:            <code class="varname">MESSAGE_SUBST</code> in the package's
                   3884:            <code class="filename">Makefile</code>:</p>
1.91      rillig   3885: <pre class="programlisting">
1.299     rillig   3886: MESSAGE_SUBST+=  SOMEVAR="somevalue"
1.91      rillig   3887: </pre>
1.299     rillig   3888: <p>replaces "${SOMEVAR}" with <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span> in
                   3889:            <code class="filename">MESSAGE</code>.  By default, substitution is
                   3890:            performed for <code class="varname">PKGNAME</code>,
                   3891:            <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
                   3892:            <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
                   3893:            <code class="varname">PKG_SYSCONFDIR</code>,
                   3894:            <code class="varname">ROOT_GROUP</code>, and
                   3895:            <code class="varname">ROOT_USER</code>.</p>
                   3896: <p>You can display a different or additional files by
                   3897:            setting the <code class="varname">MESSAGE_SRC</code> variable.  Its
                   3898:            default is <code class="filename">MESSAGE</code>, if the file
                   3899:            exists.</p>
                   3900: </dd>
                   3901: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
                   3902: <dd>
                   3903: <p>This file is used by the alternatives framework.
                   3904:            It creates, configures, and destroys generic wrappers used to
                   3905:            run programs with similar interfaces.
                   3906:            See pkg_alternatives(8) from pkgtools/pkg_alternatives
                   3907:             for more information.</p>
                   3908: <p>Each line of the file contains two filenames, first
                   3909:            the wrapper and then the alternative provided by the package.
                   3910:            Both paths are relative to <code class="varname">PREFIX</code>.</p>
                   3911: </dd>
                   3912: </dl></div>
                   3913: </div>
                   3914: <div class="sect2">
                   3915: <div class="titlepage"><div><div><h3 class="title">
                   3916: <a name="components.optional.build"></a>12.5.2. Files affecting the build process</h3></div></div></div>
                   3917: <div class="variablelist"><dl class="variablelist">
                   3918: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
                   3919: <dd><p>This file contains arbitrary things that could
                   3920:        also go into a <code class="filename">Makefile</code>, but its purpose is
                   3921:        to be used by more than one package. This file should only be
                   3922:        used when the packages that will use the file are known in
                   3923:        advance. For other purposes it is often better to write a
                   3924:        <code class="filename">*.mk</code> file and give it a good name that
                   3925:        describes what it does.</p></dd>
                   3926: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
                   3927: <dd><p>This file contains the dependency information
                   3928:        for the buildlink3 framework (see <a class="xref" href="#buildlink" title="Chapter 18. Buildlink methodology">Chapter 18, <i>Buildlink methodology</i></a>).</p></dd>
                   3929: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
                   3930: <dd><p>This file contains workarounds for compiler bugs
                   3931:        and similar things. It is included automatically by the pkgsrc
                   3932:        infrastructure, so you don't need an extra
                   3933:        <code class="literal">.include</code> line for
                   3934:        it.</p></dd>
                   3935: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
                   3936: <dd><p>This file contains the code for the
                   3937:        package-specific options (see <a class="xref" href="#options" title="Chapter 16. Options handling">Chapter 16, <i>Options handling</i></a>) that can be
                   3938:        selected by the user. If a package has only one or two options,
                   3939:        it is equally acceptable to put the code directly into the
                   3940:        <code class="filename">Makefile</code>.</p></dd>
                   3941: </dl></div>
                   3942: </div>
                   3943: <div class="sect2">
                   3944: <div class="titlepage"><div><div><h3 class="title">
                   3945: <a name="components.optional.none"></a>12.5.3. Files affecting nothing at all</h3></div></div></div>
                   3946: <div class="variablelist"><dl class="variablelist">
                   3947: <dt><span class="term"><code class="filename">README*</code></span></dt>
                   3948: <dd><p>These files do not take place in the creation of
                   3949:        a package and thus are purely informative to the package
                   3950:        developer.</p></dd>
                   3951: <dt><span class="term"><code class="filename">TODO</code></span></dt>
                   3952: <dd><p>This file contains things that need to be done
                   3953:        to make the package even
                   3954:        better.</p></dd>
                   3955: </dl></div>
                   3956: </div>
                   3957: </div>
                   3958: <div class="sect1">
                   3959: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   3960: <a name="work-dir"></a>12.6. <code class="filename">work*</code>
                   3961: </h2></div></div></div>
                   3962: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
                   3963:     unpacked into the directory denoted by
                   3964:     <code class="varname">WRKDIR</code>. It can be removed by running
                   3965:     <span class="command"><strong>make clean</strong></span>. Besides the sources, this
                   3966:     directory is also used to keep various timestamp files.
                   3967:     The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
                   3968:     The default is <code class="filename">${.CURDIR}/work</code>
                   3969:     or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
                   3970:     if <code class="varname">OBJMACHINE</code> is set.</p>
1.91      rillig   3971: </div>
1.299     rillig   3972: <div class="sect1">
                   3973: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   3974: <a name="files-dir"></a>12.7. <code class="filename">files/*</code>
                   3975: </h2></div></div></div>
                   3976: <p>If you have any files that you wish to be placed in the package
                   3977:     prior to configuration or building, you can place these files here
                   3978:     and use a <span class="command"><strong>${CP}</strong></span> command in the
                   3979:     <span class="quote">&#8220;<span class="quote">post-extract</span>&#8221;</span> target to achieve this.</p>
                   3980: <p>If you want to share files in this way with other
                   3981:     packages, set the <code class="varname">FILESDIR</code> variable to point
                   3982:     to the other package's <code class="filename">files</code> directory,
                   3983:     e.g.:</p>
1.91      rillig   3984: <pre class="programlisting">
1.299     rillig   3985: FILESDIR=       ../../editors/xemacs/files
1.91      rillig   3986: </pre>
                   3987: </div>
                   3988: </div>
1.148     asau     3989: <div class="chapter">
1.75      rillig   3990: <div class="titlepage"><div><div><h2 class="title">
1.299     rillig   3991: <a name="build"></a>Chapter 13. The build process</h2></div></div></div>
1.75      rillig   3992: <div class="toc">
                   3993: <p><b>Table of Contents</b></p>
1.210     leot     3994: <dl class="toc">
1.299     rillig   3995: <dt><span class="sect1"><a href="#build.intro">13.1. Introduction</a></span></dt>
                   3996: <dt><span class="sect1"><a href="#build.prefix">13.2. Program location</a></span></dt>
                   3997: <dt><span class="sect1"><a href="#build.builddirs">13.3. Directories used during the build process</a></span></dt>
                   3998: <dt><span class="sect1"><a href="#build.running">13.4. Running a phase</a></span></dt>
                   3999: <dt><span class="sect1"><a href="#build.fetch">13.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                   4000: <dd><dl>
                   4001: <dt><span class="sect2"><a href="#build.fetch.what">13.5.1. What to fetch and where to get it from</a></span></dt>
                   4002: <dt><span class="sect2"><a href="#build.fetch.how">13.5.2. How are the files fetched?</a></span></dt>
                   4003: </dl></dd>
                   4004: <dt><span class="sect1"><a href="#build.checksum">13.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                   4005: <dt><span class="sect1"><a href="#build.extract">13.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                   4006: <dt><span class="sect1"><a href="#build.patch">13.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                   4007: <dt><span class="sect1"><a href="#build.tools">13.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                   4008: <dt><span class="sect1"><a href="#build.wrapper">13.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                   4009: <dt><span class="sect1"><a href="#build.configure">13.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   4010: <dt><span class="sect1"><a href="#build.build">13.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   4011: <dt><span class="sect1"><a href="#build.test">13.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                   4012: <dt><span class="sect1"><a href="#build.install">13.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   4013: <dt><span class="sect1"><a href="#build.package">13.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
                   4014: <dt><span class="sect1"><a href="#build.clean">13.16. Cleaning up</a></span></dt>
                   4015: <dt><span class="sect1"><a href="#build.helpful-targets">13.17. Other helpful targets</a></span></dt>
1.75      rillig   4016: </dl>
                   4017: </div>
1.148     asau     4018: <div class="sect1">
1.75      rillig   4019: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4020: <a name="build.intro"></a>13.1. Introduction</h2></div></div></div>
                   4021: <p>This chapter gives a detailed description on how a package is
                   4022:     built. Building a package is separated into different
                   4023:     <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
                   4024:     <code class="varname">build</code>, <code class="varname">install</code>), all of which are
                   4025:     described in the following sections. Each phase is split into
                   4026:     so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
                   4027:     containing phase, prefixed by one of <code class="varname">pre-</code>,
                   4028:     <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
                   4029:     <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
                   4030:     of the actual work is done in the <code class="varname">do-*</code> stages.</p>
                   4031: <p>Never override the regular targets (like
                   4032:     <code class="varname">fetch</code>), if you have to, override the
                   4033:     <code class="varname">do-*</code> ones instead.</p>
                   4034: <p>The basic steps for building a program are always the same.  First
                   4035:     the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
                   4036:     the local system and then extracted. After any pkgsrc-specific patches
                   4037:     to compile properly are applied, the software can be configured, then
                   4038:     built (usually by compiling), and finally the generated binaries, etc.
                   4039:     can be put into place on the system.</p>
                   4040: <p>To get more details about what is happening at each step,
                   4041:     you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
                   4042:     <code class="varname">PATCH_DEBUG</code> variable if you are just interested
                   4043:     in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
                   4044: </div>
                   4045: <div class="sect1">
                   4046: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   4047: <a name="build.prefix"></a>13.2. Program location</h2></div></div></div>
                   4048: <p>Before outlining the process performed by the NetBSD package system in
                   4049:     the next section, here's a brief discussion on where programs are
                   4050:     installed, and which variables influence this.</p>
                   4051: <p>The automatic variable <code class="varname">PREFIX</code> indicates
                   4052:     where all files of the final program shall be installed. It is
                   4053:     usually set to <code class="varname">LOCALBASE</code>
                   4054:     (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
                   4055:     for pkgs in the <code class="filename">cross</code> category.  The value of
                   4056:     <code class="varname">PREFIX</code> needs to be put
                   4057:     into the various places in the program's source where paths to
                   4058:     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>
                   4059: <p>When choosing which of these variables to use,
                   4060:     follow the following rules:</p>
1.148     asau     4061: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.299     rillig   4062: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
                   4063:        where the current pkg will be installed.  When referring to a
                   4064:        pkg's own installation path, use
                   4065:        <span class="quote">&#8220;<span class="quote">${PREFIX}</span>&#8221;</span>.</p></li>
                   4066: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
                   4067:        are installed.  If you need to construct a -I or -L argument
                   4068:        to the compiler to find includes and libraries installed by
                   4069:        another non-X11 pkg, use <span class="quote">&#8220;<span class="quote">${LOCALBASE}</span>&#8221;</span>. The name
                   4070:        <code class="varname">LOCALBASE</code> stems from FreeBSD, which
                   4071:        installed all packages in <code class="filename">/usr/local</code>. As
                   4072:        pkgsrc leaves <code class="filename">/usr/local</code> for the system
                   4073:        administrator, this variable is a misnomer.</p></li>
                   4074: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
                   4075:        distribution (from xsrc, etc.) is installed. When looking for
                   4076:        <span class="emphasis"><em>standard</em></span> X11 includes (not those
                   4077:        installed by a package), use <span class="quote">&#8220;<span class="quote">${X11BASE}</span>&#8221;</span>.</p></li>
                   4078: <li class="listitem"><p>X11-based packages using imake must set
                   4079:        <code class="varname">USE_IMAKE</code> to be installed correctly under
                   4080:        <code class="varname">LOCALBASE</code>.</p></li>
                   4081: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
                   4082:        install files according to <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?hier+7.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">hier</span>(7)</span></a>, with the exception that
                   4083:        manual pages go into <code class="filename">${PREFIX}/man</code>, not
                   4084:        <code class="filename">${PREFIX}/share/man</code>.</p></li>
                   4085: </ul></div>
                   4086: </div>
                   4087: <div class="sect1">
                   4088: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   4089: <a name="build.builddirs"></a>13.3. Directories used during the build process</h2></div></div></div>
                   4090: <p>When building a package, various directories are used to store
                   4091:     source files, temporary files, pkgsrc-internal files, and so on. These
                   4092:     directories are explained here.</p>
                   4093: <p>Some of the directory variables contain relative pathnames. There
                   4094:     are two common base directories for these relative directories:
                   4095:     <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
                   4096:     pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
                   4097:     inside the package itself.</p>
                   4098: <div class="variablelist"><dl class="variablelist">
                   4099: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
                   4100: <dd><p>This is an absolute pathname that points to the pkgsrc
                   4101:       root directory. Generally, you don't need
                   4102:       it.</p></dd>
                   4103: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
                   4104: <dd><p>This is an absolute pathname that points to the
                   4105:       current package.</p></dd>
                   4106: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
                   4107: <dd><p>This is a pathname relative to
                   4108:       <code class="varname">PKGSRCDIR</code> that points to the current
                   4109:       package.</p></dd>
                   4110: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
                   4111: <dd><p>This is an absolute pathname pointing to the directory
                   4112:       where all work takes place. The distfiles are extracted to this
                   4113:       directory. It also contains temporary directories and log files used by
                   4114:       the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
                   4115:       the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
                   4116: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
                   4117: <dd><p>This is an absolute pathname pointing to the directory
                   4118:       where the distfiles are extracted. It is usually a direct subdirectory
                   4119:       of <code class="varname">WRKDIR</code>, and often it's the only directory entry
                   4120:       that isn't hidden. This variable may be changed by a package
                   4121:       <code class="filename">Makefile</code>.</p></dd>
                   4122: </dl></div>
                   4123: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
                   4124:     the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
                   4125:     to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
                   4126:     <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
                   4127:     If users would like to have their pkgsrc trees behave in a
                   4128:     read-only manner, then the value of
                   4129:     <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
                   4130:     <span class="emphasis"><em>no</em></span>.</p>
1.75      rillig   4131: </div>
1.148     asau     4132: <div class="sect1">
1.75      rillig   4133: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4134: <a name="build.running"></a>13.4. Running a phase</h2></div></div></div>
                   4135: <p>You can run a particular phase by typing <span class="command"><strong>make
                   4136:     phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
                   4137:     phase. This will automatically run all phases that are required for this
                   4138:     phase. The default phase is <code class="varname">build</code>, that is, when you
                   4139:     run <span class="command"><strong>make</strong></span> without parameters in a package directory,
                   4140:     the package will be built, but not installed.</p>
1.75      rillig   4141: </div>
1.148     asau     4142: <div class="sect1">
1.75      rillig   4143: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4144: <a name="build.fetch"></a>13.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
                   4145: <p>The first step in building a package is to fetch the
                   4146:     distribution files (distfiles) from the sites that are providing
                   4147:     them. This is the task of the <span class="emphasis"><em>fetch</em></span>
                   4148:     phase.</p>
1.148     asau     4149: <div class="sect2">
1.93      rillig   4150: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   4151: <a name="build.fetch.what"></a>13.5.1. What to fetch and where to get it from</h3></div></div></div>
                   4152: <p>In simple cases, <code class="varname">MASTER_SITES</code>
                   4153:       defines all URLs from where the distfile, whose name is
                   4154:       derived from the <code class="varname">DISTNAME</code> variable, is
                   4155:       fetched. The more complicated cases are described
                   4156:       below.</p>
                   4157: <p>The variable <code class="varname">DISTFILES</code> specifies
                   4158:       the list of distfiles that have to be fetched. Its value
                   4159:       defaults to <code class="literal">${DEFAULT_DISTFILES}</code> and
                   4160:       its value is <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
                   4161:       so that most packages don't need to define it at all.
                   4162:       <code class="varname">EXTRACT_SUFX</code> is
                   4163:       <code class="literal">.tar.gz</code> by default, but can be changed
                   4164:       freely. Note that if your package requires additional
                   4165:       distfiles to the default one, you cannot just append the
                   4166:       additional filenames using the <code class="literal">+=</code>
                   4167:       operator, but you have write for example:</p>
                   4168: <pre class="programlisting">
                   4169: DISTFILES=      ${DEFAULT_DISTFILES} additional-files.tar.gz
                   4170: </pre>
                   4171: <p>Each distfile is fetched from a list of sites, usually
                   4172:       <code class="varname">MASTER_SITES</code>. If the package has multiple
                   4173:       <code class="varname">DISTFILES</code> or multiple
                   4174:       <code class="varname">PATCHFILES</code> from different sites, you can
                   4175:       set
                   4176:       <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
                   4177:       to the list of URLs where the file
                   4178:       <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
                   4179:       (including the suffix) can be found.</p>
                   4180: <pre class="programlisting">
                   4181: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX}
                   4182: DISTFILES+=     foo-file.tar.gz
                   4183: SITES.foo-file.tar.gz= \
                   4184: https://www.somewhere.com/somehow/ \
                   4185: https://www.somewhereelse.com/mirror/somehow/
                   4186: </pre>
                   4187: <p>When actually fetching the distfiles, each item from
                   4188:       <code class="varname">MASTER_SITES</code> or
                   4189:       <code class="varname">SITES.*</code> gets the name of each distfile
                   4190:       appended to it, without an intermediate slash. Therefore,
                   4191:       all site values have to end with a slash or other separator
                   4192:       character. This allows for example to set
                   4193:       <code class="varname">MASTER_SITES</code> to a URL of a CGI script
                   4194:       that gets the name of the distfile as a parameter. In this
                   4195:       case, the definition would look like:</p>
                   4196: <pre class="programlisting">
                   4197: MASTER_SITES=   https://www.example.com/download.cgi?file=
                   4198: </pre>
                   4199: <p> The exception to this rule are URLs starting with a dash.
                   4200:       In that case the URL is taken as is, fetched and the result
                   4201:       stored under the name of the distfile. You can use this style
                   4202:       for the case when the download URL style does not match the
                   4203:       above common case. For example, if permanent download URL is a
                   4204:       redirector to the real download URL, or the download file name
                   4205:       is offered by an HTTP Content-Disposition header. In the
                   4206:       following example, <code class="filename">foo-1.0.0.tar.gz</code> will be
                   4207:       created instead of the default
                   4208:       <code class="filename">v1.0.0.tar.gz</code>.</p>
                   4209: <pre class="programlisting">
                   4210: DISTNAME=       foo-1.0.0
                   4211: MASTER_SITES=   -https://www.example.com/archive/v1.0.0.tar.gz
                   4212: </pre>
                   4213: <p>There are some predefined values for
                   4214:       <code class="varname">MASTER_SITES</code>, which can be used in
                   4215:       packages.  The names of the variables should speak for
                   4216:       themselves.</p>
                   4217: <table border="0" summary="Simple list" class="simplelist">
                   4218: <tr>
                   4219: <td>MASTER_SITE_APACHE</td>
                   4220: <td>MASTER_SITE_BACKUP</td>
                   4221: </tr>
                   4222: <tr>
                   4223: <td>MASTER_SITE_CRATESIO</td>
                   4224: <td>MASTER_SITE_CYGWIN</td>
                   4225: </tr>
                   4226: <tr>
                   4227: <td>MASTER_SITE_DEBIAN</td>
                   4228: <td>MASTER_SITE_FREEBSD</td>
                   4229: </tr>
                   4230: <tr>
                   4231: <td>MASTER_SITE_FREEBSD_LOCAL</td>
                   4232: <td>MASTER_SITE_GENTOO</td>
                   4233: </tr>
                   4234: <tr>
                   4235: <td>MASTER_SITE_GITHUB</td>
                   4236: <td>MASTER_SITE_GNOME</td>
                   4237: </tr>
                   4238: <tr>
                   4239: <td>MASTER_SITE_GNU</td>
                   4240: <td>MASTER_SITE_GNUSTEP</td>
                   4241: </tr>
                   4242: <tr>
                   4243: <td>MASTER_SITE_HASKELL_HACKAGE</td>
                   4244: <td>MASTER_SITE_IFARCHIVE</td>
                   4245: </tr>
                   4246: <tr>
                   4247: <td>MASTER_SITE_KDE</td>
                   4248: <td>MASTER_SITE_MOZILLA</td>
                   4249: </tr>
                   4250: <tr>
                   4251: <td>MASTER_SITE_MOZILLA_ALL</td>
                   4252: <td>MASTER_SITE_MYSQL</td>
                   4253: </tr>
                   4254: <tr>
                   4255: <td>MASTER_SITE_NETLIB</td>
                   4256: <td>MASTER_SITE_OPENBSD</td>
                   4257: </tr>
                   4258: <tr>
                   4259: <td>MASTER_SITE_OPENOFFICE</td>
                   4260: <td>MASTER_SITE_OSDN</td>
                   4261: </tr>
                   4262: <tr>
                   4263: <td>MASTER_SITE_PERL_CPAN</td>
                   4264: <td>MASTER_SITE_PGSQL</td>
                   4265: </tr>
                   4266: <tr>
                   4267: <td>MASTER_SITE_PYPI</td>
                   4268: <td>MASTER_SITE_RUBYGEMS</td>
                   4269: </tr>
                   4270: <tr>
                   4271: <td>MASTER_SITE_R_CRAN</td>
                   4272: <td>MASTER_SITE_SOURCEFORGE</td>
                   4273: </tr>
1.85      jmmv     4274: <tr>
1.299     rillig   4275: <td>MASTER_SITE_SUNSITE</td>
                   4276: <td>MASTER_SITE_SUSE</td>
1.85      jmmv     4277: </tr>
                   4278: <tr>
1.299     rillig   4279: <td>MASTER_SITE_TEX_CTAN</td>
                   4280: <td>MASTER_SITE_XCONTRIB</td>
1.85      jmmv     4281: </tr>
                   4282: <tr>
1.299     rillig   4283: <td>MASTER_SITE_XEMACS</td>
                   4284: <td>MASTER_SITE_XORG</td>
                   4285: </tr>
                   4286: </table>
                   4287: <p>Some explanations for the less self-explaining ones:
                   4288:       <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
                   4289:       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
                   4290:       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>
                   4291: <p>If you choose one of these predefined sites, you may
                   4292:       want to specify a subdirectory of that site. Since these
                   4293:       macros may expand to more than one actual site, you
                   4294:       <span class="emphasis"><em>must</em></span> use the following construct to
                   4295:       specify a subdirectory:</p>
1.100     rillig   4296: <pre class="programlisting">
1.299     rillig   4297: MASTER_SITES=   ${MASTER_SITE_GNU:=subdirectory/name/}
                   4298: MASTER_SITES=   ${MASTER_SITE_SOURCEFORGE:=project_name/}
1.100     rillig   4299: </pre>
1.299     rillig   4300: <p>Note the trailing slash after the subdirectory
                   4301:       name.</p>
                   4302: </div>
                   4303: <div class="sect2">
                   4304: <div class="titlepage"><div><div><h3 class="title">
                   4305: <a name="build.fetch.how"></a>13.5.2. How are the files fetched?</h3></div></div></div>
                   4306: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
                   4307:       all the distfiles exist in a local directory
                   4308:       (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
                   4309:       user). If the files do not exist, they are fetched using
                   4310:       commands of the form</p>
1.100     rillig   4311: <pre class="programlisting">
1.299     rillig   4312: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
                   4313: </pre>
                   4314: <p>where <code class="literal">${site}</code> varies through
                   4315:       several possibilities in turn: first,
                   4316:       <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
                   4317:       sites specified in either <code class="varname">SITES.file</code> if
                   4318:       defined, else <code class="varname">MASTER_SITES</code> or
                   4319:       <code class="varname">PATCH_SITES</code>, as applies, then finally the
                   4320:       value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
                   4321:       all except the first and the last can be optionally sorted
                   4322:       by the user, via setting either
                   4323:       <code class="varname">MASTER_SORT_RANDOM</code>, and
                   4324:       <code class="varname">MASTER_SORT_AWK</code> or
                   4325:       <code class="varname">MASTER_SORT_REGEX</code>.</p>
                   4326: <p> The specific command and arguments used depend on the
                   4327:       <code class="varname">FETCH_USING</code> parameter. The example above is
                   4328:       for <code class="literal">FETCH_USING=custom</code>.</p>
                   4329: <p>The distfiles mirror run by the NetBSD Foundation uses the
                   4330:       <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
                   4331:       distfiles, if they are freely distributable.  Packages setting
                   4332:       <code class="varname">NO_SRC_ON_FTP</code> (usually to
                   4333:       <span class="quote">&#8220;<span class="quote">${RESTRICTED}</span>&#8221;</span>) will not have their distfiles
                   4334:       mirrored.</p>
1.85      jmmv     4335: </div>
                   4336: </div>
1.299     rillig   4337: <div class="sect1">
                   4338: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   4339: <a name="build.checksum"></a>13.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
                   4340: <p>After the distfile(s) are fetched, their checksum is
                   4341:     generated and compared with the checksums stored in the
                   4342:     distinfo file. If the checksums don't match, the build is
                   4343:     aborted. This is to ensure the same distfile is used for
                   4344:     building, and that the distfile wasn't changed, e.g. by some
                   4345:     malign force, deliberately changed distfiles on the master
                   4346:     distribution site or network lossage.</p>
1.75      rillig   4347: </div>
1.148     asau     4348: <div class="sect1">
1.75      rillig   4349: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4350: <a name="build.extract"></a>13.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
                   4351: <p>When the distfiles are present on the local system, they
                   4352:     need to be extracted, as they usually come in the form of some
                   4353:     compressed archive format.</p>
                   4354: <p>By default, all <code class="varname">DISTFILES</code> are
                   4355:     extracted. If you only need some of them, you can set the
                   4356:     <code class="varname">EXTRACT_ONLY</code> variable to the list of those
                   4357:     files.</p>
                   4358: <p>Extracting the files is usually done by a little
                   4359:     program, <code class="filename">mk/extract/extract</code>, which
                   4360:     already knows how to extract various archive formats, so most
                   4361:     likely you will not need to change anything here. But if you
                   4362:     need, the following variables may help you:</p>
1.148     asau     4363: <div class="variablelist"><dl class="variablelist">
1.299     rillig   4364: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
                   4365: <dd><p>Use these variables to override the default
                   4366:       options for an extract command, which are defined in
                   4367:       <code class="filename">mk/extract/extract</code>.</p></dd>
                   4368: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
                   4369: <dd><p>This variable can be set to
                   4370:       <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
                   4371:       (which is the default value), <code class="literal">pax</code>, or an
                   4372:       absolute pathname pointing to the command with which tar
                   4373:       archives should be extracted.  It is preferred to choose bsdtar over gtar
                   4374:       if NetBSD's pax-as-tar is not good enough.</p></dd>
1.75      rillig   4375: </dl></div>
1.299     rillig   4376: <p>If the <code class="filename">extract</code> program doesn't
                   4377:     serve your needs, you can also override the
                   4378:     <code class="varname">EXTRACT_CMD</code> variable, which holds the
                   4379:     command used for extracting the files. This command is
                   4380:     executed in the <code class="filename">${WRKSRC}</code>
                   4381:     directory. During execution of this command, the shell
                   4382:     variable <code class="varname">extract_file</code> holds the absolute
                   4383:     pathname of the file that is going to be extracted.</p>
                   4384: <p>And if that still does not suffice, you can override the
                   4385:     <code class="varname">do-extract</code> target in the package
                   4386:     Makefile.</p>
1.75      rillig   4387: </div>
1.148     asau     4388: <div class="sect1">
1.75      rillig   4389: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4390: <a name="build.patch"></a>13.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
                   4391: <p>After extraction, all the patches named by the
                   4392:     <code class="varname">PATCHFILES</code>, those present in the patches
                   4393:     subdirectory of the package as well as in
                   4394:     $LOCALPATCHES/$PKGPATH (e.g.
                   4395:     <code class="filename">/usr/local/patches/graphics/png</code>) are
                   4396:     applied.  Patchfiles ending in <code class="filename">.Z</code> or
                   4397:     <code class="filename">.gz</code> are uncompressed before they are
                   4398:     applied, files ending in <code class="filename">.orig</code> or
                   4399:     <code class="filename">.rej</code> are ignored. Any special options to
                   4400:     <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?patch+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> can be handed in
                   4401:     <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>
                   4402: <p>By default <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?patch+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> is given special arguments to make it
                   4403:     fail if the expected text from the patch context is not found in the
                   4404:     patched file. If that happens, fix the patch file by comparing it
                   4405:     with the actual text in the file to be patched.</p>
1.78      rillig   4406: </div>
1.148     asau     4407: <div class="sect1">
1.75      rillig   4408: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4409: <a name="build.tools"></a>13.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
                   4410: <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>.
                   4411:     </p>
1.75      rillig   4412: </div>
1.148     asau     4413: <div class="sect1">
1.75      rillig   4414: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4415: <a name="build.wrapper"></a>13.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
                   4416: <p>This phase creates wrapper programs for the compilers and
                   4417:     linkers. The following variables can be used to tweak the
                   4418:     wrappers.</p>
                   4419: <div class="variablelist"><dl class="variablelist">
                   4420: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
                   4421: <dd><p>The command used to print progress
                   4422:       messages. Does nothing by default. Set to
                   4423:       <code class="literal">${ECHO}</code> to see the progress
                   4424:       messages.</p></dd>
                   4425: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
                   4426: <dd><p>This variable can be set to
                   4427:       <code class="literal">yes</code> (default) or <code class="literal">no</code>,
                   4428:       depending on whether you want additional information in the
                   4429:       wrapper log file.</p></dd>
                   4430: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
                   4431: <dd><p>This variable can be set to
                   4432:       <code class="literal">yes</code> or <code class="literal">no</code>, depending
                   4433:       on whether the wrapper should use its cache, which will
                   4434:       improve the speed. The default value is
                   4435:       <code class="literal">yes</code>, but is forced to
                   4436:       <code class="literal">no</code> if the platform does not support
                   4437:       it.</p></dd>
                   4438: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
                   4439: <dd><p>A list of reordering commands. A reordering
                   4440:       command has the form
                   4441:       <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
                   4442:       It ensures that that
                   4443:       <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
                   4444:       before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
                   4445:       </p></dd>
                   4446: </dl></div>
                   4447: </div>
                   4448: <div class="sect1">
                   4449: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   4450: <a name="build.configure"></a>13.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
                   4451: <p>Most pieces of software need information on the header
                   4452:     files, system calls, and library routines which are available
                   4453:     on the platform they run on. The process of determining this
                   4454:     information is known as configuration, and is usually
                   4455:     automated. In most cases, a script is supplied with the
                   4456:     distfiles, and its invocation results in generation of header
                   4457:     files, Makefiles, etc.</p>
                   4458: <p>If the package contains a configure script, this can be
                   4459:     invoked by setting <code class="varname">HAS_CONFIGURE</code> to
                   4460:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. If the configure script is a GNU autoconf
                   4461:     script, you should set <code class="varname">GNU_CONFIGURE</code> to
                   4462:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> instead. What happens in the
                   4463:     <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
1.87      wiz      4464: <pre class="programlisting">
1.299     rillig   4465: .for d in ${CONFIGURE_DIRS}
                   4466:         cd ${WRKSRC} \
                   4467:         &amp;&amp; cd ${d} \
                   4468:         &amp;&amp; env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
                   4469: .endfor
1.100     rillig   4470: </pre>
1.299     rillig   4471: <p><code class="varname">CONFIGURE_DIRS</code> (default:
                   4472:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span>) is a list of pathnames relative to
                   4473:     <code class="varname">WRKSRC</code>. In each of these directories, the
                   4474:     configure script is run with the environment
                   4475:     <code class="varname">CONFIGURE_ENV</code> and arguments
                   4476:     <code class="varname">CONFIGURE_ARGS</code>. The variables
                   4477:     <code class="varname">CONFIGURE_ENV</code>,
                   4478:     <code class="varname">CONFIGURE_SCRIPT</code> (default:
                   4479:     <span class="quote">&#8220;<span class="quote">./configure</span>&#8221;</span>) and
                   4480:     <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
                   4481:     package.</p>
                   4482: <p>If the program uses the Perl way of configuration (mainly Perl
                   4483:     modules, but not only), i.e. a file called
                   4484:     <code class="filename">Makefile.PL</code>, it should include
                   4485:     <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
                   4486:     <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
                   4487:     variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
                   4488: <p>If the program uses an <code class="filename">Imakefile</code>
                   4489:     for configuration, the appropriate steps can be invoked by
                   4490:     setting <code class="varname">USE_IMAKE</code> to
                   4491:     <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>.
                   4492:     You can add variables to xmkmf's environment by adding them to the
                   4493:     <code class="varname">SCRIPTS_ENV</code> variable.</p>
                   4494: <p>If the program uses <code class="filename">cmake</code>
                   4495:     for configuration, the appropriate steps can be invoked by
                   4496:     setting <code class="varname">USE_CMAKE</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.
                   4497:     You can add variables to cmake's environment by adding them to the
                   4498:     <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
                   4499:     by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
                   4500:     The top directory argument is given by the
                   4501:     <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
                   4502:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span> (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
                   4503: <p>If there is no configure step at all, set
                   4504:     <code class="varname">NO_CONFIGURE</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.</p>
1.75      rillig   4505: </div>
1.148     asau     4506: <div class="sect1">
1.75      rillig   4507: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4508: <a name="build.build"></a>13.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
                   4509: <p>For building a package, a rough equivalent of the
                   4510:     following code is executed.</p>
1.97      rillig   4511: <pre class="programlisting">
1.299     rillig   4512: .for d in ${BUILD_DIRS}
                   4513:         cd ${WRKSRC} \
                   4514:         &amp;&amp; cd ${d} \
                   4515:         &amp;&amp; env ${MAKE_ENV} \
                   4516:             ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
                   4517:                 -f ${MAKE_FILE} \
                   4518:                 ${BUILD_TARGET}
                   4519: .endfor
1.97      rillig   4520: </pre>
1.299     rillig   4521: <p><code class="varname">BUILD_DIRS</code> (default:
                   4522:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span>) is a list of pathnames relative to
                   4523:     <code class="varname">WRKSRC</code>. In each of these directories,
                   4524:     <code class="varname">MAKE_PROGRAM</code> is run with the environment
                   4525:     <code class="varname">MAKE_ENV</code> and arguments
                   4526:     <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
                   4527:     <code class="varname">MAKE_ENV</code>,
                   4528:     <code class="varname">BUILD_MAKE_FLAGS</code>,
                   4529:     <code class="varname">MAKE_FILE</code> and
                   4530:     <code class="varname">BUILD_TARGET</code> may all be changed by the
                   4531:     package.</p>
                   4532: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
                   4533:     <span class="quote">&#8220;<span class="quote">gmake</span>&#8221;</span> if <code class="varname">USE_TOOLS</code> contains
                   4534:     <span class="quote">&#8220;<span class="quote">gmake</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">make</span>&#8221;</span> otherwise. The
                   4535:     default value of <code class="varname">MAKE_FILE</code> is
                   4536:     <span class="quote">&#8220;<span class="quote">Makefile</span>&#8221;</span>, and <code class="varname">BUILD_TARGET</code>
                   4537:     defaults to <span class="quote">&#8220;<span class="quote">all</span>&#8221;</span>.</p>
                   4538: <p>If there is no build step at all, set
                   4539:     <code class="varname">NO_BUILD</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.</p>
1.97      rillig   4540: </div>
1.148     asau     4541: <div class="sect1">
1.97      rillig   4542: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4543: <a name="build.test"></a>13.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
                   4544: <p>[TODO]</p>
1.75      rillig   4545: </div>
1.148     asau     4546: <div class="sect1">
1.75      rillig   4547: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4548: <a name="build.install"></a>13.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
                   4549: <p>Once the build stage has completed, the final step is to
                   4550:     install the software in public directories, so users can
                   4551:     access the programs and files.</p>
                   4552: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
                   4553:     equivalent of the following code is executed. Additionally,
                   4554:     before and after this code, much magic is performed to do
                   4555:     consistency checks, registering the package, and so on.</p>
1.75      rillig   4556: <pre class="programlisting">
1.299     rillig   4557: .for d in ${INSTALL_DIRS}
                   4558:         cd ${WRKSRC} \
                   4559:         &amp;&amp; cd ${d} \
                   4560:         &amp;&amp; env ${MAKE_ENV} \
                   4561:             ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
                   4562:                 -f ${MAKE_FILE} \
                   4563:                 ${INSTALL_TARGET}
                   4564: .endfor
1.220     wiz      4565: </pre>
1.299     rillig   4566: <p>The variable's meanings are analogous to the ones in the
                   4567:     <span class="emphasis"><em>build</em></span> phase.
                   4568:     <code class="varname">INSTALL_DIRS</code> defaults to
                   4569:     <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
                   4570:     is <span class="quote">&#8220;<span class="quote">install</span>&#8221;</span> by default, plus
                   4571:     <span class="quote">&#8220;<span class="quote">install.man</span>&#8221;</span> if <code class="varname">USE_IMAKE</code> is
                   4572:     defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
                   4573:     defined.</p>
                   4574: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
                   4575:     variables are useful. They are all variations of the
                   4576:     <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?install+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a> command that have the owner, group and
                   4577:     permissions preset. <code class="varname">INSTALL</code> is the plain
                   4578:     install command. The specialized variants, together with their
                   4579:     intended use, are:</p>
                   4580: <div class="variablelist"><dl class="variablelist">
                   4581: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
                   4582: <dd><p>directories that contain
                   4583:       binaries</p></dd>
                   4584: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
                   4585: <dd><p>directories that contain
                   4586:       scripts</p></dd>
                   4587: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
                   4588: <dd><p>directories that contain shared and static
                   4589:       libraries</p></dd>
                   4590: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
                   4591: <dd><p>directories that contain data
                   4592:       files</p></dd>
                   4593: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
                   4594: <dd><p>directories that contain man
                   4595:       pages</p></dd>
                   4596: <dt><span class="term"><code class="varname">INSTALL_GAME_DIR</code></span></dt>
                   4597: <dd><p>directories that contain data files for games
                   4598:       </p></dd>
                   4599: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
                   4600: <dd><p>binaries that can be stripped from debugging
                   4601:       symbols</p></dd>
                   4602: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
                   4603: <dd><p>binaries that cannot be
                   4604:       stripped</p></dd>
                   4605: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
                   4606: <dd><p>game
                   4607:       binaries</p></dd>
                   4608: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
                   4609: <dd><p>shared and static
                   4610:       libraries</p></dd>
                   4611: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
                   4612: <dd><p>data files</p></dd>
                   4613: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
                   4614: <dd><p>data files for
                   4615:       games</p></dd>
                   4616: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
                   4617: <dd><p>man pages</p></dd>
                   4618: </dl></div>
                   4619: <p>Some other variables are:</p>
                   4620: <div class="variablelist"><dl class="variablelist">
                   4621: <dt><span class="term"><code class="varname">INSTALL_UNSTRIPPED</code></span></dt>
                   4622: <dd><p>If set to <code class="literal">yes</code>, do not run <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?strip+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">strip</span>(1)</span></a>
                   4623:       when installing binaries. Any debugging sections and symbols present in
                   4624:       binaries will be preserved.
                   4625:       </p></dd>
                   4626: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
                   4627: <dd><p>A list of directories relative to
                   4628:       <code class="varname">PREFIX</code> that are created by pkgsrc at the
                   4629:       beginning of the <span class="emphasis"><em>install</em></span> phase.
                   4630:       The package is supposed to create all needed directories itself
                   4631:       before installing files to it and list all other directories here.
                   4632:       </p></dd>
                   4633: </dl></div>
                   4634: <p>In the rare cases that a package shouldn't install anything,
                   4635:     set <code class="varname">NO_INSTALL</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. This is
                   4636:     mostly relevant for packages in the <code class="filename">regress</code>
                   4637:     category.</p>
1.75      rillig   4638: </div>
1.148     asau     4639: <div class="sect1">
1.75      rillig   4640: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4641: <a name="build.package"></a>13.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
                   4642: <p>Once the install stage has completed, a binary package of
                   4643:     the installed files can be built.  These binary packages can be
                   4644:     used for quick installation without previous compilation, e.g. by
                   4645:     the <span class="command"><strong>make bin-install</strong></span> or by using
                   4646:     <span class="command"><strong>pkg_add</strong></span>.</p>
                   4647: <p>By default, the binary packages are created in
                   4648:     <code class="filename">${PACKAGES}/All</code> and symlinks are created in
                   4649:     <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
                   4650:     one for each category in the <code class="varname">CATEGORIES</code>
                   4651:     variable.  <code class="varname">PACKAGES</code> defaults to
                   4652:     <code class="filename">pkgsrc/packages</code>.</p>
1.75      rillig   4653: </div>
1.148     asau     4654: <div class="sect1">
1.75      rillig   4655: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4656: <a name="build.clean"></a>13.16. Cleaning up</h2></div></div></div>
                   4657: <p>Once you're finished with a package, you can clean the work
                   4658:     directory by running <span class="command"><strong>make clean</strong></span>.  If you want
                   4659:     to clean the work directories of all dependencies too, use
                   4660:     <span class="command"><strong>make clean-depends</strong></span>.</p>
1.75      rillig   4661: </div>
1.148     asau     4662: <div class="sect1">
1.75      rillig   4663: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4664: <a name="build.helpful-targets"></a>13.17. Other helpful targets</h2></div></div></div>
1.148     asau     4665: <div class="variablelist"><dl class="variablelist">
1.299     rillig   4666: <dt><span class="term">pre/post-*</span></dt>
                   4667: <dd>
                   4668: <p>For any of the main targets described in the previous
                   4669:          section (configure, build, install, etc.), two auxiliary
                   4670:          targets exist with
                   4671:          <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
                   4672:          prefix for the main target's name.  These targets are
                   4673:          invoked before and after the main target is called,
                   4674:          allowing extra configuration or installation steps be
                   4675:          performed from a package's Makefile, for example, which
                   4676:          a program's configure script or install target
                   4677:          omitted.</p>
                   4678: <p>About 5% of the pkgsrc packages define their custom
                   4679:          post-extract target, another 5% define pre-configure, and 10%
                   4680:          define post-install. The other pre/post-* targets are defined
                   4681:          even less often.</p>
                   4682: </dd>
                   4683: <dt><span class="term">do-*</span></dt>
1.75      rillig   4684: <dd>
1.299     rillig   4685: <p>Should one of the main targets do the wrong thing,
                   4686:          and should there be no variable to fix this, you can
                   4687:          redefine it with the do-* target.  (Note that redefining
                   4688:          the target itself instead of the do-* target is a bad
                   4689:          idea, as the pre-* and post-* targets won't be called
                   4690:          anymore, etc.)</p>
                   4691: <p>About 15% of the pkgsrc packages override the default
                   4692:          do-install, the other do-* targets are overridden even less
                   4693:          often.</p>
1.75      rillig   4694: </dd>
1.299     rillig   4695: <dt><span class="term">reinstall</span></dt>
1.75      rillig   4696: <dd>
1.299     rillig   4697: <p>If you did a <span class="command"><strong>make install</strong></span> and
                   4698:          you noticed some file was not installed properly, you
                   4699:          can repeat the installation with this target, which will
                   4700:          ignore the <span class="quote">&#8220;<span class="quote">already installed</span>&#8221;</span> flag.</p>
                   4701: <p>This is the default value of
                   4702:          <code class="varname">DEPENDS_TARGET</code> except in the case of
                   4703:          <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
                   4704:          package</strong></span>, where the defaults are
                   4705:          <span class="quote">&#8220;<span class="quote">package</span>&#8221;</span> and <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span>,
                   4706:          respectively.</p>
1.75      rillig   4707: </dd>
1.299     rillig   4708: <dt><span class="term">deinstall</span></dt>
                   4709: <dd>
                   4710: <p>This target does a <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> in the
                   4711:          current directory, effectively de-installing the
                   4712:          package. The following variables can be used to tune the
                   4713:          behaviour:</p>
                   4714: <div class="variablelist"><dl class="variablelist">
                   4715: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
                   4716: <dd><p>Add a "-v" to the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> command.</p></dd>
                   4717: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
                   4718: <dd><p>Remove all packages that require (depend on)
                   4719:                the given package.  This can be used to remove any
                   4720:                packages that may have been pulled in by a given
                   4721:                package, e.g. if <span class="command"><strong>make deinstall
                   4722:                DEINSTALLDEPENDS=1</strong></span> is done in
                   4723:                <code class="filename">pkgsrc/x11/kde</code>, this is
                   4724:                likely to remove whole KDE. Works by adding
                   4725:                <span class="quote">&#8220;<span class="quote">-R</span>&#8221;</span> to the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
                   4726:                command line.</p></dd>
                   4727: </dl></div>
                   4728: </dd>
                   4729: <dt><span class="term">bin-install</span></dt>
                   4730: <dd><p>Install a binary package from local disk and via FTP
                   4731:          from a list of sites (see the
                   4732:          <code class="varname">BINPKG_SITES</code> variable), and do a
                   4733:          <span class="command"><strong>make package</strong></span> if no binary package is
                   4734:          available anywhere.  The arguments given to
                   4735:          <span class="command"><strong>pkg_add</strong></span> can be set via
                   4736:          <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
                   4737:          operation, etc.</p></dd>
                   4738: <dt><span class="term">install-clean</span></dt>
                   4739: <dd><p>This target removes the state files for the "install" and later
                   4740:          phases so that the "install" target may be re-invoked. This can be
                   4741:          used after editing the PLIST to install the package without
                   4742:          rebuilding it.</p></dd>
                   4743: <dt><span class="term">build-clean</span></dt>
                   4744: <dd><p>This target removes the state files for the "build" and later
                   4745:          phases so that the "build" target may be re-invoked.</p></dd>
                   4746: <dt><span class="term">update</span></dt>
                   4747: <dd>
                   4748: <p>This target causes the current package to be
                   4749:          updated to the latest version.  The package and all
                   4750:          depending packages first get de-installed, then current
                   4751:          versions of the corresponding packages get compiled and
                   4752:          installed.  This is similar to manually noting which
                   4753:          packages are currently installed, then performing a
                   4754:          series of <span class="command"><strong>make deinstall</strong></span> and
                   4755:          <span class="command"><strong>make install</strong></span> (or whatever
                   4756:          <code class="varname">UPDATE_TARGET</code> is set to) for these
                   4757:          packages.</p>
                   4758: <p>You can use the <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> target to
                   4759:          resume package updating in case a previous <span class="command"><strong>make
                   4760:          update</strong></span> was interrupted for some reason.
                   4761:          However, in this case, make sure you don't call
                   4762:          <span class="command"><strong>make clean</strong></span> or otherwise remove the
                   4763:          list of dependent packages in <code class="varname">WRKDIR</code>.
                   4764:          Otherwise, you lose the ability to automatically update
                   4765:          the current package along with the dependent packages
                   4766:          you have installed.</p>
                   4767: <p>Resuming an interrupted <span class="command"><strong>make
                   4768:          update</strong></span> will only work as long as the package
                   4769:          tree remains unchanged.  If the source code for one of
                   4770:          the packages to be updated has been changed, resuming
                   4771:          <span class="command"><strong>make update</strong></span> will most certainly
                   4772:          fail!</p>
                   4773: <p>The following variables can be used either on the
                   4774:          command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
                   4775:          alter the behaviour of <span class="command"><strong>make
                   4776:          update</strong></span>:</p>
                   4777: <div class="variablelist"><dl class="variablelist">
                   4778: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
                   4779: <dd><p>Install target to recursively use for the
                   4780:                updated package and the dependent packages.
                   4781:                Defaults to <code class="varname">DEPENDS_TARGET</code> if
                   4782:                set, <span class="quote">&#8220;<span class="quote">install</span>&#8221;</span> otherwise for
                   4783:                <span class="command"><strong>make update</strong></span>.  Other good
                   4784:                targets are <span class="quote">&#8220;<span class="quote">package</span>&#8221;</span> or
                   4785:                <span class="quote">&#8220;<span class="quote">bin-install</span>&#8221;</span>.  Do not set this to
                   4786:                <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> or you will get stuck in an
                   4787:                endless loop!</p></dd>
                   4788: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
                   4789: <dd><p>Don't clean up after updating.  Useful if
                   4790:                you want to leave the work sources of the updated
                   4791:                packages around for inspection or other purposes.
                   4792:                Be sure you eventually clean up the source tree
                   4793:                (see the <span class="quote">&#8220;<span class="quote">clean-update</span>&#8221;</span> target below)
                   4794:                or you may run into troubles with old source code
                   4795:                still lying around on your next
                   4796:                <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
                   4797:                update</strong></span>.</p></dd>
                   4798: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
                   4799: <dd><p>Deinstall each package before installing
                   4800:                (making <code class="varname">DEPENDS_TARGET</code>). This
                   4801:                may be necessary if the
                   4802:                <span class="quote">&#8220;<span class="quote">clean-update</span>&#8221;</span> target (see below) was
                   4803:                called after interrupting a running <span class="command"><strong>make
                   4804:                update</strong></span>.</p></dd>
                   4805: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
                   4806: <dd><p>Allows you to disable recursion and hardcode
                   4807:                the target for packages.  The default is
                   4808:                <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> for the update target,
                   4809:                facilitating a recursive update of prerequisite
                   4810:                packages.  Only set
                   4811:                <code class="varname">DEPENDS_TARGET</code> if you want to
                   4812:                disable recursive updates. Use
                   4813:                <code class="varname">UPDATE_TARGET</code> instead to just
                   4814:                set a specific target for each package to be
                   4815:                installed during <span class="command"><strong>make update</strong></span>
                   4816:                (see above).</p></dd>
                   4817: </dl></div>
                   4818: </dd>
                   4819: <dt><span class="term">clean-update</span></dt>
                   4820: <dd>
                   4821: <p>Clean the source tree for all packages that would
                   4822:          get updated if <span class="command"><strong>make update</strong></span> was called
                   4823:          from the current directory.  This target should not be
                   4824:          used if the current package (or any of its depending
                   4825:          packages) have already been de-installed (e.g., after
                   4826:          calling <span class="command"><strong>make update</strong></span>) or you may lose
                   4827:          some packages you intended to update. As a rule of
                   4828:          thumb: only use this target <span class="emphasis"><em>before</em></span>
                   4829:          the first time you run <span class="command"><strong>make update</strong></span>
                   4830:          and only if you have a dirty package tree (e.g., if you
                   4831:          used <code class="varname">NOCLEAN</code>).</p>
                   4832: <p>If you are unsure about whether your tree is
                   4833:          clean, you can either perform a <span class="command"><strong>make
                   4834:          clean</strong></span> at the top of the tree, or use the
                   4835:          following sequence of commands from the directory of the
                   4836:          package you want to update (<span class="emphasis"><em>before</em></span>
                   4837:          running <span class="command"><strong>make update</strong></span> for the first
                   4838:          time, otherwise you lose all the packages you wanted to
                   4839:          update!):</p>
                   4840: <pre class="screen">
                   4841: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
                   4842: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
                   4843: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
                   4844:          </pre>
                   4845: <p>The following variables can be used either on the
                   4846:          command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
                   4847:          <span class="command"><strong>make clean-update</strong></span>:</p>
                   4848: <div class="variablelist"><dl class="variablelist">
                   4849: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
                   4850: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
                   4851:                reconstruct the list of directories to update for
                   4852:                this package.  Only use this if <span class="command"><strong>make
                   4853:                update</strong></span> successfully installed all
                   4854:                packages you wanted to update.  Normally, this is
                   4855:                done automatically on <span class="command"><strong>make
                   4856:                update</strong></span>, but may have been suppressed by
                   4857:                the <code class="varname">NOCLEAN</code> variable (see
                   4858:                above).</p></dd>
                   4859: </dl></div>
                   4860: </dd>
                   4861: <dt><span class="term">replace</span></dt>
                   4862: <dd>
                   4863: <p>Update the installation of the current package.  This
                   4864:          differs from update in that it does not replace dependent
                   4865:          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
                   4866:          target to work.</p>
                   4867: <p><span class="emphasis"><em>Be careful when using this
                   4868:          target!</em></span> There are no guarantees that dependent
                   4869:          packages will still work, in particular they will most
                   4870:          certainly break if you <span class="command"><strong>make replace</strong></span> a
                   4871:          library package whose shared library major version changed
                   4872:          between your installed version and the new one.  For this
                   4873:          reason, this target is not officially supported and only
                   4874:          recommended for advanced users.</p>
                   4875: </dd>
                   4876: <dt><span class="term">info</span></dt>
                   4877: <dd><p>This target invokes <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a> for the current
                   4878:          package. You can use this to check which version of a
                   4879:          package is installed.</p></dd>
                   4880: <dt><span class="term">index</span></dt>
                   4881: <dd>
                   4882: <p>This is a top-level command, i.e. it should be used in
                   4883:          the <code class="filename">pkgsrc</code> directory.  It creates a
                   4884:          database of all packages in the local pkgsrc tree, including
                   4885:          dependencies, comment, maintainer, and some other useful
                   4886:          information.  Individual entries are created by running
                   4887:          <span class="command"><strong>make describe</strong></span> in the packages'
                   4888:          directories.  This index file is saved as
                   4889:          <code class="filename">pkgsrc/INDEX</code>.  It can be displayed in
                   4890:          verbose format by running <span class="command"><strong>make
                   4891:          print-index</strong></span>.  You can search in it with
                   4892:          <span class="command"><strong>make search
                   4893:          key=<em class="replaceable"><code>something</code></em></strong></span>.  You can
                   4894:          extract a list of all packages that depend on a particular
                   4895:          one by running <span class="command"><strong>make show-deps
                   4896:          PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
                   4897: <p>Running this command takes a very long time, some
                   4898:          hours even on fast machines!</p>
                   4899: </dd>
                   4900: <dt><span class="term">readme</span></dt>
                   4901: <dd>
                   4902: <p>This target generates a
                   4903:          <code class="filename">README.html</code> file, which can be
                   4904:          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
                   4905:          contain references to any packages which are in the
                   4906:          <code class="varname">PACKAGES</code> directory on the local
                   4907:          host. The generated files can be made to refer to URLs
                   4908:          based on <code class="varname">FTP_PKG_URL_HOST</code> and
                   4909:          <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
                   4910:          wanted to generate <code class="filename">README.html</code>
                   4911:          files which pointed to binary packages on the local
                   4912:          machine, in the directory
                   4913:          <code class="filename">/usr/packages</code>, set
                   4914:          <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
                   4915:          <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
                   4916:          <code class="varname">${PACKAGES}</code> directory and its
                   4917:          subdirectories will be searched for all the binary
                   4918:          packages.</p>
                   4919: <p>The target can be run at the toplevel or in category
                   4920:          directories, in which case it descends recursively.</p>
                   4921: </dd>
                   4922: <dt><span class="term">readme-all</span></dt>
                   4923: <dd><p>This is a top-level command, run it in
                   4924:          <code class="filename">pkgsrc</code>.  Use this target to create a
                   4925:          file <code class="filename">README-all.html</code> which contains a
                   4926:          list of all packages currently available in the NetBSD
                   4927:          Packages Collection, together with the category they belong
                   4928:          to and a short description. This file is compiled from the
                   4929:          <code class="filename">pkgsrc/*/README.html</code> files, so be sure
                   4930:          to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
                   4931:          readme</strong></span>.</p></dd>
                   4932: <dt><span class="term">cdrom-readme</span></dt>
                   4933: <dd><p>This is very much the same as the
                   4934:          <span class="quote">&#8220;<span class="quote">readme</span>&#8221;</span> target (see above), but is to be
                   4935:          used when generating a pkgsrc tree to be written to a
                   4936:          CD-ROM.  This target also produces
                   4937:          <code class="filename">README.html</code> files, and can be made
                   4938:          to refer to URLs based on
                   4939:          <code class="varname">CDROM_PKG_URL_HOST</code> and
                   4940:          <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
                   4941: <dt><span class="term">show-distfiles</span></dt>
                   4942: <dd><p>This target shows which distfiles and patchfiles
                   4943:          are needed to build the package
                   4944:          (<code class="varname">ALLFILES</code>, which contains all
                   4945:          <code class="varname">DISTFILES</code> and
                   4946:          <code class="varname">PATCHFILES</code>, but not
                   4947:          <code class="filename">patches/*</code>).</p></dd>
                   4948: <dt><span class="term">show-downlevel</span></dt>
                   4949: <dd><p>This target shows nothing if the package is not
                   4950:          installed. If a version of this package is installed,
                   4951:          but is not the version provided in this version of
                   4952:          pkgsrc, then a warning message is displayed. This target
                   4953:          can be used to show which of your installed packages are
                   4954:          downlevel, and so the old versions can be deleted, and
                   4955:          the current ones added.</p></dd>
                   4956: <dt><span class="term">show-pkgsrc-dir</span></dt>
                   4957: <dd><p>This target shows the directory in the pkgsrc
                   4958:          hierarchy from which the package can be built and
                   4959:          installed. This may not be the same directory as the one
                   4960:          from which the package was installed. This target is
                   4961:          intended to be used by people who may wish to upgrade
                   4962:          many packages on a single host, and can be invoked from
                   4963:          the top-level pkgsrc Makefile by using the
                   4964:          <span class="quote">&#8220;<span class="quote">show-host-specific-pkgs</span>&#8221;</span> target.</p></dd>
                   4965: <dt><span class="term">show-installed-depends</span></dt>
                   4966: <dd><p>This target shows which installed packages match
                   4967:          the current package's <code class="varname">DEPENDS</code>. Useful
                   4968:          if out of date dependencies are causing build
                   4969:          problems.</p></dd>
                   4970: <dt><span class="term">print-build-depends-list</span></dt>
                   4971: <dd><p>This target shows the list of packages that the current package
                   4972:            depends on for building.</p></dd>
                   4973: <dt><span class="term">print-run-depends-list</span></dt>
                   4974: <dd><p>This target shows the list of packages that the current package
                   4975:            depends on for running.</p></dd>
                   4976: <dt><span class="term">check-shlibs</span></dt>
                   4977: <dd><p>After a package is installed, check all its
                   4978:          binaries and (on ELF platforms) shared libraries to see
                   4979:          if they find the shared libs they need.  Run by default
                   4980:          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>
                   4981: <dt><span class="term">print-PLIST</span></dt>
                   4982: <dd>
                   4983: <p>After a <span class="quote">&#8220;<span class="quote">make install</span>&#8221;</span> from a new or
                   4984:          upgraded pkg, this prints out an attempt to generate a
                   4985:          new <code class="filename">PLIST</code> from a <span class="command"><strong>find
                   4986:          -newer work/.extract_done</strong></span>.  An attempt is made
                   4987:          to care for shared libs etc., but it is
                   4988:          <span class="emphasis"><em>strongly</em></span> recommended to review the
                   4989:          result before putting it into
                   4990:          <code class="filename">PLIST</code>. On upgrades, it's useful to
                   4991:          diff the output of this command against an already
                   4992:          existing <code class="filename">PLIST</code> file.</p>
                   4993: <p>If the package installs files via <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?tar+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a> or
                   4994:          other methods that don't update file access times, be
                   4995:          sure to add these files manually to your
                   4996:          <code class="filename">PLIST</code>, as the <span class="quote">&#8220;<span class="quote">find
                   4997:          -newer</span>&#8221;</span> command used by this target won't catch
                   4998:          them!</p>
                   4999: <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
                   5000:          information on this target.</p>
                   5001: </dd>
                   5002: </dl></div>
                   5003: </div>
                   5004: </div>
                   5005: <div class="chapter">
                   5006: <div class="titlepage"><div><div><h2 class="title">
                   5007: <a name="creating"></a>Chapter 14. Creating a new pkgsrc package from scratch</h2></div></div></div>
                   5008: <div class="toc">
                   5009: <p><b>Table of Contents</b></p>
                   5010: <dl class="toc">
                   5011: <dt><span class="sect1"><a href="#creating.common">14.1. Common types of packages</a></span></dt>
                   5012: <dd><dl>
                   5013: <dt><span class="sect2"><a href="#creating.perl-module">14.1.1. Perl modules</a></span></dt>
                   5014: <dt><span class="sect2"><a href="#creating.python-module">14.1.2. Python modules and programs</a></span></dt>
                   5015: <dt><span class="sect2"><a href="#creating.R-package">14.1.3. R packages</a></span></dt>
                   5016: <dt><span class="sect2"><a href="#creating.TeX-package">14.1.4. TeXlive packages</a></span></dt>
                   5017: </dl></dd>
                   5018: <dt><span class="sect1"><a href="#creating.examples">14.2. Examples</a></span></dt>
                   5019: <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>
                   5020: </dl>
                   5021: </div>
                   5022: <p>When you find a package that is not yet in pkgsrc, you
                   5023: most likely have a URL from where you can download the source
                   5024: code. Starting with this URL, creating a package involves only a
                   5025: few steps.</p>
                   5026: <div class="procedure"><ol class="procedure" type="1">
                   5027: <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
                   5028: enable the basic quality checks.</p></li>
                   5029: <li class="step">
                   5030: <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
                   5031: install the utilities <span class="command"><strong>url2pkg</strong></span>,
                   5032: <span class="command"><strong>pkglint</strong></span>, <span class="command"><strong>pkgvi</strong></span> and
                   5033: <span class="command"><strong>mkpatches</strong></span>:</p>
                   5034: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   5035: <code class="prompt">$</code> <strong class="userinput"><code>(cd meta-pkgs/pkg_developer &amp;&amp; bmake update)</code></strong></pre>
                   5036: </li>
                   5037: <li class="step">
                   5038: <p>Choose one of the top-level directories as the category in
                   5039: which you want to place your package. You can also create a directory of
                   5040: your own (maybe called <code class="filename">local</code>). In that category
                   5041: directory, create another directory for your package and change into
                   5042: it:</p>
                   5043: <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>
                   5044: <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>
                   5045: </li>
                   5046: <li class="step">
                   5047: <p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
                   5048: you for a URL. Enter the URL of the distribution file (in most cases a
                   5049: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
                   5050: of your package are created automatically. The distribution file is
                   5051: extracted automatically to fill in some details in the
                   5052: <code class="filename">Makefile</code> that would otherwise have to be done
                   5053: manually:</p>
                   5054: <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>
                   5055: </li>
                   5056: <li class="step">
                   5057: <p>Examine the extracted files to determine the dependencies of
                   5058: your package. Ideally, this is mentioned in some
                   5059: <code class="filename">README</code> file, but things may differ. For each of
                   5060: these dependencies, look where it exists in pkgsrc, and if there is a
                   5061: file called <code class="filename">buildlink3.mk</code> in that directory, add a
                   5062: line to your package <code class="filename">Makefile</code> which includes that
                   5063: file just before the last line. If the
                   5064: <code class="filename">buildlink3.mk</code> file does not exist, it must be
                   5065: created first. The <code class="filename">buildlink3.mk</code> file makes sure
                   5066: that the package's include files and libraries are provided.</p>
                   5067: <p>If you just need binaries from a package, add a
                   5068: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
                   5069: version of the dependency and where it can be found in pkgsrc. This line
                   5070: should be placed in the third paragraph. If the dependency is only
                   5071: needed for building the package, but not when using it, use
                   5072: <code class="varname">TOOL_DEPENDS</code> or <code class="varname">BUILD_DEPENDS</code>
                   5073: instead of <code class="varname">DEPENDS</code>.
                   5074: The difference between <code class="varname">TOOL_DEPENDS</code> and
                   5075: <code class="varname">BUILD_DEPENDS</code> occurs when cross-compiling:
                   5076: <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
                   5077: packages, i.e. packages for the architecture where the package
                   5078: is built;
                   5079: <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
                   5080: packages, i.e. packages for the architecture for which the package
                   5081: is built. There is also <code class="varname">TEST_DEPENDS</code>, which is used
                   5082: to specify a dependency used only for testing the resulting package
                   5083: built, using the upstream project's included test suite.
                   5084: Your package may then look like this:</p>
                   5085: <pre class="programlisting">
                   5086: [...]
                   5087: 
                   5088: TOOL_DEPENDS+=  libxslt-[0-9]*:../../textproc/libxslt
                   5089: DEPENDS+=       screen-[0-9]*:../../misc/screen
                   5090: DEPENDS+=       screen&gt;=4.0:../../misc/screen
                   5091: 
                   5092: [...]
                   5093: 
                   5094: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
                   5095: .include "../../devel/glib2/buildlink3.mk"
                   5096: .include "../../mk/bsd.pkg.mk"
                   5097: </pre>
                   5098: </li>
                   5099: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
                   5100: to be done to make your package a <span class="quote">&#8220;<span class="quote">good</span>&#8221;</span> one. If you don't
                   5101: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
                   5102: --explain</strong></span> or <span class="command"><strong>pkglint -e</strong></span>, which outputs
                   5103: additional explanations.</p></li>
                   5104: <li class="step"><p>In many cases the package is not yet ready to build. You can
                   5105: 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
                   5106: over there, you can hopefully continue here.</p></li>
                   5107: <li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
                   5108: directory from the extracted files. Besides these files, a lot of cache
                   5109: files and other system information has been saved in the working
                   5110: directory, which may become wrong after you edited the
                   5111: <code class="filename">Makefile</code>.</p></li>
                   5112: <li class="step">
                   5113: <p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
                   5114: 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>
                   5115: <p>If the extracted files from the package need to be fixed, run multiple rounds of these commands:</p>
                   5116: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>make</code></strong>
                   5117: <code class="prompt">$</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
                   5118: <code class="prompt">$</code> <strong class="userinput"><code>mkpatches</code></strong>
                   5119: <code class="prompt">$</code> <strong class="userinput"><code>make mps</code></strong>
                   5120: <code class="prompt">$</code> <strong class="userinput"><code>make clean</code></strong></pre>
                   5121: </li>
                   5122: <li class="step"><p>When the package builds fine, the next step is to install
                   5123: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
                   5124: everything works.</p></li>
                   5125: <li class="step"><p>Up to now, the file <code class="filename">PLIST</code>, which
                   5126: contains a list of the files that are installed by the package, is
                   5127: nearly empty. Run <span class="command"><strong>bmake print-PLIST
                   5128: &gt;PLIST</strong></span> to generate a probably correct list. Check
                   5129: the file using your preferred text editor to see if the list of
                   5130: files looks plausible.</p></li>
                   5131: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
                   5132: <code class="filename">PLIST</code> contains garbage or not.</p></li>
                   5133: <li class="step"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
                   5134: had been registered in the database of installed files, but with an
                   5135: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
                   5136: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
                   5137: registered with the list of files from
                   5138: <code class="filename">PLIST</code>.</p></li>
                   5139: <li class="step"><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
                   5140: package from the set of installed files.</p></li>
                   5141: <li class="step"><p>Run <span class="command"><strong>bmake clean update</strong></span> to run everything
                   5142: from above again in a single step, making sure that the PLIST is correct
                   5143: and the whole package is created as intended.</p></li>
                   5144: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see if there's anything left to do.</p></li>
                   5145: <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>
                   5146: </ol></div>
                   5147: <div class="sect1">
                   5148: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   5149: <a name="creating.common"></a>14.1. Common types of packages</h2></div></div></div>
                   5150: <div class="sect2">
                   5151: <div class="titlepage"><div><div><h3 class="title">
                   5152: <a name="creating.perl-module"></a>14.1.1. Perl modules</h3></div></div></div>
                   5153: <p>Simple Perl modules are handled automatically by
                   5154: <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
                   5155: </div>
                   5156: <div class="sect2">
                   5157: <div class="titlepage"><div><div><h3 class="title">
                   5158: <a name="creating.python-module"></a>14.1.2. Python modules and programs</h3></div></div></div>
                   5159: <p>Python modules and programs packages are easily created using a
                   5160: set of predefined variables.</p>
                   5161: <p>
                   5162: If some Python versions are not supported by the software, set the
                   5163: <code class="varname">PYTHON_VERSIONS_INCOMPATIBLE</code> variable to the Python versions
                   5164: that are not supported, e.g.
                   5165: </p>
                   5166: <pre class="programlisting">
                   5167: PYTHON_VERSIONS_INCOMPATIBLE=       27
                   5168: </pre>
                   5169: <p>
                   5170: If the packaged software is a Python module, include one of
                   5171: <code class="filename">../../lang/python/egg.mk</code>,
                   5172: <code class="filename">../../lang/python/distutils.mk</code>, or
                   5173: <code class="filename">../../lang/python/extension.mk</code>.</p>
                   5174: <p>Most Python packages use either <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span> or
                   5175: easy-setup/setuptools (<span class="quote">&#8220;<span class="quote">eggs</span>&#8221;</span>).
                   5176: If the packaged software is using setuptools, you only need
                   5177: to include <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>&#8221;</span>.
                   5178: Otherwise, if the software uses <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span>, include 
                   5179: <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/distutils.mk</code></span>&#8221;</span>,
                   5180: so pkgsrc will use this framework.
                   5181: <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span> uses a script called <code class="filename">setup.py</code>;
                   5182: if the <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span> driver is not called
                   5183: <code class="filename">setup.py</code>, set the <code class="varname">PYSETUP</code> variable
                   5184: to the name of the script.</p>
                   5185: <p>Either way, the package directory should be called
                   5186: <span class="quote">&#8220;<span class="quote">py-software</span>&#8221;</span> and <code class="varname">PKGNAME</code> should be set to
                   5187: <span class="quote">&#8220;<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>&#8221;</span>, e.g.
                   5188: </p>
                   5189: <pre class="programlisting">
                   5190: DISTNAME=   foopymodule-1.2.10
                   5191: PKGNAME=    ${PYPKGPREFIX}-${DISTNAME}
                   5192: </pre>
                   5193: <p>If it is an application, include
                   5194: <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>&#8221;</span>.
                   5195: In order to correctly set the path to the Python interpreter, use the
                   5196: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
                   5197: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
                   5198: For example:
                   5199: </p>
                   5200: <pre class="programlisting">
                   5201: REPLACE_PYTHON=   *.py
                   5202: </pre>
                   5203: <p>Some Python modules have separate distributions for Python-2.x
                   5204: and Python-3.x support. In pkgsrc this is handled by the
                   5205: <code class="filename">versioned_dependencies.mk</code> file. Set
                   5206: <code class="varname">PYTHON_VERSIONED_DEPENDENCIES</code> to the list of
                   5207: packages that should be depended upon and include
                   5208: <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/versioned_dependencies.mk</code></span>&#8221;</span>,
                   5209: then the pkgsrc infrastructure will depend on the appropriate package
                   5210: version. For example:
                   5211: </p>
                   5212: <pre class="programlisting">
                   5213: PYTHON_VERSIONED_DEPENDENCIES=dialog
                   5214: </pre>
                   5215: <p>
                   5216: Look inside <code class="filename">versioned_dependencies.mk</code> for a list
                   5217: of supported packages.</p>
                   5218: </div>
                   5219: <div class="sect2">
                   5220: <div class="titlepage"><div><div><h3 class="title">
                   5221: <a name="creating.R-package"></a>14.1.3. R packages</h3></div></div></div>
                   5222: <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>
                   5223: are handled automatically by <span class="command"><strong>R2pkg</strong></span>, which is
                   5224: 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>.
                   5225: Individual packages (and optionally their dependencies) may be created
                   5226: and updated.  R packages generally follow the same form, and most of
                   5227: the relevant information needed is contained in a
                   5228: <code class="filename">DESCRIPTION</code> file as part of each R package on
                   5229: <a class="ulink" href="https://cran.r-project.org/web/packages/available_packages_by_name.html" target="_top">CRAN</a>.
                   5230: Consequently, <span class="command"><strong>R2pkg</strong></span> downloads that information and
                   5231: creates or updates a package in the canonical form.  The resulting
                   5232: package should be reviewed for correctness.</p>
                   5233: </div>
                   5234: <div class="sect2">
                   5235: <div class="titlepage"><div><div><h3 class="title">
                   5236: <a name="creating.TeX-package"></a>14.1.4. TeXlive packages</h3></div></div></div>
                   5237: <p>TeXlive packages from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> are handled automatically by
                   5238: <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>
                   5239: <p>If the TeXlive package name is not known, it may be useful to
                   5240: search <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>.  A
                   5241: <span class="quote">&#8220;<span class="quote">Contained in</span>&#8221;</span> field on the package page typically
                   5242: 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
                   5243: archive</a>.</p>
                   5244: <p>If the TeXlive package name is known, download the files from
                   5245: the <a class="ulink" href="https://www.ctan.org/tex-archive/systems/texlive/tlnet/archive" target="_top">TeXlive
                   5246: archive</a>.  For package <code class="filename">foo</code>, you will need
                   5247: to download <code class="filename">foo.tar.xz</code>.  Most TeXlive packages
                   5248: also have associated documentation packages, so download
                   5249: <code class="filename">foo.doc.tar.xz</code> at the same time.  These files
                   5250: should be placed in the appropriate category directory, which is often
                   5251: but not always <code class="filename">print</code>.  Then run the following
                   5252: command in the category directory.</p>
                   5253: <pre class="programlisting">
                   5254: texlive2pkg foo.tar.xz foo.doc.tar.xz
                   5255: </pre>
                   5256: <p>This will create two packages, <code class="filename">tex-foo</code> and
                   5257: <code class="filename">tex-foo-doc</code>.  Be sure to check that both packages
                   5258: are correct.</p>
                   5259: <p>Finally, <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>
                   5260: currently does not include version information in package filenames
                   5261: and changes their contents periodically when updates occur.
                   5262: Consequently, pkgsrc avoids downloading distfiles directly from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> and instead relies on the
                   5263: pkgsrc archives.  For each new or updated TeXlive package, e.g., the
                   5264: main one and the corresponding documentation, upload the distfiles
                   5265: with the following command in each package directory.</p>
                   5266: <pre class="programlisting">
                   5267: make upload-distfiles
                   5268: </pre>
                   5269: </div>
                   5270: </div>
                   5271: <div class="sect1">
                   5272: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   5273: <a name="creating.examples"></a>14.2. Examples</h2></div></div></div>
                   5274: <div class="sect2">
                   5275: <div class="titlepage"><div><div><h3 class="title">
                   5276: <a name="creating.nvu"></a>14.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
                   5277: <div class="sect3">
                   5278: <div class="titlepage"><div><div><h4 class="title">
                   5279: <a name="creating.nvu.init"></a>14.2.1.1. The initial package</h4></div></div></div>
                   5280: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
                   5281: that the <span class="quote">&#8220;<span class="quote">nvu</span>&#8221;</span> package has not yet been imported into
                   5282: pkgsrc. As the description says it has to do with the web, the obvious
                   5283: choice for the category is <span class="quote">&#8220;<span class="quote">www</span>&#8221;</span>.</p>
                   5284: <pre class="programlisting">
                   5285: <code class="prompt">$</code> mkdir www/nvu
                   5286: <code class="prompt">$</code> cd www/nvu
                   5287: </pre>
                   5288: <p>The web site says that the sources are available as a tar file, so
                   5289: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
                   5290: <pre class="programlisting">
                   5291: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
                   5292: </pre>
                   5293: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
                   5294: below the <code class="varname">DISTNAME</code> line, as the package name should
                   5295: not have the word <span class="quote">&#8220;<span class="quote">sources</span>&#8221;</span> in it. I also filled in the
                   5296: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
                   5297: <code class="varname">COMMENT</code> fields. Then the package
                   5298: <code class="filename">Makefile</code> looked like that:</p>
                   5299: <pre class="programlisting">
                   5300: # $NetBSD $
                   5301: #
                   5302: 
                   5303: DISTNAME=       nvu-1.0-sources
                   5304: PKGNAME=        nvu-1.0
                   5305: CATEGORIES=     www
                   5306: MASTER_SITES=   http://cvs.nvu.com/download/
                   5307: EXTRACT_SUFX=   .tar.bz2
                   5308: 
                   5309: MAINTAINER=     rillig@NetBSD.org
                   5310: HOMEPAGE=       http://cvs.nvu.com/
                   5311: COMMENT=        Web Authoring System
                   5312: 
                   5313: # url2pkg-marker (please do not remove this line.)
                   5314: .include "../../mk/bsd.pkg.mk"
                   5315: </pre>
                   5316: <p>On the first line of output above, an artificial space has been added between NetBSD and $,
                   5317: this is a workaround to prevent CVS expanding to the filename of the
                   5318: guide.</p>
                   5319: <p>Then, I quit the editor and watched pkgsrc downloading a large
                   5320: source archive:</p>
                   5321: <pre class="programlisting">
                   5322: url2pkg&gt; Running "make makesum" ...
                   5323: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   5324: =&gt; Fetching nvu-1.0-sources.tar.bz2
                   5325: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
                   5326: 100% |*************************************| 28992 KB  150.77 KB/s00:00 ETA
                   5327: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
                   5328: url2pkg&gt; Running "make extract" ...
                   5329: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   5330: =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   5331: =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   5332: work.bacc -&gt; /tmp/roland/pkgsrc/www/nvu/work.bacc
                   5333: ===&gt; Installing dependencies for nvu-1.0
                   5334: ===&gt; Overriding tools for nvu-1.0
                   5335: ===&gt; Extracting for nvu-1.0
                   5336: url2pkg&gt; Adjusting the Makefile.
                   5337: 
                   5338: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
                   5339: 
                   5340: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
                   5341: </pre>
                   5342: </div>
                   5343: <div class="sect3">
                   5344: <div class="titlepage"><div><div><h4 class="title">
                   5345: <a name="creating.nvu.problems"></a>14.2.1.2. Fixing all kinds of problems to make the package work</h4></div></div></div>
                   5346: <p>Now that the package has been extracted, let's see what's inside
                   5347: it. The package has a <code class="filename">README.txt</code>, but that only
                   5348: says something about mozilla, so it's probably useless for seeing what
                   5349: dependencies this package has. But since there is a GNU configure script
                   5350: in the package, let's hope that it will complain about everything it
                   5351: needs.</p>
                   5352: <pre class="programlisting">
                   5353: <code class="prompt">$</code> bmake
                   5354: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   5355: =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   5356: =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   5357: ===&gt; Patching for nvu-1.0
                   5358: ===&gt; Creating toolchain wrappers for nvu-1.0
                   5359: ===&gt; Configuring for nvu-1.0
                   5360: [...]
                   5361: configure: error: Perl 5.004 or higher is required.
                   5362: [...]
                   5363: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
                   5364: [...]
                   5365: </pre>
                   5366: <p>That worked quite well. So I opened the package Makefile in my
                   5367: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
                   5368: just appended <span class="quote">&#8220;<span class="quote">perl</span>&#8221;</span> to it. Since the dependencies of the
                   5369: package have changed now, and since a perl wrapper is automatically
                   5370: installed in the <span class="quote">&#8220;<span class="quote">tools</span>&#8221;</span> phase, I need to build the package
                   5371: from scratch.</p>
                   5372: <pre class="programlisting">
                   5373: <code class="prompt">$</code> bmake clean
                   5374: ===&gt; Cleaning for nvu-1.0
                   5375: <code class="prompt">$</code> bmake
                   5376: [...]
                   5377: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
                   5378: GNU Make.  You will not be able to build Mozilla without GNU Make.
                   5379: [...]
                   5380: </pre>
                   5381: <p>So I added <span class="quote">&#8220;<span class="quote">gmake</span>&#8221;</span> to the
                   5382: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
                   5383: <pre class="programlisting">
                   5384: [...]
                   5385: checking for GTK - version &gt;= 1.2.0... no
                   5386: *** Could not run GTK test program, checking why...
                   5387: [...]
                   5388: </pre>
                   5389: <p>Now to the other dependencies. The first question is: Where is the
                   5390: GTK package hidden in pkgsrc?</p>
                   5391: <pre class="programlisting">
                   5392: <code class="prompt">$</code> echo ../../*/gtk*
                   5393: [many packages ...]
                   5394: <code class="prompt">$</code> echo ../../*/gtk
                   5395: ../../x11/gtk
                   5396: <code class="prompt">$</code> echo ../../*/gtk2
                   5397: ../../x11/gtk2
                   5398: <code class="prompt">$</code> echo ../../*/gtk2/bui*
                   5399: ../../x11/gtk2/buildlink3.mk
                   5400: </pre>
                   5401: <p>The first try was definitely too broad. The second one had exactly
                   5402: one result, which is very good. But there is one pitfall with GNOME
                   5403: packages. Before GNOME 2 had been released, there were already many
                   5404: GNOME 1 packages in pkgsrc. To be able to continue to use these
                   5405: packages, the GNOME 2 packages were imported as separate packages, and
                   5406: their names usually have a <span class="quote">&#8220;<span class="quote">2</span>&#8221;</span> appended. So I checked
                   5407: whether this was the case here, and indeed it was.</p>
                   5408: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
                   5409: file, adding the dependency is very easy. I just inserted an
                   5410: <code class="literal">.include</code> line before the last line of the package
                   5411: <code class="filename">Makefile</code>, so that it now looks like this:</p>
                   5412: <pre class="programlisting">
                   5413: [...]
                   5414: .include "../../x11/gtk2/buildlink3.mk"
                   5415: .include "../../mk/bsd.pkg.mk
                   5416: </pre>
                   5417: <p>After another <span class="command"><strong>bmake clean &amp;&amp; bmake</strong></span>, the answer
                   5418: was:</p>
1.75      rillig   5419: <pre class="programlisting">
1.299     rillig   5420: [...]
                   5421: checking for gtk-config... /home/roland/pkg/bin/gtk-config
                   5422: checking for GTK - version &gt;= 1.2.0... no
                   5423: *** Could not run GTK test program, checking why...
                   5424: *** The test program failed to compile or link. See the file config.log for the
                   5425: *** exact error that occured. This usually means GTK was incorrectly installed
                   5426: *** or that you have moved GTK since it was installed. In the latter case, you
                   5427: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
                   5428: configure: error: Test for GTK failed.
                   5429: [...]
1.222     sevan    5430: </pre>
1.299     rillig   5431: <p>In this particular case, the assumption that <span class="quote">&#8220;<span class="quote">every package
                   5432: prefers GNOME 2</span>&#8221;</span> had been wrong. The first of the lines above
                   5433: told me that this package really wanted to have the GNOME 1 version of
                   5434: GTK. If the package had looked for GTK2, it would have looked for
                   5435: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
                   5436: So I changed the <code class="literal">x11/gtk2</code> to
                   5437: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
                   5438: and tried again.</p>
1.119     mishka   5439: <pre class="programlisting">
1.299     rillig   5440: [...]
                   5441: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\"  [...]
                   5442: In file included from xpidl.c:42:
                   5443: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
                   5444: In file included from xpidl.c:42:
                   5445: xpidl.h:132: error: parse error before "IDL_ns"
                   5446: [...]
1.222     sevan    5447: </pre>
1.299     rillig   5448: <p>The package still does not find all of its dependencies. Now the
                   5449: question is: Which package provides the
                   5450: <code class="filename">libIDL/IDL.h</code> header file?</p>
1.119     mishka   5451: <pre class="programlisting">
1.299     rillig   5452: <code class="prompt">$</code> echo ../../*/*idl*
                   5453: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
                   5454: <code class="prompt">$</code> echo ../../*/*IDL*
                   5455: ../../net/libIDL
1.222     sevan    5456: </pre>
1.299     rillig   5457: <p>Let's take the one from the second try. So I included the
                   5458: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
                   5459: again. But the error didn't change. After digging through some of the
                   5460: code, I concluded that the build process of the package was broken and
                   5461: couldn't have ever worked, but since the Mozilla source tree is quite
                   5462: large, I didn't want to fix it. So I added the following to the package
                   5463: <code class="filename">Makefile</code> and tried again:</p>
1.197     wiz      5464: <pre class="programlisting">
1.299     rillig   5465: CPPFLAGS+=              -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
                   5466: BUILDLINK_TRANSFORM+=   l:IDL:IDL-2
1.222     sevan    5467: </pre>
1.299     rillig   5468: <p>The latter line is needed because the package expects the library
                   5469: <code class="filename">libIDL.so</code>, but only
                   5470: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
                   5471: wrapper to rewrite that on the fly.</p>
                   5472: <p>The next problem was related to a recent change of the FreeType
                   5473: 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>
                   5474: which patch files were relevant for this issue and copied them to the
                   5475: <code class="filename">patches</code> directory. Then I retried, fixed the
                   5476: patches so that they applied cleanly and retried again. This time,
                   5477: everything worked.</p>
1.197     wiz      5478: </div>
1.299     rillig   5479: <div class="sect3">
                   5480: <div class="titlepage"><div><div><h4 class="title">
                   5481: <a name="creating.nvu.inst"></a>14.2.1.3. Installing the package</h4></div></div></div>
1.87      wiz      5482: <pre class="programlisting">
1.299     rillig   5483: <code class="prompt">$</code> bmake CHECK_FILES=no install
                   5484: [...]
                   5485: <code class="prompt">$</code> bmake print-PLIST &gt;PLIST
                   5486: <code class="prompt">$</code> bmake deinstall
                   5487: <code class="prompt">$</code> bmake install
1.222     sevan    5488: </pre>
1.299     rillig   5489: </div>
                   5490: </div>
1.75      rillig   5491: </div>
                   5492: </div>
1.148     asau     5493: <div class="chapter">
1.75      rillig   5494: <div class="titlepage"><div><div><h2 class="title">
1.299     rillig   5495: <a name="makefile"></a>Chapter 15. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.75      rillig   5496: <div class="toc">
                   5497: <p><b>Table of Contents</b></p>
1.210     leot     5498: <dl class="toc">
1.299     rillig   5499: <dt><span class="sect1"><a href="#makefile.style">15.1. Caveats</a></span></dt>
                   5500: <dt><span class="sect1"><a href="#makefile.variables">15.2. <code class="filename">Makefile</code> variables</a></span></dt>
                   5501: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">15.2.1. Naming conventions</a></span></dt></dl></dd>
                   5502: <dt><span class="sect1"><a href="#makefile.code">15.3. Code snippets</a></span></dt>
                   5503: <dd><dl>
                   5504: <dt><span class="sect2"><a href="#adding-to-list">15.3.1. Adding things to a list</a></span></dt>
                   5505: <dt><span class="sect2"><a href="#echo-literal">15.3.2. Echoing a string exactly as-is</a></span></dt>
                   5506: <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>
                   5507: <dt><span class="sect2"><a href="#empty-variables">15.3.4. Handling possibly empty variables</a></span></dt>
1.75      rillig   5508: </dl></dd>
                   5509: </dl>
                   5510: </div>
1.299     rillig   5511: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
                   5512:   each of which forms a well-defined part of the pkgsrc system. Using
                   5513:   the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> system as a programming language for a big system
                   5514:   like pkgsrc requires some discipline to keep the code correct and
                   5515:   understandable.</p>
                   5516: <p>The basic ingredients for <code class="filename">Makefile</code>
                   5517:   programming are variables and shell
                   5518:   commands. Among these shell commands may even be more complex ones
                   5519:   like <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?awk+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">awk</span>(1)</span></a> programs. To make sure that every shell command runs
                   5520:   as intended it is necessary to quote all variables correctly when they
                   5521:   are used.</p>
                   5522: <p>This chapter describes some patterns that appear quite often in
                   5523:   <code class="filename">Makefile</code>s, including the pitfalls that come along
                   5524:   with them.</p>
1.148     asau     5525: <div class="sect1">
1.75      rillig   5526: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   5527: <a name="makefile.style"></a>15.1. Caveats</h2></div></div></div>
                   5528: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
                   5529: <p>When you are creating a file as a
                   5530:     target of a rule, always write the data to a temporary file first
                   5531:     and finally rename that file. Otherwise there might occur an error
                   5532:     in the middle of generating the file, and when the user runs
                   5533:     <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> for the second time, the file exists and will not be
                   5534:     regenerated properly. Example:</p>
1.75      rillig   5535: <pre class="programlisting">
1.299     rillig   5536: wrong:
                   5537:         @echo "line 1" &gt; ${.TARGET}
                   5538:         @echo "line 2" &gt;&gt; ${.TARGET}
                   5539:         @false
                   5540: 
                   5541: correct:
                   5542:         @echo "line 1" &gt; ${.TARGET}.tmp
                   5543:         @echo "line 2" &gt;&gt; ${.TARGET}.tmp
                   5544:         @false
                   5545:         @mv ${.TARGET}.tmp ${.TARGET}
1.100     rillig   5546: </pre>
1.299     rillig   5547: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
                   5548:     <code class="filename">wrong</code> will exist, although there was an error
                   5549:     message in the first run. On the other hand, running <span class="command"><strong>make
                   5550:     correct</strong></span> gives an error message twice, as expected.</p>
                   5551: <p>You might remember that <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> sometimes removes
                   5552:     <code class="literal">${.TARGET}</code> in case of error, but this only
                   5553:     happens when it is interrupted, for example by pressing
                   5554:     <code class="literal">Ctrl+C</code>. This does <span class="emphasis"><em>not</em></span> happen
                   5555:     when one of the commands fails (like <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?false+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">false</span>(1)</span></a> above).</p>
                   5556: </li></ul></div>
                   5557: </div>
                   5558: <div class="sect1">
                   5559: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   5560: <a name="makefile.variables"></a>15.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
                   5561: <p><code class="filename">Makefile</code> variables contain strings that
                   5562:     can be processed using the five operators <code class="code">=</code>,
                   5563:     <code class="code">+=</code>, <code class="code">?=</code>, <code class="code">:=</code> and
                   5564:     <code class="code">!=</code>, which are described in the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man
                   5565:     page.</p>
                   5566: <p>When a variable's value is parsed from a
                   5567:     <code class="filename">Makefile</code>, the hash character <code class="code">#</code> and
                   5568:     the backslash character <code class="code">\</code> are handled specially. If a
                   5569:     backslash is the last character in a line, that backslash is removed
                   5570:     from the line and the line continues with the next line of the file.</p>
                   5571: <p>The <code class="code">#</code> character starts a comment that reaches
                   5572:     until the end of the line. To get an actual <code class="code">#</code> character,
                   5573:     such as in a URL, write <code class="code">\#</code> instead.</p>
                   5574: <p>The evaluation of variables either happens immediately or lazy.
                   5575:     It happens immediately when the variable occurs on the right-hand
                   5576:     side of the <code class="code">:=</code> or the <code class="code">!=</code> operator, in a
                   5577:     <code class="varname">.if</code> condition or a <code class="varname">.for</code> loop.
                   5578:     In the other cases, it is evaluated lazily.</p>
                   5579: <p>Some of the modifiers split the string into words and then
                   5580:     operate on the words, others operate on the string as a whole. When a
                   5581:     string is split into words, double quotes and single quotes are
                   5582:     interpreted as delimiters, just like in <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?sh+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">sh</span>(1)</span></a>.</p>
                   5583: <div class="sect2">
                   5584: <div class="titlepage"><div><div><h3 class="title">
                   5585: <a name="makefile.variables.names"></a>15.2.1. Naming conventions</h3></div></div></div>
                   5586: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   5587: <li class="listitem"><p>All variable names starting with an underscore
                   5588:        are reserved for use by the pkgsrc infrastructure. They shall
                   5589:        not be used by packages.</p></li>
                   5590: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
                   5591:        lowercase variable names for the iteration
                   5592:        variables.</p></li>
                   5593: <li class="listitem"><p>All list variables should have a plural name,
                   5594:        such as <code class="varname">PKG_OPTIONS</code> or
                   5595:        <code class="varname">DISTFILES</code>.</p></li>
                   5596: </ul></div>
                   5597: </div>
                   5598: </div>
                   5599: <div class="sect1">
                   5600: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   5601: <a name="makefile.code"></a>15.3. Code snippets</h2></div></div></div>
                   5602: <div class="sect2">
                   5603: <div class="titlepage"><div><div><h3 class="title">
                   5604: <a name="adding-to-list"></a>15.3.1. Adding things to a list</h3></div></div></div>
                   5605: <p>When adding a string that possibly contains whitespace or quotes to
                   5606: a list (example 1), it must be quoted using the <code class="code">:Q</code>
                   5607: modifier.</p>
                   5608: <p>When adding another list to a list (example 2), it must not be
                   5609: quoted, since its elements are already quoted.</p>
1.75      rillig   5610: <pre class="programlisting">
1.299     rillig   5611: STRING=         foo * bar `date`
                   5612: LIST=           # empty
                   5613: ANOTHER_LIST=   a=b c=d
                   5614: 
                   5615: LIST+=          ${STRING:Q}       # 1
                   5616: LIST+=          ${ANOTHER_LIST}   # 2
1.100     rillig   5617: </pre>
1.299     rillig   5618: </div>
                   5619: <div class="sect2">
                   5620: <div class="titlepage"><div><div><h3 class="title">
                   5621: <a name="echo-literal"></a>15.3.2. Echoing a string exactly as-is</h3></div></div></div>
                   5622: <p>Echoing a string containing special characters needs special
                   5623: work.</p>
1.75      rillig   5624: <pre class="programlisting">
1.299     rillig   5625: STRING=         foo bar &lt;    &gt; * `date` $$HOME ' "
                   5626: EXAMPLE_ENV=    string=${STRING:Q} x=multiple\ quoted\ words
                   5627: 
                   5628: all:
                   5629:         echo ${STRING}                  # 1
                   5630:         echo ${STRING:Q}                # 2
                   5631:         printf '%s\n' ${STRING:Q}''     # 3
                   5632:         env ${EXAMPLE_ENV} sh -c 'echo "$$string"; echo "$$x"'   # 4
1.100     rillig   5633: </pre>
1.299     rillig   5634: <p>Example 1 leads to a syntax error in the shell, as the characters
                   5635: are just copied.</p>
                   5636: <p>Example 2 quotes the string so that the shell interprets it
                   5637: correctly. But the echo command may additionally interpret strings with a
                   5638: leading dash or those containing backslashes.</p>
                   5639: <p>Example 3 can handle arbitrary strings, since <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?printf+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">printf</span>(1)</span></a> only
                   5640: interprets the format string, but not the next argument. The trailing
                   5641: single quotes handle the case when the string is empty. In that case, the
                   5642: :Q modifier would result in an empty string too, which would then be
                   5643: skipped by the shell. For <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?printf+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">printf</span>(1)</span></a> this doesn't make a difference,
                   5644: but other programs may care.</p>
                   5645: <p>In example 4, the <code class="varname">EXAMPLE_ENV</code> does not
                   5646: need to be quoted because the quoting has already been done
                   5647: when adding elements to the list.</p>
1.75      rillig   5648: </div>
1.148     asau     5649: <div class="sect2">
1.75      rillig   5650: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   5651: <a name="cflags-gnu-configure"></a>15.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</h3></div></div></div>
                   5652: <p>When passing <code class="varname">CFLAGS</code> or similar variables to a
                   5653: GNU-style configure script (especially those that call other configure
                   5654: scripts), it must not have leading or trailing whitespace, since
                   5655: otherwise the configure script gets confused. To trim leading and
                   5656: trailing whitespace, use the <code class="code">:M</code> modifier, as in the
                   5657: following example:</p>
1.75      rillig   5658: <pre class="programlisting">
1.299     rillig   5659: CPPFLAGS=               # empty
                   5660: CPPFLAGS+=              -Wundef -DPREFIX=\"${PREFIX}\"
                   5661: CPPFLAGS+=              ${MY_CPPFLAGS}
1.1       grant    5662: 
1.299     rillig   5663: CONFIGURE_ARGS+=        CPPFLAGS=${CPPFLAGS:M*:Q}
1.1       grant    5664: 
1.299     rillig   5665: all:
                   5666:         echo x${CPPFLAGS:Q}x            # leading and trailing whitespace
                   5667:         echo x${CONFIGURE_ARGS:Q}x      # properly trimmed
                   5668: </pre>
                   5669: <p>In this example, <code class="varname">CPPFLAGS</code> has both leading and
                   5670: trailing whitespace because the <code class="code">+=</code> operator always adds a
                   5671: space.</p>
                   5672: </div>
                   5673: <div class="sect2">
                   5674: <div class="titlepage"><div><div><h3 class="title">
                   5675: <a name="empty-variables"></a>15.3.4. Handling possibly empty variables</h3></div></div></div>
                   5676: <p>When a possibly empty variable is used in a shell program, it may
                   5677: lead to a syntax error.</p>
                   5678: <pre class="programlisting">
                   5679: EGFILES=        # empty
1.87      wiz      5680: 
1.299     rillig   5681: install-examples:   # produces a syntax error in the shell
                   5682:         for egfile in ${EGFILES}; do            \
                   5683:                 echo "Installing $$egfile";     \
                   5684:         done
                   5685: </pre>
                   5686: <p>The shell only sees the text <code class="code">for egfile in ; do</code>, since
                   5687: <code class="code">${EGFILES}</code> is replaced with an empty string by <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>.
                   5688: To fix this syntax error, use one of the snippets below.</p>
                   5689: <pre class="programlisting">
                   5690: EMPTY=          # empty
1.87      wiz      5691: 
1.299     rillig   5692: install-examples:
                   5693:         for egfile in ${EGFILES} ""; do         \
                   5694:                 [ -n "$$egfile" ] || continue;  \
                   5695:                 echo "Installing $$egfile";     \
                   5696:         done
                   5697: </pre>
                   5698: <p>In this case, an empty string is appended to the iteration list (to
                   5699: prevent the syntax error) and filtered out later.</p>
                   5700: <pre class="programlisting">
                   5701: EGFILES=        # empty
1.87      wiz      5702: 
1.299     rillig   5703: install-examples:
                   5704: .for egfile in ${EGFILES}
                   5705:         echo "Installing ${egfile}"
                   5706: .endfor
1.100     rillig   5707: </pre>
1.299     rillig   5708: <p>If one of the filenames contains special characters, it should be
                   5709: enclosed in single or double quotes.</p>
                   5710: <p>To have a shell command test whether a make variable is empty, use
                   5711: the following code: <code class="code">${TEST} -z ${POSSIBLY_EMPTY:Q}""</code>.</p>
                   5712: </div>
                   5713: </div>
                   5714: </div>
                   5715: <div class="chapter">
                   5716: <div class="titlepage"><div><div><h2 class="title">
                   5717: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
                   5718: <div class="toc">
                   5719: <p><b>Table of Contents</b></p>
                   5720: <dl class="toc">
                   5721: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
                   5722: <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>
                   5723: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
                   5724: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
                   5725: </dl>
1.75      rillig   5726: </div>
1.299     rillig   5727: <p>Many packages have the ability to be built to support different
                   5728: sets of features.  <code class="filename">bsd.options.mk</code> is a framework
                   5729: in pkgsrc that provides generic handling of those options that
                   5730: determine different ways in which the packages can be built.  It's
                   5731: possible for the user to specify exactly which sets of options will be
                   5732: built into a package or to allow a set of global default options
                   5733: apply.</p>
                   5734: <p>There are two broad classes of behaviors that one might want to
                   5735: control via options.  One is whether some particular feature is
                   5736: enabled in a program that will be built anyway, often by including or
                   5737: not including a dependency on some other package.  The other is
                   5738: whether or not an additional program will be built as part of the
                   5739: package.  Generally, it is better to make a split package for such
                   5740: additional programs instead of using options, because it enables
                   5741: binary packages to be built which can then be added separately.  For
                   5742: example, the foo package might have minimal dependencies (those
                   5743: packages without which foo doesn't make sense), and then the foo-gfoo
                   5744: package might include the GTK frontend program gfoo.  This is better
                   5745: than including a gtk option to foo that adds gfoo, because either that
                   5746: option is default, in which case binary users can't get foo without
                   5747: gfoo, or not default, in which case they can't get gfoo.  With split
                   5748: packages, they can install foo without having GTK, and later decide to
                   5749: install gfoo (pulling in GTK at that time).  This is an advantage to
                   5750: source users too, avoiding the need for rebuilds.</p>
                   5751: <p>Plugins with widely varying dependencies should usually be split
                   5752: instead of options.</p>
                   5753: <p>It is often more work to maintain split packages, especially if
                   5754: the upstream package does not support this.  The decision of split
                   5755: vs. option should be made based on the likelihood that users will want
                   5756: or object to the various pieces, the size of the dependencies that are
                   5757: included, and the amount of work.</p>
                   5758: <p>A further consideration is licensing.  Non-free parts, or parts
                   5759: that depend on non-free dependencies (especially plugins) should
                   5760: almost always be split if feasible.</p>
                   5761: <div class="sect1">
                   5762: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   5763: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
                   5764: <p>Global default options are listed in
                   5765: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
                   5766: that should be built into every package if that option is supported.
                   5767: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75      rillig   5768: </div>
1.148     asau     5769: <div class="sect1">
1.75      rillig   5770: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   5771: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
                   5772: </h2></div></div></div>
                   5773: <p>The following example shows how
                   5774: <code class="filename">bsd.options.mk</code> should be used
                   5775: by the hypothetical ``wibble'' package, either in the package
                   5776: <code class="filename">Makefile</code>, or in a file,
                   5777: e.g. <code class="filename">options.mk</code>, that is included by the
                   5778: main package <code class="filename">Makefile</code>.</p>
1.75      rillig   5779: <pre class="programlisting">
1.299     rillig   5780: PKG_OPTIONS_VAR=                PKG_OPTIONS.wibble
                   5781: PKG_SUPPORTED_OPTIONS=          wibble-foo ldap
                   5782: PKG_OPTIONS_OPTIONAL_GROUPS=    database
                   5783: PKG_OPTIONS_GROUP.database=     mysql pgsql
                   5784: PKG_SUGGESTED_OPTIONS=          wibble-foo
                   5785: PKG_OPTIONS_LEGACY_VARS+=       WIBBLE_USE_OPENLDAP:ldap
                   5786: PKG_OPTIONS_LEGACY_OPTS+=       foo:wibble-foo
                   5787: 
                   5788: .include "../../mk/bsd.prefs.mk"
                   5789: 
                   5790: # this package was previously named wibble2
                   5791: .if defined(PKG_OPTIONS.wibble2)
                   5792: PKG_LEGACY_OPTIONS+=            ${PKG_OPTIONS.wibble2}
                   5793: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
                   5794:         "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
                   5795: .endif
                   5796: 
                   5797: .include "../../mk/bsd.options.mk"
                   5798: 
                   5799: # Package-specific option-handling
1.100     rillig   5800: 
1.299     rillig   5801: ###
                   5802: ### FOO support
                   5803: ###
                   5804: .if !empty(PKG_OPTIONS:Mwibble-foo)
                   5805: CONFIGURE_ARGS+=    --enable-foo
                   5806: .endif
1.100     rillig   5807: 
1.299     rillig   5808: ###
                   5809: ### LDAP support
                   5810: ###
                   5811: .if !empty(PKG_OPTIONS:Mldap)
                   5812: .  include "../../databases/openldap-client/buildlink3.mk"
                   5813: CONFIGURE_ARGS+=    --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
                   5814: .endif
1.100     rillig   5815: 
1.299     rillig   5816: ###
                   5817: ### database support
                   5818: ###
                   5819: .if !empty(PKG_OPTIONS:Mmysql)
                   5820: .  include "../../mk/mysql.buildlink3.mk"
                   5821: .endif
                   5822: .if !empty(PKG_OPTIONS:Mpgsql)
                   5823: .  include "../../mk/pgsql.buildlink3.mk"
                   5824: .endif
                   5825: </pre>
                   5826: <p>The first section contains the information about which build
                   5827: options are supported by the package, and any default options settings
                   5828: if needed.</p>
                   5829: <div class="orderedlist"><ol class="orderedlist" type="1">
                   5830: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
                   5831: <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> variable that the user can set to override the default
                   5832: options.  It should be set to
                   5833: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
                   5834: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
                   5835: at the point where the options are processed.</p></li>
                   5836: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
                   5837: build options supported by the package.</p></li>
                   5838: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
                   5839: list of names of groups of mutually exclusive options.  The options in
                   5840: each group are listed in
                   5841: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
                   5842: The most specific setting of any option from the group takes
                   5843: precedence over all other options in the group.  Options from the
                   5844: groups will be automatically added to
                   5845: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
                   5846: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
                   5847: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
                   5848: packages will fail if no option from the group is
                   5849: selected.</p></li>
                   5850: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
                   5851: of names of sets of options.  At least one option from each set must
                   5852: be selected.  The options in each set are listed in
                   5853: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
                   5854: Options from the sets will be automatically added to
                   5855: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.  Building the package will
                   5856: fail if no option from the set is selected.</p></li>
                   5857: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
                   5858: build options which are enabled by default.</p></li>
                   5859: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
                   5860: of
                   5861: <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>
                   5862: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
                   5863: their option counterparts.  Pairs should be added with
                   5864: <span class="quote">&#8220;<span class="quote">+=</span>&#8221;</span> to keep the listing of global legacy variables.  A
                   5865: warning will be issued if the user uses a legacy
                   5866: variable.</p></li>
                   5867: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
                   5868: of
                   5869: <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>
                   5870: pairs that map options that have been renamed to their new
                   5871: counterparts.  Pairs should be added with <span class="quote">&#8220;<span class="quote">+=</span>&#8221;</span> to keep
                   5872: the listing of global legacy options.  A warning will be issued if
                   5873: the user uses a legacy option.</p></li>
                   5874: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
                   5875: options implied by deprecated variables used.  This can be used for
                   5876: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
                   5877: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
                   5878: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
                   5879: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
                   5880: a list of warnings about deprecated variables or options used, and
                   5881: what to use instead.</p></li>
                   5882: </ol></div>
                   5883: <p>A package should never modify
                   5884: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
                   5885: <code class="varname">PKG_OPTIONS_VAR</code>.  These are strictly user-settable.
                   5886: To suggest a default set of options, use
                   5887: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
                   5888: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
                   5889: including <code class="filename">bsd.options.mk</code>.  If none of
                   5890: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
                   5891: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
                   5892: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
                   5893: happen with platform-specific options if none of them is supported on
                   5894: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
                   5895: empty list and the package is otherwise treated as not using the
                   5896: options framework.</p>
                   5897: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
                   5898: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
                   5899: build options, properly filtered to remove unsupported and duplicate
                   5900: options.</p>
                   5901: <p>The remaining sections contain the logic that is specific to
                   5902: each option.  The correct way to check for an option is to check
                   5903: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
                   5904: <pre class="programlisting">
                   5905: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
1.100     rillig   5906: </pre>
1.75      rillig   5907: </div>
1.299     rillig   5908: <div class="sect1">
                   5909: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   5910: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
                   5911: <p>Options that enable similar features in different packages (like
                   5912: optional support for a library) should use a common name in all
                   5913: packages that support it (like the name of the library).  If another
                   5914: package already has an option with the same meaning, use the same
                   5915: name.</p>
                   5916: <p>Options that enable features specific to one package, where it's
                   5917: unlikely that another (unrelated) package has the same (or a similar)
                   5918: optional feature, should use a name prefixed with
                   5919: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
                   5920: <p>If a group of related packages share an optional feature
                   5921: specific to that group, prefix it with the name of the
                   5922: <span class="quote">&#8220;<span class="quote">main</span>&#8221;</span> package
                   5923: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
                   5924: <p>For new options, add a line to
                   5925: <code class="filename">mk/defaults/options.description</code>.  Lines have two
                   5926: fields, separated by tab.  The first field is the option name, the
                   5927: second its description.  The description should be a whole sentence
                   5928: (starting with an uppercase letter and ending with a period) that
                   5929: describes what enabling the option does.  E. g. <span class="quote">&#8220;<span class="quote">Enable ispell
                   5930: support.</span>&#8221;</span> The file is sorted by option names.</p>
                   5931: </div>
                   5932: <div class="sect1">
                   5933: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   5934: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
                   5935: <p>When writing <a class="link" href="#buildlink3.mk"><code class="filename">buildlink3.mk</code></a> files, it is often necessary to list
                   5936: different dependencies based on the options with which the package was
                   5937: built. For querying these options, the file
                   5938: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
                   5939: typical example looks like this:</p>
1.87      wiz      5940: <pre class="programlisting">
1.299     rillig   5941: pkgbase := libpurple
                   5942: .include "../../mk/pkg-build-options.mk"
                   5943: 
                   5944: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
                   5945: ...
                   5946: .endif
1.229     sevan    5947: </pre>
1.299     rillig   5948: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
                   5949: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
                   5950: options of the libpurple package, which can then be queried like
                   5951: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
                   5952: file. See the file <code class="filename">pkg-build-options.mk</code> for more
                   5953: details.</p>
1.75      rillig   5954: </div>
                   5955: </div>
1.148     asau     5956: <div class="chapter">
1.75      rillig   5957: <div class="titlepage"><div><div><h2 class="title">
1.299     rillig   5958: <a name="tools"></a>Chapter 17. Tools needed for building or running</h2></div></div></div>
1.75      rillig   5959: <div class="toc">
                   5960: <p><b>Table of Contents</b></p>
1.210     leot     5961: <dl class="toc">
1.299     rillig   5962: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
                   5963: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
                   5964: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
1.75      rillig   5965: </dl>
                   5966: </div>
1.299     rillig   5967: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
                   5968: by pkgsrc and also for individual packages to define what commands
                   5969: are needed for building a package (like <code class="varname">TOOL_DEPENDS</code>)
                   5970: or for later run-time of an installed packaged (such as
                   5971: <code class="varname">DEPENDS</code>).
                   5972: If the native system provides an adequate tool, then in many cases, a pkgsrc
                   5973: package will not be used.</p>
                   5974: <p>When building a package, the replacement tools are
                   5975: made available in a directory (as symlinks or wrapper scripts)
                   5976: that is early in the executable search path. Just like the buildlink
                   5977: system, this helps with consistent builds.</p>
                   5978: <p>A tool may be needed to help build a specific package. For example,
                   5979: perl, GNU make (gmake) or yacc may be needed.</p>
                   5980: <p>Also a tool may be needed, for example, because the native system's supplied
                   5981: tool may be inefficient for building a package with pkgsrc.
                   5982: For example, a package may need GNU awk, bison (instead of
                   5983: yacc) or a better sed.</p>
                   5984: <p>The tools used by a package can be listed by running
                   5985: <span class="command"><strong>make show-tools</strong></span>.</p>
1.148     asau     5986: <div class="sect1">
1.75      rillig   5987: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   5988: <a name="pkgsrc-tools"></a>17.1. Tools for pkgsrc builds</h2></div></div></div>
                   5989: <p>The default set of tools used by pkgsrc is defined in
                   5990: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
                   5991: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
                   5992: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
                   5993: These can be seen by running:
                   5994: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
                   5995: <p>If a package needs a specific program to build
                   5996: then the <code class="varname">USE_TOOLS</code> variable can be used
                   5997: to define the tools needed.</p>
1.75      rillig   5998: </div>
1.299     rillig   5999: <div class="sect1">
                   6000: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   6001: <a name="package-tools"></a>17.2. Tools needed by packages</h2></div></div></div>
                   6002: <p>In the following examples, the :run means that it is needed at
                   6003: run-time (and becomes a DEPENDS).
                   6004: The default is a build dependency which can be set with
                   6005: :build. (So in this example, it is the same as gmake:build
                   6006: and pkg-config:build.)</p>
1.75      rillig   6007: <pre class="programlisting">
1.299     rillig   6008: USE_TOOLS+=     gmake perl:run pkg-config
1.1       grant    6009: </pre>
1.299     rillig   6010: <p>When using the tools framework, a
                   6011: <code class="varname">TOOLS_PATH.foo</code> variable is defined
                   6012: which contains the full path to the appropriate tool. For example,
                   6013: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">&#8220;<span class="quote">/bin/bash</span>&#8221;</span>
                   6014: on Linux systems.</p>
                   6015: <p>If you always need a pkgsrc version of the
                   6016: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
                   6017: </p>
1.75      rillig   6018: </div>
1.299     rillig   6019: <div class="sect1">
                   6020: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   6021: <a name="platform-tools"></a>17.3. Tools provided by platforms</h2></div></div></div>
                   6022: <p>When improving or porting pkgsrc to a new platform, have a look
                   6023: at (or create) the corresponding platform specific make file fragment under
                   6024: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
                   6025: the name of the common tools. For example:</p>
1.75      rillig   6026: <pre class="programlisting">
1.299     rillig   6027: .if exists(/usr/bin/bzcat)
                   6028: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzcat
                   6029: .elif exists(/usr/bin/bzip2)
                   6030: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzip2 -cd
                   6031: .endif
                   6032: 
                   6033: TOOLS_PLATFORM.true?=           true                    # shell builtin
1.1       grant    6034: </pre>
1.75      rillig   6035: </div>
                   6036: </div>
1.299     rillig   6037: <div class="chapter">
                   6038: <div class="titlepage"><div><div><h2 class="title">
                   6039: <a name="buildlink"></a>Chapter 18. Buildlink methodology</h2></div></div></div>
                   6040: <div class="toc">
                   6041: <p><b>Table of Contents</b></p>
                   6042: <dl class="toc">
                   6043: <dt><span class="sect1"><a href="#converting-to-buildlink3">18.1. Converting packages to use buildlink3</a></span></dt>
                   6044: <dt><span class="sect1"><a href="#creating-buildlink3.mk">18.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
                   6045: <dd><dl>
                   6046: <dt><span class="sect2"><a href="#anatomy-of-bl3">18.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
                   6047: <dt><span class="sect2"><a href="#updating-buildlink-depends">18.2.2. Updating
                   6048:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6049:       and
                   6050:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6051:       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
                   6052: </dl></dd>
                   6053: <dt><span class="sect1"><a href="#writing-builtin.mk">18.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
                   6054: <dd><dl>
                   6055: <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>
                   6056: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">18.3.2. Global preferences for native or pkgsrc software</a></span></dt>
                   6057: </dl></dd>
                   6058: </dl>
1.75      rillig   6059: </div>
1.299     rillig   6060: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
                   6061:   are seen by a package's configure and build processes.  This is implemented
                   6062:   in a two step process:</p>
                   6063: <div class="orderedlist"><ol class="orderedlist" type="1">
                   6064: <li class="listitem"><p>Symlink headers and libraries for dependencies into
                   6065:       <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
                   6066:       of <code class="varname">WRKDIR</code>.</p></li>
                   6067: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
                   6068:       tools that translate <code class="option">-I${LOCALBASE}/include</code> and
                   6069:       <code class="option">-L${LOCALBASE}/lib</code> into references to
                   6070:       <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
                   6071:       native compiler on some operating systems look like GCC, so that
                   6072:       packages that expect GCC won't require modifications to build with
                   6073:       those native compilers.</p></li>
                   6074: </ol></div>
                   6075: <p>This normalizes the environment in which a package is built so that the
                   6076:   package may be built consistently despite what other software may be
                   6077:   installed. Please note that the normal system header and library paths,
                   6078:   e.g. <code class="filename">/usr/include</code>,
                   6079:   <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
                   6080:   designed to insulate the package build from non-system-supplied
                   6081:   software.</p>
1.148     asau     6082: <div class="sect1">
1.75      rillig   6083: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6084: <a name="converting-to-buildlink3"></a>18.1. Converting packages to use buildlink3</h2></div></div></div>
                   6085: <p>The process of converting packages to use the buildlink3
                   6086:     framework (<span class="quote">&#8220;<span class="quote">bl3ifying</span>&#8221;</span>) is fairly straightforward.
                   6087:     The things to keep in mind are:</p>
1.128     wiz      6088: <div class="orderedlist"><ol class="orderedlist" type="1">
1.299     rillig   6089: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
                   6090:        instead of the actual toolchain.  Some packages are tricky,
                   6091:        and the only way to know for sure is the check
                   6092:        <code class="filename">${WRKDIR}/.work.log</code> to see if the
                   6093:        wrappers are being invoked.</p></li>
                   6094: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
                   6095:        the package Makefile, e.g. Java VMs, standalone shells,
                   6096:        etc., because the code to symlink files into
                   6097:        <code class="filename">${BUILDLINK_DIR}</code> looks for files
                   6098:        relative to <span class="quote">&#8220;<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>&#8221;</span>.
                   6099:        </p></li>
                   6100: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
                   6101:        <code class="filename">buildlink3.mk</code> files that you list in a
                   6102:        package's Makefile are added as dependencies for that package.
                   6103:        </p></li>
                   6104: </ol></div>
                   6105: <p>If a dependency on a particular package is required for its libraries and
                   6106:     headers, then we replace:</p>
                   6107: <pre class="programlisting">
                   6108: DEPENDS+=       foo&gt;=1.1.0:../../category/foo
                   6109: </pre>
                   6110: <p>with</p>
                   6111: <pre class="programlisting">
                   6112: .include "../../category/foo/buildlink3.mk"
                   6113: </pre>
                   6114: <p>The buildlink3.mk files usually define the required dependencies.
                   6115:     If you need a newer version of the dependency when using buildlink3.mk
                   6116:     files, then you can define it in your Makefile; for example:</p>
1.75      rillig   6117: <pre class="programlisting">
1.299     rillig   6118: BUILDLINK_API_DEPENDS.foo+=   foo&gt;=1.1.0
                   6119: .include "../../category/foo/buildlink3.mk"
1.1       grant    6120: </pre>
1.299     rillig   6121: <p>There are several <code class="filename">buildlink3.mk</code>
                   6122:     files in <code class="filename">pkgsrc/mk</code>
                   6123:     that handle special package issues:</p>
                   6124: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6125: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
                   6126:        the native or a pkgsrc Berkeley DB implementation based on
                   6127:        the values of <code class="varname">BDB_ACCEPTED</code> and
                   6128:        <code class="varname">BDB_DEFAULT</code>.</p></li>
                   6129: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
                   6130:        comes with neither Curses nor NCurses, this will take care
                   6131:        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>
                   6132: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
                   6133:        of <code class="varname">KRB5_ACCEPTED</code> to choose between
                   6134:        adding a dependency on Heimdal or MIT-krb5 for packages that
                   6135:        require a Kerberos 5 implementation.</p></li>
                   6136: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
                   6137:        system-provided Motif installation or adds a dependency on
                   6138:        <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
                   6139:        <code class="varname">MOTIF_TYPE</code> to <span class="quote">&#8220;<span class="quote">dt</span>&#8221;</span>,
                   6140:        <span class="quote">&#8220;<span class="quote">lesstif</span>&#8221;</span> or <span class="quote">&#8220;<span class="quote">motif</span>&#8221;</span>
                   6141:        to choose which Motif version will be used.</p></li>
                   6142: <li class="listitem"><p><code class="filename">readline.buildlink3.mk</code> checks for a
                   6143:        system-provided GNU readline or editline (libedit) installation,
                   6144:        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>,
                   6145:        <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
                   6146:        <code class="varname">READLINE_DEFAULT</code> to choose readline implementation.
                   6147:        If your package really needs GNU readline library, its Makefile
                   6148:        should include <code class="filename">devel/readline/buildlink3.mk</code>
                   6149:        instead of <code class="filename">readline.buildlink3.mk</code>.</p></li>
                   6150: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
                   6151:        variables that may be used by packages that use the
                   6152:        Open Sound System (OSS) API.</p></li>
                   6153: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
                   6154:        any of the Postgres versions in the variable
                   6155:        <code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
                   6156:        the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
                   6157:        the file for more information.</p></li>
                   6158: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
                   6159:        <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
                   6160:        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>
                   6161: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
                   6162:        <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
                   6163:        library.</p></li>
                   6164: </ul></div>
                   6165: <p>The comments in those <code class="filename">buildlink3.mk</code>
                   6166:     files provide a more complete
                   6167:     description of how to use them properly.</p>
1.75      rillig   6168: </div>
1.148     asau     6169: <div class="sect1">
1.75      rillig   6170: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6171: <a name="creating-buildlink3.mk"></a>18.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
                   6172: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
                   6173:     included by Makefiles to indicate the need to compile and link
                   6174:     against header files and libraries provided by the package.  A
                   6175:     <code class="filename">buildlink3.mk</code> file should always provide
                   6176:     enough information to add the correct type of dependency
                   6177:     relationship and include any other
                   6178:     <code class="filename">buildlink3.mk</code> files that it needs to find
                   6179:     headers and libraries that it needs in turn.</p>
                   6180: <p>To generate an initial <code class="filename">buildlink3.mk</code>
                   6181:     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>
                   6182:     package is highly recommended.  For most packages, the following
                   6183:     command will generate a good starting point for
                   6184:     <code class="filename">buildlink3.mk</code> files:</p>
                   6185: <pre class="screen">
                   6186: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
                   6187: <code class="prompt">%</code> createbuildlink &gt;buildlink3.mk</code></strong>
                   6188:     </pre>
1.148     asau     6189: <div class="sect2">
1.75      rillig   6190: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   6191: <a name="anatomy-of-bl3"></a>18.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
                   6192: <p>The following real-life example
                   6193:       <code class="filename">buildlink3.mk</code> is taken
                   6194:       from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
1.75      rillig   6195: <pre class="programlisting">
1.299     rillig   6196: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
                   6197: 
                   6198: BUILDLINK_TREE+=        tiff
                   6199: 
                   6200: .if !defined(TIFF_BUILDLINK3_MK)
                   6201: TIFF_BUILDLINK3_MK:=
                   6202: 
                   6203: BUILDLINK_API_DEPENDS.tiff+=    tiff&gt;=3.6.1
                   6204: BUILDLINK_ABI_DEPENDS.tiff+=    tiff&gt;=3.7.2nb1
                   6205: BUILDLINK_PKGSRCDIR.tiff?=      ../../graphics/tiff
                   6206: 
                   6207: .include "../../devel/zlib/buildlink3.mk"
                   6208: .include "../../graphics/jpeg/buildlink3.mk"
                   6209: .endif # TIFF_BUILDLINK3_MK
                   6210: 
                   6211: BUILDLINK_TREE+=        -tiff
1.1       grant    6212: </pre>
1.299     rillig   6213: <p>The header and footer manipulate
                   6214:       <code class="varname">BUILDLINK_TREE</code>, which is common across all
                   6215:       <code class="filename">buildlink3.mk</code> files and is used to track
                   6216:       the dependency tree.</p>
                   6217: <p>The main section is protected from multiple inclusion
                   6218:       and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
                   6219:       added.  Several important variables are set in the section:</p>
                   6220: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6221: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300   ! wiz      6222:          is the dependency version recorded in the installed
1.299     rillig   6223:          package; this should always be set using
                   6224:          <span class="command"><strong>+=</strong></span> to ensure that
                   6225:          we're appending to any pre-existing list of values.  This
1.300   ! wiz      6226:          variable should be set to the last version of the
1.299     rillig   6227:          package that had an backwards-incompatible API change.
                   6228:          </p></li>
                   6229: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
                   6230:          is the location of the <em class="replaceable"><code>pkg</code></em>
                   6231:          pkgsrc directory.</p></li>
                   6232: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
                   6233:          (not shown above) controls whether we use
                   6234:          <code class="varname">BUILD_DEPENDS</code> or
                   6235:          <code class="varname">DEPENDS</code> to add the dependency on
                   6236:          <em class="replaceable"><code>pkg</code></em>.  The build dependency is
                   6237:          selected by setting
                   6238:          <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
                   6239:          to <span class="quote">&#8220;<span class="quote">build</span>&#8221;</span>.  By default, the full dependency is
                   6240:          used.</p></li>
                   6241: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
                   6242:            and
                   6243:            <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
                   6244:            (not shown above) are lists of subdirectories of
                   6245:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
                   6246:            to add to the header and library search paths.  These
                   6247:            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>
                   6248:          respectively.</p></li>
                   6249: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
                   6250:            (not shown above) is the list of preprocessor flags to add
                   6251:            to <code class="varname">CPPFLAGS</code>, which are passed on to the
                   6252:            configure and build phases.  The <span class="quote">&#8220;<span class="quote">-I</span>&#8221;</span> option
                   6253:            should be avoided and instead be handled using
                   6254:            <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
                   6255:          above.</p></li>
                   6256: </ul></div>
                   6257: <p>The following variables are all optionally defined within
                   6258:       this second section (protected against multiple inclusion) and
                   6259:       control which package files are symlinked into
                   6260:       <code class="filename">${BUILDLINK_DIR}</code> and how their names are
                   6261:       transformed during the symlinking:</p>
                   6262: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6263: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
                   6264:            (not shown above) is a shell glob pattern relative to
                   6265:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
                   6266:            to be symlinked into
                   6267:            <code class="filename">${BUILDLINK_DIR}</code>,
                   6268:          e.g. <code class="filename">include/*.h</code>.</p></li>
                   6269: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
                   6270:            (not shown above) is a shell pipeline that
                   6271:            outputs to stdout a list of files relative to
                   6272:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
                   6273:            The resulting files are to be symlinked
                   6274:            into <code class="filename">${BUILDLINK_DIR}</code>.  By default,
                   6275:            this takes the <code class="filename">+CONTENTS</code> of a
                   6276:            <em class="replaceable"><code>pkg</code></em> and filters it through
                   6277:            <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
                   6278: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
                   6279:            (not shown above) is a filter command that filters
                   6280:            <code class="filename">+CONTENTS</code> input into a list of files
                   6281:            relative to
                   6282:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
                   6283:            on stdout.  By default,
                   6284:            <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
                   6285:            outputs the contents of the <code class="filename">include</code>
                   6286:            and <code class="filename">lib</code> directories in the package
                   6287:            <code class="filename">+CONTENTS</code>.</p></li>
                   6288: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
                   6289:            (not shown above) is a list of sed arguments used to
                   6290:            transform the name of the source filename into a
                   6291:            destination filename, e.g. <span class="command"><strong>-e
                   6292:            "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
                   6293: </ul></div>
                   6294: <p>This section can additionally include any
                   6295:       <code class="filename">buildlink3.mk</code> needed for
                   6296:       <em class="replaceable"><code>pkg</code></em>'s library dependencies.
                   6297:       Including these <code class="filename">buildlink3.mk</code> files
                   6298:       means that the headers and libraries for these
                   6299:       dependencies are also symlinked into
                   6300:       <code class="filename">${BUILDLINK_DIR}</code>
                   6301:       whenever the <em class="replaceable"><code>pkg</code></em>
                   6302:       <code class="filename">buildlink3.mk</code>
                   6303:       file is included. Dependencies are only added for directly
                   6304:       include <code class="filename">buildlink3.mk</code> files.</p>
                   6305: <p>When providing a <code class="filename">buildlink3.mk</code> and
                   6306:       including other <code class="filename">buildlink3.mk</code> files in it,
                   6307:       please only add necessary ones, i.e., those whose libraries or
                   6308:       header files are automatically exposed when the package is
                   6309:       use.</p>
                   6310: <p>In particular, if only an executable
                   6311:       (<code class="filename">bin/foo</code>) is linked against a library, that
                   6312:       library does not need to be propagated in the
                   6313:       <code class="filename">buildlink3.mk</code> file.</p>
                   6314: <p>The following steps should help you decide if a
                   6315:       <code class="filename">buildlink3.mk</code> file needs to be included:
                   6316:       </p>
                   6317: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6318: <li class="listitem"><p>Look at the installed header files: What
                   6319:        headers do they include? The packages providing these files
                   6320:        must be buildlinked.</p></li>
                   6321: <li class="listitem"><p>Run <code class="filename">ldd</code> on all installed
                   6322:        libraries and look against what other libraries they link.
                   6323:        Some of the packages providing these probably need to be
                   6324:        buildlinked; however, it's not automatic, since e.g. GTK on
                   6325:        some systems pulls in the X libraries, so they will show up in
                   6326:        the <code class="filename">ldd</code> output, while on others (like OS
                   6327:        X) it won't. <code class="filename">ldd</code> output can thus only be
                   6328:        used as a hint.</p></li>
                   6329: </ul></div>
                   6330: <p>
                   6331:       </p>
                   6332: </div>
1.148     asau     6333: <div class="sect2">
1.75      rillig   6334: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   6335: <a name="updating-buildlink-depends"></a>18.2.2. Updating
                   6336:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6337:       and
                   6338:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6339:       in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
1.300   ! wiz      6340: <p>Both variables set lower bounds for a version of this package.
        !          6341:       The two variables differ in that one describes source
1.299     rillig   6342:       compatibility (API) and the other binary compatibility (ABI).
                   6343:       The difference is that a change in the API breaks compilation of
                   6344:       programs while changes in the ABI stop compiled programs from
                   6345:       running.</p>
1.300   ! wiz      6346: <p>The
        !          6347:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
        !          6348:       variable in a <code class="filename">buildlink3.mk</code> should be
        !          6349:       changed very rarely.  (One possible scenario: If all packages
        !          6350:       using this package need a higher version than defined in the
        !          6351:       <code class="filename">buildlink3.mk</code>,
1.299     rillig   6352:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300   ! wiz      6353:       could be updated to that higher version.)</p>
        !          6354: <p>On the other hand, changes to
1.299     rillig   6355:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300   ! wiz      6356:       are more common.  The variable will need to be updated every
        !          6357:       time the major version of one of its shared libraries is changed,
        !          6358:       or any other change where a binary built against the previous
        !          6359:       version of the package will not run against the new version any
        !          6360:       longer.</p>
        !          6361: <p>In such a case, the package's
1.299     rillig   6362:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300   ! wiz      6363:       must be increased to require the new package version.  Then the
        !          6364:       <code class="varname">PKGREVISION</code> of all packages
        !          6365:       <em class="replaceable"><code>foo</code></em> that depend on this package need
        !          6366:       to be increased, and if they have
        !          6367:       <code class="filename">buildlink3.mk</code> files,
        !          6368:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>foo</code></em></code>
        !          6369:       in their <code class="filename">buildlink3.mk</code> files must be
        !          6370:       increased to the new version as well. This is required so that a
        !          6371:       package will pull in the versions of the packages that use the
        !          6372:       new ABI and that the packages' <code class="varname">PKGREVISION</code>s
        !          6373:       uniquely identify the packages built against the new ABI. The
        !          6374:       <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
        !          6375:       help with these updates.</p>
        !          6376: <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
        !          6377:       about dependencies on other packages, including the
        !          6378:       <code class="varname">BUILDLINK_API_DEPENDS</code> definitions.</p>
1.299     rillig   6379: <p>Please take careful consideration before adjusting
                   6380:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6381:       or
                   6382:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300   ! wiz      6383:       in a <code class="filename">buildlink3.mk</code> file as we don't want to
        !          6384:       cause unneeded package deletions and rebuilds.  In many cases,
        !          6385:       new versions of packages work just fine with older
        !          6386:       dependencies.</p>
1.299     rillig   6387: <p>Also it is not needed to set
                   6388:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6389:       when it is identical to
                   6390:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.        </p>
1.75      rillig   6391: </div>
                   6392: </div>
1.148     asau     6393: <div class="sect1">
1.75      rillig   6394: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6395: <a name="writing-builtin.mk"></a>18.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
                   6396: <p>Some packages in pkgsrc install headers and libraries that
                   6397:       coincide with headers and libraries present in the base system.
                   6398:       Aside from a <code class="filename">buildlink3.mk</code> file, these
                   6399:       packages should also include a <code class="filename">builtin.mk</code>
                   6400:       file that includes the necessary checks to decide whether using
                   6401:       the built-in software or the pkgsrc software is
                   6402:     appropriate.</p>
                   6403: <p>The only requirements of a builtin.mk file for
                   6404:     <em class="replaceable"><code>pkg</code></em> are:</p>
                   6405: <div class="orderedlist"><ol class="orderedlist" type="1">
                   6406: <li class="listitem"><p>It should set
                   6407:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6408:        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>
                   6409:        after it is included.</p></li>
                   6410: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
                   6411:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6412:        which is already set before the
                   6413:        <code class="filename">builtin.mk</code> file is included.</p></li>
                   6414: <li class="listitem"><p>It should be written to allow multiple inclusion.  This
                   6415:        is <span class="emphasis"><em>very</em></span> important and takes careful
                   6416:        attention to <code class="filename">Makefile</code> coding.</p></li>
                   6417: </ol></div>
                   6418: <div class="sect2">
                   6419: <div class="titlepage"><div><div><h3 class="title">
                   6420: <a name="anatomy-of-builtin.mk"></a>18.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</h3></div></div></div>
                   6421: <p>The following is the recommended template for builtin.mk
                   6422:       files:</p>
1.75      rillig   6423: <pre class="programlisting">
1.299     rillig   6424: .if !defined(IS_BUILTIN.foo)
                   6425: #
                   6426: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
                   6427: # genuinely exists in the system or not.
                   6428: #
                   6429: IS_BUILTIN.foo?=        no
1.100     rillig   6430: 
1.299     rillig   6431: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
                   6432: # version can be determined.
                   6433: #
                   6434: .  if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
                   6435: BUILTIN_PKG.foo?=       foo-1.0
                   6436: .  endif
                   6437: .endif  # IS_BUILTIN.foo
1.100     rillig   6438: 
1.299     rillig   6439: .if !defined(USE_BUILTIN.foo)
                   6440: USE_BUILTIN.foo?=       ${IS_BUILTIN.foo}
                   6441: .  if defined(BUILTIN_PKG.foo)
                   6442: .    for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
                   6443: .      if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
                   6444: USE_BUILTIN.foo!=                                                       \
                   6445:         ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo}            \
                   6446:         &amp;&amp; ${ECHO} "yes" || ${ECHO} "no"
                   6447: .      endif
                   6448: .    endfor
                   6449: .  endif
                   6450: .endif  # USE_BUILTIN.foo
1.100     rillig   6451: 
1.299     rillig   6452: CHECK_BUILTIN.foo?=     no
                   6453: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
                   6454: #
                   6455: # Here we place code that depends on whether USE_BUILTIN.foo is set to
                   6456: # "yes" or "no".
                   6457: #
                   6458: .endif  # CHECK_BUILTIN.foo
1.75      rillig   6459: </pre>
1.299     rillig   6460: <p>The first section sets
                   6461:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6462:       depending on if <em class="replaceable"><code>pkg</code></em> really exists
                   6463:       in the base system.  This should not be a base system software
                   6464:       with similar functionality to <em class="replaceable"><code>pkg</code></em>;
                   6465:       it should only be <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> if the actual package is
                   6466:       included as part of the base system.  This variable is only
                   6467:       used internally within the <code class="filename">builtin.mk</code>
                   6468:       file.</p>
                   6469: <p>The second section sets
                   6470:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   6471:       to the version of <em class="replaceable"><code>pkg</code></em> in the base
                   6472:       system if it exists (if
                   6473:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6474:       is <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>).  This variable is only used internally
                   6475:       within the <code class="filename">builtin.mk</code> file.</p>
                   6476: <p>The third section sets
                   6477:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6478:       and is <span class="emphasis"><em>required</em></span> in all
                   6479:       <code class="filename">builtin.mk</code> files.  The code in this
                   6480:       section must make the determination whether the built-in
                   6481:       software is adequate to satisfy the dependencies listed in
                   6482:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   6483:       This is typically done by comparing
                   6484:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   6485:       against each of the dependencies in
                   6486:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   6487:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6488:       <span class="emphasis"><em>must</em></span> be set to the correct value by the
                   6489:       end of the <code class="filename">builtin.mk</code> file.  Note that
                   6490:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6491:       may be <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> even if
                   6492:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6493:       is <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span> because we may make the determination
                   6494:       that the built-in version of the software is similar enough to
                   6495:       be used as a replacement.</p>
                   6496: <p>The last section is guarded by
                   6497:       <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
                   6498:       and includes code that uses the value of
                   6499:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6500:       set in the previous section.  This typically includes, e.g.,
                   6501:       adding additional dependency restrictions and listing additional
                   6502:       files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
                   6503:       <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
                   6504: </div>
                   6505: <div class="sect2">
                   6506: <div class="titlepage"><div><div><h3 class="title">
                   6507: <a name="native-or-pkgsrc-preference"></a>18.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
                   6508: <p>When building packages, it's possible to choose whether to set
                   6509:        a global preference for using either the built-in (native)
                   6510:        version or the pkgsrc version of software to satisfy a
                   6511:        dependency.  This is controlled by setting
                   6512:        <code class="varname">PREFER_PKGSRC</code> and
                   6513:        <code class="varname">PREFER_NATIVE</code>.  These variables take values
                   6514:        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
                   6515:        packages.  <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
                   6516:        use the pkgsrc versions of software, while
                   6517:        <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
                   6518:        built-in versions.  Preferences are determined by the most
                   6519:        specific instance of the package in either
                   6520:        <code class="varname">PREFER_PKGSRC</code> or
                   6521:        <code class="varname">PREFER_NATIVE</code>.  If a package is specified
                   6522:        in neither or in both variables, then
                   6523:        <code class="varname">PREFER_PKGSRC</code> has precedence over
                   6524:        <code class="varname">PREFER_NATIVE</code>.  For example, to require
                   6525:        using pkgsrc versions of software for all but the most basic
                   6526:       bits on a NetBSD system, you can set:</p>
1.75      rillig   6527: <pre class="programlisting">
1.299     rillig   6528: PREFER_PKGSRC=  yes
                   6529: PREFER_NATIVE=  getopt skey tcp_wrappers
                   6530: </pre>
                   6531: <p>A package <span class="emphasis"><em>must</em></span> have a
                   6532:       <code class="filename">builtin.mk</code>
                   6533:       file to be listed in <code class="varname">PREFER_NATIVE</code>,
                   6534:       otherwise it is simply ignored in that list.</p>
                   6535: <p>Setting <code class="varname">PREFER_NATIVE</code> should be performed
                   6536:       straight after bootstrap and <code class="varname">PREFER_PKGSRC</code> during
                   6537:       bootstrap.
                   6538:       Switching between settings globally at a later date can introduce
                   6539:       complications with dependency resolution. This is caused by packages
                   6540:       built with the opposite preference being installed alongside each other.</p>
                   6541: <pre class="screen">
                   6542: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap --prefer-pkgsrc yes</code></strong>
1.75      rillig   6543: </pre>
                   6544: </div>
1.107     rillig   6545: </div>
1.75      rillig   6546: </div>
1.148     asau     6547: <div class="chapter">
1.75      rillig   6548: <div class="titlepage"><div><div><h2 class="title">
1.299     rillig   6549: <a name="plist"></a>Chapter 19. PLIST issues</h2></div></div></div>
1.75      rillig   6550: <div class="toc">
                   6551: <p><b>Table of Contents</b></p>
1.210     leot     6552: <dl class="toc">
1.299     rillig   6553: <dt><span class="sect1"><a href="#rcs-id">19.1. RCS ID</a></span></dt>
                   6554: <dt><span class="sect1"><a href="#automatic-plist-generation">19.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                   6555: <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>
                   6556: <dt><span class="sect1"><a href="#plist.misc">19.4. Variable substitution in PLIST</a></span></dt>
                   6557: <dt><span class="sect1"><a href="#manpage-compression">19.5. Man page compression</a></span></dt>
                   6558: <dt><span class="sect1"><a href="#using-PLIST_SRC">19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
                   6559: <dt><span class="sect1"><a href="#platform-specific-plist">19.7. Platform-specific and differing PLISTs</a></span></dt>
                   6560: <dt><span class="sect1"><a href="#build-plist">19.8. Build-specific PLISTs</a></span></dt>
                   6561: <dt><span class="sect1"><a href="#faq.common-dirs">19.9. Sharing directories between packages</a></span></dt>
1.75      rillig   6562: </dl>
                   6563: </div>
1.299     rillig   6564: <p>The <code class="filename">PLIST</code> file contains a package's
                   6565:   <span class="quote">&#8220;<span class="quote">packing list</span>&#8221;</span>, i.e. a list of files that belong to
                   6566:   the package (relative to the <code class="filename">${PREFIX}</code>
                   6567:   directory it's been installed in) plus some additional statements
                   6568:   - see the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> man page for a full list.
                   6569:   This chapter addresses some issues that need attention when
                   6570:   dealing with the <code class="filename">PLIST</code> file (or files, see
                   6571:   below!).</p>
1.148     asau     6572: <div class="sect1">
1.75      rillig   6573: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6574: <a name="rcs-id"></a>19.1. RCS ID</h2></div></div></div>
                   6575: <p>Be sure to add a RCS ID line as the first thing in any
                   6576:     <code class="filename">PLIST</code> file you write:</p>
                   6577: <pre class="programlisting">
                   6578: @comment $NetBSD $
                   6579: </pre>
                   6580: <p>An artificial space has been added between NetBSD and $, this is a
                   6581: workaround here to prevent CVS expanding to the filename of the guide. When
                   6582: adding the RCS ID the space should be omitted.</p>
1.75      rillig   6583: </div>
1.148     asau     6584: <div class="sect1">
1.75      rillig   6585: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6586: <a name="automatic-plist-generation"></a>19.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
                   6587: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
                   6588:     to output a PLIST that matches any new files since the package
                   6589:     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
                   6590:     more information on this target.</p>
1.75      rillig   6591: </div>
1.148     asau     6592: <div class="sect1">
1.75      rillig   6593: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6594: <a name="print-PLIST"></a>19.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
                   6595: </h2></div></div></div>
                   6596: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
                   6597:     of AWK patterns and actions that are used to filter the output of
                   6598:     print-PLIST.  You can <span class="emphasis"><em>append</em></span> any chunk of AWK
                   6599:     scripting you like to it, but be careful with quoting.</p>
                   6600: <p>For example, to get all files inside the
                   6601:     <code class="filename">libdata/foo</code> directory removed from the
                   6602:     resulting PLIST:</p>
1.88      wiz      6603: <pre class="programlisting">
1.299     rillig   6604: PRINT_PLIST_AWK+=       /^libdata\/foo/ { next; }
1.100     rillig   6605: </pre>
1.300   ! wiz      6606: <p>The <code class="varname">PRINT_PLIST_AWK</code> transformations are
        !          6607:     evaluated after the file list and directory list are sorted.
        !          6608:     <code class="varname">EARLY_PRINT_PLIST_AWK</code> is like
        !          6609:     <code class="varname">PRINT_PLIST_AWK</code> except it operates before the file
        !          6610:     list and directory list are sorted.</p>
1.299     rillig   6611: </div>
                   6612: <div class="sect1">
                   6613: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   6614: <a name="plist.misc"></a>19.4. Variable substitution in PLIST</h2></div></div></div>
                   6615: <p>A number of variables are substituted automatically in
                   6616:     PLISTs when a package is installed on a system. This includes the
                   6617:     following variables:</p>
                   6618: <div class="variablelist"><dl class="variablelist">
                   6619: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
                   6620: <dd>
                   6621: <p>Some packages like emacs and perl embed information
                   6622:          about which architecture they were built on into the
                   6623:          pathnames where they install their files. To handle this
                   6624:          case, PLIST will be preprocessed before actually used, and
                   6625:          the symbol
                   6626:          <span class="quote">&#8220;<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>&#8221;</span> will be
                   6627:          replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
                   6628:          same is done if the string
                   6629:          <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
                   6630:          PLIST somewhere - use this on packages that have GNU
                   6631:          autoconf-created configure scripts.</p>
                   6632: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   6633: <h3 class="title">Legacy note</h3>
                   6634: <p>There used to be a symbol
                   6635:            <span class="quote">&#8220;<span class="quote"><code class="varname">$ARCH</code></span>&#8221;</span> that
                   6636:            was replaced by the output of <span class="command"><strong>uname
                   6637:            -m</strong></span>, but that's no longer supported and has
                   6638:            been removed.</p>
                   6639: </div>
                   6640: </dd>
                   6641: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
                   6642: <dd>
                   6643: <p>Some packages want to embed the OS name and version
                   6644:          into some paths.  To do this, use these variables in the
                   6645:          <code class="filename">PLIST</code>:
                   6646:          </p>
                   6647: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6648: <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>
                   6649: <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>
                   6650: <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>
                   6651: </ul></div>
                   6652: </dd>
                   6653: </dl></div>
                   6654: <p>For a list of values which are replaced by
                   6655:     default, the output of <span class="command"><strong>make help topic=PLIST_SUBST</strong></span> as
                   6656: well as searching the <code class="filename">pkgsrc/mk</code> directory with <span class="command"><strong>grep</strong></span> for
                   6657: <code class="varname">PLIST_SUBST</code> should help.</p>
                   6658: <p>If you want to change other variables not listed above, you
                   6659:     can add variables and their expansions to this variable in the
                   6660:     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   6661: <pre class="programlisting">
1.299     rillig   6662: PLIST_SUBST+=   SOMEVAR="somevalue"
1.100     rillig   6663: </pre>
1.299     rillig   6664: <p>This replaces all occurrences of <span class="quote">&#8220;<span class="quote">${SOMEVAR}</span>&#8221;</span>
                   6665:     in the <code class="filename">PLIST</code> with
                   6666:     <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span>.</p>
                   6667: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
                   6668:     the common case of conditionally including some
                   6669:     <code class="filename">PLIST</code> entries. It can be done by adding
                   6670:     <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
                   6671:     setting the corresponding <code class="varname">PLIST.foo</code> variable
                   6672:     to <code class="literal">yes</code> if the entry should be included.
                   6673:     This will substitute <span class="quote">&#8220;<span class="quote"><code class="varname">${PLIST.foo}</code></span>&#8221;</span>
                   6674:     in the <code class="filename">PLIST</code> with either
                   6675:     <span class="quote">&#8220;<span class="quote"><code class="literal">""</code></span>&#8221;</span> or
                   6676:     <span class="quote">&#8220;<span class="quote"><code class="literal">"@comment "</code></span>&#8221;</span>.
                   6677:     For example, in <code class="filename">Makefile</code>:</p>
1.174     asau     6678: <pre class="programlisting">
1.299     rillig   6679: PLIST_VARS+=    foo
                   6680: .if <em class="replaceable"><code>condition</code></em>
                   6681: PLIST.foo=      yes
                   6682: .else
1.174     asau     6683: </pre>
1.299     rillig   6684: <p>And then in <code class="filename">PLIST</code>:</p>
1.81      rillig   6685: <pre class="programlisting">
1.299     rillig   6686: @comment $NetBSD $
                   6687: bin/bar
                   6688: man/man1/bar.1
                   6689: ${PLIST.foo}bin/foo
                   6690: ${PLIST.foo}man/man1/foo.1
                   6691: ${PLIST.foo}share/bar/foo.data
1.100     rillig   6692: </pre>
1.299     rillig   6693: <p>An artificial space has been added between NetBSD and $, this is a
                   6694: workaround here to prevent CVS expanding to the filename of the guide. When
                   6695: adding the RCS ID the space should be ommited.</p>
1.81      rillig   6696: </div>
1.299     rillig   6697: <div class="sect1">
                   6698: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   6699: <a name="manpage-compression"></a>19.5. Man page compression</h2></div></div></div>
                   6700: <p>Man pages should be installed in compressed form if
                   6701:     <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
                   6702:     and uncompressed otherwise. To handle this in the
                   6703:     <code class="filename">PLIST</code> file, the suffix <span class="quote">&#8220;<span class="quote">.gz</span>&#8221;</span> is
                   6704:     appended/removed automatically for man pages according to
                   6705:     <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
                   6706:     or not, see above for details. This modification of the
                   6707:     <code class="filename">PLIST</code> file is done on a copy of it, not
                   6708:     <code class="filename">PLIST</code> itself.</p>
1.75      rillig   6709: </div>
1.148     asau     6710: <div class="sect1">
1.75      rillig   6711: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6712: <a name="using-PLIST_SRC"></a>19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
                   6713: </h2></div></div></div>
                   6714: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
                   6715:     in generating the binary package, set the variable
                   6716:     <code class="varname">PLIST_SRC</code> to the names of that file(s).
                   6717:     The files are later concatenated using <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?cat+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">cat</span>(1)</span></a>, and the order of things is
                   6718:     important. The default for <code class="varname">PLIST_SRC</code> is
                   6719:     <code class="filename">${PKGDIR}/PLIST</code>.</p>
1.75      rillig   6720: </div>
1.148     asau     6721: <div class="sect1">
1.75      rillig   6722: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6723: <a name="platform-specific-plist"></a>19.7. Platform-specific and differing PLISTs</h2></div></div></div>
                   6724: <p>Some packages decide to install a different set of files based on
                   6725:     the operating system being used. These differences can be
                   6726:     automatically handled by using the following files:</p>
                   6727: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6728: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
                   6729: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
                   6730: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
                   6731: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
                   6732: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
                   6733: </ul></div>
1.75      rillig   6734: </div>
1.148     asau     6735: <div class="sect1">
1.75      rillig   6736: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6737: <a name="build-plist"></a>19.8. Build-specific PLISTs</h2></div></div></div>
                   6738: <p>Some packages decide to generate hard-to-guess file names
                   6739:     during installation that are hard to wire down.</p>
                   6740: <p>In such cases, you can set the
                   6741:     <code class="varname">GENERATE_PLIST</code> variable to shell code
                   6742:     terminated (with a semicolon) that will output PLIST entries which
                   6743:     will be appended to the PLIST</p>
                   6744: <p>You can find one example in editors/xemacs:</p>
                   6745: <pre class="programlisting">
                   6746: GENERATE_PLIST+=        ${ECHO} bin/${DISTNAME}-`${WRKSRC}/src/xemacs -sd`.dmp ;
                   6747: </pre>
                   6748: <p>which will append something like
                   6749:     <code class="filename">bin/xemacs-21.4.23-54e8ea71.dmp</code> to the
                   6750:     <code class="filename">PLIST</code>.
                   6751:     </p>
1.75      rillig   6752: </div>
1.148     asau     6753: <div class="sect1">
1.75      rillig   6754: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6755: <a name="faq.common-dirs"></a>19.9. Sharing directories between packages</h2></div></div></div>
                   6756: <p>A <span class="quote">&#8220;<span class="quote">shared directory</span>&#8221;</span> is a directory where
                   6757:     multiple (and unrelated) packages install files.  These
                   6758:     directories were problematic because you had to add special
                   6759:     tricks in the PLIST to conditionally remove them, or have some
                   6760:     centralized package handle them.</p>
                   6761: <p>In pkgsrc, it is now easy: Each package should create
                   6762:     directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
                   6763:     will remove any directories left empty after uninstalling a
                   6764:     package.</p>
                   6765: <p>If a package needs an empty directory to work, create
                   6766:     the directory during installation as usual, and also add an
                   6767:     entry to the PLIST:
                   6768: 
                   6769: </p>
                   6770: <pre class="programlisting">
                   6771: @pkgdir path/to/empty/directory
                   6772: </pre>
                   6773: <p>
                   6774: 
                   6775:     or take a look at <code class="varname">MAKE_DIRS</code> and
                   6776:     <code class="varname">OWN_DIRS</code>.
1.88      wiz      6777:     </p>
1.75      rillig   6778: </div>
1.299     rillig   6779: </div>
                   6780: <div class="chapter">
                   6781: <div class="titlepage"><div><div><h2 class="title">
                   6782: <a name="pkginstall"></a>Chapter 20. The pkginstall framework</h2></div></div></div>
                   6783: <div class="toc">
                   6784: <p><b>Table of Contents</b></p>
                   6785: <dl class="toc">
                   6786: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">20.1. Files and directories outside the installation prefix</a></span></dt>
                   6787: <dd><dl>
                   6788: <dt><span class="sect2"><a href="#dirs-outside-prefix">20.1.1. Directory manipulation</a></span></dt>
                   6789: <dt><span class="sect2"><a href="#files-outside-prefix">20.1.2. File manipulation</a></span></dt>
                   6790: </dl></dd>
                   6791: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
                   6792: <dd><dl>
                   6793: <dt><span class="sect2"><a href="#conf-files-sysconfdir">20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
                   6794: <dt><span class="sect2"><a href="#conf-files-configure">20.2.2. Telling the software where configuration files are</a></span></dt>
                   6795: <dt><span class="sect2"><a href="#conf-files-patching">20.2.3. Patching installations</a></span></dt>
                   6796: <dt><span class="sect2"><a href="#conf-files-disable">20.2.4. Disabling handling of configuration files</a></span></dt>
                   6797: </dl></dd>
                   6798: <dt><span class="sect1"><a href="#rcd-scripts">20.3. System startup scripts</a></span></dt>
                   6799: <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>
                   6800: <dt><span class="sect1"><a href="#users-and-groups">20.4. System users and groups</a></span></dt>
                   6801: <dt><span class="sect1"><a href="#shells">20.5. System shells</a></span></dt>
                   6802: <dd><dl><dt><span class="sect2"><a href="#shells-disable">20.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   6803: <dt><span class="sect1"><a href="#fonts">20.6. Fonts</a></span></dt>
                   6804: <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>
                   6805: </dl>
                   6806: </div>
                   6807: <p>This chapter describes the framework known as
                   6808: <code class="literal">pkginstall</code>, whose key features are:</p>
                   6809: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6810: <li class="listitem"><p>Generic installation and manipulation of directories and files
                   6811:     outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
                   6812: <li class="listitem"><p>Automatic handling of configuration files during installation,
                   6813:     provided that packages are correctly designed.</p></li>
                   6814: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
                   6815: <li class="listitem"><p>Registration of system users and groups.</p></li>
                   6816: <li class="listitem"><p>Registration of system shells.</p></li>
                   6817: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
                   6818: </ul></div>
                   6819: <p>The following sections inspect each of the above points in detail.</p>
                   6820: <p>You may be thinking that many of the things described here could be
                   6821: easily done with simple code in the package's post-installation target
                   6822: (<code class="literal">post-install</code>).  <span class="emphasis"><em>This is incorrect</em></span>,
                   6823: as the code in them is only executed when building from source.  Machines
                   6824: using binary packages could not benefit from it at all (as the code itself
                   6825: could be unavailable).  Therefore, the only way to achieve any of the items
                   6826: described above is by means of the installation scripts, which are
                   6827: automatically generated by pkginstall.</p>
1.148     asau     6828: <div class="sect1">
1.75      rillig   6829: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6830: <a name="files-and-dirs-outside-prefix"></a>20.1. Files and directories outside the installation prefix</h2></div></div></div>
                   6831: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
                   6832: of files and directories that belong to a package.  The names used in it
                   6833: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
                   6834: which means that it cannot register files outside this directory (absolute
                   6835: path names are not allowed).  Despite this restriction, some packages need
                   6836: to install files outside this location; e.g., under
                   6837: <code class="filename">${VARBASE}</code> or
                   6838: <code class="filename">${PKG_SYSCONFDIR}</code>.  The only way to achieve this
                   6839: is to create such files during installation time by using
                   6840: installation scripts.</p>
                   6841: <p>The generic installation scripts are shell scripts that can
                   6842: contain arbitrary code.  The list of scripts to execute is taken from
                   6843: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
                   6844: <code class="filename">INSTALL</code>.  A similar variable exists for package
                   6845: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
                   6846: <code class="filename">DEINSTALL</code>).  These scripts can run arbitrary
                   6847: commands, so they have the potential to create and manage files
                   6848: anywhere in the file system.</p>
                   6849: <p>Using these general installation files is not recommended, but
                   6850: may be needed in some special cases.  One reason for avoiding them is
                   6851: that the user has to trust the packager that there is no unwanted or
                   6852: simply erroneous code included in the installation script. Also,
                   6853: previously there were many similar scripts for the same functionality,
                   6854: and fixing a common error involved finding and changing all of
                   6855: them.</p>
                   6856: <p>The pkginstall framework offers another, standardized way.  It
                   6857: provides generic scripts to abstract the manipulation of such files
                   6858: and directories based on variables set in the package's
                   6859: <code class="filename">Makefile</code>.  The rest of this section describes
                   6860: these variables.</p>
                   6861: <div class="sect2">
                   6862: <div class="titlepage"><div><div><h3 class="title">
                   6863: <a name="dirs-outside-prefix"></a>20.1.1. Directory manipulation</h3></div></div></div>
                   6864: <p>The following variables can be set to request the creation of
                   6865: directories anywhere in the file system:</p>
                   6866: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6867: <li class="listitem">
                   6868: <p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
                   6869:     contain a list of directories that should be created and should attempt
                   6870:     to be destroyed by the installation scripts.  The difference between
                   6871:     the two is that the latter prompts the administrator to remove any
                   6872:     directories that may be left after deinstallation (because they were
                   6873:     not empty), while the former does not.  Example:</p>
                   6874: <pre class="programlisting">
                   6875: MAKE_DIRS+=             ${VARBASE}/foo/private
                   6876: </pre>
                   6877: </li>
                   6878: <li class="listitem">
                   6879: <p><code class="varname">MAKE_DIRS_PERMS</code> and
                   6880:     <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
                   6881:     which directories should be created and should attempt to be destroyed
                   6882:     by the installation scripts.  Each tuple holds the following values,
                   6883:     separated by spaces: the directory name, its owner, its group and its
                   6884:     numerical mode.  For example:</p>
                   6885: <pre class="programlisting">
                   6886: MAKE_DIRS_PERMS+=       ${VARBASE}/foo/private \
                   6887:                         ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
                   6888: </pre>
                   6889: <p>The difference between the two is exactly the same as their
                   6890:     non-<code class="varname">PERMS</code> counterparts.</p>
                   6891: </li>
                   6892: </ul></div>
1.75      rillig   6893: </div>
1.299     rillig   6894: <div class="sect2">
                   6895: <div class="titlepage"><div><div><h3 class="title">
                   6896: <a name="files-outside-prefix"></a>20.1.2. File manipulation</h3></div></div></div>
                   6897: <p>Creating non-empty files outside the installation prefix is tricky
                   6898: because the <code class="filename">PLIST</code> forces all files to be inside it.
                   6899: To overcome this problem, the only solution is to extract the file in the
                   6900: known place (i.e., inside the installation prefix) and copy it to the
                   6901: appropriate location during installation (done by the installation scripts
                   6902: generated by pkginstall).  We will call the former the <span class="emphasis"><em>master
                   6903: file</em></span> in the following paragraphs, which describe the variables
                   6904: that can be used to automatically and consistently handle files outside the
                   6905: installation prefix:</p>
                   6906: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6907: <li class="listitem">
                   6908: <p><code class="varname">CONF_FILES</code> and
                   6909:     <code class="varname">REQD_FILES</code> are pairs of master and target files.
                   6910:     During installation time, the master file is copied to the target one
                   6911:     if and only if the latter does not exist.  Upon deinstallation, the
                   6912:     target file is removed provided that it was not modified by the
                   6913:     installation.</p>
                   6914: <p>The difference between the two is that the latter prompts the
                   6915:     administrator to remove any files that may be left after
                   6916:     deinstallation (because they were not empty), while the former does
                   6917:     not.</p>
                   6918: </li>
                   6919: <li class="listitem">
                   6920: <p><code class="varname">CONF_FILES_PERMS</code> and
                   6921:     <code class="varname">REQD_FILES_PERMS</code> contain tuples describing master
                   6922:     files as well as their target locations.  For each of them, it also
                   6923:     specifies their owner, their group and their numeric permissions, in
                   6924:     this order.  For example:</p>
1.88      wiz      6925: <pre class="programlisting">
1.299     rillig   6926: REQD_FILES_PERMS+=      ${PREFIX}/share/somefile ${VARBASE}/somefile \
                   6927:                         ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.100     rillig   6928: </pre>
1.299     rillig   6929: <p>The difference between the two is exactly the same as their
                   6930:     non-<code class="varname">PERMS</code> counterparts.</p>
                   6931: </li>
                   6932: </ul></div>
                   6933: </div>
1.75      rillig   6934: </div>
1.148     asau     6935: <div class="sect1">
1.75      rillig   6936: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6937: <a name="conf-files"></a>20.2. Configuration files</h2></div></div></div>
                   6938: <p>Configuration files are special in the sense that they are installed
                   6939: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
                   6940: need special treatment during installation (most of which is automated by
                   6941: pkginstall).  The main concept you must bear in mind is that files marked
                   6942: as configuration files are automatically copied to the right place (somewhere
                   6943: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
                   6944: and only if</em></span> they didn't exist before.  Similarly, they will not
                   6945: be removed if they have local modifications.  This ensures that
                   6946: administrators never lose any custom changes they may have made.</p>
                   6947: <div class="sect2">
                   6948: <div class="titlepage"><div><div><h3 class="title">
                   6949: <a name="conf-files-sysconfdir"></a>20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</h3></div></div></div>
                   6950: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
                   6951: specifies where configuration files shall be installed.  Its contents are
                   6952: set based upon the following variables:</p>
                   6953: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6954: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
                   6955:     directory.  Defaults to <code class="filename">${PREFIX}/etc</code> although it may
                   6956:     be overridden by the user to point to his preferred location (e.g.,
                   6957:     <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
                   6958:     Packages must not use it directly.</p></li>
                   6959: <li class="listitem">
                   6960: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
                   6961:     <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
                   6962:     for the package being built shall be installed.  The definition of this
                   6963:     variable only makes sense in the package's
                   6964:     <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
                   6965: <p>As an example, consider the Apache package,
                   6966:     <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
                   6967:     configuration files under the
                   6968:     <code class="filename">httpd/</code> subdirectory of
                   6969:     <code class="varname">PKG_SYSCONFBASE</code>.  This should be set in the package
                   6970:     Makefile.</p>
                   6971: </li>
                   6972: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
                   6973:     variable that holds this package's configuration directory (if
                   6974:     different from <code class="varname">PKG_SYSCONFBASE</code>).  It defaults to
                   6975:     <code class="varname">PKGBASE</code>'s value, and is always prefixed with
                   6976:     <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
                   6977: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
                   6978:     directory where the configuration files for the package identified by
                   6979:     <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
                   6980: </ul></div>
                   6981: <p>Based on the above variables, pkginstall determines the value of
                   6982: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
                   6983: variable that can be used within a package to refer to its configuration
                   6984: directory.  The algorithm used to set its value is basically the
                   6985: following:</p>
                   6986: <div class="orderedlist"><ol class="orderedlist" type="1">
                   6987: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
                   6988:     its value is used.</p></li>
                   6989: <li class="listitem"><p>If the previous variable is not defined but
                   6990:     <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
                   6991:     <code class="filename">Makefile</code>, the resulting value is
                   6992:     <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
                   6993: <li class="listitem"><p>Otherwise, it is set to
                   6994:     <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
                   6995: </ol></div>
                   6996: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
                   6997: 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
                   6998: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
                   6999: be created with OWN_DIRS or MAKE_DIRS.</p>
                   7000: </div>
                   7001: <div class="sect2">
                   7002: <div class="titlepage"><div><div><h3 class="title">
                   7003: <a name="conf-files-configure"></a>20.2.2. Telling the software where configuration files are</h3></div></div></div>
                   7004: <p>Given that pkgsrc (and users!) expect configuration files to be in a
                   7005: known place, you need to teach each package where it shall install its
                   7006: files.  In some cases you will have to patch the package Makefiles to
                   7007: achieve it.  If you are lucky, though, it may be as easy as passing an
                   7008: extra flag to the configuration script; this is the case of GNU Autoconf-
                   7009: generated files:</p>
1.75      rillig   7010: <pre class="programlisting">
1.299     rillig   7011: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.100     rillig   7012: </pre>
1.299     rillig   7013: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
                   7014: for</em></span> its configuration files, not where they will be originally
                   7015: installed (although the difference is never explicit,
                   7016: unfortunately).</p>
1.75      rillig   7017: </div>
1.299     rillig   7018: <div class="sect2">
                   7019: <div class="titlepage"><div><div><h3 class="title">
                   7020: <a name="conf-files-patching"></a>20.2.3. Patching installations</h3></div></div></div>
                   7021: <p>As said before, pkginstall automatically handles configuration files.
                   7022: This means that <span class="strong"><strong>the packages themselves must not
                   7023: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
                   7024: directly</strong></span>.  Bad news is that many software installation scripts
                   7025: will, out of the box, mess with the contents of that directory.  So what is
                   7026: the correct procedure to fix this issue?</p>
                   7027: <p>You must teach the package (usually by manually patching it) to
                   7028: install any configuration files under the examples hierarchy,
                   7029: <code class="filename">share/examples/${PKGBASE}/</code>.  This way, the
                   7030: <code class="filename">PLIST</code> registers them and the administrator always
                   7031: has the original copies available.</p>
                   7032: <p>Once the required configuration files are in place (i.e., under the
                   7033: examples hierarchy), the pkginstall framework can use them as master copies
                   7034: during the package installation to update what is in
                   7035: <code class="filename">${PKG_SYSCONFDIR}</code>.  To achieve this, the variables
                   7036: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
                   7037: 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
                   7038: about their syntax and their purpose.  Here is an example, taken from the
                   7039: <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      7040: <pre class="programlisting">
1.299     rillig   7041: EGDIR=        ${PREFIX}/share/doc/mutt/samples
                   7042: CONF_FILES=   ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
1.100     rillig   7043: </pre>
1.299     rillig   7044: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
                   7045: package and has no meaning outside it.</p>
1.75      rillig   7046: </div>
1.299     rillig   7047: <div class="sect2">
                   7048: <div class="titlepage"><div><div><h3 class="title">
                   7049: <a name="conf-files-disable"></a>20.2.4. Disabling handling of configuration files</h3></div></div></div>
                   7050: <p>The automatic copying of config files can be toggled by setting the
                   7051: environment variable <code class="varname">PKG_CONFIG</code> prior to package
                   7052: installation.</p>
1.88      wiz      7053: </div>
1.75      rillig   7054: </div>
1.148     asau     7055: <div class="sect1">
1.75      rillig   7056: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   7057: <a name="rcd-scripts"></a>20.3. System startup scripts</h2></div></div></div>
                   7058: <p>System startup scripts are special files because they must be
                   7059: installed in a place known by the underlying OS, usually outside the
                   7060: 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
                   7061: can be used.  However, pkginstall provides a special mechanism to handle
                   7062: these files.</p>
                   7063: <p>In order to provide system startup scripts, the package has
                   7064: to:</p>
                   7065: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7066: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
                   7067:     the <code class="literal">.sh</code> suffix appended.  Considering the
                   7068:     <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
                   7069:     <code class="filename">cupsd.sh</code> in its files directory.</p></li>
                   7070: <li class="listitem">
                   7071: <p>Tell pkginstall to handle it, appending the name of the script,
                   7072:     without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
                   7073:     Continuing the previous example:</p>
                   7074: <pre class="programlisting">
                   7075: RCD_SCRIPTS+=   cupsd
                   7076: </pre>
                   7077: </li>
                   7078: </ol></div>
                   7079: <p>Once this is done, pkginstall will do the following steps for each
                   7080: script in an automated fashion:</p>
                   7081: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7082: <li class="listitem"><p>Process the file found in the files directory applying all the
                   7083:     substitutions described in the <code class="filename">FILES_SUBST</code>
                   7084:     variable.</p></li>
                   7085: <li class="listitem"><p>Copy the script from the files directory to the examples
                   7086:     hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>.  Note
                   7087:     that this master file must be explicitly registered in the
                   7088:     <code class="filename">PLIST</code>.</p></li>
                   7089: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
                   7090:     from the examples hierarchy into the system-wide startup scripts
                   7091:     directory.</p></li>
                   7092: </ol></div>
                   7093: <div class="sect2">
                   7094: <div class="titlepage"><div><div><h3 class="title">
                   7095: <a name="rcd-scripts-disable"></a>20.3.1. Disabling handling of system startup scripts</h3></div></div></div>
                   7096: <p>The automatic copying of config files can be toggled by setting the
                   7097: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
                   7098: installation.  Note that the scripts will be always copied inside the
                   7099: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
                   7100: matter what the value of this variable is.</p>
1.75      rillig   7101: </div>
                   7102: </div>
1.299     rillig   7103: <div class="sect1">
                   7104: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   7105: <a name="users-and-groups"></a>20.4. System users and groups</h2></div></div></div>
                   7106: <p>If a package needs to create special users and/or groups during
                   7107: installation, it can do so by using the pkginstall framework.</p>
                   7108: <p>Users can be created by adding entries to the
                   7109: <code class="varname">PKG_USERS</code> variable.  Each entry has the following
                   7110: syntax:</p>
                   7111: <pre class="programlisting">
                   7112: user:group
                   7113: </pre>
                   7114: <p>Further specification of user details may be done by setting
                   7115: per-user variables.
                   7116: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
                   7117: numeric UID for the user.
                   7118: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
                   7119: user's description or comment.
                   7120: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
                   7121: user's home directory, and defaults to
                   7122: <code class="filename">/nonexistent</code> if not specified.
                   7123: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
                   7124: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
                   7125: not specified.</p>
                   7126: <p>Similarly, groups can be created by adding entries to the
                   7127: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
                   7128: <pre class="programlisting">
                   7129: group
                   7130: </pre>
                   7131: <p>The numeric GID of the group may be set by defining
                   7132: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
                   7133: <p>If a package needs to create the users and groups at an earlier
                   7134: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to either
                   7135: <code class="literal">configure</code>,<code class="literal">build</code>, or
                   7136: <code class="literal">pre-install</code> to indicate the phase before which the
                   7137: users and groups are created. In this case, the numeric UIDs and GIDs
                   7138: of the created users and groups are automatically hardcoded into the
                   7139: final installation scripts.</p>
1.75      rillig   7140: </div>
1.148     asau     7141: <div class="sect1">
1.75      rillig   7142: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   7143: <a name="shells"></a>20.5. System shells</h2></div></div></div>
                   7144: <p>Packages that install system shells should register them in the shell
                   7145: database, <code class="filename">/etc/shells</code>, to make things easier to the
                   7146: administrator.  This must be done from the installation scripts to keep
                   7147: binary packages working on any system.  pkginstall provides an easy way to
                   7148: accomplish this task.</p>
                   7149: <p>When a package provides a shell interpreter, it has to set the
                   7150: <code class="varname">PKG_SHELL</code> variable to its absolute file name.  This will
                   7151: add some hooks to the installation scripts to handle it.  Consider the
                   7152: 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>
                   7153: <pre class="programlisting">
                   7154: PKG_SHELL=      ${PREFIX}/bin/zsh
                   7155: </pre>
                   7156: <div class="sect2">
                   7157: <div class="titlepage"><div><div><h3 class="title">
                   7158: <a name="shells-disable"></a>20.5.1. Disabling shell registration</h3></div></div></div>
                   7159: <p>The automatic registration of shell interpreters can be disabled by
                   7160: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
                   7161: environment variable to <code class="literal">NO</code>.</p>
                   7162: </div>
1.75      rillig   7163: </div>
1.148     asau     7164: <div class="sect1">
1.75      rillig   7165: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   7166: <a name="fonts"></a>20.6. Fonts</h2></div></div></div>
                   7167: <p>Packages that install X11 fonts should update the database files
                   7168: that index the fonts within each fonts directory.  This can easily be
                   7169: accomplished within the pkginstall framework.</p>
                   7170: <p>When a package installs X11 fonts, it must list the directories in
                   7171: which fonts are installed in the
                   7172: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
                   7173: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">&#8220;<span class="quote">ttf</span>&#8221;</span>,
                   7174: <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
                   7175: installation scripts to run the appropriate commands to update the fonts
                   7176: database files within each of those directories.  For convenience, if the
                   7177: directory path is relative, it is taken to be relative to the package's
                   7178: 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   7179: <pre class="programlisting">
1.299     rillig   7180: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF
1.75      rillig   7181: </pre>
1.299     rillig   7182: <div class="sect2">
                   7183: <div class="titlepage"><div><div><h3 class="title">
                   7184: <a name="fonts-disable"></a>20.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
                   7185: <p>The automatic update of fonts databases can be disabled by
                   7186: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
                   7187: environment variable to <code class="literal">NO</code>.</p>
1.75      rillig   7188: </div>
                   7189: </div>
                   7190: </div>
1.148     asau     7191: <div class="chapter">
1.75      rillig   7192: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   7193: <a name="fixes"></a>Chapter 21. Making your package work</h2></div></div></div>
1.75      rillig   7194: <div class="toc">
                   7195: <p><b>Table of Contents</b></p>
1.210     leot     7196: <dl class="toc">
1.267     rillig   7197: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
1.75      rillig   7198: <dd><dl>
1.267     rillig   7199: <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>
                   7200: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
                   7201: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
                   7202: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
                   7203: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
                   7204: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
                   7205: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
                   7206: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
                   7207: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
                   7208: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
                   7209: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                   7210: </dl></dd>
                   7211: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                   7212: <dd><dl>
                   7213: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   7214: <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>
                   7215: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
                   7216: </dl></dd>
                   7217: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   7218: <dd><dl>
                   7219: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
                   7220: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   7221: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
                   7222: </dl></dd>
                   7223: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
                   7224: <dd><dl>
                   7225: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
                   7226: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
                   7227: <dt><span class="sect2"><a href="#perl-scripts">21.4.3. Packages containing perl scripts</a></span></dt>
                   7228: <dt><span class="sect2"><a href="#shell-scripts">21.4.4. Packages containing shell scripts</a></span></dt>
                   7229: <dt><span class="sect2"><a href="#other-programming-languages">21.4.5. Other programming languages</a></span></dt>
                   7230: </dl></dd>
                   7231: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   7232: <dd><dl>
                   7233: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   7234: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.287     rillig   7235: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
                   7236: <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>
                   7237: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.267     rillig   7238: </dl></dd>
                   7239: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   7240: <dd><dl>
                   7241: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
                   7242: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
                   7243: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
                   7244: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
                   7245: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
                   7246: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing perl modules</a></span></dt>
                   7247: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
                   7248: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
                   7249: <dt><span class="sect2"><a href="#gconf-data-files">21.6.9. Packages installing GConf data files</a></span></dt>
                   7250: <dt><span class="sect2"><a href="#scrollkeeper-data-files">21.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
                   7251: <dt><span class="sect2"><a href="#x11-fonts">21.6.11. Packages installing X11 fonts</a></span></dt>
                   7252: <dt><span class="sect2"><a href="#gtk2-modules">21.6.12. Packages installing GTK2 modules</a></span></dt>
                   7253: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.13. Packages installing SGML or XML data</a></span></dt>
                   7254: <dt><span class="sect2"><a href="#mime-database">21.6.14. Packages installing extensions to the MIME database</a></span></dt>
                   7255: <dt><span class="sect2"><a href="#intltool">21.6.15. Packages using intltool</a></span></dt>
                   7256: <dt><span class="sect2"><a href="#startup-scripts">21.6.16. Packages installing startup scripts</a></span></dt>
                   7257: <dt><span class="sect2"><a href="#tex-packages">21.6.17. Packages installing TeX modules</a></span></dt>
                   7258: <dt><span class="sect2"><a href="#emulation-packages">21.6.18. Packages supporting running binaries in
1.87      wiz      7259:     emulation</a></span></dt>
1.267     rillig   7260: <dt><span class="sect2"><a href="#hicolor-theme">21.6.19. Packages installing hicolor theme icons</a></span></dt>
                   7261: <dt><span class="sect2"><a href="#desktop-files">21.6.20. Packages installing desktop files</a></span></dt>
1.75      rillig   7262: </dl></dd>
1.267     rillig   7263: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.75      rillig   7264: </dl>
                   7265: </div>
1.148     asau     7266: <div class="sect1">
1.75      rillig   7267: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   7268: <a name="general-operation"></a>21.1. General operation</h2></div></div></div>
1.78      rillig   7269: <p>One appealing feature of pkgsrc is that it runs on many
1.218     rillig   7270:   different platforms. As a result, it is important to ensure,
                   7271:   where possible, that packages in pkgsrc are portable. This
                   7272:   chapter mentions some particular details you should pay
                   7273:   attention to while working on pkgsrc.</p>
1.148     asau     7274: <div class="sect2">
1.78      rillig   7275: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7276: <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   7277: </h3></div></div></div>
1.78      rillig   7278: <p>The pkgsrc user can configure pkgsrc by overriding several
1.87      wiz      7279:     variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.110     hubertf  7280:     which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.87      wiz      7281:     want to use those variables in the preprocessor directives of
1.289     leot     7282:     <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> (for example <code class="literal">.if</code> or
1.87      wiz      7283:     <code class="literal">.for</code>), you need to include the file
                   7284:     <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
                   7285:     loads the user preferences.</p>
1.78      rillig   7286: <p>But note that some variables may not be completely defined
1.219     rillig   7287:     after <code class="filename">../../mk/bsd.prefs.mk</code> has been
                   7288:     included, as they may contain references to variables that are
                   7289:     not yet defined. In shell commands (the lines in
                   7290:     <code class="filename">Makefile</code> that are indented with a tab) this
                   7291:     is no problem, since variables are only expanded when they are
                   7292:     used. But in the preprocessor directives mentioned above and in
                   7293:     dependency lines (of the form <code class="literal">target:
                   7294:     dependencies</code>) the variables are expanded at load
                   7295:     time.</p>
1.148     asau     7296: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.78      rillig   7297: <h3 class="title">Note</h3>
1.218     rillig   7298: <p>To check whether a variable can be used at load time,
                   7299:     run <span class="command"><strong>pkglint -Wall</strong></span> on your package.</p>
1.78      rillig   7300: </div>
                   7301: </div>
1.148     asau     7302: <div class="sect2">
1.78      rillig   7303: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7304: <a name="user-interaction"></a>21.1.2. User interaction</h3></div></div></div>
1.88      wiz      7305: <p>Occasionally, packages require interaction from the user,
                   7306:     and this can be in a number of ways:</p>
1.148     asau     7307: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      7308: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.87      wiz      7309:        interaction such as entering username/password or accepting a
                   7310:        license on a web page.</p></li>
1.128     wiz      7311: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.88      wiz      7312:        passwords.</p></li>
1.128     wiz      7313: <li class="listitem"><p>help to configure the package before it is built</p></li>
                   7314: <li class="listitem"><p>help during the build process</p></li>
                   7315: <li class="listitem"><p>help during the installation of a package</p></li>
1.78      rillig   7316: </ul></div>
1.218     rillig   7317: <p>A package can set the <code class="varname">INTERACTIVE_STAGE</code>
                   7318:     variable to define which stages need interaction. This should be
                   7319:     done in the package's <code class="filename">Makefile</code>, e.g.:</p>
1.75      rillig   7320: <pre class="programlisting">
1.100     rillig   7321: INTERACTIVE_STAGE=      configure install
1.222     sevan    7322: </pre>
1.88      wiz      7323: <p>The user can then decide to skip this package by setting the
1.218     rillig   7324:     <code class="varname">BATCH</code> variable. Packages that require interaction
                   7325:     are also excluded from bulk builds.</p>
1.75      rillig   7326: </div>
1.148     asau     7327: <div class="sect2">
1.75      rillig   7328: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7329: <a name="handling-licenses"></a>21.1.3. Handling licenses</h3></div></div></div>
1.222     sevan    7330: <p>Authors of software can choose the licence under which software
                   7331:     can be copied.  The Free Software Foundation has declared some
                   7332:     licenses "Free", and the Open Source Initiative has a definition of
                   7333:     "Open Source".</p>
                   7334: <p>By default, pkgsrc allows packages with Free or Open Source
                   7335:     licenses to be built.  To allow packages with other licenses to be
                   7336:     built as well, the pkgsrc user needs to add these licenses to the
                   7337:     <code class="varname">ACCEPTABLE_LICENSES</code> variable in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  Note
                   7338:     that this variable only affects which packages may be
                   7339:     <span class="emphasis"><em>built</em></span>, while the license terms often also
                   7340:     restrict the actual use of the package and its redistribution.</p>
1.98      wiz      7341: <p>One might want to only install packages with a BSD license,
1.218     rillig   7342:     or the GPL, and not the other.  The free licenses are added to the
1.222     sevan    7343:     default <code class="varname">ACCEPTABLE_LICENSES</code> variable.  The pkgsrc
1.121     jnemeth  7344:     user can override the default by setting the
                   7345:     <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
1.222     sevan    7346:     of "+=".  The licenses accepted by default are defined in the
                   7347:     <code class="varname">DEFAULT_ACCEPTABLE_LICENSES</code> variable in the file
                   7348:     <code class="filename">pkgsrc/mk/license.mk</code>.</p>
1.78      rillig   7349: <p>The license tag mechanism is intended to address
1.87      wiz      7350:     copyright-related issues surrounding building, installing and
                   7351:     using a package, and not to address redistribution issues (see
                   7352:     <code class="varname">RESTRICTED</code> and
1.222     sevan    7353:     <code class="varname">NO_SRC_ON_FTP</code>, etc.).
1.121     jnemeth  7354:     Packages with redistribution restrictions should set these
                   7355:     tags.</p>
1.98      wiz      7356: <p>Denoting that a package may be copied according to a
                   7357:     particular license is done by placing the license in
1.87      wiz      7358:     <code class="filename">pkgsrc/licenses</code> and setting the
                   7359:     <code class="varname">LICENSE</code> variable to a string identifying the
1.250     leot     7360:     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      7361: <pre class="programlisting">
1.100     rillig   7362: LICENSE=        xv-license
1.222     sevan    7363: </pre>
1.87      wiz      7364: <p>When trying to build, the user will get a notice that the
1.98      wiz      7365:     package is covered by a license which has not been placed in the
                   7366:     <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
1.87      wiz      7367: <pre class="programlisting">
1.100     rillig   7368: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   7369: ===&gt; xv-3.10anb9 has an unacceptable license: xv-license.
                   7370: ===&gt;     To view the license, enter "/usr/bin/make show-license".
                   7371: ===&gt;     To indicate acceptance, add this line to your /etc/mk.conf:
                   7372: ===&gt;     ACCEPTABLE_LICENSES+=xv-license
                   7373: *** Error code 1
1.222     sevan    7374: </pre>
1.110     hubertf  7375: <p>The license can be viewed with <span class="command"><strong>make
1.98      wiz      7376:     show-license</strong></span>, and if the user so chooses, the line
1.110     hubertf  7377:     printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.98      wiz      7378:     convey to pkgsrc that it should not in the future fail because of
                   7379:     that license:</p>
1.78      rillig   7380: <pre class="programlisting">
1.100     rillig   7381: ACCEPTABLE_LICENSES+=xv-license
1.222     sevan    7382: </pre>
                   7383: <p>The use of <code class="varname">LICENSE=shareware</code>,
                   7384:     <code class="varname">LICENSE=no-commercial-use</code>, and similar language
                   7385:     is deprecated because it does not crisply refer to a particular
                   7386:     license text.  Another problem with such usage is that it does not
                   7387:     enable a user to tell pkgsrc to proceed for a single package
                   7388:     without also telling pkgsrc to proceed for all packages with that
                   7389:     tag.</p>
                   7390: <div class="sect3">
                   7391: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   7392: <a name="new-license"></a>21.1.3.1. Adding a package with a new license</h4></div></div></div>
1.154     rodent   7393: <p>When adding a package with a new license, the following steps
                   7394:     are required:</p>
                   7395: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7396: <li class="listitem">
1.284     rillig   7397: <p>Check whether the license qualifies as Free or Open Source by
                   7398:     referencing <a class="ulink" href="https://www.gnu.org/licenses/license-list.en.html" target="_top">Various
                   7399:     Licenses and Comments about Them</a> and <a class="ulink" href="https://opensource.org/licenses/alphabetical" target="_top">Licenses by Name |
1.222     sevan    7400:     Open Source Initiative</a>.  If this is the case, the filename in
                   7401:     <code class="filename">pkgsrc/licenses/</code> does not need the
                   7402:     <code class="filename">-license</code> suffix, and the license name should be
                   7403:     added to:</p>
1.154     rodent   7404: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.284     rillig   7405: <li class="listitem"><p>DEFAULT_ACCEPTABLE_LICENSES in
                   7406:     <code class="filename">pkgsrc/mk/license.mk</code></p></li>
                   7407: <li class="listitem"><p>default_acceptable_licenses in
                   7408:     <code class="filename">pkgsrc/pkgtools/pkg_install/files/lib/license.c</code></p></li>
1.154     rodent   7409: </ul></div>
                   7410: </li>
1.284     rillig   7411: <li class="listitem"><p>The license text should be added to
                   7412:     <code class="filename">pkgsrc/licenses</code> for displaying.  A list of known
                   7413:     licenses can be seen in this directory.</p></li>
1.154     rodent   7414: </ol></div>
1.222     sevan    7415: </div>
                   7416: <div class="sect3">
                   7417: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   7418: <a name="change-license"></a>21.1.3.2. Change to the license</h4></div></div></div>
1.98      wiz      7419: <p>When the license changes (in a way other than formatting),
1.222     sevan    7420:     make sure that the new license has a different name (e.g.,
1.98      wiz      7421:     append the version number if it exists, or the date).  Just
                   7422:     because a user told pkgsrc to build programs under a previous
                   7423:     version of a license does not mean that pkgsrc should build
1.99      rillig   7424:     programs under the new licenses.  The higher-level point is that
1.98      wiz      7425:     pkgsrc does not evaluate licenses for reasonableness; the only
                   7426:     test is a mechanistic test of whether a particular text has been
1.222     sevan    7427:     approved by either of two bodies (FSF or OSI).</p>
                   7428: </div>
1.75      rillig   7429: </div>
1.148     asau     7430: <div class="sect2">
1.75      rillig   7431: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7432: <a name="restricted-packages"></a>21.1.4. Restricted packages</h3></div></div></div>
1.75      rillig   7433: <p>Some licenses restrict how software may be re-distributed.
1.222     sevan    7434:     By declaring the restrictions, package tools can
1.98      wiz      7435:     automatically refrain from e.g. placing binary packages on FTP
                   7436:     sites.</p>
1.222     sevan    7437: <p>There are four possible restrictions, which are
1.98      wiz      7438:     the cross product of sources (distfiles) and binaries not being
                   7439:     placed on FTP sites and CD-ROMs.  Because this is rarely the exact
                   7440:     language in any license, and because non-Free licenses tend to be
                   7441:     different from each other, pkgsrc adopts a definition of FTP and
1.222     sevan    7442:     CD-ROM.
                   7443: 
                   7444:     "FTP" means making the source or binary file available over the
                   7445:     Internet at no charge.
                   7446: 
                   7447:     "CD-ROM" means making the source or binary available on some kind of
                   7448:     media, together with other source and binary packages, which is sold
                   7449:     for a distribution charge.
1.98      wiz      7450:     </p>
                   7451: <p>In order to encode these restrictions, the package system
1.87      wiz      7452:     defines five make variables that can be set to note these
                   7453:     restrictions:</p>
1.148     asau     7454: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      7455: <li class="listitem">
1.75      rillig   7456: <p><code class="varname">RESTRICTED</code></p>
                   7457: <p>This variable should be set whenever a restriction
1.87      wiz      7458:        exists (regardless of its kind).  Set this variable to a
1.98      wiz      7459:        string containing the reason for the restriction.  It should
                   7460:        be understood that those wanting to understand the restriction
                   7461:        will have to read the license, and perhaps seek advice of
                   7462:        counsel.</p>
1.75      rillig   7463: </li>
1.128     wiz      7464: <li class="listitem">
1.75      rillig   7465: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
1.98      wiz      7466: <p>Binaries may not be placed on CD-ROM containing other
                   7467:        binary packages, for which a distribution charge may be made.
                   7468:        In this case, set this variable to
                   7469:        <code class="varname">${RESTRICTED}</code>.</p>
1.75      rillig   7470: </li>
1.128     wiz      7471: <li class="listitem">
1.75      rillig   7472: <p><code class="varname">NO_BIN_ON_FTP</code></p>
1.98      wiz      7473: <p>Binaries may not made available on the Internet without
                   7474:        charge.  In this case, set this variable to
                   7475:        <code class="varname">${RESTRICTED}</code>.  If this variable is set,
                   7476:        binary packages will not be included on ftp.NetBSD.org.</p>
1.75      rillig   7477: </li>
1.128     wiz      7478: <li class="listitem">
1.75      rillig   7479: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
1.98      wiz      7480: <p>Distfiles may not be placed on CD-ROM, together with
                   7481:        other distfiles, for which a fee may be charged.  In this
                   7482:        case, set this variable to <code class="varname">${RESTRICTED}</code>.
                   7483:        </p>
1.75      rillig   7484: </li>
1.128     wiz      7485: <li class="listitem">
1.75      rillig   7486: <p><code class="varname">NO_SRC_ON_FTP</code></p>
1.98      wiz      7487: <p>Distfiles may not made available via FTP at no charge.
                   7488:        In this case, set this variable to
                   7489:        <code class="varname">${RESTRICTED}</code>.  If this variable is set,
                   7490:        the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
1.75      rillig   7491: </li>
                   7492: </ul></div>
1.222     sevan    7493: <p>Please note that packages will be removed from pkgsrc when the
                   7494:     distfiles are not distributable and cannot be obtained for a period
                   7495:     of one full quarter branch. Packages with manual/interactive fetch
                   7496:     must have a maintainer and it is his/her responsibility to ensure
                   7497:     this.</p>
1.75      rillig   7498: </div>
1.148     asau     7499: <div class="sect2">
1.75      rillig   7500: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7501: <a name="dependencies"></a>21.1.5. Handling dependencies</h3></div></div></div>
1.290     gutterid 7502: <p>Your package may depend on some other package being present,
                   7503:     and there are various ways of expressing this dependency.
                   7504:     pkgsrc supports the <code class="varname">DEPENDS</code>,
                   7505:     <code class="varname">BUILD_DEPENDS</code>,
                   7506:     <code class="varname">TOOL_DEPENDS</code>, and
                   7507:     <code class="varname">TEST_DEPENDS</code> definitions, the
1.88      wiz      7508:     <code class="varname">USE_TOOLS</code> definition, as well as dependencies
                   7509:     via <code class="filename">buildlink3.mk</code>, which is the preferred way
                   7510:     to handle dependencies, and which uses the variables named above.
1.299     rillig   7511:     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 7512: <p>The basic difference is that the <code class="varname">DEPENDS</code>
                   7513:     definition registers that pre-requisite in the binary package so it
                   7514:     will be pulled in when the binary package is later installed, whilst
                   7515:     the <code class="varname">BUILD_DEPENDS</code>, <code class="varname">TOOL_DEPENDS</code>,
                   7516:     and <code class="varname">TEST_DEPENDS</code> definitions do not, marking a
                   7517:     dependency that is only needed for building or testing the resulting
1.299     rillig   7518:     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   7519: <p>This means that if you only need a package present whilst
1.290     gutterid 7520:     you are building or testing, it should be noted as a
                   7521:     <code class="varname">TOOL_DEPENDS</code>,
                   7522:     <code class="varname">BUILD_DEPENDS</code>, or
                   7523:     <code class="varname">TEST_DEPENDS</code>.  When cross-compiling,
1.269     leot     7524:     <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
                   7525:     packages, i.e. packages for the architecture where the package
                   7526:     is built;
                   7527:     <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
1.290     gutterid 7528:     packages, i.e., packages for the architecture for which the package
1.269     leot     7529:     is built.</p>
1.290     gutterid 7530: <p>The format for a <code class="varname">DEPENDS</code>,
                   7531:     <code class="varname">BUILD_DEPENDS</code>, <code class="varname">TOOL_DEPENDS</code>,
                   7532:     and <code class="varname">TEST_DEPENDS</code> definition is:</p>
1.75      rillig   7533: <pre class="programlisting">
1.100     rillig   7534: &lt;pre-req-package-name&gt;:../../&lt;category&gt;/&lt;pre-req-package&gt;
1.222     sevan    7535: </pre>
1.128     wiz      7536: <p>Please note that the <span class="quote">&#8220;<span class="quote">pre-req-package-name</span>&#8221;</span>
1.87      wiz      7537:     may include any of the wildcard version numbers recognized by
1.289     leot     7538:     <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a>.</p>
1.128     wiz      7539: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7540: <li class="listitem">
1.75      rillig   7541: <p>If your package needs another package's binaries or
1.160     wiz      7542:        libraries to build and run, and if that package has a
1.87      wiz      7543:        <code class="filename">buildlink3.mk</code> file available, use it:</p>
1.75      rillig   7544: <pre class="programlisting">
1.100     rillig   7545: .include "../../graphics/jpeg/buildlink3.mk"
1.222     sevan    7546: </pre>
1.75      rillig   7547: </li>
1.128     wiz      7548: <li class="listitem">
1.160     wiz      7549: <p>If your package needs another package's binaries or
                   7550:        libraries only for building, and if that package has a
                   7551:        <code class="filename">buildlink3.mk</code> file available, use it:</p>
                   7552: <pre class="programlisting">
                   7553: .include "../../graphics/jpeg/buildlink3.mk"
1.222     sevan    7554: </pre>
1.160     wiz      7555: <p>but set
                   7556:        <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>jpeg</code></em>?=build</code>
                   7557:        to make it a build dependency only. This case is rather
                   7558:        rare.</p>
                   7559: </li>
                   7560: <li class="listitem">
1.132     spz      7561: <p>If your package needs binaries from another package to build,
1.269     leot     7562:        use the <code class="varname">TOOL_DEPENDS</code> definition:</p>
1.75      rillig   7563: <pre class="programlisting">
1.269     leot     7564: TOOL_DEPENDS+= itstool-[0-9]*:../../textproc/itstool
1.222     sevan    7565: </pre>
1.75      rillig   7566: </li>
1.269     leot     7567: <li class="listitem"><p>If your package needs static libraries to link against, header
                   7568:        files to include, etc. from another package to build,
                   7569:        use the <code class="varname">BUILD_DEPENDS</code> definition.</p></li>
1.132     spz      7570: <li class="listitem"><p>If your package needs a library with which to link and
                   7571:        there is no <code class="filename">buildlink3.mk</code> file
                   7572:        available, create one. Using
                   7573:        <code class="varname">DEPENDS</code> won't be sufficient because the
                   7574:        include files and libraries will be hidden from the compiler.</p></li>
1.128     wiz      7575: <li class="listitem">
1.132     spz      7576: <p>If your package needs some executable to be able to run
                   7577:        correctly and if there's no
                   7578:        <code class="filename">buildlink3.mk</code> file, this is specified
                   7579:        using the <code class="varname">DEPENDS</code> variable. The
1.250     leot     7580:        <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      7581:        be able to execute the latex binary from the tex-latex-bin package
1.132     spz      7582:        when it runs, and that is specified:</p>
1.75      rillig   7583: <pre class="programlisting">
1.242     wiz      7584: DEPENDS+=        tex-latex-bin-[0-9]*:../../print/tex-latex-bin
1.222     sevan    7585: </pre>
1.132     spz      7586: </li>
1.290     gutterid 7587: <li class="listitem"><p>If your package includes a test suite that has extra
                   7588:         dependencies only required for this purpose (frequently this
                   7589:         can be run as a <span class="quote">&#8220;<span class="quote">make test</span>&#8221;</span> target), use the
                   7590:         <code class="varname">TEST_DEPENDS</code> variable.</p></li>
1.132     spz      7591: <li class="listitem">
                   7592: <p>You can use wildcards in package dependencies. Note that
                   7593:        such wildcard dependencies are retained when creating binary
                   7594:        packages. The dependency is checked when installing the binary
                   7595:        package and any package which matches the pattern will be
                   7596:        used. Wildcard dependencies should be used with care.</p>
1.128     wiz      7597: <p>The <span class="quote">&#8220;<span class="quote">-[0-9]*</span>&#8221;</span> should be used instead of
                   7598:        <span class="quote">&#8220;<span class="quote">-*</span>&#8221;</span> to avoid potentially ambiguous matches
                   7599:        such as <span class="quote">&#8220;<span class="quote">tk-postgresql</span>&#8221;</span> matching a
                   7600:        <span class="quote">&#8220;<span class="quote">tk-*</span>&#8221;</span> <code class="varname">DEPENDS</code>.</p>
1.75      rillig   7601: <p>Wildcards can also be used to specify that a package
1.87      wiz      7602:        will only build against a certain minimum version of a
                   7603:        pre-requisite:</p>
1.75      rillig   7604: <pre class="programlisting">
1.132     spz      7605: DEPENDS+=       ImageMagick&gt;=6.0:../../graphics/ImageMagick
1.222     sevan    7606: </pre>
1.132     spz      7607: <p>This means that the package will build using version 6.0
                   7608:        of ImageMagick or newer. Such a dependency may be warranted
                   7609:        if, for example, the command line options of an executable
                   7610:        have changed.</p>
                   7611: <p>If you need to depend on minimum versions of libraries,
1.298     wiz      7612:        set
                   7613:        <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   7614:        to the appropriate pattern before including its
                   7615:        <code class="filename">buildlink3.mk</code> file, e.g.</p>
                   7616: <pre class="programlisting">
                   7617: BUILDLINK_API_DEPENDS.jpeg+=    jpeg&gt;=9.0
                   7618: .include "../../graphics/jpeg/buildlink3.mk"
                   7619: </pre>
1.75      rillig   7620: <p>For security fixes, please update the package
1.267     rillig   7621:        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      7622:        information.</p>
1.75      rillig   7623: </li>
                   7624: </ol></div>
                   7625: <p>If your package needs files from another package to build,
1.87      wiz      7626:     add the relevant distribution files to
                   7627:     <code class="varname">DISTFILES</code>, so they will be extracted
1.250     leot     7628:     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      7629:     (It relies on the jpeg sources being present in source form
                   7630:     during the build.)</p>
1.75      rillig   7631: </div>
1.148     asau     7632: <div class="sect2">
1.75      rillig   7633: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7634: <a name="conflicts"></a>21.1.6. Handling conflicts with other packages</h3></div></div></div>
1.75      rillig   7635: <p>Your package may conflict with other packages a user might
1.87      wiz      7636:     already have installed on his system, e.g. if your package
1.88      wiz      7637:     installs the same set of files as another package in the pkgsrc
1.190     wiz      7638:     tree or has the same <code class="varname">PKGNAME</code>.</p>
1.255     leot     7639: <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>
                   7640:     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>
                   7641:     install the same shared library, thus you set in
                   7642:     <code class="filename">pkgsrc/x11/libXaw3d/Makefile</code>:</p>
                   7643: <pre class="programlisting">
                   7644: CONFLICTS=      Xaw-Xpm-[0-9]*
                   7645:     </pre>
                   7646: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
                   7647: <pre class="programlisting">
                   7648: CONFLICTS=      libXaw3d-[0-9]*
                   7649:     </pre>
1.289     leot     7650: <p><a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> is able to detect attempts to install packages
1.255     leot     7651:     that conflict with existing packages and abort. However, in many
                   7652:     situations this is too late in the process. Binary package managers
                   7653:     will not know about the conflict until they attempt to install the
                   7654:     package after already downloading it and all its dependencies.
                   7655:     Users may also waste time building a package and its dependencies
                   7656:     only to find out at the end that it conflicts with another package
                   7657:     they have installed.</p>
                   7658: <p>To avoid these issues <code class="varname">CONFLICTS</code> entries
                   7659:     should be added in all cases where it is known that packages conflict
                   7660:     with each other.  These <code class="varname">CONFLICTS</code> entries are
1.289     leot     7661:     exported in <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_summary+5.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_summary</span>(5)</span></a> files and consumed by binary package
1.255     leot     7662:     managers to inform users that packages cannot be installed onto
                   7663:     the target system.</p>
1.75      rillig   7664: </div>
1.148     asau     7665: <div class="sect2">
1.75      rillig   7666: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7667: <a name="not-building-packages"></a>21.1.7. Packages that cannot or should not be built</h3></div></div></div>
1.75      rillig   7668: <p>There are several reasons why a package might be
1.88      wiz      7669:     instructed to not build under certain circumstances.  If the
1.87      wiz      7670:     package builds and runs on most platforms, the exceptions
1.193     dholland 7671:     should be noted with <code class="varname">BROKEN_ON_PLATFORM</code>.  If
                   7672:     the package builds and runs on a small handful of platforms,
                   7673:     set <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> instead.
                   7674:     Both <code class="varname">BROKEN_ON_PLATFORM</code> and
                   7675:     <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> are OS triples
                   7676:     (OS-version-platform) that can use glob-style
                   7677:     wildcards.</p>
                   7678: <p>If a package is not appropriate for some platforms (as
1.225     maya     7679:     opposed to merely broken), a different set of variables should be
1.193     dholland 7680:     used as this affects failure reporting and statistics.
                   7681:     If the package is appropriate for most platforms, the exceptions
1.87      wiz      7682:     should be noted with <code class="varname">NOT_FOR_PLATFORM</code>.  If
1.193     dholland 7683:     the package is appropriate for only a small handful of platforms
                   7684:     (often exactly one), set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
1.87      wiz      7685:     Both <code class="varname">ONLY_FOR_PLATFORM</code> and
                   7686:     <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
                   7687:     (OS-version-platform) that can use glob-style
                   7688:     wildcards.</p>
1.88      wiz      7689: <p>Some packages are tightly bound to a specific version of an
1.250     leot     7690:     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      7691:     backwards compatible with other versions of the OS, and should be
                   7692:     uploaded to a version specific directory on the FTP server.  Mark
                   7693:     these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.128     wiz      7694:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.  This variable is not currently used by any of
1.88      wiz      7695:     the package system internals, but may be used in the
                   7696:     future.</p>
1.75      rillig   7697: <p>If the package should be skipped (for example, because it
1.87      wiz      7698:     provides functionality already provided by the system), set
1.88      wiz      7699:     <code class="varname">PKG_SKIP_REASON</code> to a descriptive message.  If
                   7700:     the package should fail because some preconditions are not met,
                   7701:     set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
1.87      wiz      7702:     message.</p>
1.75      rillig   7703: </div>
1.148     asau     7704: <div class="sect2">
1.75      rillig   7705: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7706: <a name="undeletable-packages"></a>21.1.8. Packages which should not be deleted, once installed</h3></div></div></div>
1.75      rillig   7707: <p>To ensure that a package may not be deleted, once it has been
1.87      wiz      7708:     installed, the <code class="varname">PKG_PRESERVE</code> definition should
                   7709:     be set in the package Makefile. This will be carried into any
                   7710:     binary package that is made from this pkgsrc entry. A
1.128     wiz      7711:     <span class="quote">&#8220;<span class="quote">preserved</span>&#8221;</span> package will
1.289     leot     7712:     not be deleted using <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> unless the
1.128     wiz      7713:     <span class="quote">&#8220;<span class="quote">-f</span>&#8221;</span> option is used.</p>
1.75      rillig   7714: </div>
1.148     asau     7715: <div class="sect2">
1.75      rillig   7716: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7717: <a name="security-handling"></a>21.1.9. Handling packages with security problems</h3></div></div></div>
1.75      rillig   7718: <p>When a vulnerability is found, this should be noted in
1.87      wiz      7719:     <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
1.138     wiz      7720:     and after committing that file, ask pkgsrc-security@NetBSD.org to
                   7721:     update the file on ftp.NetBSD.org.</p>
1.75      rillig   7722: <p>After fixing the vulnerability by a patch, its
1.138     wiz      7723:     <code class="varname">PKGREVISION</code> should be increased (this is of
                   7724:     course not necessary if the problem is fixed by using a newer
                   7725:     release of the software), and the pattern in the
                   7726:     pkg-vulnerabilities file must be updated.</p>
1.75      rillig   7727: <p>Also, if the fix should be applied to the stable pkgsrc
1.87      wiz      7728:     branch, be sure to submit a pullup request!</p>
1.75      rillig   7729: <p>Binary packages already on ftp.NetBSD.org will be handled
1.87      wiz      7730:     semi-automatically by a weekly cron job.</p>
1.75      rillig   7731: </div>
1.148     asau     7732: <div class="sect2">
1.75      rillig   7733: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7734: <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   7735: <p>When making fixes to an existing package it can be useful
1.87      wiz      7736:     to change the version number in <code class="varname">PKGNAME</code>. To
                   7737:     avoid conflicting with future versions by the original author, a
1.128     wiz      7738:     <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      7739:     on package versions by setting <code class="varname">PKGREVISION=1</code>
1.128     wiz      7740:     (2, ...). The <span class="quote">&#8220;<span class="quote">nb</span>&#8221;</span> is treated like a
                   7741:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span> by the package tools. e.g.</p>
1.87      wiz      7742: <pre class="programlisting">
1.100     rillig   7743: DISTNAME=       foo-17.42
                   7744: PKGREVISION=    9
1.222     sevan    7745: </pre>
1.75      rillig   7746: <p>will result in a <code class="varname">PKGNAME</code> of
1.128     wiz      7747:     <span class="quote">&#8220;<span class="quote">foo-17.42nb9</span>&#8221;</span>. If you want to use the original
                   7748:     value of <code class="varname">PKGNAME</code> without the <span class="quote">&#8220;<span class="quote">nbX</span>&#8221;</span>
1.87      wiz      7749:     suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
                   7750:     <code class="varname">PKGNAME_NOREV</code>.</p>
1.75      rillig   7751: <p>When a new release of the package is released, the
1.87      wiz      7752:     <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
                   7753:     minor release of the above package, things should be like:</p>
1.75      rillig   7754: <pre class="programlisting">
1.100     rillig   7755: DISTNAME=       foo-17.43
1.222     sevan    7756: </pre>
1.87      wiz      7757: <p><code class="varname">PKGREVISION</code> should be incremented for any
                   7758:     non-trivial change in the resulting binary package.  Without a
                   7759:     <code class="varname">PKGREVISION</code> bump, someone with the previous
                   7760:     version installed has no way of knowing that their package is out
                   7761:     of date.  Thus, changes without increasing
                   7762:     <code class="varname">PKGREVISION</code> are essentially labeled "this is so
                   7763:     trivial that no reasonable person would want to upgrade", and this
                   7764:     is the rough test for when increasing
                   7765:     <code class="varname">PKGREVISION</code> is appropriate.  Examples of
                   7766:     changes that do not merit increasing
                   7767:     <code class="varname">PKGREVISION</code> are:</p>
1.148     asau     7768: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      7769: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.284     rillig   7770:       <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>, or
                   7771:       comments in Makefile.</p></li>
                   7772: <li class="listitem"><p>Changing build variables if the resulting binary
                   7773:       package is the same.</p></li>
                   7774: <li class="listitem"><p>Changing
                   7775:       <code class="filename">DESCR</code>.</p></li>
                   7776: <li class="listitem"><p>Adding <code class="varname">PKG_OPTIONS</code> if the
                   7777:       default options don't change.</p></li>
1.100     rillig   7778: </ul></div>
1.87      wiz      7779: <p>Examples of changes that do merit an increase to
                   7780:     <code class="varname">PKGREVISION</code> include:</p>
1.148     asau     7781: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.284     rillig   7782: <li class="listitem"><p>Security fixes</p></li>
                   7783: <li class="listitem"><p>Changes or additions to a patch
                   7784:       file</p></li>
                   7785: <li class="listitem"><p>Changes to the
                   7786:       <code class="filename">PLIST</code></p></li>
                   7787: <li class="listitem"><p>A dependency is changed or
                   7788:       renamed.</p></li>
1.100     rillig   7789: </ul></div>
1.78      rillig   7790: <p>PKGREVISION must also be incremented when dependencies have ABI
                   7791:     changes.</p>
1.75      rillig   7792: </div>
1.148     asau     7793: <div class="sect2">
1.79      rillig   7794: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7795: <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   7796: <p>When you want to replace the same text in multiple files, or
                   7797: multiple times in the same file, it is cumbersome to maintain a patch
                   7798: file for this. This is where the SUBST framework steps in. It provides an
                   7799: easy-to-use interface for replacing text in files. It just needs the
                   7800: following information:</p>
                   7801: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   7802: <li class="listitem"><p>In which phase of the package build cycle should the
                   7803: replacement happen?</p></li>
                   7804: <li class="listitem"><p>In which files should the replacement
1.287     rillig   7805: happen?</p></li>
1.295     rillig   7806: <li class="listitem"><p>Which text should be replaced with
                   7807: what?</p></li>
1.287     rillig   7808: </ul></div>
                   7809: <p>This information is encoded in a block of <code class="varname">SUBST</code>
1.295     rillig   7810: variables. A minimal example is:</p>
                   7811: <pre class="programlisting">
                   7812: SUBST_CLASSES+=         paths
                   7813: SUBST_STAGE.paths=      pre-configure
                   7814: SUBST_FILES.paths=      src/*.c
                   7815: SUBST_SED.paths=        -e 's,/usr/local,${PREFIX},g'
                   7816: </pre>
                   7817: <p>Translated into English, it means: In the pre-configure stage (that
                   7818: is, after applying the patches from the patches/ directory and before
                   7819: running the configure script and the portability check), replace the text
                   7820: <code class="literal">/usr/local</code> with the content of the variable
                   7821: <code class="varname">PREFIX</code>.</p>
                   7822: <p>Each SUBST block starts by appending an identifier to
                   7823: <code class="varname">SUBST_CLASSES</code> (note the <code class="literal">+=</code>). This
                   7824: identifier can be chosen freely by the package. If there should ever be
                   7825: duplicate identifiers, the pkgsrc infrastructure will catch this and fail
                   7826: early, so don't worry about name collisions.</p>
                   7827: <p>Except for <code class="varname">SUBST_CLASSES</code>, all variables in a
                   7828: SUBST block are parameterized using this identifier. In the remainder of
                   7829: this section, these parameterized variables are written as
                   7830: <code class="varname">SUBST_STAGE.*</code>.</p>
                   7831: <pre class="programlisting">
                   7832: SUBST_CLASSES+=         paths
                   7833: SUBST_STAGE.paths=      pre-configure
                   7834: SUBST_MESSAGE.paths=    Fixing absolute paths.
                   7835: SUBST_FILES.paths=      src/*.c
                   7836: SUBST_FILES.paths+=     scripts/*.sh
                   7837: SUBST_SED.paths=        -e 's,"/usr/local,"${PREFIX},g'
                   7838: SUBST_SED.paths+=       -e 's,"/var/log,"${VARBASE}/log,g'
                   7839: SUBST_VARS.paths=       LOCALBASE PREFIX PKGVERSION
                   7840: </pre>
                   7841: <p>To get a complete picture about the SUBST substitutions, run
                   7842: <span class="command"><strong>bmake show-all-subst</strong></span>. If something doesn't work as
                   7843: expected, run pkglint on the package, which detects several typical
                   7844: mistakes surrounding the SUBST blocks. For any questions that might
                   7845: remain after this, have a look at
                   7846: <code class="filename">mk/subst.mk</code>.</p>
                   7847: <div class="sect3">
                   7848: <div class="titlepage"><div><div><h4 class="title">
                   7849: <a name="fixes.subst.when"></a>21.1.11.1. Choosing the time where the substitutions happen</h4></div></div></div>
                   7850: <p>The <code class="varname">SUBST_STAGE.*</code> is one of
                   7851: {pre,do,post}-{extract,patch,configure,build,test,install}. Of these,
                   7852: <code class="literal">pre-configure</code> is used most often, by far. The most
                   7853: popular stages are, in chronological order:</p>
                   7854: <div class="variablelist"><dl class="variablelist">
                   7855: <dt><span class="term"><code class="literal">post-extract</code></span></dt>
                   7856: <dd>
                   7857: <p>The substitutions are applied immediately after the
                   7858: distfiles are extracted. Running <span class="command"><strong>bmake extract</strong></span> on the
                   7859: package will leave no traces of the original files.</p>
                   7860: <p>When the substitution applies to files for which there is also a
                   7861: patch in the <code class="filename">patches/</code> directory, this means that the
                   7862: patches will be computed based on the result of the substitution. When
                   7863: these patches are sent to the upstream maintainer later, to be fixed in
                   7864: the upstream package, these patches may no longer match what the upstream
                   7865: author is used to. Because of this, <code class="literal">pre-configure</code> is
                   7866: often a better choice.</p>
                   7867: </dd>
                   7868: <dt><span class="term"><code class="literal">pre-configure</code></span></dt>
                   7869: <dd>
                   7870: <p>The substitutions are applied after the patches from the
                   7871: <code class="filename">patches/</code> directory. This makes it possible to run
                   7872: <span class="command"><strong>bmake patch</strong></span> on the package, after which the patches
                   7873: 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>
                   7874: <p>When updating the patches, it is helpful to explicitly separate the
                   7875: <span class="command"><strong>bmake patch</strong></span> from the <span class="command"><strong>bmake
                   7876: configure</strong></span>, and to only edit the patches between these commands.
                   7877: Otherwise the substitutions from the SUBST block will end up in the patch
                   7878: file. When this happens in really obvious ways, pkglint will complain
                   7879: about patches that contain a hard-coded <code class="literal">/usr/pkg</code>
                   7880: instead of the correct and intended <code class="literal">@PREFIX@</code>, but it
                   7881: can only detect these really obvious
                   7882: cases.</p>
                   7883: </dd>
                   7884: <dt><span class="term"><code class="literal">do-configure</code></span></dt>
                   7885: <dd><p>This stage should only be used if the package defines a
                   7886: <code class="literal">pre-configure</code> action itself, and the substitution must
                   7887: happen after that. Typical examples are packages that use the
                   7888: <code class="literal">pre-configure</code> stage to regenerate the GNU configure
                   7889: script from
                   7890: <code class="filename">configure.ac</code>.</p></dd>
                   7891: <dt><span class="term"><code class="literal">post-configure</code></span></dt>
                   7892: <dd><p>This stage is used to fix up any mistakes by the
                   7893: configure stage.</p></dd>
                   7894: <dt><span class="term"><code class="literal">pre-build</code></span></dt>
                   7895: <dd><p>This stage should only be used for substitutions that are
                   7896: clearly related to building the package, not for fixing the
                   7897: configuration. Substitutions for pathnames (such as replacing
                   7898: <code class="filename">/usr/local</code> with <code class="literal">${PREFIX}</code>) or
                   7899: user names (such as replacing <code class="literal">@MY_USER@</code> with the
                   7900: actual username) belong in pre-configure or post-configure
                   7901: instead.</p></dd>
                   7902: <dt><span class="term"><code class="literal">post-build</code></span></dt>
                   7903: <dd>
                   7904: <p>Just as with pre-build, this stage should only be used
                   7905: for substitutions that are clearly related to building the package, not
                   7906: for fixing the configuration. Substitutions for pathnames (such as
                   7907: replacing <code class="filename">/usr/local</code> with
                   7908: <code class="literal">${PREFIX}</code>) or user names (such as replacing
                   7909: <code class="literal">@MY_USER@</code> with the actual username) belong in
                   7910: pre-configure or post-configure instead.</p>
                   7911: <p>A typical use is to update pkg-config files to include the rpath
                   7912: compiler options.</p>
                   7913: </dd>
                   7914: <dt><span class="term"><code class="literal">pre-install</code></span></dt>
                   7915: <dd><p>In general, the install phase should be as simple as
                   7916: possible. As with the pre-build and post-build stages, it should not be
                   7917: used to fix pathnames or user names, these belong in pre-configure
                   7918: instead. There are only few legitimate use cases for applying
                   7919: substitutions in this stage.</p></dd>
                   7920: </dl></div>
                   7921: </div>
                   7922: <div class="sect3">
                   7923: <div class="titlepage"><div><div><h4 class="title">
1.296     rillig   7924: <a name="fixes.subst.where"></a>21.1.11.2. Choosing the files where the substitutions happen</h4></div></div></div>
1.295     rillig   7925: <p>The <code class="varname">SUBST_FILES.*</code> variable contains a list of
                   7926: filename patterns. These patterns are relative to
                   7927: <code class="varname">WRKSRC</code> since that is where most substitutions happen.
                   7928: A typical example is:</p>
                   7929: <pre class="programlisting">
                   7930: SUBST_FILES.path=       Makefile */Makefile */*/Makefile *.[ch]
                   7931: </pre>
                   7932: <p>The above patterns, especially the last, are quite broad. The SUBST
                   7933: implementation checks that each filename pattern that is mentioned here
                   7934: has an effect. For example, if none of the
                   7935: <code class="filename">*/*/Makefile</code> files contains the patterns to be found
                   7936: and substituted, that filename pattern is redundant and should be left
1.296     rillig   7937: out. By default, the SUBST framework will complain with an error message.
                   7938: If the text to be substituted occurs in some of the files from a single
                   7939: pattern, but not in all of them, that is totally ok, and the SUBST
1.295     rillig   7940: framework will only print an INFO message for those files.</p>
                   7941: <p>If there is a good reason for having redundant filename patterns,
1.296     rillig   7942: set <code class="varname">SUBST_NOOP_OK.*</code> to <code class="literal">yes</code>.</p>
1.295     rillig   7943: <p>Another popular way of choosing the files for the substitutions is
                   7944: via a shell command, like this:</p>
                   7945: <pre class="programlisting">
1.296     rillig   7946: C_FILES_CMD=            cd ${WRKSRC} &amp;&amp; ${FIND} . -name '*.c'
1.295     rillig   7947: SUBST_FILES.path=       ${C_FILES_CMD:sh}
                   7948: </pre>
                   7949: <p>The variable name <code class="varname">C_FILES_CMD</code> in this example is
                   7950: freely chosen and independent of the SUBST framework.</p>
                   7951: <p>In this variant, the <code class="varname">SUBST_FILES.*</code> variable
                   7952: lists each file individually. Thereby chances are higher that there are
                   7953: filename patterns in which no substitution happens. Since the SUBST
                   7954: framework cannot know whether the filename patterns in
                   7955: <code class="varname">SUBST_FILES.*</code> have been explicitly listed in the
                   7956: Makefile (where any redundant filename pattern would be suspicious) or
                   7957: been generated by a shell command (in which redundant filename patterns
                   7958: are more likely and to be expected), it will complain about these
                   7959: redundant filename patterns. Therefore, SUBST blocks that use a shell
                   7960: command to generate the list of filename patterns often need to set
                   7961: <code class="varname">SUBST_NOOP_OK.*</code> to <code class="literal">yes</code>.</p>
                   7962: </div>
                   7963: <div class="sect3">
                   7964: <div class="titlepage"><div><div><h4 class="title">
                   7965: <a name="fixes.subst.what"></a>21.1.11.3. Choosing what to substitute</h4></div></div></div>
                   7966: <p>In most cases, the substitutions are given using one or more
                   7967: <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?sed+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">sed</span>(1)</span></a> commands, like this:</p>
                   7968: <pre class="programlisting">
                   7969: SUBST_SED.path=         -e 's|/usr/local|${PREFIX}|g'
                   7970: </pre>
                   7971: <p>Each of the sed commands needs to be preceded by the
                   7972: <code class="literal">-e</code> option and should be specified on a line of its
                   7973: own, to avoid hiding short sed commands at the end of a line.</p>
                   7974: <p>Since the sed commands often contain shell metacharacters as the
                   7975: separator (the <code class="literal">|</code> in the above example), it is common
                   7976: to enclose them in single quotes.</p>
                   7977: <p>A common substitution is to replace placeholders of the form
                   7978: <code class="literal">@VARNAME@</code> with their pkgsrc counterpart variable
                   7979: <code class="literal">${VARNAME}</code>. A typical example is:</p>
                   7980: <pre class="programlisting">
                   7981: SUBST_VARS.path=        PREFIX
                   7982: </pre>
                   7983: <p>This type of substitutions is typically done by the GNU configure
1.296     rillig   7984: scripts during the do-configure stage, but in some cases these need to be
                   7985: overridden. The same pattern is also used when a package defines patches
                   7986: that replace previously hard-coded paths like
                   7987: <code class="literal">/usr/local</code> with a <code class="literal">@PREFIX@</code>
                   7988: placeholder first, which then gets substituted by the actual
                   7989: <code class="literal">${PREFIX}</code> in the pre-configure stage. In many of these
                   7990: cases, it works equally well to just use the SUBST framework to directly
                   7991: replace <code class="literal">/usr/local</code> with <code class="literal">${PREFIX}</code>,
                   7992: thereby omitting the intermediate patch file.</p>
1.295     rillig   7993: <p>If the above is not flexible enough, it is possible to not use sed
                   7994: at all for the substitution but to specify an entirely different command,
                   7995: like this:</p>
1.87      wiz      7996: <pre class="programlisting">
1.295     rillig   7997: SUBST_FILTER_CMD.path=  LC_ALL=C ${TR} -d '\r'
                   7998: </pre>
                   7999: <p>This is used for the few remaining packages in which the
                   8000: distributed files use Windows-style line endings that need to be
                   8001: converted to UNIX-style line endings.</p>
                   8002: </div>
                   8003: <div class="sect3">
                   8004: <div class="titlepage"><div><div><h4 class="title">
                   8005: <a name="fixes.subst.other"></a>21.1.11.4. Other SUBST variables</h4></div></div></div>
                   8006: <p>When a SUBST block is applied during a package build, a message is
                   8007: logged. The default message is fine for most purposes but can be
                   8008: overridden by setting <code class="literal">SUBST_MESSAGE.*</code> to an individual
                   8009: message.</p>
                   8010: </div>
1.79      rillig   8011: </div>
1.75      rillig   8012: </div>
1.148     asau     8013: <div class="sect1">
1.75      rillig   8014: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   8015: <a name="fixes.fetch"></a>21.2. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.148     asau     8016: <div class="sect2">
1.75      rillig   8017: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8018: <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   8019: <p>If you need to download from a dynamic URL you can set
1.110     hubertf  8020:     <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.87      wiz      8021:     fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
                   8022:     with the name of each file to download as an argument, expecting
                   8023:     it to output the URL of the directory from which to download
1.250     leot     8024:     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      8025:     example of this usage.</p>
1.75      rillig   8026: <p>If the download can't be automated, because the user must
1.87      wiz      8027:     submit personal information to apply for a password, or must pay
                   8028:     for the source, or whatever, you can set
                   8029:     <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
                   8030:     displayed to the user before aborting the build. Example:</p>
                   8031: <pre class="programlisting">
1.100     rillig   8032: FETCH_MESSAGE=  "Please download the files"
                   8033: FETCH_MESSAGE+= "    "${DISTFILES:Q}
                   8034: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.222     sevan    8035: </pre>
1.75      rillig   8036: </div>
1.148     asau     8037: <div class="sect2">
1.75      rillig   8038: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8039: <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   8040: <p>Sometimes authors of a software package make some
1.87      wiz      8041:     modifications after the software was released, and they put up a
                   8042:     new distfile without changing the package's version number. If a
                   8043:     package is already in pkgsrc at that time, the checksum will
                   8044:     no longer match. The contents of the new distfile should be
                   8045:     compared against the old one before changing anything, to make
                   8046:     sure the distfile was really updated on purpose, and that
                   8047:     no trojan horse or so crept in.
1.97      rillig   8048:     Please mention that the distfiles were compared and what was found
1.159     rodent   8049:     in your commit message.</p>
1.220     wiz      8050: <p>Then, the correct way to work around this is to set
                   8051:     <code class="varname">DIST_SUBDIR</code> to a unique directory name, usually
                   8052:     based on <code class="varname">PKGNAME_NOREV</code> (but take care with
                   8053:     python or ruby packages, where <code class="varname">PKGNAME</code> includes
                   8054:     a variable prefix). All <code class="varname">DISTFILES</code> and
1.93      rillig   8055:     <code class="varname">PATCHFILES</code> for this package will be put in that
1.267     rillig   8056:     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      8057:     happens more often, <code class="varname">PKGNAME</code> can be used (thus
1.220     wiz      8058:     including the <code class="filename">nbX</code> suffix) or a date stamp can
                   8059:     be appended, like
                   8060:     <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.</p>
1.284     rillig   8061: <p><code class="varname">DIST_SUBDIR</code> is also used when a distfile's
                   8062:     name does not contain a version and the distfile is apt to change. In
                   8063:     cases where the likelihood of this is very small,
                   8064:     <code class="varname">DIST_SUBDIR</code> might not be required. Additionally,
                   8065:     <code class="varname">DIST_SUBDIR</code> must not be removed unless the
                   8066:     distfile name changes, even if a package is being moved or
                   8067:     renamed.</p>
1.159     rodent   8068: <p>Do not forget regenerating the <code class="filename">distinfo</code> file
1.87      wiz      8069:     after that, since it contains the <code class="varname">DIST_SUBDIR</code>
                   8070:     path in the filenames.
1.159     rodent   8071:     Also, increase the PKGREVISION if the installed package is different.
1.87      wiz      8072:     Furthermore, a mail to the package's authors seems appropriate
                   8073:     telling them that changing distfiles after releases without
                   8074:     changing the file names is not good practice.</p>
1.75      rillig   8075: </div>
1.199     tnn      8076: <div class="sect2">
                   8077: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8078: <a name="build.fetch.github"></a>21.2.3. Packages hosted on github.com</h3></div></div></div>
1.284     rillig   8079: <p>Helper methods exist for packages hosted on github.com which
                   8080:     will often have distfile names that clash with other packages, for
                   8081:     example <code class="filename">1.0.tar.gz</code>. Use one of the three recipes
                   8082:     from below:</p>
1.199     tnn      8083: <div class="sect3">
                   8084: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   8085: <a name="build.fetch.github.tag"></a>21.2.3.1. Fetch based on a tagged release</h4></div></div></div>
1.284     rillig   8086: <p>If your distfile URL looks similar to
1.289     leot     8087:       <code class="literal">https://github.com/username/exampleproject/archive/v1.0.zip</code>,
1.284     rillig   8088:       then you are packaging a tagged release.</p>
1.199     tnn      8089: <pre class="programlisting">
                   8090: DISTNAME=       exampleproject-1.0
1.200     tnn      8091: MASTER_SITES=   ${MASTER_SITE_GITHUB:=username/}
                   8092: #GITHUB_PROJECT=        # can be omitted if same as DISTNAME
                   8093: GITHUB_TAG=     v${PKGVERSION_NOREV}
1.199     tnn      8094: EXTRACT_SUFX=   .zip
                   8095: </pre>
                   8096: </div>
                   8097: <div class="sect3">
                   8098: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   8099: <a name="build.fetch.github.commit"></a>21.2.3.2. Fetch based on a specific commit</h4></div></div></div>
1.284     rillig   8100: <p>If your distfile URL looks similar to
1.289     leot     8101:       <code class="literal">https://github.com&#8203;/example&#8203;/example&#8203;/archive&#8203;/988881adc9fc3655077dc2d4d757d480b5ea0e11.tar.gz</code>,
1.284     rillig   8102:       then you are packaging a specific commit not tied to a
                   8103:       release.</p>
1.199     tnn      8104: <pre class="programlisting">
                   8105: DISTNAME=       example-1.0
1.217     jnemeth  8106: MASTER_SITES=   ${MASTER_SITE_GITHUB:=example/}
1.200     tnn      8107: #GITHUB_PROJECT=        # can be omitted if same as DISTNAME
                   8108: GITHUB_TAG=     988881adc9fc3655077dc2d4d757d480b5ea0e11
1.222     sevan    8109: </pre>
1.199     tnn      8110: </div>
                   8111: <div class="sect3">
                   8112: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   8113: <a name="build.fetch.github.release"></a>21.2.3.3. Fetch based on release</h4></div></div></div>
1.284     rillig   8114: <p>If your distfile URL looks similar to
1.289     leot     8115:       <code class="literal">https://github.com&#8203;/username/exampleproject&#8203;/releases&#8203;/download&#8203;/rel-1.6&#8203;/offensive-1.6.zip</code>,
1.284     rillig   8116:       then you are packaging a release.</p>
1.199     tnn      8117: <pre class="programlisting">
                   8118: DISTNAME=       offensive-1.6
1.200     tnn      8119: PKGNAME=        ${DISTNAME:S/offensive/proper/}
                   8120: MASTER_SITES=   ${MASTER_SITE_GITHUB:=username/}
                   8121: GITHUB_PROJECT= exampleproject
                   8122: GITHUB_RELEASE= rel-${PKGVERSION_NOREV} # usually just set this to ${DISTNAME}
                   8123: EXTRACT_SUFX=   .zip
1.222     sevan    8124: </pre>
1.199     tnn      8125: </div>
                   8126: </div>
1.75      rillig   8127: </div>
1.148     asau     8128: <div class="sect1">
1.75      rillig   8129: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   8130: <a name="fixes.configure"></a>21.3. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.148     asau     8131: <div class="sect2">
1.75      rillig   8132: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8133: <a name="fixes.libtool"></a>21.3.1. Shared libraries - libtool</h3></div></div></div>
1.75      rillig   8134: <p>pkgsrc supports many different machines, with different
1.87      wiz      8135:     object formats like a.out and ELF, and varying abilities to do
                   8136:     shared library and dynamic loading at all. To accompany this,
                   8137:     varying commands and options have to be passed to the
                   8138:     compiler, linker, etc. to get the Right Thing, which can be
                   8139:     pretty annoying especially if you don't have all the machines
                   8140:     at your hand to test things.  The
1.250     leot     8141:     <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      8142:     can help here, as it just <span class="quote">&#8220;<span class="quote">knows</span>&#8221;</span> how to build
1.87      wiz      8143:     both static and dynamic libraries from a set of source files,
                   8144:     thus being platform-independent.</p>
                   8145: <p>Here's how to use libtool in a package in seven simple
                   8146:     steps:</p>
1.128     wiz      8147: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8148: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.87      wiz      8149:        Makefile.</p></li>
1.128     wiz      8150: <li class="listitem"><p>For library objects, use <span class="quote">&#8220;<span class="quote">${LIBTOOL} --mode=compile
                   8151:        ${CC}</span>&#8221;</span> in place of <span class="quote">&#8220;<span class="quote">${CC}</span>&#8221;</span>. You could even
1.87      wiz      8152:        add it to the definition of <code class="varname">CC</code>, if only
                   8153:        libraries are being built in a given Makefile. This one command
                   8154:        will build both PIC and non-PIC library objects, so you need not
                   8155:        have separate shared and non-shared library rules.</p></li>
1.128     wiz      8156: <li class="listitem">
1.75      rillig   8157: <p>For the linking of the library, remove any
1.128     wiz      8158:        <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
                   8159:        -Bshareable</span>&#8221;</span> commands, and instead use:</p>
1.75      rillig   8160: <pre class="programlisting">
1.100     rillig   8161: ${LIBTOOL} --mode=link \
                   8162:     ${CC} -o ${.TARGET:.a=.la} \
                   8163:         ${OBJS:.o=.lo} \
                   8164:         -rpath ${PREFIX}/lib \
                   8165:         -version-info major:minor
1.222     sevan    8166: </pre>
1.75      rillig   8167: <p>Note that the library is changed to have a
1.87      wiz      8168:        <code class="filename">.la</code> extension, and the objects are
                   8169:        changed to have a <code class="filename">.lo</code>
                   8170:        extension. Change <code class="varname">OBJS</code> as
                   8171:        necessary. This automatically creates all of the
                   8172:        <code class="filename">.a</code>,
                   8173:        <code class="filename">.so.major.minor</code>, and ELF symlinks (if
                   8174:        necessary) in the build directory. Be sure to include
1.128     wiz      8175:        <span class="quote">&#8220;<span class="quote">-version-info</span>&#8221;</span>, especially when major and
1.87      wiz      8176:        minor are zero, as libtool will otherwise strip off the
                   8177:        shared library version.</p>
1.75      rillig   8178: <p>From the libtool manual:</p>
                   8179: <pre class="programlisting">
1.100     rillig   8180: So, libtool library versions are described by three integers:
1.69      rillig   8181: 
1.100     rillig   8182: CURRENT
                   8183: The most recent interface number that this library implements.
1.69      rillig   8184: 
1.100     rillig   8185: REVISION
                   8186: The implementation number of the CURRENT interface.
1.69      rillig   8187: 
1.100     rillig   8188: AGE
                   8189: The difference between the newest and oldest interfaces that
                   8190: this library implements.  In other words, the library implements
                   8191: all the interface numbers in the range from number `CURRENT -
                   8192: AGE' to `CURRENT'.
1.1       grant    8193: 
1.100     rillig   8194: If two libraries have identical CURRENT and AGE numbers, then the
                   8195: dynamic linker chooses the library with the greater REVISION number.
1.222     sevan    8196: </pre>
1.128     wiz      8197: <p>The <span class="quote">&#8220;<span class="quote">-release</span>&#8221;</span> option will produce
1.87      wiz      8198:        different results for a.out and ELF (excluding symlinks)
                   8199:        in only one case. An ELF library of the form
1.128     wiz      8200:        <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      8201:        will have a symlink of
1.128     wiz      8202:        <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      8203:        on an a.out platform. This is handled
                   8204:        automatically.</p>
1.128     wiz      8205: <p>The <span class="quote">&#8220;<span class="quote">-rpath argument</span>&#8221;</span> is the install
1.87      wiz      8206:        directory of the library being built.</p>
1.76      rillig   8207: <p>In the <code class="filename">PLIST</code>, include only the
1.87      wiz      8208:        <code class="filename">.la</code> file, the other files will be
                   8209:        added automatically.</p>
1.75      rillig   8210: </li>
1.128     wiz      8211: <li class="listitem">
1.76      rillig   8212: <p>When linking shared object (<code class="filename">.so</code>)
1.289     leot     8213:        files, i.e. files that are loaded via <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?dlopen+3.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">dlopen</span>(3)</span></a>, NOT
1.128     wiz      8214:        shared libraries, use <span class="quote">&#8220;<span class="quote">-module
                   8215:        -avoid-version</span>&#8221;</span> to prevent them getting version
1.87      wiz      8216:        tacked on.</p>
1.76      rillig   8217: <p>The <code class="filename">PLIST</code> file gets the
1.87      wiz      8218:        <code class="filename">foo.so</code> entry.</p>
1.75      rillig   8219: </li>
1.128     wiz      8220: <li class="listitem">
1.75      rillig   8221: <p>When linking programs that depend on these libraries
1.87      wiz      8222:        <span class="emphasis"><em>before</em></span> they are installed, preface
1.289     leot     8223:        the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?cc+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">cc</span>(1)</span></a> or <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?ld+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">ld</span>(1)</span></a> line with <span class="quote">&#8220;<span class="quote">${LIBTOOL}
1.128     wiz      8224:        --mode=link</span>&#8221;</span>, and it will find the correct
1.87      wiz      8225:        libraries (static or shared), but please be aware that
                   8226:        libtool will not allow you to specify a relative path in
1.128     wiz      8227:        -L (such as <span class="quote">&#8220;<span class="quote">-L../somelib</span>&#8221;</span>), because it
1.87      wiz      8228:        expects you to change that argument to be the
                   8229:        <code class="filename">.la</code> file. e.g.</p>
1.75      rillig   8230: <pre class="programlisting">
1.100     rillig   8231: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.222     sevan    8232: </pre>
1.75      rillig   8233: <p>should be changed to:</p>
                   8234: <pre class="programlisting">
1.100     rillig   8235: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.222     sevan    8236: </pre>
1.75      rillig   8237: <p>and it will do the right thing with the libraries.</p>
                   8238: </li>
1.128     wiz      8239: <li class="listitem">
1.289     leot     8240: <p>When installing libraries, preface the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?install+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a>
                   8241:        or <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?cp+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">cp</span>(1)</span></a> command with <span class="quote">&#8220;<span class="quote">${LIBTOOL}
1.128     wiz      8242:        --mode=install</span>&#8221;</span>, and change the library name to
1.87      wiz      8243:        <code class="filename">.la</code>. e.g.</p>
1.75      rillig   8244: <pre class="programlisting">
1.126     jakllsch 8245: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.222     sevan    8246: </pre>
1.76      rillig   8247: <p>This will install the static <code class="filename">.a</code>,
1.87      wiz      8248:        shared library, any needed symlinks, and run
1.289     leot     8249:        <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?ldconfig+8.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">ldconfig</span>(8)</span></a>.</p>
1.75      rillig   8250: </li>
1.128     wiz      8251: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.87      wiz      8252:        the <code class="filename">.la</code>
                   8253:        file (this is a change from previous behaviour).</p></li>
1.75      rillig   8254: </ol></div>
                   8255: </div>
1.148     asau     8256: <div class="sect2">
1.75      rillig   8257: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8258: <a name="using-libtool"></a>21.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.75      rillig   8259: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
1.87      wiz      8260:     package Makefile. This will override the package's own libtool
                   8261:     in most cases.  For older libtool using packages,  libtool is
                   8262:     made by ltconfig script during the do-configure step; you can
1.110     hubertf  8263:     check the libtool script location by doing <span class="command"><strong>make
1.87      wiz      8264:     configure; find work*/ -name libtool</strong></span>.</p>
1.75      rillig   8265: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
1.87      wiz      8266:     scripts, relative to <code class="varname">WRKSRC</code>, to override.  By
1.128     wiz      8267:     default, it is set to <span class="quote">&#8220;<span class="quote">libtool */libtool
                   8268:     */*/libtool</span>&#8221;</span>.  If this does not match the location of the
1.87      wiz      8269:     package's libtool script(s), set it as appropriate.</p>
1.76      rillig   8270: <p>If you do not need <code class="filename">*.a</code> static
1.87      wiz      8271:     libraries built and installed, then use
                   8272:     <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
1.75      rillig   8273: <p>If your package makes use of the platform-independent library
1.87      wiz      8274:     for loading dynamic shared objects, that comes with libtool
                   8275:     (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
                   8276: <p>Some packages use libtool incorrectly so that the package
                   8277:     may not work or build in some circumstances. Some of the more
                   8278:     common errors are:</p>
1.148     asau     8279: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      8280: <li class="listitem">
1.75      rillig   8281: <p>The inclusion of a shared object (-module) as a dependent library in an
1.87      wiz      8282:        executable or library. This in itself isn't a problem if one of two things
                   8283:        has been done:</p>
1.128     wiz      8284: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8285: <li class="listitem"><p>The shared object is named correctly, i.e.
1.87      wiz      8286:            <code class="filename">libfoo.la</code>, not
                   8287:            <code class="filename">foo.la</code></p></li>
1.128     wiz      8288: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.75      rillig   8289: </ol></div>
                   8290: </li>
1.128     wiz      8291: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.87      wiz      8292:        The function lt_dlinit() should be called and the macro
                   8293:        <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
                   8294:        executables.</p></li>
1.75      rillig   8295: </ul></div>
                   8296: </div>
1.148     asau     8297: <div class="sect2">
1.75      rillig   8298: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8299: <a name="autoconf-automake"></a>21.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.75      rillig   8300: <p>If a package needs GNU autoconf or automake to be executed
1.87      wiz      8301:     to regenerate the configure script and Makefile.in makefile
                   8302:     templates, then they should be executed in a pre-configure
                   8303:     target.</p>
1.75      rillig   8304: <p>For packages that need only autoconf:</p>
                   8305: <pre class="programlisting">
1.100     rillig   8306: AUTOCONF_REQD=  2.50            # if default version is not good enough
                   8307: USE_TOOLS+=     autoconf        # use "autoconf213" for autoconf-2.13
                   8308: ...
1.1       grant    8309: 
1.100     rillig   8310: pre-configure:
                   8311:         cd ${WRKSRC} &amp;&amp; autoconf
1.1       grant    8312: 
1.100     rillig   8313: ...
1.222     sevan    8314: </pre>
1.75      rillig   8315: <p>and for packages that need automake and autoconf:</p>
                   8316: <pre class="programlisting">
1.100     rillig   8317: AUTOMAKE_REQD=  1.7.1           # if default version is not good enough
                   8318: USE_TOOLS+=     automake        # use "automake14" for automake-1.4
                   8319: ...
                   8320: 
                   8321: pre-configure:
                   8322:         set -e; cd ${WRKSRC}; \
                   8323:         aclocal; autoheader; automake -a --foreign -i; autoconf
1.1       grant    8324: 
1.100     rillig   8325: ...
1.222     sevan    8326: </pre>
1.75      rillig   8327: <p>Packages which use GNU Automake will almost certainly
1.87      wiz      8328:     require GNU Make.</p>
1.75      rillig   8329: <p>There are times when the configure process makes
1.87      wiz      8330:     additional changes to the generated files, which then causes
                   8331:     the build process to try to re-execute the automake sequence.
                   8332:     This is prevented by touching various files in the configure
                   8333:     stage. If this causes problems with your package you can set
                   8334:     <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
                   8335:     Makefile.</p>
1.75      rillig   8336: </div>
                   8337: </div>
1.148     asau     8338: <div class="sect1">
1.75      rillig   8339: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   8340: <a name="programming-languages"></a>21.4. Programming languages</h2></div></div></div>
1.148     asau     8341: <div class="sect2">
1.87      wiz      8342: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8343: <a name="basic-programming-languages"></a>21.4.1. C, C++, and Fortran</h3></div></div></div>
1.87      wiz      8344: <p>Compilers for the C, C++, and Fortran languages comes with
                   8345:     the NetBSD base system.  By default, pkgsrc assumes that a package
                   8346:     is written in C and will hide all other compilers (via the wrapper
1.299     rillig   8347:     framework, see <a class="xref" href="#buildlink" title="Chapter 18. Buildlink methodology">Chapter 18, <i>Buildlink methodology</i></a>).</p>
1.87      wiz      8348: <p>To declare which language's compiler a package needs, set
                   8349:     the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.128     wiz      8350:     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
                   8351:     <span class="quote">&#8220;<span class="quote">fortran</span>&#8221;</span> (and any combination).  The default is
                   8352:     <span class="quote">&#8220;<span class="quote">c</span>&#8221;</span>.  Packages using GNU configure scripts, even if
1.87      wiz      8353:     written in C++, usually need a C compiler for the configure
                   8354:     phase.</p>
                   8355: </div>
1.148     asau     8356: <div class="sect2">
1.87      wiz      8357: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8358: <a name="java-programming-language"></a>21.4.2. Java</h3></div></div></div>
1.87      wiz      8359: <p>If a program is written in Java, use the Java framework in
                   8360:     pkgsrc.  The package must include
                   8361:     <code class="filename">../../mk/java-vm.mk</code>.  This Makefile fragment
                   8362:     provides the following variables:</p>
1.148     asau     8363: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      8364: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.87      wiz      8365:       dependency on the JDK is added.  If
1.128     wiz      8366:       <code class="varname">USE_JAVA</code> is set to <span class="quote">&#8220;<span class="quote">run</span>&#8221;</span>, then
1.87      wiz      8367:       there is only a runtime dependency on the JDK.  The default is
1.128     wiz      8368:       <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>, which also adds a build dependency on the
1.87      wiz      8369:       JDK.</p></li>
1.128     wiz      8370: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.87      wiz      8371:       a package needs a Java2 implementation.  The supported values
1.128     wiz      8372:       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
                   8373:       <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
                   8374:       implementation, <span class="quote">&#8220;<span class="quote">1.4</span>&#8221;</span> insists on versions 1.4 or
                   8375:       above, and <span class="quote">&#8220;<span class="quote">1.5</span>&#8221;</span> only accepts versions 1.5 or
1.87      wiz      8376:       above. This variable is not set by default.</p></li>
1.130     wiz      8377: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
                   8378:       automatically set to the runtime location of the used Java
                   8379:       implementation dependency. It may be used to set
                   8380:       <code class="varname">JAVA_HOME</code> to a good value if the program
                   8381:       needs this variable to be defined.
                   8382:       </p></li>
1.87      wiz      8383: </ul></div>
                   8384: </div>
1.148     asau     8385: <div class="sect2">
1.87      wiz      8386: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8387: <a name="perl-scripts"></a>21.4.3. Packages containing perl scripts</h3></div></div></div>
1.87      wiz      8388: <p>If your package contains interpreted perl scripts, add
1.128     wiz      8389:     <span class="quote">&#8220;<span class="quote">perl</span>&#8221;</span> to the <code class="varname">USE_TOOLS</code> variable
1.87      wiz      8390:     and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
                   8391:     interpreter path is set. <code class="varname">REPLACE_PERL</code> should
                   8392:     contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
1.183     wiz      8393:     that you want adjusted. Every occurrence of
                   8394:     <code class="filename">*/bin/perl</code> in a she-bang line will be
                   8395:     replaced with the full path to the perl executable.</p>
1.87      wiz      8396: <p>If a particular version of perl is needed, set the
                   8397:     <code class="varname">PERL5_REQD</code> variable to the version number.  The
1.128     wiz      8398:     default is <span class="quote">&#8220;<span class="quote">5.0</span>&#8221;</span>.</p>
1.267     rillig   8399: <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      8400:     about handling perl modules.</p>
                   8401: </div>
1.148     asau     8402: <div class="sect2">
1.87      wiz      8403: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8404: <a name="shell-scripts"></a>21.4.4. Packages containing shell scripts</h3></div></div></div>
1.147     wiz      8405: <p><code class="varname">REPLACE_SH</code>,
                   8406:     <code class="varname">REPLACE_BASH</code>, <code class="varname">REPLACE_CSH</code>,
                   8407:     and <code class="varname">REPLACE_KSH</code> can be used to replace shell
                   8408:     hash bangs in files. Please use the appropriate one, prefering
                   8409:     <code class="varname">REPLACE_SH</code> in case this shell is sufficient.
1.183     wiz      8410:     Each should contain a list of scripts, relative to
                   8411:     <code class="varname">WRKSRC</code>, that you want adjusted. Every
                   8412:     occurrence of the matching shell in a she-bang line will be
                   8413:     replaced with the full path to the shell executable.
1.147     wiz      8414:     When using <code class="varname">REPLACE_BASH</code>, don't forget to add
                   8415:     <code class="filename">bash</code> to <code class="varname">USE_TOOLS</code>.</p>
                   8416: </div>
1.148     asau     8417: <div class="sect2">
1.147     wiz      8418: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8419: <a name="other-programming-languages"></a>21.4.5. Other programming languages</h3></div></div></div>
1.87      wiz      8420: <p>Currently, there is no special handling for other languages
                   8421:     in pkgsrc.  If a compiler package provides a
                   8422:     <code class="filename">buildlink3.mk</code> file, include that, otherwise
                   8423:     just add a (build) dependency on the appropriate compiler
                   8424:     package.</p>
                   8425: </div>
                   8426: </div>
1.148     asau     8427: <div class="sect1">
1.87      wiz      8428: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   8429: <a name="fixes.build"></a>21.5. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.77      rillig   8430: <p>The most common failures when building a package are that
                   8431:        some platforms do not provide certain header files, functions or
                   8432:        libraries, or they provide the functions in a library that the
                   8433:        original package author didn't know. To work around this, you
                   8434:        can rewrite the source code in most cases so that it does not
                   8435:        use the missing functions or provides a replacement function.</p>
1.148     asau     8436: <div class="sect2">
1.77      rillig   8437: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8438: <a name="fixes.build.cpp"></a>21.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.77      rillig   8439: <p>If a package already comes with a GNU configure script, the
                   8440:        preferred way to fix the build failure is to change the
                   8441:        configure script, not the code. In the other cases, you can
                   8442:        utilize the C preprocessor, which defines certain macros
                   8443:        depending on the operating system and hardware architecture it
                   8444:        compiles for. These macros can be queried using for example
                   8445:        <code class="varname">#if defined(__i386)</code>. Almost every operating
                   8446:        system, hardware architecture and compiler has its own macro.
                   8447:        For example, if the macros <code class="varname">__GNUC__</code>,
                   8448:        <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
                   8449:        are all defined, you know that you are using NetBSD on an i386
                   8450:        compatible CPU, and your compiler is GCC.</p>
                   8451: <p>The list of the following macros for hardware and
                   8452:        operating system depends on the compiler that is used. For
                   8453:        example, if you want to conditionally compile code on Solaris,
                   8454:        don't use <code class="varname">__sun__</code>, as the SunPro compiler
                   8455:        does not define it. Use <code class="varname">__sun</code> instead.</p>
1.148     asau     8456: <div class="sect3">
1.75      rillig   8457: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   8458: <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   8459: <p>To distinguish between 4.4 BSD-derived systems and the
                   8460:         rest of the world, you should use the following code.</p>
                   8461: <pre class="programlisting">
1.100     rillig   8462: #include &lt;sys/param.h&gt;
                   8463: #if (defined(BSD) &amp;&amp; BSD &gt;= 199306)
                   8464: /* BSD-specific code goes here */
                   8465: #else
                   8466: /* non-BSD-specific code goes here */
                   8467: #endif
1.75      rillig   8468: </pre>
1.77      rillig   8469: <p>If this distinction is not fine enough, you can also test
                   8470:        for the following macros.</p>
1.75      rillig   8471: <pre class="programlisting">
1.151     obache   8472: Cygwin      __CYGWIN__
                   8473: DragonFly   __DragonFly__
1.100     rillig   8474: FreeBSD     __FreeBSD__
1.151     obache   8475: Haiku       __HAIKU__
1.100     rillig   8476: Interix     __INTERIX
                   8477: IRIX        __sgi (TODO: get a definite source for this)
                   8478: Linux       linux, __linux, __linux__
1.193     dholland 8479: Mac OS X    __APPLE__
1.151     obache   8480: MirBSD      __MirBSD__ (__OpenBSD__ is also defined)
                   8481: Minix3      __minix
1.100     rillig   8482: NetBSD      __NetBSD__
                   8483: OpenBSD     __OpenBSD__
                   8484: Solaris     sun, __sun
1.75      rillig   8485: </pre>
                   8486: </div>
1.148     asau     8487: <div class="sect3">
1.75      rillig   8488: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   8489: <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   8490: <pre class="programlisting">
1.100     rillig   8491: i386        i386, __i386, __i386__
                   8492: MIPS        __mips
                   8493: SPARC       sparc, __sparc
1.75      rillig   8494: </pre>
                   8495: </div>
1.148     asau     8496: <div class="sect3">
1.75      rillig   8497: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   8498: <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   8499: <pre class="programlisting">
1.100     rillig   8500: GCC         __GNUC__ (major version), __GNUC_MINOR__
                   8501: MIPSpro     _COMPILER_VERSION (0x741 for MIPSpro 7.41)
                   8502: SunPro      __SUNPRO_C (0x570 for Sun C 5.7)
                   8503: SunPro C++  __SUNPRO_CC (0x580 for Sun C++ 5.8)
1.75      rillig   8504: </pre>
                   8505: </div>
                   8506: </div>
1.148     asau     8507: <div class="sect2">
1.78      rillig   8508: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8509: <a name="compiler-bugs"></a>21.5.2. How to handle compiler bugs</h3></div></div></div>
1.78      rillig   8510: <p>Some source files trigger bugs in the compiler, based on
1.87      wiz      8511:         combinations of compiler version and architecture and almost
                   8512:         always relation to optimisation being enabled.  Common symptoms
                   8513:         are gcc internal errors or never finishing compiling a
1.78      rillig   8514:        file.</p>
                   8515: <p>Typically, a workaround involves testing the
                   8516:         <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
                   8517:         optimisation for that combination of file,
1.198     tnn      8518:        <code class="varname">MACHINE_ARCH</code> and compiler.</p>
                   8519: <p>This used to be a big problem in the past, but is rarely
                   8520:        needed now as compiler technology has matured. If you still need
                   8521:        to add a compiler specific workaround, please do so in the file
                   8522:        <code class="filename">hacks.mk</code> and describe the symptom and
                   8523:        compiler version as detailed as possible.</p>
1.78      rillig   8524: </div>
1.148     asau     8525: <div class="sect2">
1.78      rillig   8526: <div class="titlepage"><div><div><h3 class="title">
1.287     rillig   8527: <a name="fixes.build.header"></a>21.5.3. No such file or directory</h3></div></div></div>
                   8528: <p>Compilation sometimes fails with an error message like this:</p>
                   8529: <pre class="programlisting">
                   8530: .../x11/gtk3/work/gtk+-3.24.12/gdk/gdktypes.h:35:10:
                   8531:     fatal error: pango/pango.h: No such file or directory
                   8532: </pre>
                   8533: <p>The proper way to fix this problem depends on the type of the
                   8534: header, which is described in the following sections.</p>
                   8535: <div class="sect3">
                   8536: <div class="titlepage"><div><div><h4 class="title">
                   8537: <a name="fixes.build.header.bl3"></a>21.5.3.1. Headers from other packages</h4></div></div></div>
                   8538: <p>If the header name looks like it comes from a different package,
                   8539: that other package should be included via the buildlink3
                   8540: framework.</p>
                   8541: <p>First, look whether the header is somewhere in the buildlink3
                   8542: directory below <code class="varname">WRKDIR</code>. In the above case of
                   8543: the missing Pango header:</p>
                   8544: <pre class="programlisting">
                   8545: <code class="prompt">$</code> find work/.buildlink/ -print | grep -F pango/pango.h
                   8546: </pre>
                   8547: <p>In the case of Pango, the output is:</p>
                   8548: <pre class="programlisting">
                   8549: work/.buildlink/include/pango-1.0/pango/pango.h
                   8550: </pre>
                   8551: <p>If the <code class="filename">pango/pango.h</code> file were placed directly
                   8552: in the <code class="filename">.buildlink</code> directory, it would have been
                   8553: found automatically. There is an extra <code class="filename">pango-1.0</code>
                   8554: path component though, which means that the compiler command line must
                   8555: contain an option of the form
                   8556: <code class="literal">-I${BUILDLINK3_PREFIX.pango}/include/pango-1.0</code>. In
                   8557: most cases this option is generated by the configure script, which can be examined using:</p>
                   8558: <pre class="programlisting">
                   8559: <code class="prompt">$</code> $ grep -o '[-]I[^[:space:]]*/pango[^[:space:]]*' work/*/Makefile
                   8560: -I/usr/pkg/include/pango-1.0
                   8561: -I/usr/pkg/include/pango-1.0
                   8562: -I/usr/pkg/include/pango-1.0
                   8563: -I/usr/pkg/include/pango-1.0
                   8564: -I/usr/pkg/include/pango-1.0
                   8565: </pre>
                   8566: <p>This looks good. These options are transformed by the buildlink
                   8567: wrapper to refer to the correct path inside
                   8568: <code class="filename">work/.buildlink</code>.</p>
                   8569: <p>Since the compilation fails though, examine the compiler command
                   8570: lines in <code class="filename">work/.work.log</code> to see whether the
                   8571: <code class="literal">-I</code> option is included in the particular command
                   8572: line.</p>
                   8573: <p>To further analyze the situation, run <span class="command"><strong>bmake
                   8574: build-env</strong></span>, which sets up an interactive, realistic environment
                   8575: including all the pkgsrc wrapper commands and environment variables. From
                   8576: there, try to compile some simple example programs that use the
                   8577: header.</p>
                   8578: </div>
                   8579: <div class="sect3">
                   8580: <div class="titlepage"><div><div><h4 class="title">
                   8581: <a name="fixes.build.header.gen"></a>21.5.3.2. Headers generated during the build</h4></div></div></div>
                   8582: <p>If the name of the header seems to come from the package itself,
                   8583: and if the build is run with parallel jobs, the package may have some
                   8584: undeclared dependencies between the <code class="filename">.c</code> and the
                   8585: <code class="filename">.h</code> files, and a C file is compiled before its
                   8586: required header is generated.</p>
                   8587: <p>To see whether the build runs with parallel jobs, run
                   8588: <span class="command"><strong>bmake show-all-build | grep JOBS</strong></span>. Its output looks
                   8589: like this:</p>
                   8590: <pre class="programlisting">
                   8591:   usr   MAKE_JOBS=              7
                   8592:   pkg   MAKE_JOBS_SAFE          # undefined
                   8593:   def   _MAKE_JOBS_N=           7
                   8594: </pre>
                   8595: <p>In this case the pkgsrc user has asked pkgsrc to build packages
                   8596: with 7 jobs in parallel (<code class="varname">MAKE_JOBS</code>). The
                   8597: package could have disabled parallel builds by setting
                   8598: <code class="varname">MAKE_JOBS_SAFE</code> to <code class="literal">no</code>, but
                   8599: in this case it hasn't.</p>
                   8600: <p>To see whether the build failure is caused by parallel builds,
                   8601: first save the exact error message and a bit of context, maybe you need
                   8602: it later for reporting a bug. Next, run:</p>
                   8603: <pre class="programlisting">
                   8604: MAKE_JOBS_SAFE=no bmake clean build
                   8605: </pre>
                   8606: <p>If that succeeds, <a class="ulink" href="https://www.NetBSD.org/cgi-bin/sendpr.cgi?gndb=netbsd" target="_top">file a bug
                   8607: report</a> against the pkgsrc package, including the exact error
                   8608: message and the contents of your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file.</p>
                   8609: </div>
1.288     rillig   8610: <div class="sect3">
                   8611: <div class="titlepage"><div><div><h4 class="title">
                   8612: <a name="fixes.build.header.symlink"></a>21.5.3.3. Symlinks</h4></div></div></div>
                   8613: <p>Pkgsrc does not work reliably if any of
                   8614: <code class="varname">LOCALBASE</code>, <code class="varname">VARBASE</code> or
                   8615: <code class="varname">WRKDIR</code> contains a symlink. Since 2019Q2, the pkgsrc
                   8616: bootstrap program prevents installing pkgsrc in symlink-based
                   8617: directories. Existing pkgsrc installations are not checked for symlinks
                   8618: though.</p>
                   8619: <p>The "No such file or directory" error messages are a typical
                   8620: symptom of symlinks, and it's quite difficult to find out that this is
                   8621: the actual cause.</p>
                   8622: </div>
                   8623: <div class="sect3">
                   8624: <div class="titlepage"><div><div><h4 class="title">
                   8625: <a name="fixes.build.header.stale"></a>21.5.3.4. Stale working directories</h4></div></div></div>
                   8626: <p>When building a hierarchy of packages, it may happen that one
                   8627: package is built and then pkgsrc is updated. This situation can provoke
                   8628: various hard to diagnose build errors. To clean up the situation:</p>
                   8629: <pre class="programlisting">
                   8630: <code class="prompt">$</code> (cd ../../ &amp;&amp; test -f mk/bsd.pkg.mk &amp;&amp; rm -rf */*/work)
                   8631: </pre>
                   8632: <p>(The test for <code class="filename">bsd.pkg.mk</code> just prevents running
                   8633: this command in the wrong directory.)</p>
                   8634: <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
                   8635: that directory as well.</p>
                   8636: </div>
                   8637: <div class="sect3">
                   8638: <div class="titlepage"><div><div><h4 class="title">
                   8639: <a name="fixes.build.header.misc"></a>21.5.3.5. Other possible reasons</h4></div></div></div>
                   8640: <p>On platforms other than BSD, third-party packages are installed in
                   8641: <code class="filename">/usr/include</code>, together with the base system. This
                   8642: means that pkgsrc cannot distinguish between headers provided by the base
                   8643: system (which it needs) and headers from third-party packages (which are
                   8644: often included in pkgsrc as well). This can lead to subtle version
                   8645: mismatches.</p>
                   8646: <p>In pkgsrc installations that have been active for several years, it
                   8647: may happen that some files are manually deleted. To exclude this unlikely
                   8648: reason, run <span class="command"><strong>pkg_admin check</strong></span>.</p>
                   8649: <p>It may help to run <span class="command"><strong>pkg_admin rebuild-tree</strong></span> to
                   8650: check/fix dependencies.</p>
                   8651: <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>
                   8652: for contact information. Be prepared to describe what you have tried so
                   8653: far and what any error messages were.</p>
                   8654: </div>
1.287     rillig   8655: </div>
                   8656: <div class="sect2">
                   8657: <div class="titlepage"><div><div><h3 class="title">
                   8658: <a name="undefined-reference"></a>21.5.4. Undefined reference to <span class="quote">&#8220;<span class="quote">...</span>&#8221;</span>
1.128     wiz      8659: </h3></div></div></div>
1.92      rillig   8660: <p>This error message often means that a package did not
1.78      rillig   8661:        link to a shared library it needs. The following functions are
                   8662:        known to cause this error message over and over.</p>
                   8663: <div class="informaltable">
1.216     tnn      8664: <a name="undefined-reference-functions"></a><table class="informaltable" border="1">
1.78      rillig   8665: <colgroup>
                   8666: <col>
                   8667: <col>
                   8668: <col>
                   8669: </colgroup>
                   8670: <thead><tr>
                   8671: <th>Function</th>
                   8672: <th>Library</th>
                   8673: <th>Affected platforms</th>
                   8674: </tr></thead>
                   8675: <tbody>
                   8676: <tr>
                   8677: <td>accept, bind, connect</td>
                   8678: <td>-lsocket</td>
                   8679: <td>Solaris</td>
                   8680: </tr>
                   8681: <tr>
                   8682: <td>crypt</td>
                   8683: <td>-lcrypt</td>
                   8684: <td>DragonFly, NetBSD</td>
                   8685: </tr>
                   8686: <tr>
                   8687: <td>dlopen, dlsym</td>
                   8688: <td>-ldl</td>
                   8689: <td>Linux</td>
                   8690: </tr>
                   8691: <tr>
                   8692: <td>gethost*</td>
                   8693: <td>-lnsl</td>
                   8694: <td>Solaris</td>
                   8695: </tr>
                   8696: <tr>
                   8697: <td>inet_aton</td>
                   8698: <td>-lresolv</td>
                   8699: <td>Solaris</td>
                   8700: </tr>
                   8701: <tr>
                   8702: <td>nanosleep, sem_*, timer_*</td>
                   8703: <td>-lrt</td>
                   8704: <td>Solaris</td>
                   8705: </tr>
                   8706: <tr>
                   8707: <td>openpty</td>
                   8708: <td>-lutil</td>
                   8709: <td>Linux</td>
                   8710: </tr>
                   8711: </tbody>
                   8712: </table>
                   8713: </div>
                   8714: <p>To fix these linker errors, it is often sufficient to say
1.87      wiz      8715:     <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
                   8716:     -l<em class="replaceable"><code>foo</code></em></code> to the package
1.110     hubertf  8717:     <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
1.87      wiz      8718:     bmake</strong></span>.</p>
1.148     asau     8719: <div class="sect3">
1.92      rillig   8720: <div class="titlepage"><div><div><h4 class="title">
1.287     rillig   8721: <a name="undefined-reference-sunpro"></a>21.5.4.1. Special issue: The SunPro compiler</h4></div></div></div>
1.92      rillig   8722: <p>When you are using the SunPro compiler, there is another
                   8723: possibility. That compiler cannot handle the following code:</p>
                   8724: <pre class="programlisting">
1.100     rillig   8725: extern int extern_func(int);
1.93      rillig   8726: 
1.100     rillig   8727: static inline int
                   8728: inline_func(int x)
                   8729: {
1.92      rillig   8730:         return extern_func(x);
1.100     rillig   8731: }
1.93      rillig   8732: 
1.100     rillig   8733: int main(void)
                   8734: {
1.92      rillig   8735:         return 0;
1.100     rillig   8736: }
1.92      rillig   8737: </pre>
                   8738: <p>It generates the code for <code class="function">inline_func</code> even if
                   8739: that function is never used. This code then refers to
                   8740: <code class="function">extern_func</code>, which can usually not be resolved. To
                   8741: solve this problem you can try to tell the package to disable inlining
                   8742: of functions.</p>
                   8743: </div>
1.87      wiz      8744: </div>
1.148     asau     8745: <div class="sect2">
1.87      wiz      8746: <div class="titlepage"><div><div><h3 class="title">
1.287     rillig   8747: <a name="out-of-memory"></a>21.5.5. Running out of memory</h3></div></div></div>
1.87      wiz      8748: <p>Sometimes packages fail to build because the compiler runs
                   8749:     into an operating system specific soft limit.  With the
                   8750:     <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
1.204     wiz      8751:     to unlimit the resources.  Currently, the allowed values are any combination of
                   8752:     <span class="quote">&#8220;<span class="quote">cputime</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">datasize</span>&#8221;</span>,
                   8753:     <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      8754:     Setting this variable is similar to running the shell builtin
1.110     hubertf  8755:     <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.87      wiz      8756:     segment size or maximum stack size of a process, respectively, to
                   8757:     their hard limits.</p>
1.78      rillig   8758: </div>
1.75      rillig   8759: </div>
1.148     asau     8760: <div class="sect1">
1.75      rillig   8761: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   8762: <a name="fixes.install"></a>21.6. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.148     asau     8763: <div class="sect2">
1.75      rillig   8764: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8765: <a name="install-scripts"></a>21.6.1. Creating needed directories</h3></div></div></div>
1.110     hubertf  8766: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.87      wiz      8767:     with some operating systems cannot create more than one
                   8768:     directory at a time. As such, you should call
                   8769:     <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
                   8770: <pre class="programlisting">
1.100     rillig   8771: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
                   8772: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.222     sevan    8773: </pre>
1.128     wiz      8774: <p>You can also just append <span class="quote">&#8220;<span class="quote"><code class="literal">dir1
                   8775:     dir2</code></span>&#8221;</span> to the
1.87      wiz      8776:     <code class="varname">INSTALLATION_DIRS</code> variable, which will
                   8777:     automatically do the right thing.</p>
1.75      rillig   8778: </div>
1.148     asau     8779: <div class="sect2">
1.75      rillig   8780: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8781: <a name="where-to-install-documentation"></a>21.6.2. Where to install documentation</h3></div></div></div>
1.83      wiz      8782: <p>In general, documentation should be installed into
1.87      wiz      8783:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
                   8784:     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
                   8785:     includes the version number of the package).</p>
1.84      wiz      8786: <p>Many modern packages using GNU autoconf allow to set the
1.87      wiz      8787:     directory where HTML documentation is installed with the
1.128     wiz      8788:     <span class="quote">&#8220;<span class="quote">--with-html-dir</span>&#8221;</span> option. Sometimes using this flag
1.87      wiz      8789:     is needed because otherwise the documentation ends up in
                   8790:     <code class="filename">${PREFIX}/share/doc/html</code> or other
                   8791:     places.</p>
                   8792: <p>An exception to the above is that library API documentation
1.250     leot     8793:     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      8794:     browsers (devhelp) should be left at their default location, which
                   8795:     is <code class="filename">${PREFIX}/share/gtk-doc</code>.  Such
                   8796:     documentation can be recognized from files ending in
                   8797:     <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
                   8798:     (It is also acceptable to install such files in
                   8799:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
                   8800:     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
                   8801:     <code class="filename">.devhelp*</code> file must be directly in that
                   8802:     directory then, no additional subdirectory level is allowed in
                   8803:     this case. This is usually achieved by using
1.128     wiz      8804:     <span class="quote">&#8220;<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>&#8221;</span>.
1.87      wiz      8805:     <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
                   8806:     though.)</p>
1.75      rillig   8807: </div>
1.148     asau     8808: <div class="sect2">
1.75      rillig   8809: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8810: <a name="installing-score-files"></a>21.6.3. Installing highscore files</h3></div></div></div>
1.75      rillig   8811: <p>Certain packages, most of them in the games category, install
1.87      wiz      8812:     a score file that allows all users on the system to record their
                   8813:     highscores.  In order for this to work, the binaries need to be
                   8814:     installed setgid and the score files owned by the appropriate
1.142     wiz      8815:     group and/or owner (traditionally the "games" user/group).  Set
                   8816:     <code class="varname">USE_GAMESGROUP</code> to yes to support this. The
1.87      wiz      8817:     following variables, documented in more detail in
                   8818:     <code class="filename">mk/defaults/mk.conf</code>, control this
1.142     wiz      8819:     behaviour: <code class="varname">GAMEDATAMODE</code>,
                   8820:     <code class="varname">GAMEDIRMODE</code>, <code class="varname">GAMES_GROUP</code>,
1.210     leot     8821:     <code class="varname">GAMEMODE</code>, <code class="varname">GAME_USER</code>.
                   8822:     Other useful variables are: <code class="varname">GAMEDIR_PERMS</code>,
                   8823:     <code class="varname">GAMEDATA_PERMS</code> and
                   8824:     <code class="varname">SETGID_GAMES_PERMS</code>.</p>
                   8825: <p>An example that illustrates some of the variables described above is
                   8826:     <code class="filename">games/moon-buggy</code>. <code class="varname">OWN_DIRS_PERMS</code> is
                   8827:     used to properly set directory permissions of the directory where the
                   8828:     scorefile is saved, <code class="varname">REQD_FILES_PERMS</code> is used to create a
                   8829:     dummy scorefile (<code class="filename">mbscore</code>) with the proper permissions
                   8830:     and <code class="varname">SPECIAL_PERMS</code> is used to install setgid the game
                   8831:     binary:</p>
                   8832: <pre class="programlisting">
1.223     rillig   8833: USE_GAMESGROUP=         yes
1.210     leot     8834: 
1.223     rillig   8835: BUILD_DEFS+=            VARBASE
1.210     leot     8836: 
1.223     rillig   8837: OWN_DIRS_PERMS+=        ${VARBASE}/games/moon-buggy ${GAMEDIR_PERMS}
                   8838: REQD_FILES_PERMS+=      /dev/null ${VARBASE}/games/moon-buggy/mbscore ${GAMEDATA_PERMS}
                   8839: SPECIAL_PERMS+=         ${PREFIX}/bin/moon-buggy ${SETGID_GAMES_PERMS}
1.222     sevan    8840: </pre>
1.210     leot     8841: <p>Various <code class="varname">INSTALL_*</code> variables are also available:
                   8842:     <code class="varname">INSTALL_GAME</code> to install setgid game binaries,
                   8843:     <code class="varname">INSTALL_GAME_DIR</code> to install game directories that are
                   8844:     needed to be accessed by setgid games and
                   8845:     <code class="varname">INSTALL_GAME_DATA</code> to install scorefiles.</p>
1.114     jmcneill 8846: <p>A package should therefore never hard code file ownership or
1.210     leot     8847:     access permissions but rely on <code class="varname">*_PERMS</code> as described above
                   8848:     or alternatively on <code class="varname">INSTALL_GAME</code>,
                   8849:     <code class="varname">INSTALL_GAME_DATA</code> and
                   8850:     <code class="varname">INSTALL_GAME_DIR</code> to set these correctly.</p>
1.75      rillig   8851: </div>
1.148     asau     8852: <div class="sect2">
1.75      rillig   8853: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8854: <a name="destdir-support"></a>21.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.114     jmcneill 8855: <p><code class="varname">DESTDIR</code> support means that a package
                   8856:     installs into a staging directory, not the final location of the
                   8857:     files. Then a binary package is created which can be used for
                   8858:     installation as usual. There are two ways: Either the package must
1.128     wiz      8859:     install as root (<span class="quote">&#8220;<span class="quote">destdir</span>&#8221;</span>) or the package can
                   8860:     install as non-root user (<span class="quote">&#8220;<span class="quote">user-destdir</span>&#8221;</span>).</p>
1.148     asau     8861: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      8862: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
1.224     leot     8863:       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>.
                   8864:       By default <code class="varname">PKG_DESTDIR_SUPPORT</code>
1.145     wiz      8865:       is set to <span class="quote">&#8220;<span class="quote">user-destdir</span>&#8221;</span> to help catching more
                   8866:       potential packaging problems. If bsd.prefs.mk is included in the Makefile,
1.114     jmcneill 8867:       <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
                   8868:       the inclusion.</p></li>
1.128     wiz      8869: <li class="listitem"><p>All installation operations have to be prefixed with
1.103     wiz      8870:       <code class="filename">${DESTDIR}</code>.</p></li>
1.128     wiz      8871: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.103     wiz      8872:       automatically. Many manual rules and pre/post-install often are
                   8873:       incorrect; fix them.</p></li>
1.128     wiz      8874: <li class="listitem"><p>If files are installed with special owner/group
1.118     imil     8875:       use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.128     wiz      8876: <li class="listitem"><p>In general, packages should support
1.103     wiz      8877:       <code class="varname">UNPRIVILEGED</code> to be able to use
                   8878:       DESTDIR.</p></li>
                   8879: </ul></div>
                   8880: </div>
1.148     asau     8881: <div class="sect2">
1.103     wiz      8882: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8883: <a name="hardcoded-paths"></a>21.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.87      wiz      8884: <p>Your package may also contain scripts with hardcoded paths to
                   8885:       other interpreters besides (or as well as) perl.  To correct the
                   8886:       full pathname to the script interpreter, you need to set the
                   8887:       following definitions in your <code class="filename">Makefile</code> (we
1.110     hubertf  8888:     shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.87      wiz      8889: <pre class="programlisting">
1.100     rillig   8890: REPLACE_INTERPRETER+=   tcl
                   8891: REPLACE.tcl.old=        .*/bin/tclsh
                   8892: REPLACE.tcl.new=        ${PREFIX}/bin/tclsh
                   8893: REPLACE_FILES.tcl=      # list of tcl scripts which need to be fixed,
                   8894: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.222     sevan    8895: </pre>
1.148     asau     8896: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   8897: <h3 class="title">Note</h3>
                   8898: <p>Before March 2006, these variables were called
1.87      wiz      8899:     <code class="varname">_REPLACE.*</code> and
                   8900:     <code class="varname">_REPLACE_FILES.*</code>.</p>
1.75      rillig   8901: </div>
                   8902: </div>
1.148     asau     8903: <div class="sect2">
1.75      rillig   8904: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8905: <a name="perl-modules"></a>21.6.6. Packages installing perl modules</h3></div></div></div>
1.75      rillig   8906: <p>Makefiles of packages providing perl5 modules should include
1.87      wiz      8907:     the Makefile fragment
                   8908:     <code class="filename">../../lang/perl5/module.mk</code>.  It provides a
1.110     hubertf  8909:     <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.87      wiz      8910:     configuration for such modules as well as various hooks to tune
                   8911:     this configuration.  See comments in this file for
                   8912:     details.</p>
1.75      rillig   8913: <p>Perl5 modules will install into different places depending
1.87      wiz      8914:     on the version of perl used during the build process.  To
                   8915:     address this, pkgsrc will append lines to the
                   8916:     <code class="filename">PLIST</code> corresponding to the files listed in
                   8917:     the installed <code class="filename">.packlist</code> file generated by
                   8918:     most perl5 modules.  This is invoked by defining
                   8919:     <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
1.153     wiz      8920:     packlist files relative to <code class="varname">PERL5_PACKLIST_DIR</code>
                   8921:     (<code class="varname">PERL5_INSTALLVENDORARCH</code> by default),
                   8922:     e.g.:</p>
1.75      rillig   8923: <pre class="programlisting">
1.153     wiz      8924: PERL5_PACKLIST= auto/Pg/.packlist
1.222     sevan    8925: </pre>
1.153     wiz      8926: <p>The perl5 config variables
                   8927:     <code class="varname">installarchlib</code>,
                   8928:     <code class="varname">installscript</code>,
                   8929:     <code class="varname">installvendorbin</code>,
                   8930:     <code class="varname">installvendorscript</code>,
                   8931:     <code class="varname">installvendorarch</code>,
                   8932:     <code class="varname">installvendorlib</code>,
                   8933:     <code class="varname">installvendorman1dir</code>, and
                   8934:     <code class="varname">installvendorman3dir</code> represent those
                   8935:     locations in which components of perl5 modules may be installed,
                   8936:     provided as variable with uppercase and prefixed with
                   8937:     <code class="varname">PERL5_</code>, e.g. <code class="varname">PERL5_INSTALLARCHLIB</code>
                   8938:     and may be used by perl5 packages that don't have a packlist.
                   8939:     These variables are also substituted for in the
                   8940:     <code class="filename">PLIST</code> as uppercase prefixed with
                   8941:     <code class="varname">PERL5_SUB_</code>.</p>
1.75      rillig   8942: </div>
1.148     asau     8943: <div class="sect2">
1.75      rillig   8944: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8945: <a name="faq.info-files"></a>21.6.7. Packages installing info files</h3></div></div></div>
1.75      rillig   8946: <p>Some packages install info files or use the
1.128     wiz      8947:     <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      8948:     commands.  <code class="varname">INFO_FILES</code> should be defined in
                   8949:     the package Makefile so that <code class="filename">INSTALL</code> and
                   8950:     <code class="filename">DEINSTALL</code> scripts will be generated to
                   8951:     handle registration of the info files in the Info directory
1.128     wiz      8952:     file. The <span class="quote">&#8220;<span class="quote">install-info</span>&#8221;</span> command used for the info
1.87      wiz      8953:     files registration is either provided by the system, or by a
                   8954:     special purpose package automatically added as dependency if
                   8955:     needed.</p>
1.75      rillig   8956: <p><code class="varname">PKGINFODIR</code> is the directory under
1.87      wiz      8957:     <code class="filename">${PREFIX}</code> where info files are primarily
                   8958:     located. <code class="varname">PKGINFODIR</code> defaults to
1.128     wiz      8959:     <span class="quote">&#8220;<span class="quote">info</span>&#8221;</span> and can be overridden by the user.</p>
1.75      rillig   8960: <p>The info files for the package should be listed in the
1.87      wiz      8961:     package <code class="filename">PLIST</code>; however any split info files
                   8962:     need not be listed.</p>
1.128     wiz      8963: <p>A package which needs the <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> command
                   8964:     at build time must add <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> to
1.87      wiz      8965:     <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.128     wiz      8966:     version of the <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> command is needed it
1.87      wiz      8967:     should be noted with the <code class="varname">TEXINFO_REQD</code>
                   8968:     variable in the package <code class="filename">Makefile</code>. By
                   8969:     default, a minimum version of 3.12 is required. If the system
1.110     hubertf  8970:     does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.87      wiz      8971:     does not match the required minimum, a build dependency on the
1.250     leot     8972:     <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      8973:     be added automatically.</p>
1.75      rillig   8974: <p>The build and installation process of the software provided
1.87      wiz      8975:     by the package should not use the
1.110     hubertf  8976:     <span class="command"><strong>install-info</strong></span> command as the registration of
1.87      wiz      8977:     info files is the task of the package
                   8978:     <code class="filename">INSTALL</code> script, and it must use the
1.110     hubertf  8979:     appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.75      rillig   8980: <p>To achieve this goal, the pkgsrc infrastructure creates
1.110     hubertf  8981:     overriding scripts for the <span class="command"><strong>install-info</strong></span> and
                   8982:     <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.87      wiz      8983:     in <code class="varname">PATH</code>.</p>
1.110     hubertf  8984: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.87      wiz      8985:     no effect except the logging of a message. The script overriding
1.110     hubertf  8986:     <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.87      wiz      8987:     value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.110     hubertf  8988:     <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.75      rillig   8989: </div>
1.148     asau     8990: <div class="sect2">
1.75      rillig   8991: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8992: <a name="manpages"></a>21.6.8. Packages installing man pages</h3></div></div></div>
1.81      rillig   8993: <p>All packages that install manual pages should install them
1.87      wiz      8994:     into the same directory, so that there is one common place to look
                   8995:     for them. In pkgsrc, this place is
                   8996:     <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
                   8997:     should be used in packages. The default for
                   8998:     <code class="varname">PKGMANDIR</code> is
1.128     wiz      8999:     <span class="quote">&#8220;<span class="quote"><code class="filename">man</code></span>&#8221;</span>. Another often-used value
                   9000:     is <span class="quote">&#8220;<span class="quote"><code class="filename">share/man</code></span>&#8221;</span>.</p>
1.148     asau     9001: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   9002: <h3 class="title">Note</h3>
1.87      wiz      9003: <p>The support for a custom <code class="varname">PKGMANDIR</code>
                   9004:     is far from complete.</p>
1.75      rillig   9005: </div>
1.81      rillig   9006: <p>The <code class="filename">PLIST</code> files can just use
1.87      wiz      9007:     <code class="filename">man/</code> as the top level directory for the man
                   9008:     page file entries, and the pkgsrc framework will convert as
                   9009:     needed. In all other places, the correct
                   9010:     <code class="varname">PKGMANDIR</code> must be used.</p>
                   9011: <p>Packages that are
                   9012:     configured with <code class="varname">GNU_CONFIGURE</code> set as
1.128     wiz      9013:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>, by default will use the
1.87      wiz      9014:     <code class="filename">./configure</code>
                   9015:     --mandir switch to set where the man pages should be installed.
                   9016:     The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
                   9017:     to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
                   9018: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
                   9019:     use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.128     wiz      9020:     to <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span>.
1.87      wiz      9021:     Or if the <code class="filename">./configure</code> script uses
                   9022:     a non-standard use of --mandir, you can set
                   9023:     <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.299     rillig   9024: <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      9025:     information on installation of compressed manual pages.</p>
1.75      rillig   9026: </div>
1.148     asau     9027: <div class="sect2">
1.75      rillig   9028: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   9029: <a name="gconf-data-files"></a>21.6.9. Packages installing GConf data files</h3></div></div></div>
1.87      wiz      9030: <p>If a package installs <code class="filename">.schemas</code> or
1.107     rillig   9031:     <code class="filename">.entries</code> files, used by GConf,
1.87      wiz      9032:     you need to take some extra steps to make sure they get registered
                   9033:     in the database:</p>
1.128     wiz      9034: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9035: <li class="listitem"><p>Include <code class="filename">../../devel/GConf/schemas.mk</code>
1.87      wiz      9036:        instead of its <code class="filename">buildlink3.mk</code> file.  This
1.107     rillig   9037:        takes care of rebuilding the GConf database at installation and
1.87      wiz      9038:        deinstallation time, and tells the package where to install
1.107     rillig   9039:        GConf data files using some standard configure arguments.  It
1.87      wiz      9040:        also disallows any access to the database directly from the
                   9041:        package.</p></li>
1.128     wiz      9042: <li class="listitem"><p>Ensure that the package installs its
1.87      wiz      9043:        <code class="filename">.schemas</code> files under
                   9044:        <code class="filename">${PREFIX}/share/gconf/schemas</code>.  If they get
                   9045:        installed under <code class="filename">${PREFIX}/etc</code>, you will
                   9046:        need to manually patch the package.</p></li>
1.128     wiz      9047: <li class="listitem"><p>Check the PLIST and remove any entries under the etc/gconf
1.87      wiz      9048:        directory, as they will be handled automatically.  See
1.267     rillig   9049:        <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      9050: <li class="listitem"><p>Define the <code class="varname">GCONF_SCHEMAS</code> variable in
1.87      wiz      9051:        your <code class="filename">Makefile</code> with a list of all
                   9052:        <code class="filename">.schemas</code> files installed by the package, if
                   9053:        any.  Names must not contain any directories in them.</p></li>
1.128     wiz      9054: <li class="listitem"><p>Define the <code class="varname">GCONF_ENTRIES</code> variable in
1.87      wiz      9055:        your <code class="filename">Makefile</code> with a
                   9056:        list of all <code class="filename">.entries</code> files installed by the
                   9057:        package, if any. Names must not contain any directories in
                   9058:        them.</p></li>
1.75      rillig   9059: </ol></div>
                   9060: </div>
1.148     asau     9061: <div class="sect2">
1.75      rillig   9062: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   9063: <a name="scrollkeeper-data-files"></a>21.6.10. Packages installing scrollkeeper/rarian data files</h3></div></div></div>
1.87      wiz      9064: <p>If a package installs <code class="filename">.omf</code> files, used by
1.119     mishka   9065:     scrollkeeper/rarian, you need to take some extra steps to make sure they
1.87      wiz      9066:     get registered in the database:</p>
1.128     wiz      9067: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9068: <li class="listitem"><p>Include
1.119     mishka   9069:        <code class="filename">../../mk/omf-scrollkeeper.mk</code>
                   9070:        instead of rarian's <code class="filename">buildlink3.mk</code> file.  This
1.87      wiz      9071:        takes care of rebuilding the scrollkeeper database at
                   9072:        installation and deinstallation time, and disallows any access
                   9073:        to it directly from the package.</p></li>
1.128     wiz      9074: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.87      wiz      9075:        <code class="filename">libdata/scrollkeeper</code> directory, as they
                   9076:        will be handled automatically.</p></li>
1.128     wiz      9077: <li class="listitem"><p>Remove the <code class="filename">share/omf</code> directory from
1.119     mishka   9078:        the PLIST.  It will be handled by rarian. (<span class="command"><strong>make
                   9079:        print-PLIST</strong></span> does this automatically.)</p></li>
1.75      rillig   9080: </ol></div>
                   9081: </div>
1.148     asau     9082: <div class="sect2">
1.75      rillig   9083: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   9084: <a name="x11-fonts"></a>21.6.11. Packages installing X11 fonts</h3></div></div></div>
1.75      rillig   9085: <p>If a package installs font files, you will need to rebuild
1.87      wiz      9086:     the fonts database in the directory where they get installed at
                   9087:     installation and deinstallation time.  This can be automatically
                   9088:     done by using the pkginstall framework.</p>
1.75      rillig   9089: <p>You can list the directories where fonts are installed in the
1.87      wiz      9090:     <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
                   9091:     variables, where <em class="replaceable"><code>type</code></em> can be one of
1.128     wiz      9092:     <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      9093:     Also make sure that the database file
                   9094:     <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
1.75      rillig   9095: <p>Note that you should not create new directories for fonts;
1.87      wiz      9096:     instead use the standard ones to avoid that the user needs to
                   9097:     manually configure his X server to find them.</p>
1.75      rillig   9098: </div>
1.148     asau     9099: <div class="sect2">
1.75      rillig   9100: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   9101: <a name="gtk2-modules"></a>21.6.12. Packages installing GTK2 modules</h3></div></div></div>
1.75      rillig   9102: <p>If a package installs GTK2 immodules or loaders, you need to
1.87      wiz      9103:     take some extra steps to get them registered in the GTK2 database
                   9104:     properly:</p>
1.128     wiz      9105: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9106: <li class="listitem"><p>Include
1.87      wiz      9107:       <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
                   9108:       <code class="filename">buildlink3.mk</code> file.  This takes care of
                   9109:       rebuilding the database at installation and deinstallation time.</p></li>
1.128     wiz      9110: <li class="listitem"><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
1.87      wiz      9111:       your package installs GTK2 immodules.</p></li>
1.128     wiz      9112: <li class="listitem"><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
1.87      wiz      9113:       GTK2 loaders.</p></li>
1.128     wiz      9114: <li class="listitem">
1.87      wiz      9115: <p>Patch the package to not touch any of the GTK2
                   9116:       databases directly.  These are:</p>
1.148     asau     9117: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      9118: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
                   9119: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.75      rillig   9120: </ul></div>
                   9121: </li>
1.128     wiz      9122: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove
1.87      wiz      9123:       any entries under the <code class="filename">libdata/gtk-2.0</code>
                   9124:       directory, as they will be handled automatically.</p></li>
1.75      rillig   9125: </ol></div>
                   9126: </div>
1.148     asau     9127: <div class="sect2">
1.75      rillig   9128: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   9129: <a name="sgml-xml-data"></a>21.6.13. Packages installing SGML or XML data</h3></div></div></div>
1.75      rillig   9130: <p>If a package installs SGML or XML data files that need to be
1.87      wiz      9131:     registered in system-wide catalogs (like DTDs, sub-catalogs,
                   9132:     etc.), you need to take some extra steps:</p>
1.128     wiz      9133: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9134: <li class="listitem"><p>Include
1.87      wiz      9135:        <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
                   9136:        your <code class="filename">Makefile</code>, which takes care of
                   9137:        registering those files in system-wide catalogs at
                   9138:        installation and deinstallation time.</p></li>
1.128     wiz      9139: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.87      wiz      9140:        any SGML catalogs installed by the package.</p></li>
1.128     wiz      9141: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.87      wiz      9142:        any XML catalogs installed by the package.</p></li>
1.128     wiz      9143: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.87      wiz      9144:        to be added to the SGML catalog.  These come in groups of
                   9145:        three strings; see xmlcatmgr(1) for more information
                   9146:        (specifically, arguments recognized by the 'add' action).
                   9147:        Note that you will normally not use this variable.</p></li>
1.128     wiz      9148: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.87      wiz      9149:        to be added to the XML catalog.  These come in groups of three
                   9150:        strings; see xmlcatmgr(1) for more information (specifically,
                   9151:        arguments recognized by the 'add' action).  Note that you will
                   9152:        normally not use this variable.</p></li>
1.75      rillig   9153: </ol></div>
                   9154: </div>
1.148     asau     9155: <div class="sect2">
1.75      rillig   9156: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   9157: <a name="mime-database"></a>21.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
1.75      rillig   9158: <p>If a package provides extensions to the MIME database by
1.87      wiz      9159:     installing <code class="filename">.xml</code> files inside
                   9160:     <code class="filename">${PREFIX}/share/mime/packages</code>, you
                   9161:     need to take some extra steps to ensure that the database is kept
                   9162:     consistent with respect to these new files:</p>
1.128     wiz      9163: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9164: <li class="listitem"><p>Include
1.87      wiz      9165:        <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
                   9166:        (avoid using the <code class="filename">buildlink3.mk</code> file from
                   9167:        this same directory, which is reserved for inclusion from
                   9168:        other <code class="filename">buildlink3.mk</code> files).  It takes
                   9169:        care of rebuilding the MIME database at installation and
                   9170:        deinstallation time, and disallows any access to it directly
                   9171:        from the package.</p></li>
1.128     wiz      9172: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.87      wiz      9173:        <code class="filename">share/mime</code> directory,
                   9174:        <span class="emphasis"><em>except</em></span> for files saved under
                   9175:        <code class="filename">share/mime/packages</code>.  The former are
                   9176:        handled automatically by
                   9177:        the update-mime-database program, but the latter are
                   9178:        package-dependent and must be removed by the package that
                   9179:        installed them in the first place.</p></li>
1.128     wiz      9180: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.87      wiz      9181:        from the PLIST.  They will be handled by the shared-mime-info
                   9182:        package.</p></li>
1.75      rillig   9183: </ol></div>
                   9184: </div>
1.148     asau     9185: <div class="sect2">
1.75      rillig   9186: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   9187: <a name="intltool"></a>21.6.15. Packages using intltool</h3></div></div></div>
1.93      rillig   9188: <p>If a package uses intltool during its build, add
                   9189:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
1.87      wiz      9190:     which forces it to use the intltool package provided by pkgsrc,
                   9191:     instead of the one bundled with the distribution file.</p>
1.75      rillig   9192: <p>This tracks intltool's build-time dependencies and uses the
1.87      wiz      9193:     latest available version; this way, the package benefits of any
                   9194:     bug fixes that may have appeared since it was released.</p>
1.75      rillig   9195: </div>
1.148     asau     9196: <div class="sect2">
1.75      rillig   9197: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   9198: <a name="startup-scripts"></a>21.6.16. Packages installing startup scripts</h3></div></div></div>
1.75      rillig   9199: <p>If a package contains a rc.d script, it won't be copied into
1.87      wiz      9200:     the startup directory by default, but you can enable it, by adding
                   9201:     the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.110     hubertf  9202:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.87      wiz      9203:     into <code class="filename">/etc/rc.d</code> when a package is installed, and
                   9204:     it will automatically remove the scripts when the package is
                   9205:     deinstalled.</p>
1.75      rillig   9206: </div>
1.148     asau     9207: <div class="sect2">
1.75      rillig   9208: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   9209: <a name="tex-packages"></a>21.6.17. Packages installing TeX modules</h3></div></div></div>
1.75      rillig   9210: <p>If a package installs TeX packages into the texmf tree,
1.87      wiz      9211:     the <code class="filename">ls-R</code> database of the tree needs to be
                   9212:     updated.</p>
1.148     asau     9213: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   9214: <h3 class="title">Note</h3>
1.125     wiz      9215: <p>Except the main TeX packages such as kpathsea,
1.87      wiz      9216:     packages should install files
1.125     wiz      9217:     into <code class="filename">${PREFIX}/share/texmf-dist</code>,
                   9218:     not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.75      rillig   9219: </div>
1.128     wiz      9220: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9221: <li class="listitem"><p>Include
1.125     wiz      9222:       <code class="filename">../../print/kpathsea/texmf.mk</code>.  This
1.87      wiz      9223:       takes care of rebuilding the <code class="filename">ls-R</code>
                   9224:       database at installation and deinstallation time.</p></li>
1.128     wiz      9225: <li class="listitem">
1.75      rillig   9226: <p>If your package installs files into a texmf
1.87      wiz      9227:       tree other than the one
1.125     wiz      9228:       at <code class="filename">${PREFIX}/share/texmf-dist</code>,
                   9229:       set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.87      wiz      9230:       trees that need database update.</p>
1.75      rillig   9231: <p>If your package also installs font map files that need
1.110     hubertf  9232:       to be registered using <span class="command"><strong>updmap</strong></span>,
1.136     dholland 9233:       include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.125     wiz      9234:       set <code class="varname">TEX_MAP_FILES</code> and/or
                   9235:       <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.110     hubertf  9236:       such font map files.  Then <span class="command"><strong>updmap</strong></span> will
1.87      wiz      9237:       be run automatically at installation/deinstallation to
                   9238:       enable/disable font map files for TeX output
                   9239:       drivers.</p>
1.75      rillig   9240: </li>
1.128     wiz      9241: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.87      wiz      9242:       databases are included in <code class="filename">PLIST</code>, as
1.136     dholland 9243:       they will be removed only by the kpathsea package.</p></li>
1.75      rillig   9244: </ol></div>
                   9245: </div>
1.148     asau     9246: <div class="sect2">
1.85      jmmv     9247: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   9248: <a name="emulation-packages"></a>21.6.18. Packages supporting running binaries in
1.87      wiz      9249:     emulation</h3></div></div></div>
                   9250: <p>There are some packages that provide libraries and
                   9251:     executables for running binaries from a one operating system
                   9252:     on a different one (if the latter supports it).  One example
                   9253:     is running Linux binaries on NetBSD.</p>
1.250     leot     9254: <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      9255:     helps in extracting and packaging Linux rpm packages.</p>
                   9256: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.110     hubertf  9257:     avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.87      wiz      9258:     if all libraries for each installed executable can be found by
                   9259:     the dynamic linker.  Since the standard dynamic linker is run,
                   9260:     this fails for emulation packages, because the libraries used
                   9261:     by the emulation are not in the standard directories.</p>
                   9262: </div>
1.299     rillig   9263: <div class="sect2">
                   9264: <div class="titlepage"><div><div><h3 class="title">
                   9265: <a name="hicolor-theme"></a>21.6.19. Packages installing hicolor theme icons</h3></div></div></div>
                   9266: <p>If a package installs images under the
                   9267:     <code class="filename">share/icons/hicolor</code> and/or updates the
                   9268:     <code class="filename">share/icons/hicolor/icon-theme.cache</code>
                   9269:     database, you need to take some extra steps to make sure that the
                   9270:     shared theme directory is handled appropriately and that the cache
                   9271:     database is rebuilt:</p>
                   9272: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9273: <li class="listitem"><p>Include
                   9274:        <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
                   9275: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
                   9276:        entry that refers to the theme cache.</p></li>
                   9277: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
                   9278:          directories from the <code class="filename">share/icons/hicolor</code>
                   9279:          hierarchy because they will be handled automatically.</p></li>
                   9280: </ol></div>
                   9281: <p>The best way to verify that the PLIST is correct with
                   9282:       respect to the last two points is to regenerate it using
                   9283:       <span class="command"><strong>make print-PLIST</strong></span>.</p>
                   9284: </div>
                   9285: <div class="sect2">
                   9286: <div class="titlepage"><div><div><h3 class="title">
                   9287: <a name="desktop-files"></a>21.6.20. Packages installing desktop files</h3></div></div></div>
                   9288: <p>If a package installs <code class="filename">.desktop</code> files
                   9289:       under <code class="filename">share/applications</code> and these include
                   9290:       MIME information (MimeType key), you need to take extra steps to
                   9291:       ensure that they are registered into the MIME database:</p>
                   9292: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9293: <li class="listitem"><p>Include
                   9294:          <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
                   9295: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
                   9296:          <code class="filename">share/applications/mimeinfo.cache</code> file.
                   9297:          It will be handled automatically.</p></li>
                   9298: </ol></div>
                   9299: <p>The best way to verify that the PLIST is correct with
                   9300:       respect to the last point is to regenerate it using <span class="command"><strong>make
                   9301:       print-PLIST</strong></span>.</p>
                   9302: </div>
                   9303: </div>
                   9304: <div class="sect1">
                   9305: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   9306: <a name="punting"></a>21.7. Marking packages as having problems</h2></div></div></div>
                   9307: <p>In some cases one does not have the time to solve a problem
                   9308:   immediately. In this case, one can plainly mark a package as broken.  For
                   9309:   this, one just sets the variable <code class="varname">BROKEN</code> to the
                   9310:   reason why the package is broken (similar to the
                   9311:   <code class="varname">PKG_FAIL_REASON</code> variable).  A user trying to build
                   9312:   the package will immediately be shown this message, and the build
                   9313:   will not be even tried.</p>
                   9314: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
                   9315:   intervals.</p>
                   9316: </div>
                   9317: </div>
                   9318: <div class="chapter">
                   9319: <div class="titlepage"><div><div><h2 class="title">
                   9320: <a name="gnome"></a>Chapter 22. GNOME packaging and porting</h2></div></div></div>
                   9321: <div class="toc">
                   9322: <p><b>Table of Contents</b></p>
                   9323: <dl class="toc">
                   9324: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
                   9325: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
                   9326: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
                   9327: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
                   9328: </dl>
                   9329: </div>
                   9330: <p>Quoting <a class="ulink" href="https://www.gnome.org/" target="_top">GNOME's web
                   9331: site</a>:</p>
                   9332: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
                   9333:   environment, an intuitive and attractive desktop for users, and the
                   9334:   GNOME development platform, an extensive framework for building
                   9335:   applications that integrate into the rest of the desktop.</p></blockquote></div>
                   9336: <p>pkgsrc provides a seamless way to automatically build and install
                   9337: a complete GNOME environment <span class="emphasis"><em>under many different
                   9338: platforms</em></span>.  We can say with confidence that pkgsrc is one of
                   9339: the most advanced build and packaging systems for GNOME due to its
                   9340: included technologies buildlink3, the wrappers and tools framework and
                   9341: automatic configuration file management.  Lots of efforts are put into
                   9342: achieving a completely clean deinstallation of installed software
                   9343: components.</p>
                   9344: <p>Given that pkgsrc is <a class="ulink" href="https://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
                   9345: the above also means that great efforts are put into making GNOME work
                   9346: under this operating system.  Recently, <a class="ulink" href="https://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
                   9347: pkgsrc as its preferred packaging system, contributing lots of
                   9348: portability fixes to make GNOME build and install under it.</p>
                   9349: <p>This chapter is aimed at pkgsrc developers and other people
                   9350: interested in helping our GNOME porting and packaging efforts.  It
                   9351: provides instructions on how to manage the existing packages and some
                   9352: important information regarding their internals.</p>
                   9353: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   9354: <h3 class="title">We need your help!</h3>
                   9355: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
                   9356:   and GNOME and are willing to learn new exciting stuff, please jump
                   9357:   straight to the <a class="ulink" href="https://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
                   9358:   work</a> list!  There is still a long way to go to get a
                   9359:   fully-functional GNOME desktop under NetBSD and we need your help to
                   9360:   achieve it!</p>
                   9361: </div>
                   9362: <div class="sect1">
                   9363: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   9364: <a name="meta-packages"></a>22.1. Meta packages</h2></div></div></div>
                   9365: <p>pkgsrc includes three GNOME-related meta packages:</p>
                   9366: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   9367: <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
                   9368:     the core GNOME desktop environment.  It only includes the necessary
                   9369:     bits to get it to boot correctly, although it may lack important
                   9370:     functionality for daily operation.  The idea behind this package is
                   9371:     to let end users build their own configurations on top of this one,
                   9372:     first installing this meta package to achieve a functional setup and
                   9373:     then adding individual applications.</p></li>
                   9374: <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
                   9375:     complete installation of the GNOME platform and desktop as defined
                   9376:     by the GNOME project; this is based on the components distributed in
                   9377:     the <code class="filename">platform/x.y/x.y.z/sources</code> and
                   9378:     <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
                   9379:     official FTP server.  Developer-only tools found in those
                   9380:     directories are not installed unless required by some other
                   9381:     component to work properly.  Similarly, packages from the bindings
                   9382:     set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
                   9383:     in unless required as a dependency for an end-user component.  This
                   9384:     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>
                   9385: <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>:
                   9386:     Installs all the tools required to build a GNOME component when
                   9387:     fetched from the CVS repository.  These are required to let the
                   9388:     <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
                   9389: </ul></div>
                   9390: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
                   9391: sorted in a way that eases updates: a package may depend on other
                   9392: packages listed before it but not on any listed after it.  It is very
                   9393: important to keep this order to ease updates so... <span class="emphasis"><em>do not
                   9394: change it to alphabetical sorting!</em></span></p>
                   9395: </div>
                   9396: <div class="sect1">
                   9397: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   9398: <a name="new-package"></a>22.2. Packaging a GNOME application</h2></div></div></div>
                   9399: <p>Almost all GNOME applications are written in C and use a common
                   9400: set of tools as their build system.  Things get different with the new
                   9401: bindings to other languages (such as Python), but the following will
                   9402: give you a general idea on the minimum required tools:</p>
                   9403: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   9404: <li class="listitem">
                   9405: <p>Almost all GNOME applications use the GNU Autotools as their
                   9406:     build system.  As a general rule you will need to tell this to your
                   9407:     package:</p>
                   9408: <pre class="programlisting">
                   9409: GNU_CONFIGURE=yes
                   9410: USE_LIBTOOL=yes
                   9411: USE_TOOLS+=gmake
                   9412: </pre>
                   9413: </li>
                   9414: <li class="listitem">
                   9415: <p>If the package uses pkg-config to detect dependencies, add this
                   9416:     tool to the list of required utilities:</p>
                   9417: <pre class="programlisting">
                   9418: USE_TOOLS+=pkg-config
                   9419: </pre>
                   9420: <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
                   9421:     the end of the build process to ensure that you did not miss to
                   9422:     specify any dependency in your package and that the version
                   9423:     requirements are all correct.</p>
                   9424: </li>
                   9425: <li class="listitem"><p>If the package uses intltool, be sure to add
                   9426:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
                   9427:     to handle dependencies and to force the package to use the latest
                   9428:     available version.</p></li>
                   9429: <li class="listitem">
                   9430: <p>If the package uses gtk-doc (a documentation generation
                   9431:     utility), do <span class="emphasis"><em>not</em></span> add a dependency on it.  The
                   9432:     tool is rather big and the distfile should come with pregenerated
                   9433:     documentation anyway; if it does not, it is a bug that you ought to
                   9434:     report.  For such packages you should disable gtk-doc (unless it is
                   9435:     the default):</p>
                   9436: <pre class="programlisting">
                   9437: CONFIGURE_ARGS+=--disable-gtk-doc
                   9438: </pre>
                   9439: <p>The default location of installed HTML files
                   9440:     (<code class="filename">share/gtk-doc/&lt;package-name&gt;</code>) is correct
                   9441:     and should not be changed unless the package insists on installing
                   9442:     them somewhere else.  Otherwise programs as
                   9443:     <span class="command"><strong>devhelp</strong></span> will not be able to open them.  You can
                   9444:     do that with an entry similar to:</p>
                   9445: <pre class="programlisting">
                   9446: CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...
                   9447: </pre>
                   9448: </li>
                   9449: </ul></div>
                   9450: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
                   9451: files under the installation prefix to maintain databases.  In this
                   9452: context, shared means that those exact same directories and files are
                   9453: used among several different packages, leading to conflicts in the
                   9454: <code class="filename">PLIST</code>.  pkgsrc currently includes functionality to
                   9455: handle the most common cases, so you have to forget about using
                   9456: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
                   9457: omitting shared files from them.  If you find yourself doing those,
                   9458: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
                   9459: <p>The following table lists the common situations that result in
                   9460: using shared directories or files.  For each of them, the appropriate
                   9461: solution is given.  After applying the solution be sure to
                   9462: <span class="emphasis"><em>regenerate the package's file list</em></span> with
                   9463: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
                   9464: <div class="table">
                   9465: <a name="plist-handling"></a><p class="title"><b>Table 22.1. PLIST handling for GNOME packages</b></p>
                   9466: <div class="table-contents"><table class="table" summary="PLIST handling for GNOME packages" border="1">
                   9467: <colgroup>
                   9468: <col>
                   9469: <col>
                   9470: </colgroup>
                   9471: <thead><tr>
                   9472: <th>If the package...</th>
                   9473: <th>Then...</th>
                   9474: </tr></thead>
                   9475: <tbody>
                   9476: <tr>
                   9477: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
                   9478: <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>
                   9479: </tr>
                   9480: <tr>
                   9481: <td>Installs icons under the
                   9482:         <code class="filename">share/icons/hicolor</code> hierarchy or updates
                   9483:         <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
                   9484: <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>
                   9485: </tr>
                   9486: <tr>
                   9487: <td>Installs files under
                   9488:         <code class="filename">share/mime/packages</code>.</td>
                   9489: <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>
                   9490: </tr>
                   9491: <tr>
                   9492: <td>Installs <code class="filename">.desktop</code> files under
                   9493:         <code class="filename">share/applications</code> and these include MIME
                   9494:         information.</td>
                   9495: <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>
                   9496: </tr>
                   9497: </tbody>
                   9498: </table></div>
1.75      rillig   9499: </div>
1.299     rillig   9500: <br class="table-break">
1.75      rillig   9501: </div>
1.148     asau     9502: <div class="sect1">
1.87      wiz      9503: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   9504: <a name="full-update"></a>22.3. Updating GNOME to a newer version</h2></div></div></div>
                   9505: <p>When seeing GNOME as a whole, there are two kinds of
                   9506: updates:</p>
                   9507: <div class="variablelist"><dl class="variablelist">
                   9508: <dt><span class="term">Major update</span></dt>
                   9509: <dd>
                   9510: <p>Given that there is still a very long way for GNOME 3 (if it
                   9511:       ever appears), we consider a major update one that goes from a
                   9512:       <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
                   9513:       where <code class="literal">Y</code> is even and greater than
                   9514:       <code class="literal">X</code>.  These are hard to achieve because they
                   9515:       introduce lots of changes in the components' code and almost all
                   9516:       GNOME distfiles are updated to newer versions.  Some of them can
                   9517:       even break API and ABI compatibility with the previous major
                   9518:       version series.  As a result, the update needs to be done all at
                   9519:       once to minimize breakage.</p>
                   9520: <p>A major update typically consists of around 80 package
                   9521:       updates and the addition of some new ones.</p>
                   9522: </dd>
                   9523: <dt><span class="term">Minor update</span></dt>
                   9524: <dd>
                   9525: <p>We consider a minor update one that goes from a
                   9526:       <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
                   9527:       one where <code class="literal">Y</code> is greater than
                   9528:       <code class="literal">X</code>.  These are easy to achieve because they do
                   9529:       not update all GNOME components, can be done in an incremental way
                   9530:       and do not break API nor ABI compatibility.</p>
                   9531: <p>A minor update typically consists of around 50 package
                   9532:       updates, although the numbers here may vary a lot.</p>
                   9533: </dd>
                   9534: </dl></div>
                   9535: <p>In order to update the GNOME components in pkgsrc to a new stable
                   9536: release (either major or minor), the following steps should be
                   9537: followed:</p>
                   9538: <div class="orderedlist"><ol class="orderedlist" type="1">
1.128     wiz      9539: <li class="listitem">
1.299     rillig   9540: <p>Get a list of all the tarballs that form the new release by
                   9541:     using the following commands.  These will leave the full list of the
                   9542:     components' distfiles into the <code class="filename">list.txt</code>
                   9543:     file:</p>
                   9544: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
                   9545:     ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
                   9546:     awk '{ print $9 }' &gt;list.txt</code></strong>
                   9547: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
                   9548:     ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
                   9549:     awk '{ print $9 }' &gt;&gt;list.txt</code></strong></pre>
1.75      rillig   9550: </li>
1.299     rillig   9551: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
                   9552:     bump their version to the release you are updating them to.  The
                   9553:     three meta packages should be always consistent with versioning.
                   9554:     Obviously remove any <code class="varname">PKGREVISION</code>s that might be
                   9555:     in them.</p></li>
1.128     wiz      9556: <li class="listitem">
1.299     rillig   9557: <p>For each meta package, update all its
                   9558:     <code class="varname">DEPENDS</code> lines to match the latest versions as
                   9559:     shown by the above commands.  Do <span class="emphasis"><em>not</em></span> list any
                   9560:     newer version (even if found in the FTP) because the meta packages
                   9561:     are supposed to list the exact versions that form a specific GNOME
                   9562:     release.  Exceptions are permitted here if a newer version solves a
                   9563:     serious issue in the overall desktop experience; these typically
                   9564:     come in the form of a revision bump in pkgsrc, not in newer versions
                   9565:     from the developers.</p>
                   9566: <p>Packages not listed in the <code class="filename">list.txt</code> file
                   9567:     should be updated to the latest version available (if found in
                   9568:     pkgsrc).  This is the case, for example, of the dependencies on the
                   9569:     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   9570: </li>
1.128     wiz      9571: <li class="listitem">
1.299     rillig   9572: <p>Generate a patch from the modified meta packages and extract the
                   9573:     list of "new" lines.  This will provide you an outline on what
                   9574:     packages need to be updated in pkgsrc and in what order:</p>
                   9575: <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   9576: </li>
1.299     rillig   9577: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
                   9578:     installed packages and start over from scratch at this point.</p></li>
                   9579: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
                   9580:     of <code class="filename">todo.txt</code> and update the packages listed in
                   9581:     it in order.  For major desktop updates none of these should be
                   9582:     committed until the entire set is completed because there are chances
                   9583:     of breaking not-yet-updated packages.</p></li>
                   9584: <li class="listitem"><p>Once the packages are up to date and working, commit them to
                   9585:     the tree one by one with appropriate log messages.  At the end,
                   9586:     commit the three meta package updates and all the corresponding
                   9587:     changes to the <code class="filename">doc/CHANGES-&lt;YEAR&gt;</code> and
                   9588:     <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>
                   9589: </ol></div>
                   9590: </div>
                   9591: <div class="sect1">
                   9592: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   9593: <a name="patching"></a>22.4. Patching guidelines</h2></div></div></div>
                   9594: <p>GNOME is a very big component in pkgsrc which approaches 100
                   9595: packages.  Please, it is very important that you always, always,
                   9596: <span class="strong"><strong>always</strong></span> feed back any portability
                   9597: 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
                   9598: their attention on portability issues and to ensure that future versions
                   9599: can be built out-of-the box on NetBSD.  The less custom patches in
                   9600: pkgsrc, the easier further updates are.  Those developers in charge of
                   9601: issuing major GNOME updates will be grateful if you do that.</p>
                   9602: <p>The most common places to report bugs are the <a class="ulink" href="https://bugzilla.gnome.org/" target="_top">GNOME's Bugzilla</a> and the <a class="ulink" href="https://bugzilla.freedesktop.org/" target="_top">freedesktop.org's
                   9603: Bugzilla</a>.  Not all components use these to track bugs, but most
                   9604: of them do.  Do not be short on your reports: always provide detailed
                   9605: explanations of the current failure, how it can be improved to achieve
                   9606: maximum portability and, if at all possible, provide a patch against CVS
                   9607: head.  The more verbose you are, the higher chances of your patch being
                   9608: accepted.</p>
                   9609: <p>Also, please avoid using preprocessor magic to fix portability
                   9610: issues.  While the FreeBSD GNOME people are doing a great job in porting
                   9611: GNOME to their operating system, the official GNOME sources are now
                   9612: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
                   9613: and similar macros.  This hurts portability.  Please see our patching
                   9614: 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
                   9615: details.</p>
                   9616: </div>
1.75      rillig   9617: </div>
1.148     asau     9618: <div class="chapter">
1.75      rillig   9619: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   9620: <a name="submit"></a>Chapter 23. Submitting and Committing</h2></div></div></div>
1.75      rillig   9621: <div class="toc">
                   9622: <p><b>Table of Contents</b></p>
1.210     leot     9623: <dl class="toc">
1.267     rillig   9624: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
                   9625: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   9626: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
                   9627: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
                   9628: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
                   9629: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
                   9630: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
                   9631: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
1.75      rillig   9632: </dl>
                   9633: </div>
1.148     asau     9634: <div class="sect1">
1.75      rillig   9635: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9636: <a name="submitting-binary-packages"></a>23.1. Submitting binary packages</h2></div></div></div>
1.75      rillig   9637: <p>Our policy is that we accept binaries only from pkgsrc
                   9638:        developers to guarantee that the packages don't contain any
                   9639:        trojan horses etc. This is not to annoy anyone but rather to
                   9640:        protect our users! You're still free to put up your home-made
                   9641:        binary packages and tell the world where to get them. NetBSD
                   9642:        developers doing bulk builds and wanting to upload them please
1.267     rillig   9643:        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     9644: builds)</i></a>.</p>
1.75      rillig   9645: </div>
1.148     asau     9646: <div class="sect1">
1.75      rillig   9647: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9648: <a name="submitting-your-package"></a>23.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.75      rillig   9649: <p>First, check that your package is complete, compiles and
1.299     rillig   9650:        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.289     leot     9651:        document. Next, generate an uuencoded gzipped <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?tar+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a>
1.82      rillig   9652:        archive that contains all files that make up the package.
1.87      wiz      9653:        Finally, send this package to the pkgsrc bug tracking system,
1.289     leot     9654:        either with the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> command, or if you don't have
1.87      wiz      9655:        that, go to the web page
1.289     leot     9656:        <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      9657:        which contains some instructions and a link to a form where you
                   9658:        can submit packages.  The
1.250     leot     9659:        <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      9660:        also available as a substitute for either of the above two tools.
                   9661:        </p>
1.87      wiz      9662: <p>In the form of the problem report, the category should be
1.128     wiz      9663:        <span class="quote">&#8220;<span class="quote">pkg</span>&#8221;</span>, the synopsis should include the package name
1.87      wiz      9664:        and version number, and the description field should contain a
                   9665:        short description of your package (contents of the COMMENT
                   9666:        variable or DESCR file are OK). The uuencoded package data should
1.128     wiz      9667:        go into the <span class="quote">&#8220;<span class="quote">fix</span>&#8221;</span> field.</p>
1.75      rillig   9668: <p>If you want to submit several packages, please send a
                   9669:        separate PR for each one, it's easier for us to track things
                   9670:        that way.</p>
                   9671: <p>Alternatively, you can also import new packages into
1.128     wiz      9672:        pkgsrc-wip (<span class="quote">&#8220;<span class="quote">pkgsrc work-in-progress</span>&#8221;</span>); see the
1.289     leot     9673:        homepage at <a class="ulink" href="https://pkgsrc.org/wip/" target="_top">https://pkgsrc.org/wip/</a>
1.75      rillig   9674:        for details.</p>
                   9675: </div>
1.148     asau     9676: <div class="sect1">
1.75      rillig   9677: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9678: <a name="general-notes-for-changes"></a>23.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.75      rillig   9679: <p>Please note all package additions, updates, moves, and
1.93      rillig   9680:        removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
1.75      rillig   9681:        important to keep this file up to date and conforming to the
                   9682:        existing format, because it will be used by scripts to
1.289     leot     9683:        automatically update pages on <a class="ulink" href="https://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.75      rillig   9684:        sites. Additionally, check the
1.76      rillig   9685:        <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
1.75      rillig   9686:        for the package you updated or removed, in case it was mentioned
                   9687:        there.</p>
                   9688: <p>When the <code class="varname">PKGREVISION</code> of a package is
                   9689:        bumped, the change should appear in
1.93      rillig   9690:        <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
1.75      rillig   9691:        related or otherwise relevant. Mass bumps that result from a
                   9692:        dependency being updated should not be mentioned. In all other
                   9693:        cases it's the developer's decision.</p>
                   9694: <p>There is a make target that helps in creating proper
1.110     hubertf  9695:   <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries:  <span class="command"><strong>make
1.75      rillig   9696:   changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
                   9697:   and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
1.93      rillig   9698:   usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
1.75      rillig   9699:   file is up-to-date (to avoid having to resolve conflicts later-on)
1.110     hubertf  9700:   and then to <span class="command"><strong>cd</strong></span> to the package directory.  For
                   9701:   package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.75      rillig   9702:   For new packages, or package moves or removals, set the
                   9703:   <code class="varname">CTYPE</code> variable on the command line to "Added",
                   9704:   "Moved", or "Removed".  You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.110     hubertf  9705:   in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.125     wiz      9706:   not the same as your NetBSD login name. The target also automatically
                   9707:   removes possibly existing entries for the package in the
                   9708:   <code class="filename">TODO</code> file. Don't forget to commit
1.174     asau     9709:   the changes, e.g. by using <span class="command"><strong>make commit-changes-entry</strong></span>!
1.126     jakllsch 9710:   If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
1.125     wiz      9711:   a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
                   9712:   makes the cvs commands use the main repository.
                   9713:   </p>
1.75      rillig   9714: </div>
1.148     asau     9715: <div class="sect1">
1.75      rillig   9716: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9717: <a name="commit-messages"></a>23.4. Commit Messages</h2></div></div></div>
1.243     wiz      9718: <p>For several years, there have been mirrors of pkgsrc in
                   9719:   fossil, git, and hg. Standard practise when using these tools is to
                   9720:   make the first line of a commit message function as a summary that
                   9721:   can be read without the rest, such as is commonly done with "git log
                   9722:   --oneline". For this reason, we have the following guidelines for
                   9723:   pkgsrc commit messages:</p>
                   9724: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   9725: <li class="listitem"><p>Start the commit message with a line that explains the
1.244     wiz      9726:     big picture in 65 characters or less. When a commit is for one
1.243     wiz      9727:     package, include the name of the package. For updates, include the
                   9728:     version to which it is updated.</p></li>
                   9729: <li class="listitem"><p>Leave the next line empty.</p></li>
                   9730: <li class="listitem"><p>Then come the details for the commit (changes in that
                   9731:     package, reason for a change) and any relevant PRs. Wrap this
                   9732:     section.</p></li>
                   9733: </ul></div>
                   9734: <p>Here is an example:
                   9735:   </p>
                   9736: <pre class="programlisting">
                   9737:   libxslt: update to 1.0.30
                   9738: 
                   9739:   Changes since 1.0.29:
                   9740:   ...
                   9741:   </pre>
                   9742: <p>
                   9743:   </p>
                   9744: <p>Here is another example:
                   9745:   </p>
                   9746: <pre class="programlisting">
                   9747:   mk/bsd.pkg.mk: enable SSP by default on NetBSD
                   9748: 
                   9749:   (rationale)
                   9750:   </pre>
                   9751: <p>
                   9752:   </p>
                   9753: <p>Commit messages are final: no <span class="quote">&#8220;<span class="quote">cvs admin</span>&#8221;</span> is
                   9754:   allowed on the pkgsrc repository to change commit messages.</p>
                   9755: </div>
                   9756: <div class="sect1">
                   9757: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9758: <a name="committing-importing"></a>23.5. Committing: Adding a package to CVS</h2></div></div></div>
1.87      wiz      9759: <p>This section is only of interest for pkgsrc developers with write
1.140     wiz      9760:   access to the pkgsrc repository.</p>
                   9761: <p>When the package is finished, <span class="quote">&#8220;<span class="quote">cvs add</span>&#8221;</span> the files.
                   9762: Start by adding the directory and then files in the directory. Don't
                   9763: forget to add the new package to the category's
                   9764: <code class="filename">Makefile</code>. Make sure you don't forget any files;
                   9765: you can check by running <span class="quote">&#8220;<span class="quote">cvs status</span>&#8221;</span>. An example:</p>
                   9766: <pre class="programlisting">
                   9767: <code class="prompt">$</code> cd .../pkgsrc/category
                   9768: <code class="prompt">$</code> cvs add pkgname
                   9769: <code class="prompt">$</code> cd pkgname
                   9770: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
                   9771: <code class="prompt">$</code> cvs add patches/p*
                   9772: <code class="prompt">$</code> cvs status | less
1.141     wiz      9773: <code class="prompt">$</code> cvs commit
1.140     wiz      9774: <code class="prompt">$</code> cd ..
                   9775: <code class="prompt">$</code> vi Makefile # add SUBDIRS+=pkgname line
1.141     wiz      9776: <code class="prompt">$</code> cvs commit Makefile
1.174     asau     9777: <code class="prompt">$</code> cd pkgname
1.182     jnemeth  9778: <code class="prompt">$</code> make CTYPE=Added commit-changes-entry
1.140     wiz      9779: </pre>
1.87      wiz      9780: <p>The commit message of the initial import should include part of the
1.76      rillig   9781:   <code class="filename">DESCR</code> file, so people reading the mailing lists know
1.87      wiz      9782:   what the package is/does.</p>
1.140     wiz      9783: <p>Also mention the new package in
                   9784: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
                   9785: <p>Previously, <span class="quote">&#8220;<span class="quote">cvs import</span>&#8221;</span> was suggested, but it was
                   9786: much easier to get wrong than <span class="quote">&#8220;<span class="quote">cvs add</span>&#8221;</span>.</p>
1.75      rillig   9787: </div>
1.148     asau     9788: <div class="sect1">
1.75      rillig   9789: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9790: <a name="updating-package"></a>23.6. Updating a package to a newer version</h2></div></div></div>
1.87      wiz      9791: <p>Please always put a concise, appropriate and relevant summary of the
1.75      rillig   9792:   changes between old and new versions into the commit log when updating
1.87      wiz      9793:   a package. There are various reasons for this:</p>
1.148     asau     9794: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      9795: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.87      wiz      9796:   or its information may be overwritten by newer information.</p></li>
1.128     wiz      9797: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.87      wiz      9798:   repository is very useful for people who use either cvs or anoncvs.</p></li>
1.128     wiz      9799: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.75      rillig   9800:   repository is very useful for people who read the pkgsrc-changes mailing
                   9801:   list, so that they can make tactical decisions about when to upgrade
1.87      wiz      9802:   the package.</p></li>
1.75      rillig   9803: </ul></div>
1.87      wiz      9804: <p>Please also recognize that, just because a new version of a package
1.75      rillig   9805:   has been released, it should not automatically be upgraded in the CVS
                   9806:   repository.  We prefer to be conservative in the packages that are
                   9807:   included in pkgsrc - development or beta packages are not really the
                   9808:   best thing for most places in which pkgsrc is used. Please use your
                   9809:   judgement about what should go into pkgsrc, and bear in mind that
1.87      wiz      9810:   stability is to be preferred above new and possibly untested features.</p>
1.75      rillig   9811: </div>
1.148     asau     9812: <div class="sect1">
1.75      rillig   9813: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9814: <a name="renaming-package"></a>23.7. Renaming a package in pkgsrc</h2></div></div></div>
1.122     reed     9815: <p>Renaming packages is not recommended.</p>
1.290     gutterid 9816: <p>When renaming packages, be sure to fix any references to the old name
1.122     reed     9817:   in other Makefiles, options, buildlink files, etc.</p>
1.282     leot     9818: <p>
1.290     gutterid 9819:   Also, when renaming a package, please add
1.282     leot     9820:   the package name and version pattern(s) of the previous package
                   9821:   to <code class="varname">SUPERSEDES</code>.
1.122     reed     9822:   This may be repeated for multiple renames.
                   9823:   The new package would be an exact replacement.
1.282     leot     9824:   Example:
1.122     reed     9825: </p>
1.282     leot     9826: <pre class="programlisting">
                   9827: SUPERSEDES+=    p5-IO-Compress-Zlib&lt;2.017
                   9828: SUPERSEDES+=    optcomp-[0-9]*
                   9829: </pre>
1.128     wiz      9830: <p>Note that <span class="quote">&#8220;<span class="quote">successor</span>&#8221;</span> in the
1.122     reed     9831:   CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
                   9832:   mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
                   9833:   not be an exact replacement but is a suggestion for the replaced
                   9834:   functionality.</p>
                   9835: </div>
1.148     asau     9836: <div class="sect1">
1.122     reed     9837: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9838: <a name="moving-package"></a>23.8. Moving a package in pkgsrc</h2></div></div></div>
1.122     reed     9839: <p>It is preferred that packages are not renamed or moved, but if needed
                   9840:   please follow these steps.
                   9841: </p>
1.128     wiz      9842: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9843: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
                   9844: <li class="listitem">
1.75      rillig   9845: <p>Remove all CVS dirs.</p>
1.87      wiz      9846: <p>Alternatively to the first two steps you can also do:</p>
1.75      rillig   9847: <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      9848: <p>and use that for further work.</p>
1.75      rillig   9849: </li>
1.128     wiz      9850: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
                   9851: <code class="varname">DEPENDS</code> paths that just did <span class="quote">&#8220;<span class="quote">../package</span>&#8221;</span>
                   9852: instead of <span class="quote">&#8220;<span class="quote">../../category/package</span>&#8221;</span>.</p></li>
                   9853: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.122     reed     9854: <code class="varname">PREV_PKGPATH</code> to the previous category/package
                   9855: pathname.  The <code class="varname">PREV_PKGPATH</code> can be used by tools
                   9856: for doing an update using pkgsrc building; for example, it can
1.289     leot     9857: search the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_summary+5.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_summary</span>(5)</span></a> database for <code class="varname">PREV_PKGPATH</code>
1.122     reed     9858: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
                   9859: new <code class="varname">PKGPATH</code> for that moved package.  Note that
                   9860: it may have multiple matches, so the tool should also check on the
                   9861: <code class="varname">PKGBASE</code> too.  The <code class="varname">PREV_PKGPATH</code>
                   9862: probably has no value unless <code class="varname">SUPERSEDES</code> is not
                   9863: set, i.e.  <code class="varname">PKGBASE</code> stays the same.  </p></li>
1.128     wiz      9864: <li class="listitem"><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.75      rillig   9865: place.</p></li>
1.128     wiz      9866: <li class="listitem">
1.75      rillig   9867: <p>Check if any package depends on it:
                   9868: </p>
                   9869: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   9870: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
                   9871: </li>
1.128     wiz      9872: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
                   9873: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
                   9874: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
                   9875: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
                   9876: <li class="listitem">
1.75      rillig   9877: <p>Commit the changed and removed files:</p>
                   9878: <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      9879: <p>(and any packages from step 5, of course).</p>
1.75      rillig   9880: </li>
                   9881: </ol></div>
                   9882: </div>
                   9883: </div>
1.148     asau     9884: <div class="chapter">
1.75      rillig   9885: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   9886: <a name="devfaq"></a>Chapter 24. Frequently Asked Questions</h2></div></div></div>
1.75      rillig   9887: <p>This section contains the answers to questions that may
                   9888:        arise when you are writing a package. If you don't find your
                   9889:        question answered here, first have a look in the other chapters,
                   9890:        and if you still don't have the answer, ask on the
                   9891:        <code class="literal">pkgsrc-users</code> mailing list.</p>
1.148     asau     9892: <div class="qandaset">
1.289     leot     9893: <a name="devfaq.qandaset"></a><dl>
1.267     rillig   9894: <dt>24.1. <a href="#devfaq.makeflags">What is the difference between
1.75      rillig   9895:        MAKEFLAGS, .MAKEFLAGS and
                   9896:        MAKE_FLAGS?</a>
                   9897: </dt>
1.267     rillig   9898: <dt>24.2. <a href="#devfaq.make">What is the difference between
1.75      rillig   9899:        MAKE, GMAKE and
                   9900:        MAKE_PROGRAM?</a>
                   9901: </dt>
1.267     rillig   9902: <dt>24.3. <a href="#devfaq.cc">What is the difference between
1.75      rillig   9903:        CC, PKG_CC and
                   9904:        PKGSRC_COMPILER?</a>
                   9905: </dt>
1.267     rillig   9906: <dt>24.4. <a href="#devfaq.bl3flags">What is the difference between
1.75      rillig   9907:        BUILDLINK_LDFLAGS,
                   9908:        BUILDLINK_LDADD and
                   9909:        BUILDLINK_LIBS?</a>
                   9910: </dt>
1.267     rillig   9911: <dt>24.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.75      rillig   9912:        VARNAME=BUILDLINK_PREFIX.foo
                   9913:        say it's empty?</a>
                   9914: </dt>
1.267     rillig   9915: <dt>24.6. <a href="#devfaq.master_sites">What does
1.78      rillig   9916:        ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
                   9917:        don't understand the := inside
                   9918:        it.</a>
                   9919: </dt>
1.267     rillig   9920: <dt>24.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.78      rillig   9921:        developers?</a>
                   9922: </dt>
1.267     rillig   9923: <dt>24.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.80      rillig   9924:        documentation?</a>
                   9925: </dt>
1.289     leot     9926: <dt>24.9. <a href="#devfaq.too-much-time">I have a little time to kill. 
                   9927: What shall I do?</a>
1.92      rillig   9928: </dt>
1.75      rillig   9929: </dl>
1.148     asau     9930: <table border="0" style="width: 100%;">
                   9931: <colgroup>
1.75      rillig   9932: <col align="left" width="1%">
1.128     wiz      9933: <col>
1.148     asau     9934: </colgroup>
1.75      rillig   9935: <tbody>
1.148     asau     9936: <tr class="question">
1.75      rillig   9937: <td align="left" valign="top">
1.289     leot     9938: <a name="devfaq.makeflags"></a><a name="devfaq.makeflags.q"></a><p><b>24.1.</b></p>
1.75      rillig   9939: </td>
                   9940: <td align="left" valign="top"><p>What is the difference between
                   9941:        <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
                   9942:        <code class="varname">MAKE_FLAGS</code>?</p></td>
                   9943: </tr>
                   9944: <tr class="answer">
1.91      rillig   9945: <td align="left" valign="top"></td>
1.75      rillig   9946: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
1.289     leot     9947:        to the pkgsrc-internal invocations of <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>, while
1.75      rillig   9948:        <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
                   9949:        the <code class="varname">MAKE_PROGRAM</code> when building the
                   9950:        package. [FIXME: What is .MAKEFLAGS for?]</p></td>
                   9951: </tr>
1.148     asau     9952: <tr class="question">
1.75      rillig   9953: <td align="left" valign="top">
1.289     leot     9954: <a name="devfaq.make"></a><a name="devfaq.make.q"></a><p><b>24.2.</b></p>
1.75      rillig   9955: </td>
                   9956: <td align="left" valign="top"><p>What is the difference between
                   9957:        <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
                   9958:        <code class="varname">MAKE_PROGRAM</code>?</p></td>
                   9959: </tr>
                   9960: <tr class="answer">
1.91      rillig   9961: <td align="left" valign="top"></td>
1.75      rillig   9962: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
1.289     leot     9963:        <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> program that is used in the pkgsrc
1.75      rillig   9964:        infrastructure. <code class="varname">GMAKE</code> is the path to GNU
                   9965:        Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
                   9966:        use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
                   9967:        Make program that is used for building the
                   9968:        package.</p></td>
                   9969: </tr>
1.148     asau     9970: <tr class="question">
1.75      rillig   9971: <td align="left" valign="top">
1.289     leot     9972: <a name="devfaq.cc"></a><a name="devfaq.cc.q"></a><p><b>24.3.</b></p>
1.75      rillig   9973: </td>
                   9974: <td align="left" valign="top"><p>What is the difference between
                   9975:        <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
                   9976:        <code class="varname">PKGSRC_COMPILER</code>?</p></td>
                   9977: </tr>
                   9978: <tr class="answer">
1.91      rillig   9979: <td align="left" valign="top"></td>
1.75      rillig   9980: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
                   9981:        compiler, which can be configured by the pkgsrc user.
                   9982:        <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
                   9983:        <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
                   9984:        path to a compiler, but the type of compiler that should be
1.76      rillig   9985:        used. See <code class="filename">mk/compiler.mk</code> for more
1.75      rillig   9986:        information about the latter variable.</p></td>
                   9987: </tr>
1.148     asau     9988: <tr class="question">
1.75      rillig   9989: <td align="left" valign="top">
1.289     leot     9990: <a name="devfaq.bl3flags"></a><a name="devfaq.bl3flags.q"></a><p><b>24.4.</b></p>
1.75      rillig   9991: </td>
                   9992: <td align="left" valign="top"><p>What is the difference between
                   9993:        <code class="varname">BUILDLINK_LDFLAGS</code>,
                   9994:        <code class="varname">BUILDLINK_LDADD</code> and
                   9995:        <code class="varname">BUILDLINK_LIBS</code>?</p></td>
                   9996: </tr>
                   9997: <tr class="answer">
1.91      rillig   9998: <td align="left" valign="top"></td>
1.75      rillig   9999: <td align="left" valign="top"><p>[FIXME]</p></td>
                   10000: </tr>
1.148     asau     10001: <tr class="question">
1.75      rillig   10002: <td align="left" valign="top">
1.289     leot     10003: <a name="devfaq.bl3prefix"></a><a name="devfaq.bl3prefix.q"></a><p><b>24.5.</b></p>
1.75      rillig   10004: </td>
1.110     hubertf  10005: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.75      rillig   10006:        VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
                   10007:        say it's empty?</p></td>
                   10008: </tr>
                   10009: <tr class="answer">
1.91      rillig   10010: <td align="left" valign="top"></td>
1.75      rillig   10011: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.128     wiz      10012:        available in the <span class="quote">&#8220;<span class="quote">wrapper</span>&#8221;</span> phase and later. To
                   10013:        <span class="quote">&#8220;<span class="quote">simulate</span>&#8221;</span> the wrapper phase, append
1.110     hubertf  10014:        <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.75      rillig   10015:        command.</p></td>
                   10016: </tr>
1.148     asau     10017: <tr class="question">
1.78      rillig   10018: <td align="left" valign="top">
1.289     leot     10019: <a name="devfaq.master_sites"></a><a name="devfaq.master_sites.q"></a><p><b>24.6.</b></p>
1.78      rillig   10020: </td>
                   10021: <td align="left" valign="top"><p>What does
1.220     wiz      10022:        <code class="code">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
                   10023:        don't understand the <code class="code">:=</code> inside
1.78      rillig   10024:        it.</p></td>
                   10025: </tr>
                   10026: <tr class="answer">
1.91      rillig   10027: <td align="left" valign="top"></td>
1.220     wiz      10028: <td align="left" valign="top"><p>The <code class="code">:=</code> is not really an
                   10029:        assignment operator, although it looks like it.
1.78      rillig   10030:        Instead, it is a degenerate form of
1.220     wiz      10031:        <code class="code">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.289     leot     10032:        which is documented in the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man page and which is
1.220     wiz      10033:        commonly used in the form <code class="code">${SRCS:.c=.o}</code>. In the
1.78      rillig   10034:        case of <code class="varname">MASTER_SITE_*</code>,
                   10035:        <em class="replaceable"><code>old_string</code></em> is the empty string and
                   10036:        <em class="replaceable"><code>new_string</code></em> is
1.220     wiz      10037:        <code class="code">package/</code>. That's where the
                   10038:        <code class="code">:</code> and the <code class="code">=</code> fall
1.78      rillig   10039:        together.</p></td>
                   10040: </tr>
1.148     asau     10041: <tr class="question">
1.78      rillig   10042: <td align="left" valign="top">
1.289     leot     10043: <a name="devfaq.mailinglists"></a><a name="devfaq.mailinglists.q"></a><p><b>24.7.</b></p>
1.78      rillig   10044: </td>
                   10045: <td align="left" valign="top"><p>Which mailing lists are there for package
                   10046:        developers?</p></td>
                   10047: </tr>
                   10048: <tr class="answer">
1.91      rillig   10049: <td align="left" valign="top"></td>
1.148     asau     10050: <td align="left" valign="top"><div class="variablelist"><dl class="variablelist">
1.289     leot     10051: <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   10052: <dd><p>This is a list for technical discussions related
                   10053:        to pkgsrc development, e.g. soliciting feedback for changes to
                   10054:        pkgsrc infrastructure, proposed new features, questions related
                   10055:        to porting pkgsrc to a new platform, advice for maintaining a
                   10056:        package, patches that affect many packages, help requests moved
                   10057:        from pkgsrc-users when an infrastructure bug is found,
                   10058:        etc.</p></dd>
1.289     leot     10059: <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   10060: <dd><p>All bug reports in category "pkg" sent with
1.289     leot     10061:        <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> appear here. Please do not report your bugs here
1.78      rillig   10062:        directly; use one of the other mailing
                   10063:        lists.</p></dd>
                   10064: </dl></div></td>
                   10065: </tr>
1.148     asau     10066: <tr class="question">
1.80      rillig   10067: <td align="left" valign="top">
1.289     leot     10068: <a name="devfaq.documentation"></a><a name="devfaq.documentation.q"></a><p><b>24.8.</b></p>
1.80      rillig   10069: </td>
                   10070: <td align="left" valign="top"><p>Where is the pkgsrc
                   10071:        documentation?</p></td>
                   10072: </tr>
                   10073: <tr class="answer">
1.91      rillig   10074: <td align="left" valign="top"></td>
1.80      rillig   10075: <td align="left" valign="top">
                   10076: <p>There are many places where you can find
                   10077:        documentation about pkgsrc:</p>
1.148     asau     10078: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      10079: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.80      rillig   10080:        of chapters that explain large parts of pkgsrc, but some
                   10081:        chapters tend to be outdated. Which ones they are is hard to
                   10082:        say.</p></li>
1.289     leot     10083: <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   10084:        about certain features, announcements of new parts of the pkgsrc
                   10085:        infrastructure and sometimes even announcements that a certain
                   10086:        feature has been marked as obsolete. The benefit here is that
                   10087:        each message has a date appended to it.</p></li>
1.128     wiz      10088: <li class="listitem"><p>Many of the files in the
1.80      rillig   10089:        <code class="filename">mk/</code> directory start with a comment that
                   10090:        describes the purpose of the file and how it can be used by the
1.92      rillig   10091:        pkgsrc user and package authors. An easy way to find this
1.110     hubertf  10092:        documentation is to run <span class="command"><strong>bmake
1.92      rillig   10093:        help</strong></span>.</p></li>
1.128     wiz      10094: <li class="listitem"><p>The CVS log messages are a rich source of
1.80      rillig   10095:        information, but they tend to be highly abbreviated, especially
                   10096:        for actions that occur often. Some contain a detailed
                   10097:        description of what has changed, but they are geared towards the
                   10098:        other pkgsrc developers, not towards an average pkgsrc user.
                   10099:        They also only document <span class="emphasis"><em>changes</em></span>, so if you
                   10100:        don't know what has been before, these messages may not be worth
                   10101:        too much to you.</p></li>
1.128     wiz      10102: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">&#8220;<span class="quote">implicitly
                   10103:        documented</span>&#8221;</span>, that is the documentation exists only in the
1.80      rillig   10104:        mind of the developer who wrote the code. To get this
1.110     hubertf  10105:        information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.80      rillig   10106:        to see who has written it and ask on the
                   10107:        <code class="literal">tech-pkg</code> mailing list, so that others can
                   10108:        find your questions later (see above). To be sure that the
                   10109:        developer in charge reads the mail, you may CC him or
                   10110:        her.</p></li>
                   10111: </ul></div>
1.299     rillig   10112: </td>
                   10113: </tr>
                   10114: <tr class="question">
                   10115: <td align="left" valign="top">
                   10116: <a name="devfaq.too-much-time"></a><a name="devfaq.too-much-time.q"></a><p><b>24.9.</b></p>
                   10117: </td>
                   10118: <td align="left" valign="top"><p>I have a little time to kill. 
                   10119: What shall I do?</p></td>
                   10120: </tr>
                   10121: <tr class="answer">
                   10122: <td align="left" valign="top"></td>
                   10123: <td align="left" valign="top">
                   10124: <p>This is not really an FAQ yet, but here's the answer
                   10125: anyway.</p>
1.148     asau     10126: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.299     rillig   10127: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
                   10128:     <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
                   10129:     will tell you about newer versions of installed packages that are
                   10130:     available, but not yet updated in pkgsrc.</p></li>
                   10131: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
                   10132:     &mdash; it contains a list of suggested new packages and a list of
                   10133:     cleanups and enhancements for pkgsrc that would be nice to
                   10134:     have.</p></li>
                   10135: <li class="listitem"><p>Review packages for which review was requested on
                   10136:     the <a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a>
                   10137:     mailing list.</p></li>
1.85      jmmv     10138: </ul></div>
1.299     rillig   10139: </td>
1.85      jmmv     10140: </tr>
                   10141: </tbody>
1.299     rillig   10142: </table>
1.85      jmmv     10143: </div>
                   10144: </div>
1.75      rillig   10145: </div>
1.148     asau     10146: <div class="part">
1.75      rillig   10147: <div class="titlepage"><div><div><h1 class="title">
                   10148: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.148     asau     10149: <div class="partintro">
1.75      rillig   10150: <div></div>
                   10151: <p>This part of the guide deals with everything
                   10152:        from the infrastructure that is behind the interfaces described
                   10153:        in the developer's guide. A casual package maintainer should not
                   10154:        need anything from this part.</p>
                   10155: <div class="toc">
                   10156: <p><b>Table of Contents</b></p>
1.210     leot     10157: <dl class="toc">
1.299     rillig   10158: <dt><span class="chapter"><a href="#infr.design">25. Design of the pkgsrc infrastructure</a></span></dt>
1.75      rillig   10159: <dd><dl>
1.299     rillig   10160: <dt><span class="sect1"><a href="#infr.vardef">25.1. The meaning of variable definitions</a></span></dt>
                   10161: <dt><span class="sect1"><a href="#infr.vardef.problems">25.2. Avoiding problems before they arise</a></span></dt>
                   10162: <dt><span class="sect1"><a href="#infr.var">25.3. Variable evaluation</a></span></dt>
1.75      rillig   10163: <dd><dl>
1.299     rillig   10164: <dt><span class="sect2"><a href="#infr.var.load">25.3.1. At load time</a></span></dt>
                   10165: <dt><span class="sect2"><a href="#infr.var.run">25.3.2. At runtime</a></span></dt>
1.75      rillig   10166: </dl></dd>
1.299     rillig   10167: <dt><span class="sect1"><a href="#infr.varspec">25.4. How can variables be specified?</a></span></dt>
                   10168: <dt><span class="sect1"><a href="#infr.design.intf">25.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig   10169: <dd><dl>
1.299     rillig   10170: <dt><span class="sect2"><a href="#infr.design.intf.proc">25.5.1. Procedures with parameters</a></span></dt>
                   10171: <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   10172: </dl></dd>
1.299     rillig   10173: <dt><span class="sect1"><a href="#infr.order">25.6. The order in which files are loaded</a></span></dt>
1.81      rillig   10174: <dd><dl>
1.299     rillig   10175: <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>
                   10176: <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   10177: </dl></dd>
                   10178: </dl></dd>
1.299     rillig   10179: <dt><span class="chapter"><a href="#regression">26. Regression tests</a></span></dt>
1.75      rillig   10180: <dd><dl>
1.299     rillig   10181: <dt><span class="sect1"><a href="#regression.run">26.1. Running the regression tests</a></span></dt>
                   10182: <dt><span class="sect1"><a href="#regression.new">26.2. Adding a new regression test</a></span></dt>
1.75      rillig   10183: <dd><dl>
1.299     rillig   10184: <dt><span class="sect2"><a href="#regression.fun.override">26.2.1. Overridable functions</a></span></dt>
                   10185: <dt><span class="sect2"><a href="#regression.fun.helper">26.2.2. Helper functions</a></span></dt>
1.75      rillig   10186: </dl></dd>
                   10187: </dl></dd>
1.299     rillig   10188: <dt><span class="chapter"><a href="#porting">27. Porting pkgsrc</a></span></dt>
                   10189: <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   10190: </dl>
                   10191: </div>
                   10192: </div>
1.148     asau     10193: <div class="chapter">
1.75      rillig   10194: <div class="titlepage"><div><div><h2 class="title">
1.299     rillig   10195: <a name="infr.design"></a>Chapter 25. Design of the pkgsrc infrastructure</h2></div></div></div>
1.75      rillig   10196: <div class="toc">
                   10197: <p><b>Table of Contents</b></p>
1.210     leot     10198: <dl class="toc">
1.299     rillig   10199: <dt><span class="sect1"><a href="#infr.vardef">25.1. The meaning of variable definitions</a></span></dt>
                   10200: <dt><span class="sect1"><a href="#infr.vardef.problems">25.2. Avoiding problems before they arise</a></span></dt>
                   10201: <dt><span class="sect1"><a href="#infr.var">25.3. Variable evaluation</a></span></dt>
1.81      rillig   10202: <dd><dl>
1.299     rillig   10203: <dt><span class="sect2"><a href="#infr.var.load">25.3.1. At load time</a></span></dt>
                   10204: <dt><span class="sect2"><a href="#infr.var.run">25.3.2. At runtime</a></span></dt>
1.81      rillig   10205: </dl></dd>
1.299     rillig   10206: <dt><span class="sect1"><a href="#infr.varspec">25.4. How can variables be specified?</a></span></dt>
                   10207: <dt><span class="sect1"><a href="#infr.design.intf">25.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig   10208: <dd><dl>
1.299     rillig   10209: <dt><span class="sect2"><a href="#infr.design.intf.proc">25.5.1. Procedures with parameters</a></span></dt>
                   10210: <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   10211: </dl></dd>
1.299     rillig   10212: <dt><span class="sect1"><a href="#infr.order">25.6. The order in which files are loaded</a></span></dt>
1.75      rillig   10213: <dd><dl>
1.299     rillig   10214: <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>
                   10215: <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   10216: </dl></dd>
                   10217: </dl>
                   10218: </div>
                   10219: <p>The pkgsrc infrastructure consists of many small Makefile
                   10220:        fragments. Each such fragment needs a properly specified
                   10221:        interface. This chapter explains how such an interface looks
                   10222:        like.</p>
1.148     asau     10223: <div class="sect1">
1.75      rillig   10224: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   10225: <a name="infr.vardef"></a>25.1. The meaning of variable definitions</h2></div></div></div>
1.81      rillig   10226: <p>Whenever a variable is defined in the pkgsrc
                   10227:        infrastructure, the location and the way of definition provide
                   10228:        much information about the intended use of that variable.
                   10229:        Additionally, more documentation may be found in a header
                   10230:        comment or in this pkgsrc guide.</p>
                   10231: <p>A special file is
                   10232:        <code class="filename">mk/defaults/mk.conf</code>, which lists all
                   10233:        variables that are intended to be user-defined. They are either
                   10234:        defined using the <code class="literal">?=</code> operator or they are
                   10235:        left undefined because defining them to anything would
1.128     wiz      10236:        effectively mean <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. All these variables may be
1.81      rillig   10237:        overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
                   10238:        file.</p>
                   10239: <p>Outside this file, the following conventions apply:
                   10240:        Variables that are defined using the <code class="literal">?=</code>
                   10241:        operator may be overridden by a package.</p>
                   10242: <p>Variables that are defined using the <code class="literal">=</code>
                   10243:        operator may be used read-only at run-time.</p>
                   10244: <p>Variables whose name starts with an underscore must not be
                   10245:        accessed outside the pkgsrc infrastructure at all. They may
                   10246:        change without further notice.</p>
1.148     asau     10247: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.81      rillig   10248: <h3 class="title">Note</h3>
                   10249: <p>These conventions are currently not applied
                   10250:        consistently to the complete pkgsrc
                   10251:        infrastructure.</p>
                   10252: </div>
                   10253: </div>
1.148     asau     10254: <div class="sect1">
1.81      rillig   10255: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   10256: <a name="infr.vardef.problems"></a>25.2. Avoiding problems before they arise</h2></div></div></div>
1.81      rillig   10257: <p>All variables that contain lists of things should default
                   10258:        to being empty. Two examples that do not follow this rule are
                   10259:        <code class="varname">USE_LANGUAGES</code> and
                   10260:        <code class="varname">DISTFILES</code>. These variables cannot simply be
                   10261:        modified using the <code class="literal">+=</code> operator in package
                   10262:        <code class="filename">Makefile</code>s (or other files included by
                   10263:        them), since there is no guarantee whether the variable is
                   10264:        already set or not, and what its value is. In the case of
1.128     wiz      10265:        <code class="varname">DISTFILES</code>, the packages <span class="quote">&#8220;<span class="quote">know</span>&#8221;</span>
1.81      rillig   10266:        the default value and just define it as in the following
                   10267:        example.</p>
                   10268: <pre class="programlisting">
1.100     rillig   10269: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
1.81      rillig   10270: </pre>
                   10271: <p>Because of the selection of this default value, the same
                   10272:        value appears in many package Makefiles. Similarly for
                   10273:        <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.128     wiz      10274:        value (<span class="quote">&#8220;<span class="quote"><code class="literal">c</code></span>&#8221;</span>) is so short that it
1.81      rillig   10275:        doesn't stand out. Nevertheless it is mentioned in many
                   10276:        files.</p>
                   10277: </div>
1.148     asau     10278: <div class="sect1">
1.81      rillig   10279: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   10280: <a name="infr.var"></a>25.3. Variable evaluation</h2></div></div></div>
1.148     asau     10281: <div class="sect2">
1.75      rillig   10282: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   10283: <a name="infr.var.load"></a>25.3.1. At load time</h3></div></div></div>
1.75      rillig   10284: <p>Variable evaluation takes place either at load time or at
                   10285:        runtime, depending on the context in which they occur. The
                   10286:        contexts where variables are evaluated at load time are:</p>
1.148     asau     10287: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      10288: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.75      rillig   10289:        and <code class="literal">!=</code> operators,</p></li>
1.128     wiz      10290: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.75      rillig   10291:        <code class="literal">.for</code>,</p></li>
1.128     wiz      10292: <li class="listitem"><p>Dependency lines.</p></li>
1.75      rillig   10293: </ul></div>
                   10294: <p>A special exception are references to the iteration
                   10295:        variables of <code class="literal">.for</code> loops, which are expanded
                   10296:        inline, no matter in which context they appear.</p>
                   10297: <p>As the values of variables may change during load time,
                   10298:        care must be taken not to evaluate them by accident. Typical
                   10299:        examples for variables that should not be evaluated at load time
                   10300:        are <code class="varname">DEPENDS</code> and
                   10301:        <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
                   10302:        clear, here is an example:</p>
                   10303: <pre class="programlisting">
1.100     rillig   10304: CONFIGURE_ARGS=         # none
                   10305: CFLAGS=                 -O
                   10306: CONFIGURE_ARGS+=        CFLAGS=${CFLAGS:Q}
1.1       grant    10307: 
1.100     rillig   10308: CONFIGURE_ARGS:=        ${CONFIGURE_ARGS}
1.1       grant    10309: 
1.100     rillig   10310: CFLAGS+=                -Wall
1.222     sevan    10311: </pre>
1.75      rillig   10312: <p>This code shows how the use of the <code class="literal">:=</code>
                   10313:        operator can quickly lead to unexpected results. The first
                   10314:        paragraph is fairly common code. The second paragraph evaluates
                   10315:        the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
                   10316:        <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
                   10317:        <code class="literal">-Wall</code> is appended to the
                   10318:        <code class="varname">CFLAGS</code>, but this addition will not appear in
                   10319:        <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
                   10320:        paragraphs from above typically occur in completely unrelated
                   10321:        files.</p>
                   10322: </div>
1.148     asau     10323: <div class="sect2">
1.75      rillig   10324: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   10325: <a name="infr.var.run"></a>25.3.2. At runtime</h3></div></div></div>
1.75      rillig   10326: <p>After all the files have been loaded, the values of the
                   10327:        variables cannot be changed anymore. Variables that are used in
                   10328:        the shell commands are expanded at this point.</p>
                   10329: </div>
                   10330: </div>
1.148     asau     10331: <div class="sect1">
1.75      rillig   10332: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   10333: <a name="infr.varspec"></a>25.4. How can variables be specified?</h2></div></div></div>
1.78      rillig   10334: <p>There are many ways in which the definition and use of a
1.218     rillig   10335:        variable can be restricted in order to detect bugs and violations
                   10336:        of the (mostly unwritten) policies. A package can be checked with
                   10337:        <code class="literal">pkglint -Wall</code> to see whether it meets these
                   10338:        rules.</p>
1.78      rillig   10339: </div>
1.148     asau     10340: <div class="sect1">
1.78      rillig   10341: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   10342: <a name="infr.design.intf"></a>25.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.76      rillig   10343: <p>Most of the <code class="filename">.mk</code> files fall into one
1.75      rillig   10344:        of the following classes. Cases where a file falls into more
                   10345:        than one class should be avoided as it often leads to subtle
                   10346:        bugs.</p>
1.148     asau     10347: <div class="sect2">
1.75      rillig   10348: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   10349: <a name="infr.design.intf.proc"></a>25.5.1. Procedures with parameters</h3></div></div></div>
1.75      rillig   10350: <p>In a traditional imperative programming language some of
1.76      rillig   10351:        the <code class="filename">.mk</code> files could be described as
1.126     jakllsch 10352:        procedures. They take some input parameters and&mdash;after
                   10353:        inclusion&mdash;provide a result in output parameters. Since all
1.76      rillig   10354:        variables in <code class="filename">Makefile</code>s have global scope
1.75      rillig   10355:        care must be taken not to use parameter names that have already
                   10356:        another meaning. For example, <code class="varname">PKGNAME</code> is a
                   10357:        bad choice for a parameter name.</p>
                   10358: <p>Procedures are completely evaluated at preprocessing time.
                   10359:        That is, when calling a procedure all input parameters must be
                   10360:        completely resolvable. For example,
                   10361:        <code class="varname">CONFIGURE_ARGS</code> should never be an input
                   10362:        parameter since it is very likely that further text will be
                   10363:        added after calling the procedure, which would effectively apply
                   10364:        the procedure to only a part of the variable. Also, references
1.218     rillig   10365:        to other variables will be modified after calling the
1.75      rillig   10366:        procedure.</p>
                   10367: <p>A procedure can declare its output parameters either as
                   10368:        suitable for use in preprocessing directives or as only
                   10369:        available at runtime. The latter alternative is for variables
                   10370:        that contain references to other runtime variables.</p>
                   10371: <p>Procedures shall be written such that it is possible to
                   10372:        call the procedure more than once. That is, the file must not
                   10373:        contain multiple-inclusion guards.</p>
                   10374: <p>Examples for procedures are
1.76      rillig   10375:        <code class="filename">mk/bsd.options.mk</code> and
                   10376:        <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
1.75      rillig   10377:        that the parameters are evaluated at load time, they should be
                   10378:        assigned using the <code class="literal">:=</code> operator, which should
                   10379:        be used only for this purpose.</p>
                   10380: </div>
1.148     asau     10381: <div class="sect2">
1.75      rillig   10382: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   10383: <a name="infr.design.intf.action"></a>25.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.75      rillig   10384: <p>Action files take some input parameters and may define
                   10385:        runtime variables. They shall not define loadtime variables.
                   10386:        There are action files that are included implicitly by the
                   10387:        pkgsrc infrastructure, while other must be included
                   10388:        explicitly.</p>
                   10389: <p>An example for action files is
1.76      rillig   10390:        <code class="filename">mk/subst.mk</code>.</p>
1.75      rillig   10391: </div>
                   10392: </div>
1.148     asau     10393: <div class="sect1">
1.81      rillig   10394: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   10395: <a name="infr.order"></a>25.6. The order in which files are loaded</h2></div></div></div>
1.81      rillig   10396: <p>Package <code class="filename">Makefile</code>s usually consist of
                   10397:        a set of variable definitions, and include the file
                   10398:        <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
                   10399:        Before that, they may also include various other
                   10400:        <code class="filename">*.mk</code> files if they need to query the
                   10401:        availability of certain features like the type of compiler or
                   10402:        the X11 implementation. Due to the heavy use of preprocessor
                   10403:        directives like <code class="literal">.if</code> and
                   10404:        <code class="literal">.for</code>, the order in which the files are loaded
                   10405:        matters.</p>
                   10406: <p>This section describes at which point the various files
                   10407:        are loaded and gives reasons for that order.</p>
1.148     asau     10408: <div class="sect2">
1.81      rillig   10409: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   10410: <a name="infr.order.prefs"></a>25.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.93      rillig   10411: </h3></div></div></div>
                   10412: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
1.81      rillig   10413:        is to define some essential variables like
                   10414:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
                   10415:        <code class="varname">MACHINE_ARCH</code>.</p>
                   10416: <p>Then, the user settings are loaded from the file specified
1.110     hubertf  10417:        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   10418:        After that, those variables
1.81      rillig   10419:        that have not been overridden by the user are loaded from
                   10420:        <code class="filename">mk/defaults/mk.conf</code>.</p>
                   10421: <p>After the user settings, the system settings and platform
                   10422:        settings are loaded, which may override the user
                   10423:        settings.</p>
                   10424: <p>Then, the tool definitions are loaded. The tool wrappers
                   10425:        are not yet in effect. This only happens when building a
                   10426:        package, so the proper variables must be used instead of the
                   10427:        direct tool names.</p>
                   10428: <p>As the last steps, some essential variables from the
                   10429:        wrapper and the package system flavor are loaded, as well as the
                   10430:        variables that have been cached in earlier phases of a package
                   10431:        build.</p>
                   10432: </div>
1.148     asau     10433: <div class="sect2">
1.81      rillig   10434: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   10435: <a name="infr.order.pkg"></a>25.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.93      rillig   10436: </h3></div></div></div>
1.81      rillig   10437: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
                   10438: <p>Then, the various <code class="filename">*-vars.mk</code> files are
                   10439:        loaded, which fill default values for those variables that have
1.93      rillig   10440:        not been defined by the package. These variables may later
1.81      rillig   10441:        be used even in unrelated files.</p>
                   10442: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
                   10443:        provides the target <code class="literal">error-check</code> that is added
                   10444:        as a special dependency to all other targets that use
                   10445:        <code class="varname">DELAYED_ERROR_MSG</code> or
                   10446:        <code class="varname">DELAYED_WARNING_MSG</code>.</p>
                   10447: <p>Then, the package-specific hacks from
                   10448:        <code class="filename">hacks.mk</code> are included.</p>
                   10449: <p>Then, various other files follow. Most of them don't have
                   10450:        any dependencies on what they need to have included before or
                   10451:        after them, though some do.</p>
                   10452: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
                   10453:        <code class="varname">PKG_SKIP_REASON</code> is then executed, which
                   10454:        restricts the use of these variables to all the files that have
                   10455:        been included before. Appearances in later files will be
                   10456:        silently ignored.</p>
                   10457: <p>Then, the files for the main targets are included, in the
                   10458:        order of later execution, though the actual order should not
                   10459:        matter.</p>
                   10460: <p>At last, some more files are included that don't set any
                   10461:        interesting variables but rather just define make targets to be
                   10462:        executed.</p>
                   10463: </div>
                   10464: </div>
1.75      rillig   10465: </div>
1.148     asau     10466: <div class="chapter">
1.75      rillig   10467: <div class="titlepage"><div><div><h2 class="title">
1.299     rillig   10468: <a name="regression"></a>Chapter 26. Regression tests</h2></div></div></div>
1.75      rillig   10469: <div class="toc">
                   10470: <p><b>Table of Contents</b></p>
1.210     leot     10471: <dl class="toc">
1.299     rillig   10472: <dt><span class="sect1"><a href="#regression.run">26.1. Running the regression tests</a></span></dt>
                   10473: <dt><span class="sect1"><a href="#regression.new">26.2. Adding a new regression test</a></span></dt>
1.75      rillig   10474: <dd><dl>
1.299     rillig   10475: <dt><span class="sect2"><a href="#regression.fun.override">26.2.1. Overridable functions</a></span></dt>
                   10476: <dt><span class="sect2"><a href="#regression.fun.helper">26.2.2. Helper functions</a></span></dt>
1.75      rillig   10477: </dl></dd>
                   10478: </dl>
                   10479: </div>
                   10480: <p>The pkgsrc infrastructure consists of a large codebase,
                   10481:        and there are many corners where every little bit of a file is
                   10482:        well thought out, making pkgsrc likely to fail as soon as
                   10483:        anything is changed near those parts. To prevent most changes
                   10484:        from breaking anything, a suite of regression tests should go
                   10485:        along with every important part of the pkgsrc infrastructure.
                   10486:        This chapter describes how regression tests work in pkgsrc and
                   10487:        how you can add new tests.</p>
1.148     asau     10488: <div class="sect1">
1.75      rillig   10489: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   10490: <a name="regression.run"></a>26.1. Running the regression tests</h2></div></div></div>
1.250     leot     10491: <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  10492:        provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.75      rillig   10493:        can simply run that command, which will run all tests in the
1.283     rillig   10494:        <code class="filename">regress/</code> directory.</p>
1.75      rillig   10495: </div>
1.148     asau     10496: <div class="sect1">
1.75      rillig   10497: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   10498: <a name="regression.new"></a>26.2. Adding a new regression test</h2></div></div></div>
1.283     rillig   10499: <p>Every directory in the <code class="filename">regress/</code>
                   10500:        directory that contains a file called <code class="filename">spec</code>
1.75      rillig   10501:        is considered a regression test. This file is a shell program
1.110     hubertf  10502:        that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.75      rillig   10503:        The following functions can be overridden to suit your
                   10504:        needs.</p>
1.148     asau     10505: <div class="sect2">
1.75      rillig   10506: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   10507: <a name="regression.fun.override"></a>26.2.1. Overridable functions</h3></div></div></div>
1.218     rillig   10508: <p>These functions do not take any parameters. Although they
                   10509:        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     10510:        first failing command. See <a class="ulink" href="https://stackoverflow.com/q/4072984" target="_top">this Stack Overflow
1.218     rillig   10511:        question</a> for details.</p>
1.148     asau     10512: <div class="variablelist"><dl class="variablelist">
1.218     rillig   10513: <dt><span class="term"><code class="varname">do_setup</code></span></dt>
1.75      rillig   10514: <dd><p>This function prepares the environment for the
                   10515:        test. By default it does nothing.</p></dd>
1.218     rillig   10516: <dt><span class="term"><code class="varname">do_test</code></span></dt>
                   10517: <dd>
                   10518: <p>This function runs the actual test. By default,
1.75      rillig   10519:        it calls <code class="varname">TEST_MAKE</code> with the arguments
                   10520:        <code class="varname">MAKEARGS_TEST</code> and writes its output including
                   10521:        error messages into the file
1.218     rillig   10522:        <code class="varname">TEST_OUTFILE</code>.</p>
                   10523: <p>When defining this function, make sure that all output that
                   10524:        needs to be checked is written to the correct output file.
                   10525:        Example:</p>
                   10526: <pre class="programlisting">
                   10527: do_test() {
1.223     rillig   10528:         echo "Example output"
1.218     rillig   10529: } 1&gt;$TEST_OUTFILE 2&gt;&amp;1
                   10530: </pre>
                   10531: </dd>
                   10532: <dt><span class="term"><code class="varname">check_result</code></span></dt>
                   10533: <dd>
                   10534: <p>This function is run after the test and is
1.75      rillig   10535:        typically used to compare the actual output from the one that is
                   10536:        expected. It can make use of the various helper functions from
1.218     rillig   10537:        the next section. Example:</p>
                   10538: <pre class="programlisting">
                   10539: check_result() {
1.223     rillig   10540:         exit_status 0
                   10541:         output_require "Example"
                   10542:         output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
                   10543:         output_prohibit "no such file or directory"
1.283     rillig   10544:         regress_fail "expected $expected but got $actual for input $input"
1.218     rillig   10545: }
                   10546: </pre>
                   10547: </dd>
                   10548: <dt><span class="term"><code class="varname">do_cleanup</code></span></dt>
1.75      rillig   10549: <dd><p>This function cleans everything up after the
                   10550:        test has been run. By default it does nothing.</p></dd>
                   10551: </dl></div>
                   10552: </div>
1.148     asau     10553: <div class="sect2">
1.75      rillig   10554: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   10555: <a name="regression.fun.helper"></a>26.2.2. Helper functions</h3></div></div></div>
1.148     asau     10556: <div class="variablelist"><dl class="variablelist">
1.283     rillig   10557: <dt><span class="term"><code class="varname">regress_fail <em class="replaceable"><code>message...</code></em></code></span></dt>
                   10558: <dd><p>This function makes the test fail with the given error message.</p></dd>
1.218     rillig   10559: <dt><span class="term"><code class="varname">exit_status expected</code></span></dt>
1.75      rillig   10560: <dd><p>This function compares the exitcode of the
1.218     rillig   10561:        <span class="command"><strong>do_test</strong></span> function with its first parameter.
1.75      rillig   10562:        If they differ, the test will fail.</p></dd>
1.218     rillig   10563: <dt><span class="term"><code class="varname">output_require regex...</code></span></dt>
                   10564: <dd>
                   10565: <p>This function checks for each of its parameters
                   10566:        if the output from <span class="command"><strong>do_test</strong></span> matches the
1.75      rillig   10567:        extended regular expression. If it does not, the test will
1.218     rillig   10568:        fail. Example:</p>
                   10569: <pre class="programlisting">
1.219     rillig   10570: output_require "looks fine"
                   10571: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
1.218     rillig   10572: </pre>
                   10573: </dd>
1.292     leot     10574: <dt><span class="term"><code class="varname">output_prohibit regex...</code></span></dt>
1.75      rillig   10575: <dd><p>This function checks for each of its parameters
1.110     hubertf  10576:        if the output from <span class="command"><strong>do_test()</strong></span> does
1.75      rillig   10577:        <span class="emphasis"><em>not</em></span> match the extended regular expression.
                   10578:        If any of the regular expressions matches, the test will
                   10579:        fail.</p></dd>
                   10580: </dl></div>
                   10581: </div>
                   10582: </div>
                   10583: </div>
1.148     asau     10584: <div class="chapter">
1.75      rillig   10585: <div class="titlepage"><div><div><h2 class="title">
1.299     rillig   10586: <a name="porting"></a>Chapter 27. Porting pkgsrc</h2></div></div></div>
1.75      rillig   10587: <div class="toc">
                   10588: <p><b>Table of Contents</b></p>
1.299     rillig   10589: <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   10590: </div>
                   10591: <p>The pkgsrc system has already been ported to many
                   10592:        operating systems, hardware architectures and compilers. This
                   10593:        chapter explains the necessary steps to make pkgsrc even more
                   10594:        portable.</p>
1.148     asau     10595: <div class="sect1">
1.75      rillig   10596: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   10597: <a name="porting.opsys"></a>27.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.75      rillig   10598: <p>To port pkgsrc to a new operating system (called
                   10599:        <code class="literal">MyOS</code> in this example), you need to touch the
                   10600:        following files:</p>
1.148     asau     10601: <div class="variablelist"><dl class="variablelist">
1.93      rillig   10602: <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   10603: <dd><p>This file contains some basic definitions, for
                   10604:        example the name of the C
                   10605:        compiler.</p></dd>
1.76      rillig   10606: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
1.75      rillig   10607: <dd><p>Insert code that defines the variables
                   10608:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
                   10609:        <code class="varname">LOWER_OS_VERSION</code>,
                   10610:        <code class="varname">LOWER_VENDOR</code>,
                   10611:        <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
                   10612:        <code class="varname">APPEND_ELF</code>, and the other variables that
                   10613:        appear in this file.</p></dd>
1.93      rillig   10614: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75      rillig   10615: <dd><p>This file contains the platform-specific
                   10616:        definitions that are used by pkgsrc. Start by copying one of the
                   10617:        other files and edit it to your
                   10618:        needs.</p></dd>
1.93      rillig   10619: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75      rillig   10620: <dd><p>This file defines the paths to all the tools
                   10621:        that are needed by one or the other package in pkgsrc, as well
                   10622:        as by pkgsrc itself. Find out where these tools are on your
                   10623:        platform and add them.</p></dd>
                   10624: </dl></div>
                   10625: <p>Now, you should be able to build some basic packages, like
1.250     leot     10626:        <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   10627: </div>
                   10628: </div>
                   10629: </div>
1.148     asau     10630: <div class="appendix">
                   10631: <div class="titlepage"><div><div><h1 class="title">
                   10632: <a name="examples"></a>Appendix A. A simple example package: bison</h1></div></div></div>
1.75      rillig   10633: <div class="toc">
                   10634: <p><b>Table of Contents</b></p>
1.210     leot     10635: <dl class="toc">
1.75      rillig   10636: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
                   10637: <dd><dl>
                   10638: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
                   10639: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
                   10640: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.287     rillig   10641: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with pkglint</a></span></dt>
1.75      rillig   10642: </dl></dd>
                   10643: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
                   10644: </dl>
                   10645: </div>
                   10646: <p>We checked to find a piece of software that wasn't in the packages
                   10647:     collection, and picked GNU bison. Quite why someone would want to have
1.110     hubertf  10648:     <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.75      rillig   10649:     present in the tree is beyond us, but it's useful for the purposes of
                   10650:     this exercise.</p>
1.148     asau     10651: <div class="sect1">
1.75      rillig   10652: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10653: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.148     asau     10654: <div class="sect2">
1.75      rillig   10655: <div class="titlepage"><div><div><h3 class="title">
                   10656: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
                   10657: <pre class="programlisting">
1.100     rillig   10658: # $NetBSD$
                   10659: #
1.1       grant    10660: 
1.100     rillig   10661: DISTNAME=       bison-1.25
                   10662: CATEGORIES=     devel
1.286     rillig   10663: MASTER_SITES=   ${MASTER_SITE_GNU:=bison/}
1.1       grant    10664: 
1.136     dholland 10665: MAINTAINER=     pkgsrc-users@NetBSD.org
1.289     leot     10666: HOMEPAGE=       https://www.gnu.org/software/bison/bison.html
1.100     rillig   10667: COMMENT=        GNU yacc clone
1.1       grant    10668: 
1.100     rillig   10669: GNU_CONFIGURE=  yes
1.152     wiz      10670: INFO_FILES=     yes
1.1       grant    10671: 
1.100     rillig   10672: .include "../../mk/bsd.pkg.mk"
1.1       grant    10673: </pre>
1.75      rillig   10674: </div>
1.148     asau     10675: <div class="sect2">
1.75      rillig   10676: <div class="titlepage"><div><div><h3 class="title">
                   10677: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
                   10678: <pre class="programlisting">
1.100     rillig   10679: GNU version of yacc.  Can make re-entrant parsers, and numerous other
1.289     leot     10680: improvements.  Why you would want this when Berkeley <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?yacc+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">yacc</span>(1)</span></a> is part
1.100     rillig   10681: of the NetBSD source tree is beyond me.
1.1       grant    10682: </pre>
1.75      rillig   10683: </div>
1.148     asau     10684: <div class="sect2">
1.75      rillig   10685: <div class="titlepage"><div><div><h3 class="title">
                   10686: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
                   10687: <pre class="programlisting">
1.100     rillig   10688: @comment $NetBSD$
                   10689: bin/bison
                   10690: man/man1/bison.1.gz
                   10691: share/bison.simple
                   10692: share/bison.hairy
1.1       grant    10693: </pre>
1.75      rillig   10694: </div>
1.148     asau     10695: <div class="sect2">
1.75      rillig   10696: <div class="titlepage"><div><div><h3 class="title">
1.287     rillig   10697: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with pkglint</h3></div></div></div>
1.75      rillig   10698: <p>The NetBSD package system comes with
1.250     leot     10699:         <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   10700:        which helps to check the contents of these
                   10701:        files. After installation it is quite easy to use, just change to the
1.286     rillig   10702:        directory of the package you wish to examine and run
1.110     hubertf  10703:        <span class="command"><strong>pkglint</strong></span>:</p>
1.75      rillig   10704: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
1.286     rillig   10705: ERROR: Makefile: Each package must define its LICENSE.
                   10706: WARN: Makefile:9: HOMEPAGE should migrate from http to https.
                   10707: NOTE: PLIST:3: The .gz extension is unnecessary for manual pages.
                   10708: WARN: PLIST:5: "share/bison.hairy" should be sorted before "share/bison.simple".
                   10709: 1 error, 2 warnings and 1 note found.
                   10710: (Run "pkglint -e" to show explanations.)
                   10711: (Run "pkglint -fs" to show what can be fixed automatically.)
1.287     rillig   10712: (Run "pkglint -F" to automatically fix some issues.)</pre>
1.75      rillig   10713: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.285     rillig   10714:        more checks will be performed. Use e.g. <span class="command"><strong>pkglint
1.75      rillig   10715:        -Wall</strong></span> for a very thorough check.</p>
                   10716: </div>
                   10717: </div>
1.148     asau     10718: <div class="sect1">
1.75      rillig   10719: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10720: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
                   10721: <p>Create the directory where the package lives,
                   10722:       plus any auxiliary directories:</p>
                   10723: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
                   10724: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
                   10725: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
                   10726: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
1.76      rillig   10727: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.299     rillig   10728:       <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   10729:       then continue with fetching the distfile:</p>
                   10730: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
1.1       grant    10731: &gt;&gt; bison-1.25.tar.gz doesn't seem to exist on this system.
                   10732: &gt;&gt; Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
                   10733: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   10734: ftp: Error retrieving file: 500 Internal error
                   10735: 
                   10736: &gt;&gt; Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
                   10737: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   10738: ftp: Error retrieving file: 500 Internal error
                   10739: 
                   10740: &gt;&gt; Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
                   10741: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
1.75      rillig   10742: Successfully retrieved file.</pre>
                   10743: <p>Generate the checksum of the distfile into
1.76      rillig   10744:       <code class="filename">distinfo</code>:</p>
1.88      wiz      10745: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
1.75      rillig   10746: <p>Now compile:</p>
                   10747: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1       grant    10748: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10749: ===&gt;  Extracting for bison-1.25
                   10750: ===&gt;  Patching for bison-1.25
                   10751: ===&gt;   Ignoring empty patch directory
                   10752: ===&gt;  Configuring for bison-1.25
                   10753: creating cache ./config.cache
                   10754: checking for gcc... cc
                   10755: checking whether we are using GNU C... yes
                   10756: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
                   10757: checking how to run the C preprocessor... cc -E
                   10758: checking for minix/config.h... no
                   10759: checking for POSIXized ISC... no
                   10760: checking whether cross-compiling... no
                   10761: checking for ANSI C header files... yes
                   10762: checking for string.h... yes
                   10763: checking for stdlib.h... yes
                   10764: checking for memory.h... yes
                   10765: checking for working const... yes
                   10766: checking for working alloca.h... no
                   10767: checking for alloca... yes
                   10768: checking for strerror... yes
                   10769: updating cache ./config.cache
                   10770: creating ./config.status
                   10771: creating Makefile
                   10772: ===&gt;  Building for bison-1.25
                   10773: 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
                   10774: 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
                   10775: 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
                   10776: 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
                   10777: 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   10778: 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    10779: 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
                   10780: 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
                   10781: 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
                   10782: 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
                   10783: 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
                   10784: 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
                   10785: 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
                   10786: 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
                   10787: 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
                   10788: 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
                   10789: 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
                   10790: 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
                   10791: 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
                   10792: 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
                   10793: 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
                   10794: 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
                   10795: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
                   10796: rm -f bison.s1
1.75      rillig   10797: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" &lt; ./bison.simple &gt; bison.s1</pre>
                   10798: <p>Everything seems OK, so install the files:</p>
                   10799: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1       grant    10800: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10801: ===&gt;  Installing for bison-1.25
                   10802: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share  /usr/pkg/info /usr/pkg/man/man1
                   10803: rm -f /usr/pkg/bin/bison
                   10804: cd /usr/pkg/share; rm -f bison.simple bison.hairy
                   10805: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
                   10806: install -c  -o bin -g bin -m 555 bison /usr/pkg/bin/bison
                   10807: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
                   10808: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
                   10809: cd .; for f in bison.info*;  do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
                   10810: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
1.75      rillig   10811: ===&gt;  Registering installation for bison-1.25</pre>
                   10812: <p>You can now use bison, and also - if you decide so - remove it with
1.110     hubertf  10813:       <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.75      rillig   10814:       binary package, do this now:</p>
                   10815: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1       grant    10816: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10817: ===&gt;  Building package for bison-1.25
                   10818: Creating package bison-1.25.tgz
                   10819: Registering depends:.
1.75      rillig   10820: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
                   10821: <p>Now that you don't need the source and object files
                   10822:       any more, clean up:</p>
                   10823: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
                   10824: ===&gt;  Cleaning for bison-1.25</pre>
                   10825: </div>
                   10826: </div>
1.148     asau     10827: <div class="appendix">
                   10828: <div class="titlepage"><div><div><h1 class="title">
                   10829: <a name="logs"></a>Appendix B. Build logs</h1></div></div></div>
1.75      rillig   10830: <div class="toc">
                   10831: <p><b>Table of Contents</b></p>
1.210     leot     10832: <dl class="toc">
1.75      rillig   10833: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
                   10834: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
                   10835: </dl>
                   10836: </div>
1.148     asau     10837: <div class="sect1">
1.75      rillig   10838: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10839: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
                   10840: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1       grant    10841: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10842: =&gt; figlet221.tar.gz doesn't seem to exist on this system.
                   10843: =&gt; Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
                   10844: =&gt; [172219 bytes]
                   10845: Connected to ftp.plig.net.
                   10846: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
                   10847: 331 Guest login ok, send your complete e-mail address as password.
                   10848: 230-You are user #5 of 500 simultaneous users allowed.
                   10849: 230-
1.68      rillig   10850: 230-  ___ _             _ _
                   10851: 230- |  _| |_ ___   ___| |_|___   ___ ___ ___
1.1       grant    10852: 230- |  _|  _| . |_| . | | | . |_| . |  _| . |
                   10853: 230- |_| |_| |  _|_|  _|_|_|_  |_|___|_| |_  |
                   10854: 230-         |_|   |_|     |___|         |___|
                   10855: 230-
                   10856: 230-** Welcome to ftp.plig.org **
                   10857: 230-
                   10858: 230-Please note that all transfers from this FTP site are logged. If you
                   10859: 230-do not like this, please disconnect now.
                   10860: 230-
1.120     snj      10861: 230-This archive is available via
1.1       grant    10862: 230-
                   10863: 230-HTTP:  http://ftp.plig.org/
                   10864: 230-FTP:   ftp://ftp.plig.org/     (max 500 connections)
                   10865: 230-RSYNC: rsync://ftp.plig.org/   (max  30 connections)
                   10866: 230-
                   10867: 230-Please email comments, bug reports and requests for packages to be
1.68      rillig   10868: 230-mirrored to ftp-admin@plig.org.
1.1       grant    10869: 230-
                   10870: 230-
                   10871: 230 Logged in anonymously.
                   10872: Remote system type is UNIX.
                   10873: Using binary mode to transfer files.
                   10874: 200 Type okay.
                   10875: 250 "/pub" is new cwd.
                   10876: 250-"/pub/figlet" is new cwd.
                   10877: 250-
                   10878: 250-Welcome to the figlet archive at ftp.figlet.org
1.68      rillig   10879: 250-
1.75      rillig   10880: 250-   ftp://ftp.figlet.org/pub/figlet/
1.1       grant    10881: 250-
                   10882: 250-The official FIGlet web page is:
1.75      rillig   10883: 250-   http://www.figlet.org/
1.1       grant    10884: 250-
                   10885: 250-If you have questions, please mailto:info@figlet.org. If you want to
                   10886: 250-contribute a font or something else, you can email us.
1.68      rillig   10887: 250
1.1       grant    10888: 250 "/pub/figlet/program" is new cwd.
                   10889: 250 "/pub/figlet/program/unix" is new cwd.
                   10890: local: figlet221.tar.gz remote: figlet221.tar.gz
                   10891: 502 Unimplemented command.
                   10892: 227 Entering Passive Mode (195,40,6,41,246,104)
                   10893: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
                   10894: 38% |**************                       | 65800      64.16 KB/s    00:01 ETA
                   10895: 226 Transfer completed.
                   10896: 172219 bytes received in 00:02 (75.99 KB/s)
                   10897: 221 Goodbye.
                   10898: =&gt; Checksum OK for figlet221.tar.gz.
                   10899: ===&gt; Extracting for figlet-2.2.1nb2
                   10900: ===&gt; Required installed package ccache-[0-9]*: ccache-2.3nb1 found
                   10901: ===&gt; Patching for figlet-2.2.1nb2
                   10902: ===&gt; Applying pkgsrc patches for figlet-2.2.1nb2
                   10903: ===&gt; Overriding tools for figlet-2.2.1nb2
                   10904: ===&gt; Creating toolchain wrappers for figlet-2.2.1nb2
                   10905: ===&gt; Configuring for figlet-2.2.1nb2
                   10906: ===&gt; Building for figlet-2.2.1nb2
                   10907: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\"  -DDEFAULTFONTFILE=\"standard.flf\"  figlet.c zipio.c crc.c inflate.c -o figlet
                   10908: chmod a+x figlet
                   10909: gcc -O2 -o chkfont chkfont.c
                   10910: =&gt; Unwrapping files-to-be-installed.
1.14      xtraeme  10911: <code class="prompt">#</code>
1.75      rillig   10912: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1       grant    10913: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10914: ===&gt; Installing for figlet-2.2.1nb2
                   10915: install -d -o root -g wheel -m 755 /usr/pkg/bin
                   10916: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
                   10917: mkdir -p /usr/pkg/share/figlet
                   10918: cp figlet /usr/pkg/bin
                   10919: cp chkfont /usr/pkg/bin
                   10920: chmod 555 figlist showfigfonts
                   10921: cp figlist /usr/pkg/bin
                   10922: cp showfigfonts /usr/pkg/bin
                   10923: cp fonts/*.flf /usr/pkg/share/figlet
                   10924: cp fonts/*.flc /usr/pkg/share/figlet
                   10925: cp figlet.6 /usr/pkg/man/man6
                   10926: ===&gt; Registering installation for figlet-2.2.1nb2
1.75      rillig   10927: <code class="prompt">#</code></pre>
                   10928: </div>
1.148     asau     10929: <div class="sect1">
1.75      rillig   10930: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10931: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
                   10932: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1       grant    10933: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10934: ===&gt; Packaging figlet-2.2.1nb2
                   10935: ===&gt; Building binary package for figlet-2.2.1nb2
                   10936: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
                   10937: Using SrcDir value of /usr/pkg
1.68      rillig   10938: Registering depends:.
1.75      rillig   10939: <code class="prompt">#</code></pre>
                   10940: </div>
                   10941: </div>
1.148     asau     10942: <div class="appendix">
                   10943: <div class="titlepage"><div><div><h1 class="title">
                   10944: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h1></div></div></div>
1.76      rillig   10945: <div class="toc">
                   10946: <p><b>Table of Contents</b></p>
1.210     leot     10947: <dl class="toc">
1.128     wiz      10948: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
                   10949: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
                   10950: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
                   10951: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
                   10952: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
1.261     leot     10953: <code class="filename">stable</code>,
1.128     wiz      10954: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76      rillig   10955: source packages</a></span></dt>
                   10956: </dl>
                   10957: </div>
                   10958: <p>As in other big projects, the directory layout of pkgsrc
                   10959:        is quite complex for newbies. This chapter explains where you
                   10960:        find things on the FTP server. The base directory on
1.110     hubertf  10961:        <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   10962:        On other servers it may be different, but inside this directory,
                   10963:        everything should look the same, no matter on which server you
                   10964:        are. This directory contains some subdirectories, which are
                   10965:        explained below.</p>
1.148     asau     10966: <div class="sect1">
1.76      rillig   10967: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126     jakllsch 10968: <a name="ftp-distfiles"></a>C.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
1.76      rillig   10969: <p>The directory <code class="filename">distfiles</code> contains lots
                   10970:        of archive files from all pkgsrc packages, which are mirrored
                   10971:        here. The subdirectories are called after their package names
                   10972:        and are used when the distributed files have names that don't
                   10973:        explicitly contain a version number or are otherwise too generic
                   10974:        (for example <code class="filename">release.tar.gz</code>).</p>
                   10975: </div>
1.148     asau     10976: <div class="sect1">
1.76      rillig   10977: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126     jakllsch 10978: <a name="ftp-misc"></a>C.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
1.76      rillig   10979: <p>This directory contains things that individual pkgsrc
                   10980:        developers find worth publishing.</p>
                   10981: </div>
1.148     asau     10982: <div class="sect1">
1.76      rillig   10983: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126     jakllsch 10984: <a name="ftp-packages"></a>C.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
1.102     rillig   10985: <p>This directory contains binary packages for the various
                   10986:        platforms that are supported by pkgsrc.
                   10987:        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     10988: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      10989: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
1.109     rillig   10990:        operating system for which the packages have been built. The
1.110     hubertf  10991:        name is taken from the output of the <span class="command"><strong>uname</strong></span>
1.109     rillig   10992:        command, so it may differ from the one you are used to
                   10993:        hear.</p></li>
1.128     wiz      10994: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
1.108     rillig   10995:        architecture of the platform for which the packages have been
1.110     hubertf  10996:        built. It also includes the <code class="varname">ABI</code> (Application
                   10997:        Binary Interface) for platforms that have several of
                   10998:        them.</p></li>
1.128     wiz      10999: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
1.108     rillig   11000:        the operating system. For version numbers that change often (for
                   11001:        example NetBSD-current), the often-changing part should be
                   11002:        replaced with an <code class="literal">x</code>, for example
                   11003:        <code class="literal">4.99.x</code>.</p></li>
1.128     wiz      11004: <li class="listitem"><p><code class="varname">TAG</code> is either
1.126     jakllsch 11005:        <code class="literal">20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
1.108     rillig   11006:        for a stable branch, or <code class="literal">head</code> for packages
                   11007:        built from the HEAD branch. The latter should only be used when
                   11008:        the packages are updated on a regular basis. Otherwise the date
                   11009:        from checking out pkgsrc should be appended, for example
                   11010:        <code class="literal">head_20071015</code>.</p></li>
1.102     rillig   11011: </ul></div>
                   11012: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
                   11013:        can quickly click through the directories on the
                   11014:        server and find the best binary packages for their machines. Since they
                   11015:        usually know the operating system and the hardware architecture, OPSYS
                   11016:        and ARCH are placed first. After these choices, they can select the
                   11017:        best combination of OSVERSION and TAG together, since it is usually the
                   11018:        case that packages stay compatible between different version of the
                   11019:        operating system.</p>
                   11020: <p>In each of these directories, there is a
                   11021:        whole binary packages collection for a specific platform. It has a directory called
1.76      rillig   11022:        <code class="filename">All</code> which contains all binary packages.
                   11023:        Besides that, there are various category directories that
                   11024:        contain symbolic links to the real binary packages.</p>
                   11025: </div>
1.148     asau     11026: <div class="sect1">
1.76      rillig   11027: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126     jakllsch 11028: <a name="ftp-reports"></a>C.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.108     rillig   11029: <p>Here are the reports from bulk builds, for those who want
                   11030:        to fix packages that didn't build on some of the platforms. The
1.128     wiz      11031:        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   11032: </div>
1.148     asau     11033: <div class="sect1">
1.108     rillig   11034: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126     jakllsch 11035: <a name="ftp-source"></a>C.5. <code class="filename">current</code>,
1.261     leot     11036: <code class="filename">stable</code>,
1.126     jakllsch 11037: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76      rillig   11038: source packages</h2></div></div></div>
1.128     wiz      11039: <p>These directories contain the <span class="quote">&#8220;<span class="quote">real</span>&#8221;</span> pkgsrc,
1.76      rillig   11040:        that is the files that define how to create binary packages from
                   11041:        source archives.</p>
1.262     leot     11042: <p>Each of the <code class="filename">current</code>,
                   11043:        <code class="filename">stable</code> and
                   11044:        <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
                   11045:        directories share the same structure.  They each contain a
                   11046:        <code class="filename">pkgsrc</code> directory and
                   11047:        <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> file.</p>
1.76      rillig   11048: <p>The directory <code class="filename">pkgsrc</code> contains a
1.89      rillig   11049:        snapshot of the CVS repository, which is updated regularly. The
1.262     leot     11050:        file <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> contains the same
                   11051:        as the directory, ready to be downloaded as a whole.</p>
                   11052: <p>The <code class="filename">current</code> directory contains files
                   11053:        related to the HEAD branch of the CVS repository.
                   11054:        In this directory there is an additional file called
                   11055:        <code class="filename">pkgsrc-readmes.tar.{bz,gz,xz}</code> that contains
                   11056:        all pkgsrc <code class="filename">README</code>s with information about
                   11057:        categories and packages.
                   11058:        </p>
                   11059: <p>The <code class="filename">stable</code> directory is a symlink to
                   11060:        the latest 
                   11061:        <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
                   11062:        </p>
                   11063: <p>The
                   11064:        <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
                   11065:        directories contain files related to the 
                   11066:        <code class="filename">-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
                   11067:        stable branch of the CVS repository. In these directories there is
                   11068:        an additional file called
                   11069:        <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   11070:        which contains the state of pkgsrc when it was branched.</p>
                   11071: </div>
1.75      rillig   11072: </div>
1.148     asau     11073: <div class="appendix">
                   11074: <div class="titlepage"><div><div><h1 class="title">
1.267     rillig   11075: <a name="help-topics"></a>Appendix D. Help topics</h1></div></div></div>
                   11076: <p>
                   11077:        The following list contains all help topics that are available
                   11078:        when running <span class="command"><strong>bmake help topic=:index</strong></span>.
                   11079: </p>
1.269     leot     11080: <table border="0" summary="Simple list" class="simplelist">
                   11081: <tr>
                   11082: <td>#!</td>
                   11083: <td>-lintl</td>
                   11084: </tr>
                   11085: <tr>
                   11086: <td>64bit</td>
                   11087: <td>ABI</td>
                   11088: </tr>
                   11089: <tr>
                   11090: <td>ACCEPTABLE_LICENSES</td>
                   11091: <td>ACROREAD_FONTPATH</td>
                   11092: </tr>
                   11093: <tr>
                   11094: <td>ADDITIONAL</td>
                   11095: <td>AFAIK</td>
                   11096: </tr>
                   11097: <tr>
                   11098: <td>AIX</td>
                   11099: <td>ALLOW_VULNERABLE_PACKAGES</td>
                   11100: </tr>
                   11101: <tr>
                   11102: <td>ALL_ENV</td>
1.292     leot     11103: <td>ALSA_PC</td>
                   11104: </tr>
                   11105: <tr>
1.290     gutterid 11106: <td>ALTERNATIVES_SRC</td>
1.292     leot     11107: <td>AMANDA_TMP</td>
1.274     rillig   11108: </tr>
                   11109: <tr>
1.290     gutterid 11110: <td>AMANDA_USER</td>
1.292     leot     11111: <td>AMANDA_VAR</td>
1.269     leot     11112: </tr>
                   11113: <tr>
1.290     gutterid 11114: <td>APACHE_GROUP</td>
1.292     leot     11115: <td>APACHE_MODULE_NAME</td>
1.269     leot     11116: </tr>
                   11117: <tr>
1.290     gutterid 11118: <td>APACHE_MODULE_SRC</td>
1.292     leot     11119: <td>APACHE_MODULE_SRCDIR</td>
1.269     leot     11120: </tr>
                   11121: <tr>
1.290     gutterid 11122: <td>APACHE_PKG_PREFIX</td>
1.292     leot     11123: <td>APACHE_SUEXEC_CONFIGURE_ARGS</td>
1.269     leot     11124: </tr>
                   11125: <tr>
1.290     gutterid 11126: <td>APACHE_SUEXEC_DOCROOT</td>
1.292     leot     11127: <td>APACHE_USER</td>
1.269     leot     11128: </tr>
                   11129: <tr>
1.290     gutterid 11130: <td>APPEND_ABI</td>
1.292     leot     11131: <td>APPEND_ELF</td>
1.269     leot     11132: </tr>
                   11133: <tr>
1.290     gutterid 11134: <td>ARLA_CACHE</td>
1.292     leot     11135: <td>AUDIT_PACKAGES_FLAGS</td>
1.269     leot     11136: </tr>
                   11137: <tr>
1.290     gutterid 11138: <td>AUTOCONF_REQD</td>
1.292     leot     11139: <td>AUTOMAKE_OVERRIDE</td>
1.269     leot     11140: </tr>
                   11141: <tr>
1.290     gutterid 11142: <td>AUTOMAKE_REQD</td>
1.292     leot     11143: <td>AUTO_MKDIRS</td>
1.269     leot     11144: </tr>
                   11145: <tr>
1.290     gutterid 11146: <td>BDB185_DEFAULT</td>
1.292     leot     11147: <td>BDBBASE</td>
1.269     leot     11148: </tr>
                   11149: <tr>
1.290     gutterid 11150: <td>BDB_ACCEPTED</td>
1.292     leot     11151: <td>BDB_DEFAULT</td>
1.269     leot     11152: </tr>
                   11153: <tr>
1.290     gutterid 11154: <td>BDB_LIBS</td>
1.292     leot     11155: <td>BDB_TYPE</td>
1.269     leot     11156: </tr>
                   11157: <tr>
1.290     gutterid 11158: <td>BIND_DIR</td>
1.292     leot     11159: <td>BIND_GROUP</td>
1.269     leot     11160: </tr>
                   11161: <tr>
1.290     gutterid 11162: <td>BIND_USER</td>
1.292     leot     11163: <td>BINPKG_SITES</td>
1.269     leot     11164: </tr>
                   11165: <tr>
1.290     gutterid 11166: <td>BIN_INSTALL_FLAGS</td>
1.292     leot     11167: <td>BISON_PKGDATADIR</td>
                   11168: </tr>
                   11169: <tr>
                   11170: <td>BLAS_ACCEPTED</td>
                   11171: <td>BLAS_LIBS</td>
1.269     leot     11172: </tr>
                   11173: <tr>
1.292     leot     11174: <td>BLAS_TYPE</td>
1.269     leot     11175: <td>BOOTSTRAP_DEPENDS</td>
                   11176: </tr>
                   11177: <tr>
                   11178: <td>BOOTSTRAP_SETUPTOOLS</td>
                   11179: <td>BROKEN</td>
                   11180: </tr>
                   11181: <tr>
                   11182: <td>BROKEN_EXCEPT_ON_PLATFORM</td>
                   11183: <td>BROKEN_ON_PLATFORM</td>
                   11184: </tr>
                   11185: <tr>
                   11186: <td>BSDSRCDIR</td>
                   11187: <td>BSDXSRCDIR</td>
                   11188: </tr>
                   11189: <tr>
                   11190: <td>BSD_MAKE_ENV</td>
                   11191: <td>BUILDLINK_AUTO_DIRS</td>
                   11192: </tr>
                   11193: <tr>
                   11194: <td>BUILDLINK_AUTO_VARS</td>
                   11195: <td>BUILDLINK_CFLAGS</td>
                   11196: </tr>
                   11197: <tr>
                   11198: <td>BUILDLINK_CONTENTS_FILTER</td>
                   11199: <td>BUILDLINK_CPPFLAGS</td>
                   11200: </tr>
                   11201: <tr>
                   11202: <td>BUILDLINK_DEPMETHOD</td>
                   11203: <td>BUILDLINK_FILES</td>
                   11204: </tr>
                   11205: <tr>
                   11206: <td>BUILDLINK_FILES_CMD</td>
                   11207: <td>BUILDLINK_FNAME_TRANSFORM</td>
                   11208: </tr>
                   11209: <tr>
                   11210: <td>BUILDLINK_LDFLAGS</td>
                   11211: <td>BUILDLINK_LIBS</td>
                   11212: </tr>
                   11213: <tr>
                   11214: <td>BUILDLINK_OPSYS_SUPPORT_PTHREAD</td>
                   11215: <td>BUILDLINK_PKGNAME</td>
                   11216: </tr>
                   11217: <tr>
                   11218: <td>BUILDLINK_PREFIX</td>
                   11219: <td>BUILDLINK_RPATHDIRS</td>
                   11220: </tr>
                   11221: <tr>
                   11222: <td>BUILDLINK_TREE</td>
                   11223: <td>BUILD_DEFS</td>
                   11224: </tr>
                   11225: <tr>
                   11226: <td>BUILD_DEFS_EFFECTS</td>
                   11227: <td>BUILD_DEPENDS</td>
                   11228: </tr>
                   11229: <tr>
                   11230: <td>BUILD_DIRS</td>
                   11231: <td>BUILD_ENV_SHELL</td>
                   11232: </tr>
                   11233: <tr>
                   11234: <td>BUILD_MAKE_CMD</td>
                   11235: <td>BUILD_MAKE_FLAGS</td>
                   11236: </tr>
                   11237: <tr>
                   11238: <td>BUILD_TARGET</td>
                   11239: <td>BUILTIN_FIND_FILES</td>
                   11240: </tr>
                   11241: <tr>
                   11242: <td>BUILTIN_FIND_FILES_VAR</td>
                   11243: <td>BUILTIN_FIND_GREP</td>
                   11244: </tr>
                   11245: <tr>
                   11246: <td>BUILTIN_FIND_HEADERS</td>
                   11247: <td>BUILTIN_FIND_HEADERS_VAR</td>
                   11248: </tr>
                   11249: <tr>
                   11250: <td>BUILTIN_PKG</td>
                   11251: <td>BUILTIN_TEST_CURSES_DEFINES</td>
                   11252: </tr>
                   11253: <tr>
                   11254: <td>BUILTIN_TEST_CURSES_FUNCS</td>
                   11255: <td>BUILTIN_VERSION_SCRIPT</td>
                   11256: </tr>
                   11257: <tr>
                   11258: <td>BUILTIN_X11_TYPE</td>
                   11259: <td>BUILTIN_X11_VERSION</td>
                   11260: </tr>
                   11261: <tr>
                   11262: <td>CACTI_GROUP</td>
                   11263: <td>CACTI_USER</td>
                   11264: </tr>
                   11265: <tr>
                   11266: <td>CANNA_GROUP</td>
                   11267: <td>CANNA_USER</td>
                   11268: </tr>
                   11269: <tr>
                   11270: <td>CAT</td>
                   11271: <td>CCACHE_BASE</td>
                   11272: </tr>
                   11273: <tr>
                   11274: <td>CCACHE_DIR</td>
                   11275: <td>CCACHE_LOGFILE</td>
                   11276: </tr>
                   11277: <tr>
                   11278: <td>CC_VERSION</td>
                   11279: <td>CC_VERSION_STRING</td>
                   11280: </tr>
                   11281: <tr>
                   11282: <td>CDRECORD_CONF</td>
                   11283: <td>CDROM_PKG_URL_DIR</td>
                   11284: </tr>
                   11285: <tr>
                   11286: <td>CDROM_PKG_URL_HOST</td>
1.292     leot     11287: <td>CHECKOUT_DATE</td>
                   11288: </tr>
                   11289: <tr>
1.295     rillig   11290: <td>CHECK_COMPILER</td>
1.290     gutterid 11291: <td>CHECK_FAKEHOME</td>
1.274     rillig   11292: </tr>
                   11293: <tr>
1.295     rillig   11294: <td>CHECK_FILES</td>
1.290     gutterid 11295: <td>CHECK_FILES_SKIP</td>
1.269     leot     11296: </tr>
                   11297: <tr>
1.295     rillig   11298: <td>CHECK_FILES_STRICT</td>
1.290     gutterid 11299: <td>CHECK_HEADERS</td>
1.269     leot     11300: </tr>
                   11301: <tr>
1.295     rillig   11302: <td>CHECK_HEADERS_SKIP</td>
1.290     gutterid 11303: <td>CHECK_INTERPRETER</td>
1.269     leot     11304: </tr>
                   11305: <tr>
1.295     rillig   11306: <td>CHECK_INTERPRETER_SKIP</td>
1.290     gutterid 11307: <td>CHECK_PERMS</td>
1.269     leot     11308: </tr>
                   11309: <tr>
1.295     rillig   11310: <td>CHECK_PERMS_AUTOFIX</td>
1.290     gutterid 11311: <td>CHECK_PERMS_SKIP</td>
1.269     leot     11312: </tr>
                   11313: <tr>
1.295     rillig   11314: <td>CHECK_PORTABILITY</td>
1.292     leot     11315: <td>CHECK_PORTABILITY_EXPERIMENTAL</td>
1.269     leot     11316: </tr>
                   11317: <tr>
1.295     rillig   11318: <td>CHECK_PORTABILITY_SKIP</td>
1.274     rillig   11319: <td>CHECK_RELRO</td>
1.269     leot     11320: </tr>
                   11321: <tr>
1.295     rillig   11322: <td>CHECK_RELRO_SKIP</td>
1.274     rillig   11323: <td>CHECK_RELRO_SUPPORTED</td>
1.269     leot     11324: </tr>
                   11325: <tr>
1.295     rillig   11326: <td>CHECK_SHLIBS</td>
1.274     rillig   11327: <td>CHECK_SHLIBS_BLACKLIST</td>
1.269     leot     11328: </tr>
                   11329: <tr>
1.295     rillig   11330: <td>CHECK_SHLIBS_SKIP</td>
1.274     rillig   11331: <td>CHECK_SHLIBS_SUPPORTED</td>
1.269     leot     11332: </tr>
                   11333: <tr>
1.295     rillig   11334: <td>CHECK_SSP</td>
1.274     rillig   11335: <td>CHECK_SSP_SKIP</td>
1.269     leot     11336: </tr>
                   11337: <tr>
1.295     rillig   11338: <td>CHECK_SSP_SUPPORTED</td>
1.274     rillig   11339: <td>CHECK_STRIPPED</td>
1.269     leot     11340: </tr>
                   11341: <tr>
1.295     rillig   11342: <td>CHECK_STRIPPED_SKIP</td>
1.274     rillig   11343: <td>CHECK_WRKREF</td>
1.269     leot     11344: </tr>
                   11345: <tr>
1.295     rillig   11346: <td>CHECK_WRKREF_EXTRA_DIRS</td>
1.274     rillig   11347: <td>CHECK_WRKREF_SKIP</td>
1.269     leot     11348: </tr>
                   11349: <tr>
1.295     rillig   11350: <td>CLAMAV_DBDIR</td>
1.274     rillig   11351: <td>CLAMAV_GROUP</td>
1.269     leot     11352: </tr>
                   11353: <tr>
1.295     rillig   11354: <td>CLAMAV_USER</td>
1.274     rillig   11355: <td>CLANGBASE</td>
1.269     leot     11356: </tr>
                   11357: <tr>
1.295     rillig   11358: <td>CLEANDEPENDS</td>
1.274     rillig   11359: <td>CMAKE_DEPENDENCIES_REWRITE</td>
1.269     leot     11360: </tr>
                   11361: <tr>
1.295     rillig   11362: <td>CMAKE_INSTALL_PREFIX</td>
1.274     rillig   11363: <td>CMAKE_MODULE_PATH_OVERRIDE</td>
1.269     leot     11364: </tr>
                   11365: <tr>
1.295     rillig   11366: <td>CMAKE_PKGSRC_BUILD_FLAGS</td>
1.274     rillig   11367: <td>CMAKE_PREFIX_PATH</td>
1.269     leot     11368: </tr>
                   11369: <tr>
1.295     rillig   11370: <td>CMAKE_USE_GNU_INSTALL_DIRS</td>
1.292     leot     11371: <td>COMMON_LISP_DOCFILES</td>
                   11372: </tr>
                   11373: <tr>
1.295     rillig   11374: <td>COMMON_LISP_EXAMPLES</td>
1.292     leot     11375: <td>COMMON_LISP_EXTRAFILES</td>
                   11376: </tr>
                   11377: <tr>
1.295     rillig   11378: <td>COMMON_LISP_PACKAGES</td>
1.292     leot     11379: <td>COMMON_LISP_SYSTEM</td>
                   11380: </tr>
                   11381: <tr>
1.295     rillig   11382: <td>COMPILER_RPATH_FLAG</td>
1.269     leot     11383: <td>COMPILER_USE_SYMLINKS</td>
                   11384: </tr>
                   11385: <tr>
1.295     rillig   11386: <td>CONFIGURE_ARGS</td>
1.269     leot     11387: <td>CONFIGURE_DIRS</td>
                   11388: </tr>
                   11389: <tr>
1.295     rillig   11390: <td>CONFIGURE_ENV</td>
1.287     rillig   11391: <td>CONFIGURE_ENV_SHELL</td>
1.269     leot     11392: </tr>
                   11393: <tr>
1.295     rillig   11394: <td>CONFIGURE_HAS_INFODIR</td>
1.269     leot     11395: <td>CONFIGURE_HAS_MANDIR</td>
                   11396: </tr>
                   11397: <tr>
1.295     rillig   11398: <td>CONFIGURE_SCRIPT</td>
1.269     leot     11399: <td>CONFIG_SHELL</td>
                   11400: </tr>
                   11401: <tr>
1.295     rillig   11402: <td>CONFIG_SHELL_FLAGS</td>
1.269     leot     11403: <td>CONF_FILES</td>
                   11404: </tr>
                   11405: <tr>
1.295     rillig   11406: <td>CONF_FILES_MODE</td>
1.269     leot     11407: <td>CONF_FILES_PERMS</td>
                   11408: </tr>
                   11409: <tr>
1.295     rillig   11410: <td>CONSERVER_DEFAULTHOST</td>
1.269     leot     11411: <td>CONSERVER_DEFAULTPORT</td>
                   11412: </tr>
                   11413: <tr>
1.295     rillig   11414: <td>CP</td>
1.269     leot     11415: <td>CPP</td>
                   11416: </tr>
                   11417: <tr>
1.295     rillig   11418: <td>CPP_PRECOMP_FLAGS</td>
1.269     leot     11419: <td>CREATE_WRKDIR_SYMLINK</td>
                   11420: </tr>
                   11421: <tr>
1.295     rillig   11422: <td>CROSSBASE</td>
1.269     leot     11423: <td>CTFCONVERT</td>
                   11424: </tr>
                   11425: <tr>
1.295     rillig   11426: <td>CTF_FILES_SKIP</td>
1.269     leot     11427: <td>CTF_SUPPORTED</td>
                   11428: </tr>
                   11429: <tr>
1.295     rillig   11430: <td>CTYPE</td>
1.269     leot     11431: <td>CUPS_GROUP</td>
                   11432: </tr>
                   11433: <tr>
1.295     rillig   11434: <td>CUPS_SYSTEM_GROUPS</td>
1.269     leot     11435: <td>CUPS_USER</td>
                   11436: </tr>
                   11437: <tr>
1.295     rillig   11438: <td>CURSES_DEFAULT</td>
1.269     leot     11439: <td>CURSES_TYPE</td>
1.292     leot     11440: </tr>
                   11441: <tr>
1.295     rillig   11442: <td>CVS_EXTRACTDIR</td>
1.292     leot     11443: <td>CVS_MODULE</td>
                   11444: </tr>
                   11445: <tr>
1.295     rillig   11446: <td>CVS_PROJECT</td>
1.292     leot     11447: <td>CVS_REPOSITORIES</td>
                   11448: </tr>
                   11449: <tr>
1.295     rillig   11450: <td>CVS_ROOT</td>
1.292     leot     11451: <td>CVS_ROOT_GNU</td>
                   11452: </tr>
                   11453: <tr>
1.295     rillig   11454: <td>CVS_ROOT_NONGNU</td>
1.292     leot     11455: <td>CVS_ROOT_SOURCEFORGE</td>
1.274     rillig   11456: </tr>
                   11457: <tr>
1.295     rillig   11458: <td>CVS_TAG</td>
1.273     brook    11459: <td>CXX</td>
1.269     leot     11460: </tr>
                   11461: <tr>
1.295     rillig   11462: <td>CYRUS_GROUP</td>
1.273     brook    11463: <td>CYRUS_IDLE</td>
1.269     leot     11464: </tr>
                   11465: <tr>
1.295     rillig   11466: <td>CYRUS_USER</td>
1.273     brook    11467: <td>DAEMONTOOLS_GROUP</td>
1.269     leot     11468: </tr>
                   11469: <tr>
1.295     rillig   11470: <td>DAEMONTOOLS_LOG_USER</td>
1.273     brook    11471: <td>DBUS_GROUP</td>
1.269     leot     11472: </tr>
                   11473: <tr>
1.295     rillig   11474: <td>DBUS_USER</td>
1.273     brook    11475: <td>DEFANG_GROUP</td>
1.269     leot     11476: </tr>
                   11477: <tr>
1.295     rillig   11478: <td>DEFANG_USER</td>
1.273     brook    11479: <td>DEFAULT_ACCEPTABLE_LICENSES</td>
1.269     leot     11480: </tr>
                   11481: <tr>
1.295     rillig   11482: <td>DEFAULT_DISTFILES</td>
1.273     brook    11483: <td>DEFAULT_IRC_SERVER</td>
1.269     leot     11484: </tr>
                   11485: <tr>
1.295     rillig   11486: <td>DEFAULT_SERIAL_DEVICE</td>
1.273     brook    11487: <td>DEF_UMASK</td>
1.269     leot     11488: </tr>
                   11489: <tr>
1.295     rillig   11490: <td>DEINSTALLDEPENDS</td>
1.273     brook    11491: <td>DEINSTALL_SRC</td>
1.269     leot     11492: </tr>
                   11493: <tr>
1.295     rillig   11494: <td>DEINSTALL_TEMPLATES</td>
1.273     brook    11495: <td>DELAYED_ERROR_MSG</td>
1.269     leot     11496: </tr>
                   11497: <tr>
1.295     rillig   11498: <td>DELAYED_WARNING_MSG</td>
1.273     brook    11499: <td>DEPENDS</td>
1.269     leot     11500: </tr>
                   11501: <tr>
1.295     rillig   11502: <td>DEPENDS_TARGET</td>
1.273     brook    11503: <td>DEPENDS_TYPE</td>
1.269     leot     11504: </tr>
                   11505: <tr>
1.295     rillig   11506: <td>DESTDIR</td>
1.273     brook    11507: <td>DESTDIR_VARNAME</td>
1.269     leot     11508: </tr>
                   11509: <tr>
1.295     rillig   11510: <td>DIALER_GROUP</td>
1.273     brook    11511: <td>DIGEST_REQD</td>
1.269     leot     11512: </tr>
                   11513: <tr>
1.295     rillig   11514: <td>DISTDIR</td>
1.273     brook    11515: <td>DISTFILES</td>
1.269     leot     11516: </tr>
                   11517: <tr>
1.295     rillig   11518: <td>DISTINFO_FILE</td>
1.273     brook    11519: <td>DISTNAME</td>
1.269     leot     11520: </tr>
                   11521: <tr>
1.295     rillig   11522: <td>DIST_PATH</td>
1.273     brook    11523: <td>DIST_SUBDIR</td>
1.269     leot     11524: </tr>
                   11525: <tr>
1.295     rillig   11526: <td>DJBDNS_AXFR_USER</td>
1.273     brook    11527: <td>DJBDNS_CACHE_USER</td>
1.269     leot     11528: </tr>
                   11529: <tr>
1.295     rillig   11530: <td>DJBDNS_DJBDNS_GROUP</td>
1.273     brook    11531: <td>DJBDNS_LOG_USER</td>
1.269     leot     11532: </tr>
                   11533: <tr>
1.295     rillig   11534: <td>DJBDNS_RBL_USER</td>
1.273     brook    11535: <td>DJBDNS_TINY_USER</td>
1.269     leot     11536: </tr>
                   11537: <tr>
1.295     rillig   11538: <td>DLOPEN_REQUIRE_PTHREADS</td>
1.273     brook    11539: <td>DL_AUTO_VARS</td>
1.269     leot     11540: </tr>
                   11541: <tr>
1.295     rillig   11542: <td>DL_CFLAGS</td>
1.273     brook    11543: <td>DL_LDFLAGS</td>
1.269     leot     11544: </tr>
                   11545: <tr>
1.295     rillig   11546: <td>DL_LIBS</td>
1.273     brook    11547: <td>DNS</td>
1.269     leot     11548: </tr>
                   11549: <tr>
1.295     rillig   11550: <td>DOWNLOADED_DISTFILE</td>
1.273     brook    11551: <td>DT_LAYOUT</td>
1.269     leot     11552: </tr>
                   11553: <tr>
1.295     rillig   11554: <td>DYNAMIC_SITES_CMD</td>
1.273     brook    11555: <td>DYNAMIC_SITES_SCRIPT</td>
1.269     leot     11556: </tr>
                   11557: <tr>
1.295     rillig   11558: <td>ECHO</td>
1.273     brook    11559: <td>ECHO_N</td>
1.269     leot     11560: </tr>
                   11561: <tr>
1.295     rillig   11562: <td>ELK_GUI</td>
1.273     brook    11563: <td>EMACS_TYPE</td>
1.269     leot     11564: </tr>
                   11565: <tr>
1.295     rillig   11566: <td>EMULDIR</td>
1.273     brook    11567: <td>EMULSUBDIR</td>
1.269     leot     11568: </tr>
                   11569: <tr>
1.295     rillig   11570: <td>EMULSUBDIRSLASH</td>
1.273     brook    11571: <td>EMUL_ARCH</td>
1.269     leot     11572: </tr>
                   11573: <tr>
1.295     rillig   11574: <td>EMUL_DISTRO</td>
1.273     brook    11575: <td>EMUL_EXEC_FMT</td>
1.269     leot     11576: </tr>
                   11577: <tr>
1.295     rillig   11578: <td>EMUL_IS_NATIVE</td>
1.273     brook    11579: <td>EMUL_MODULES</td>
1.269     leot     11580: </tr>
                   11581: <tr>
1.295     rillig   11582: <td>EMUL_OPSYS</td>
1.273     brook    11583: <td>EMUL_PKG_FMT</td>
1.269     leot     11584: </tr>
                   11585: <tr>
1.295     rillig   11586: <td>EMUL_PLATFORM</td>
1.273     brook    11587: <td>EMUL_PLATFORMS</td>
1.269     leot     11588: </tr>
                   11589: <tr>
1.295     rillig   11590: <td>EMUL_PREFER</td>
1.273     brook    11591: <td>EMUL_REQD</td>
1.269     leot     11592: </tr>
                   11593: <tr>
1.295     rillig   11594: <td>EMUL_TYPE</td>
1.273     brook    11595: <td>ERROR_MSG</td>
1.269     leot     11596: </tr>
                   11597: <tr>
1.295     rillig   11598: <td>EXIM_GROUP</td>
1.273     brook    11599: <td>EXIM_USER</td>
1.269     leot     11600: </tr>
                   11601: <tr>
1.295     rillig   11602: <td>EXPORT_SYMBOLS_LDFLAGS</td>
1.273     brook    11603: <td>EXTRACTOR</td>
1.269     leot     11604: </tr>
                   11605: <tr>
1.295     rillig   11606: <td>EXTRACT_CMD</td>
1.273     brook    11607: <td>EXTRACT_CMD_DEFAULT</td>
1.269     leot     11608: </tr>
                   11609: <tr>
1.295     rillig   11610: <td>EXTRACT_DIR</td>
1.273     brook    11611: <td>EXTRACT_ELEMENTS</td>
1.269     leot     11612: </tr>
                   11613: <tr>
1.295     rillig   11614: <td>EXTRACT_ENV</td>
1.273     brook    11615: <td>EXTRACT_ONLY</td>
1.269     leot     11616: </tr>
                   11617: <tr>
1.295     rillig   11618: <td>EXTRACT_OPTS</td>
1.273     brook    11619: <td>EXTRACT_SUFX</td>
1.269     leot     11620: </tr>
                   11621: <tr>
1.295     rillig   11622: <td>EXTRACT_USING</td>
1.292     leot     11623: <td>FAIL</td>
                   11624: </tr>
                   11625: <tr>
1.295     rillig   11626: <td>FAILOVER_FETCH</td>
1.290     gutterid 11627: <td>FAIL_MSG</td>
1.269     leot     11628: </tr>
                   11629: <tr>
1.295     rillig   11630: <td>FAKE_NCURSES</td>
1.290     gutterid 11631: <td>FAM</td>
1.269     leot     11632: </tr>
                   11633: <tr>
1.295     rillig   11634: <td>FAM_ACCEPTED</td>
1.290     gutterid 11635: <td>FAM_DEFAULT</td>
1.269     leot     11636: </tr>
                   11637: <tr>
1.295     rillig   11638: <td>FAM_SERVER</td>
1.290     gutterid 11639: <td>FCPATH</td>
1.269     leot     11640: </tr>
                   11641: <tr>
1.295     rillig   11642: <td>FEATURE_CPPFLAGS</td>
1.290     gutterid 11643: <td>FEATURE_LDFLAGS</td>
1.269     leot     11644: </tr>
                   11645: <tr>
1.295     rillig   11646: <td>FEATURE_LIBS</td>
1.290     gutterid 11647: <td>FETCH_AFTER_ARGS</td>
1.269     leot     11648: </tr>
                   11649: <tr>
1.295     rillig   11650: <td>FETCH_BEFORE_ARGS</td>
1.290     gutterid 11651: <td>FETCH_CMD</td>
1.269     leot     11652: </tr>
                   11653: <tr>
1.295     rillig   11654: <td>FETCH_OUTPUT_ARGS</td>
1.290     gutterid 11655: <td>FETCH_PROXY</td>
1.269     leot     11656: </tr>
                   11657: <tr>
1.295     rillig   11658: <td>FETCH_RESUME_ARGS</td>
1.290     gutterid 11659: <td>FETCH_USING</td>
1.269     leot     11660: </tr>
                   11661: <tr>
1.295     rillig   11662: <td>FILES_SUBST</td>
1.290     gutterid 11663: <td>FILES_SUBST_SED</td>
1.269     leot     11664: </tr>
                   11665: <tr>
1.295     rillig   11666: <td>FIX_SYSTEM_HEADERS</td>
1.290     gutterid 11667: <td>FLUXBOX_USE_GNOME</td>
1.269     leot     11668: </tr>
                   11669: <tr>
1.295     rillig   11670: <td>FLUXBOX_USE_KDE</td>
1.290     gutterid 11671: <td>FLUXBOX_USE_XFT</td>
1.269     leot     11672: </tr>
                   11673: <tr>
1.295     rillig   11674: <td>FLUXBOX_USE_XINERAMA</td>
1.292     leot     11675: <td>FONTDIR</td>
1.269     leot     11676: </tr>
                   11677: <tr>
1.295     rillig   11678: <td>FONTS_DIRS</td>
1.287     rillig   11679: <td>FONTS_VERBOSE</td>
1.274     rillig   11680: </tr>
                   11681: <tr>
1.295     rillig   11682: <td>FOO_HACKS_MK</td>
1.292     leot     11683: <td>FOSSIL_EXTRACTDIR</td>
                   11684: </tr>
                   11685: <tr>
1.295     rillig   11686: <td>FOSSIL_REPO</td>
1.292     leot     11687: <td>FOSSIL_REPOSITORIES</td>
                   11688: </tr>
                   11689: <tr>
1.295     rillig   11690: <td>FOSSIL_VERSION</td>
1.287     rillig   11691: <td>FOX_USE_XUNICODE</td>
1.269     leot     11692: </tr>
                   11693: <tr>
1.295     rillig   11694: <td>FREEWNN_GROUP</td>
1.287     rillig   11695: <td>FREEWNN_USER</td>
1.269     leot     11696: </tr>
                   11697: <tr>
1.295     rillig   11698: <td>FTP_PKG_URL_DIR</td>
1.287     rillig   11699: <td>FTP_PKG_URL_HOST</td>
1.269     leot     11700: </tr>
                   11701: <tr>
1.295     rillig   11702: <td>GAMEDATAMODE</td>
1.287     rillig   11703: <td>GAMEDATA_PERMS</td>
1.269     leot     11704: </tr>
                   11705: <tr>
1.295     rillig   11706: <td>GAMEDIRMODE</td>
1.287     rillig   11707: <td>GAMEDIR_PERMS</td>
1.269     leot     11708: </tr>
                   11709: <tr>
1.295     rillig   11710: <td>GAMEGRP</td>
1.287     rillig   11711: <td>GAMEMODE</td>
1.269     leot     11712: </tr>
                   11713: <tr>
1.295     rillig   11714: <td>GAMEOWN</td>
1.287     rillig   11715: <td>GAMES_GROUP</td>
1.269     leot     11716: </tr>
                   11717: <tr>
1.295     rillig   11718: <td>GAMES_USER</td>
1.287     rillig   11719: <td>GCC</td>
1.269     leot     11720: </tr>
                   11721: <tr>
1.295     rillig   11722: <td>GCCBASE</td>
1.287     rillig   11723: <td>GCC_REQD</td>
1.269     leot     11724: </tr>
                   11725: <tr>
1.295     rillig   11726: <td>GCC_VERSION_SUFFIX</td>
1.287     rillig   11727: <td>GEM_BUILD</td>
1.269     leot     11728: </tr>
                   11729: <tr>
1.295     rillig   11730: <td>GEM_CLEANBUILD</td>
1.287     rillig   11731: <td>GEM_CLEANBUILD_EXTENSIONS</td>
1.269     leot     11732: </tr>
                   11733: <tr>
1.295     rillig   11734: <td>GEM_DOCDIR</td>
1.287     rillig   11735: <td>GEM_EXTSDIR</td>
1.269     leot     11736: </tr>
                   11737: <tr>
1.295     rillig   11738: <td>GEM_HOME</td>
1.292     leot     11739: <td>GEM_KEEPBUILD</td>
                   11740: </tr>
                   11741: <tr>
1.295     rillig   11742: <td>GEM_LIBDIR</td>
1.269     leot     11743: <td>GEM_NAME</td>
                   11744: </tr>
                   11745: <tr>
1.295     rillig   11746: <td>GEM_PATH</td>
1.269     leot     11747: <td>GEM_SPECFILE</td>
                   11748: </tr>
                   11749: <tr>
1.295     rillig   11750: <td>GENERATE_PLIST</td>
1.269     leot     11751: <td>GHOSTSCRIPT_REQD</td>
                   11752: </tr>
                   11753: <tr>
1.295     rillig   11754: <td>GITHUB_PROJECT</td>
1.269     leot     11755: <td>GITHUB_RELEASE</td>
                   11756: </tr>
                   11757: <tr>
1.295     rillig   11758: <td>GITHUB_TAG</td>
1.269     leot     11759: <td>GITHUB_TYPE</td>
1.292     leot     11760: </tr>
                   11761: <tr>
1.295     rillig   11762: <td>GITLAB_PROJECT</td>
1.292     leot     11763: <td>GITLAB_TAG</td>
                   11764: </tr>
                   11765: <tr>
1.295     rillig   11766: <td>GITLAB_TYPE</td>
1.292     leot     11767: <td>GIT_BRANCH</td>
1.274     rillig   11768: </tr>
                   11769: <tr>
1.295     rillig   11770: <td>GIT_ENV</td>
1.292     leot     11771: <td>GIT_EXTRACTDIR</td>
                   11772: </tr>
                   11773: <tr>
1.295     rillig   11774: <td>GIT_REPO</td>
1.292     leot     11775: <td>GIT_REPOSITORIES</td>
                   11776: </tr>
                   11777: <tr>
1.295     rillig   11778: <td>GIT_REVISION</td>
1.292     leot     11779: <td>GIT_TAG</td>
                   11780: </tr>
                   11781: <tr>
1.295     rillig   11782: <td>GNU</td>
1.290     gutterid 11783: <td>GNU_CONFIGURE</td>
1.269     leot     11784: </tr>
                   11785: <tr>
1.295     rillig   11786: <td>GNU_CONFIGURE_INFODIR</td>
1.290     gutterid 11787: <td>GNU_CONFIGURE_MANDIR</td>
1.269     leot     11788: </tr>
                   11789: <tr>
1.295     rillig   11790: <td>GNU_CONFIGURE_QUIET</td>
1.293     rillig   11791: <td>GNU_CONFIGURE_STRICT</td>
1.269     leot     11792: </tr>
                   11793: <tr>
1.295     rillig   11794: <td>GODEP_REDIRECTS</td>
1.293     rillig   11795: <td>GO_BUILD_PATTERN</td>
1.269     leot     11796: </tr>
                   11797: <tr>
1.295     rillig   11798: <td>GO_DEPS</td>
1.293     rillig   11799: <td>GO_DIST_BASE</td>
1.269     leot     11800: </tr>
                   11801: <tr>
1.295     rillig   11802: <td>GO_MODULE_FILES</td>
1.293     rillig   11803: <td>GO_SRCPATH</td>
1.276     leot     11804: </tr>
                   11805: <tr>
1.295     rillig   11806: <td>GO_VERSION_DEFAULT</td>
1.293     rillig   11807: <td>GROUP_SPECIFIC_PKGS</td>
1.269     leot     11808: </tr>
                   11809: <tr>
1.295     rillig   11810: <td>GRUB_NETWORK_CARDS</td>
1.293     rillig   11811: <td>GRUB_PRESET_COMMAND</td>
1.269     leot     11812: </tr>
                   11813: <tr>
1.295     rillig   11814: <td>GRUB_SCAN_ARGS</td>
1.293     rillig   11815: <td>GZIP</td>
1.269     leot     11816: </tr>
                   11817: <tr>
1.295     rillig   11818: <td>HASKELL_COMPILER</td>
1.293     rillig   11819: <td>HASKELL_ENABLE_HADDOCK_DOCUMENTATION</td>
1.269     leot     11820: </tr>
                   11821: <tr>
1.295     rillig   11822: <td>HASKELL_ENABLE_LIBRARY_PROFILING</td>
1.293     rillig   11823: <td>HASKELL_ENABLE_SHARED_LIBRARY</td>
1.269     leot     11824: </tr>
                   11825: <tr>
1.295     rillig   11826: <td>HASKELL_OPTIMIZATION_LEVEL</td>
1.293     rillig   11827: <td>HAS_CONFIGURE</td>
1.292     leot     11828: </tr>
                   11829: <tr>
1.295     rillig   11830: <td>HEADER_TEMPLATES</td>
1.293     rillig   11831: <td>HG_REPO</td>
1.274     rillig   11832: </tr>
                   11833: <tr>
1.295     rillig   11834: <td>HG_REPOSITORIES</td>
1.293     rillig   11835: <td>HG_TAG</td>
1.269     leot     11836: </tr>
                   11837: <tr>
1.295     rillig   11838: <td>HOST_PKGTOOLS_ARGS</td>
1.293     rillig   11839: <td>HOST_SPECIFIC_PKGS</td>
1.269     leot     11840: </tr>
                   11841: <tr>
1.295     rillig   11842: <td>HOWL_GROUP</td>
1.293     rillig   11843: <td>HOWL_USER</td>
1.269     leot     11844: </tr>
                   11845: <tr>
1.295     rillig   11846: <td>ICCBASE</td>
1.293     rillig   11847: <td>ICECAST_CHROOTDIR</td>
1.269     leot     11848: </tr>
                   11849: <tr>
1.295     rillig   11850: <td>ICON_THEMES</td>
1.293     rillig   11851: <td>IDOBASE</td>
1.269     leot     11852: </tr>
                   11853: <tr>
1.295     rillig   11854: <td>IGNORE_CCACHE</td>
1.293     rillig   11855: <td>IGNORE_INFO_DIRS</td>
1.269     leot     11856: </tr>
                   11857: <tr>
1.295     rillig   11858: <td>IGNORE_INTERACTIVE_FETCH</td>
1.293     rillig   11859: <td>IMAKE</td>
1.269     leot     11860: </tr>
                   11861: <tr>
1.295     rillig   11862: <td>IMAKEOPTS</td>
1.293     rillig   11863: <td>IMAKE_MAKE</td>
1.269     leot     11864: </tr>
                   11865: <tr>
1.295     rillig   11866: <td>IMAKE_MANINSTALL</td>
1.293     rillig   11867: <td>IMAP_UW_CCLIENT_MBOX_FMT</td>
1.269     leot     11868: </tr>
                   11869: <tr>
1.295     rillig   11870: <td>IMDICTDIR</td>
1.293     rillig   11871: <td>INCOMPAT_CURSES</td>
1.269     leot     11872: </tr>
                   11873: <tr>
1.295     rillig   11874: <td>INFO_DIR</td>
1.293     rillig   11875: <td>INFO_FILES</td>
1.269     leot     11876: </tr>
                   11877: <tr>
1.295     rillig   11878: <td>INFO_FILES_VERBOSE</td>
1.293     rillig   11879: <td>INFO_MSG</td>
1.269     leot     11880: </tr>
                   11881: <tr>
1.295     rillig   11882: <td>INIT_SYSTEM</td>
1.293     rillig   11883: <td>INN_DATA_DIR</td>
1.269     leot     11884: </tr>
                   11885: <tr>
1.295     rillig   11886: <td>INN_GROUP</td>
1.293     rillig   11887: <td>INN_USER</td>
1.287     rillig   11888: </tr>
                   11889: <tr>
1.295     rillig   11890: <td>INSTALLATION_DIRS</td>
1.293     rillig   11891: <td>INSTALLATION_DIRS_FROM_PLIST</td>
1.269     leot     11892: </tr>
                   11893: <tr>
1.295     rillig   11894: <td>INSTALL_ENV</td>
1.293     rillig   11895: <td>INSTALL_SH_OVERRIDE</td>
1.269     leot     11896: </tr>
                   11897: <tr>
1.295     rillig   11898: <td>INSTALL_SRC</td>
1.293     rillig   11899: <td>INSTALL_TEMPLATES</td>
1.269     leot     11900: </tr>
                   11901: <tr>
1.295     rillig   11902: <td>INSTALL_UNSTRIPPED</td>
1.293     rillig   11903: <td>IRCD_HYBRID_IRC_GROUP</td>
1.269     leot     11904: </tr>
                   11905: <tr>
1.295     rillig   11906: <td>IRCD_HYBRID_IRC_USER</td>
1.293     rillig   11907: <td>IRCD_HYBRID_MAXCONN</td>
1.269     leot     11908: </tr>
                   11909: <tr>
1.295     rillig   11910: <td>IRCD_HYBRID_NICLEN</td>
1.293     rillig   11911: <td>IRCD_HYBRID_SYSLOG_EVENTS</td>
1.269     leot     11912: </tr>
                   11913: <tr>
1.295     rillig   11914: <td>IRCD_HYBRID_SYSLOG_FACILITY</td>
1.293     rillig   11915: <td>IRCD_HYBRID_TOPICLEN</td>
1.269     leot     11916: </tr>
                   11917: <tr>
1.295     rillig   11918: <td>IRIX</td>
1.293     rillig   11919: <td>IRRD_USE_PGP</td>
1.269     leot     11920: </tr>
                   11921: <tr>
1.295     rillig   11922: <td>JABBERD_GROUP</td>
1.293     rillig   11923: <td>JABBERD_LOGDIR</td>
1.269     leot     11924: </tr>
                   11925: <tr>
1.295     rillig   11926: <td>JABBERD_PIDDIR</td>
1.293     rillig   11927: <td>JABBERD_SPOOLDIR</td>
1.269     leot     11928: </tr>
                   11929: <tr>
1.295     rillig   11930: <td>JABBERD_USER</td>
1.293     rillig   11931: <td>JAKARTA_HOME</td>
1.292     leot     11932: </tr>
                   11933: <tr>
1.295     rillig   11934: <td>JAVA_APP_PATH</td>
1.293     rillig   11935: <td>JAVA_APP_TARGETS</td>
1.274     rillig   11936: </tr>
                   11937: <tr>
1.295     rillig   11938: <td>JAVA_BINPREFIX</td>
1.293     rillig   11939: <td>JAVA_CLASSPATH</td>
1.269     leot     11940: </tr>
                   11941: <tr>
1.295     rillig   11942: <td>JAVA_HOME</td>
1.293     rillig   11943: <td>JAVA_LD_LIBRARY_PATH</td>
1.269     leot     11944: </tr>
                   11945: <tr>
1.295     rillig   11946: <td>JAVA_NAME</td>
1.293     rillig   11947: <td>JAVA_UNLIMIT</td>
1.269     leot     11948: </tr>
                   11949: <tr>
1.295     rillig   11950: <td>JAVA_WRAPPERS</td>
1.293     rillig   11951: <td>JPEG_ACCEPTED</td>
1.269     leot     11952: </tr>
                   11953: <tr>
1.295     rillig   11954: <td>JPEG_DEFAULT</td>
1.293     rillig   11955: <td>KERBEROS</td>
1.269     leot     11956: </tr>
                   11957: <tr>
1.295     rillig   11958: <td>KERMIT_SUID_UUCP</td>
1.293     rillig   11959: <td>KJS_USE_PCRE</td>
1.269     leot     11960: </tr>
                   11961: <tr>
1.295     rillig   11962: <td>KNEWS_DOMAIN_FILE</td>
1.293     rillig   11963: <td>KNEWS_DOMAIN_NAME</td>
1.269     leot     11964: </tr>
                   11965: <tr>
1.295     rillig   11966: <td>KRB5_ACCEPTED</td>
1.293     rillig   11967: <td>KRB5_DEFAULT</td>
1.292     leot     11968: </tr>
                   11969: <tr>
1.295     rillig   11970: <td>LANGUAGES</td>
1.293     rillig   11971: <td>LAPACK_LIBS</td>
1.271     brook    11972: </tr>
                   11973: <tr>
1.295     rillig   11974: <td>LATEX2HTML_ICONPATH</td>
1.293     rillig   11975: <td>LDCONFIG_ADD_CMD</td>
1.269     leot     11976: </tr>
                   11977: <tr>
1.295     rillig   11978: <td>LDCONFIG_REMOVE_CMD</td>
1.293     rillig   11979: <td>LEAFNODE_DATA_DIR</td>
1.269     leot     11980: </tr>
                   11981: <tr>
1.295     rillig   11982: <td>LEAFNODE_GROUP</td>
1.293     rillig   11983: <td>LEAFNODE_USER</td>
1.269     leot     11984: </tr>
                   11985: <tr>
1.295     rillig   11986: <td>LIBDVDCSS_HOMEPAGE</td>
1.293     rillig   11987: <td>LIBDVDCSS_MASTER_SITES</td>
1.269     leot     11988: </tr>
                   11989: <tr>
1.295     rillig   11990: <td>LIBRSVG_TYPE</td>
1.293     rillig   11991: <td>LIBTOOL</td>
1.270     leot     11992: </tr>
                   11993: <tr>
1.295     rillig   11994: <td>LIBTOOLIZE_PLIST</td>
1.293     rillig   11995: <td>LIBTOOL_M4_OVERRIDE</td>
1.269     leot     11996: </tr>
                   11997: <tr>
1.295     rillig   11998: <td>LIBUSB_TYPE</td>
1.293     rillig   11999: <td>LICENSE</td>
1.292     leot     12000: </tr>
                   12001: <tr>
1.295     rillig   12002: <td>LINKER_RPATH_FLAG</td>
1.293     rillig   12003: <td>LINK_RPATH_FLAG</td>
1.269     leot     12004: </tr>
                   12005: <tr>
1.295     rillig   12006: <td>LINUX_BASE_NODEPS</td>
1.293     rillig   12007: <td>LINUX_BASE_PREFERRED</td>
1.274     rillig   12008: </tr>
                   12009: <tr>
1.295     rillig   12010: <td>LINUX_BASE_REQUIRED</td>
1.293     rillig   12011: <td>LINUX_LOCALES</td>
1.269     leot     12012: </tr>
                   12013: <tr>
1.295     rillig   12014: <td>LOCALBASE</td>
1.293     rillig   12015: <td>LOCALBASE_LOCKTYPE</td>
1.269     leot     12016: </tr>
                   12017: <tr>
1.295     rillig   12018: <td>LOCALPATCHES</td>
1.293     rillig   12019: <td>LOVE_DATA</td>
1.269     leot     12020: </tr>
                   12021: <tr>
1.295     rillig   12022: <td>LOVE_GAME</td>
1.293     rillig   12023: <td>LOVE_VERSION</td>
1.269     leot     12024: </tr>
                   12025: <tr>
1.295     rillig   12026: <td>LP64PLATFORMS</td>
1.293     rillig   12027: <td>MACHINE_PLATFORM</td>
1.269     leot     12028: </tr>
                   12029: <tr>
1.295     rillig   12030: <td>MAILAGENT_DOMAIN</td>
1.293     rillig   12031: <td>MAILAGENT_EMAIL</td>
1.269     leot     12032: </tr>
                   12033: <tr>
1.295     rillig   12034: <td>MAILAGENT_FQDN</td>
1.293     rillig   12035: <td>MAILAGENT_ORGANIZATION</td>
1.274     rillig   12036: </tr>
                   12037: <tr>
1.295     rillig   12038: <td>MAJORDOMO_HOMEDIR</td>
1.293     rillig   12039: <td>MAJOR_OS_VERSION</td>
1.269     leot     12040: </tr>
                   12041: <tr>
1.295     rillig   12042: <td>MAKEINFO_ARGS</td>
1.293     rillig   12043: <td>MAKE_DIRS</td>
1.269     leot     12044: </tr>
                   12045: <tr>
1.295     rillig   12046: <td>MAKE_DIRS_PERMS</td>
1.293     rillig   12047: <td>MAKE_ENV</td>
1.269     leot     12048: </tr>
                   12049: <tr>
1.295     rillig   12050: <td>MAKE_FILE</td>
1.293     rillig   12051: <td>MAKE_FLAGS</td>
1.269     leot     12052: </tr>
                   12053: <tr>
1.295     rillig   12054: <td>MAKE_JOBS</td>
1.293     rillig   12055: <td>MAKE_JOBS_SAFE</td>
1.269     leot     12056: </tr>
                   12057: <tr>
1.295     rillig   12058: <td>MAKE_PROGRAM</td>
1.293     rillig   12059: <td>MANINSTALL</td>
1.269     leot     12060: </tr>
                   12061: <tr>
1.295     rillig   12062: <td>MANZ</td>
1.293     rillig   12063: <td>MASTER_SITES</td>
1.269     leot     12064: </tr>
                   12065: <tr>
1.295     rillig   12066: <td>MASTER_SITE_BACKUP</td>
1.293     rillig   12067: <td>MASTER_SITE_LOCAL</td>
1.269     leot     12068: </tr>
                   12069: <tr>
1.295     rillig   12070: <td>MASTER_SITE_MOZILLA</td>
1.293     rillig   12071: <td>MASTER_SITE_OVERRIDE</td>
1.269     leot     12072: </tr>
                   12073: <tr>
1.295     rillig   12074: <td>MASTER_SITE_PERL_CPAN</td>
1.293     rillig   12075: <td>MASTER_SORT</td>
1.269     leot     12076: </tr>
                   12077: <tr>
1.295     rillig   12078: <td>MASTER_SORT_RANDOM</td>
1.293     rillig   12079: <td>MASTER_SORT_REGEX</td>
1.269     leot     12080: </tr>
                   12081: <tr>
1.295     rillig   12082: <td>MECAB_CHARSET</td>
1.293     rillig   12083: <td>MEDIATOMB_GROUP</td>
1.269     leot     12084: </tr>
                   12085: <tr>
1.295     rillig   12086: <td>MEDIATOMB_USER</td>
1.293     rillig   12087: <td>MIPSPROBASE</td>
1.269     leot     12088: </tr>
                   12089: <tr>
1.295     rillig   12090: <td>MIREDO_GROUP</td>
1.293     rillig   12091: <td>MIREDO_USER</td>
1.269     leot     12092: </tr>
                   12093: <tr>
1.295     rillig   12094: <td>MISSING_FEATURES</td>
1.293     rillig   12095: <td>MKDIR</td>
1.269     leot     12096: </tr>
                   12097: <tr>
1.295     rillig   12098: <td>MLDONKEY_GROUP</td>
1.293     rillig   12099: <td>MLDONKEY_HOME</td>
1.269     leot     12100: </tr>
                   12101: <tr>
1.295     rillig   12102: <td>MLDONKEY_USER</td>
1.293     rillig   12103: <td>MONOTONE_GROUP</td>
1.269     leot     12104: </tr>
                   12105: <tr>
1.295     rillig   12106: <td>MONOTONE_USER</td>
1.293     rillig   12107: <td>MOTIFBASE</td>
1.269     leot     12108: </tr>
                   12109: <tr>
1.295     rillig   12110: <td>MOTIF_TYPE</td>
1.293     rillig   12111: <td>MOTIF_TYPE_DEFAULT</td>
1.269     leot     12112: </tr>
                   12113: <tr>
1.295     rillig   12114: <td>MPI_TYPE</td>
1.293     rillig   12115: <td>MSGFMT_STRIP_MSGCTXT</td>
1.269     leot     12116: </tr>
                   12117: <tr>
1.295     rillig   12118: <td>MSGFMT_STRIP_MSGID_PLURAL</td>
1.293     rillig   12119: <td>MTOOLS_ENABLE_FLOPPYD</td>
1.269     leot     12120: </tr>
                   12121: <tr>
1.295     rillig   12122: <td>MUST</td>
1.293     rillig   12123: <td>MV</td>
1.269     leot     12124: </tr>
                   12125: <tr>
1.295     rillig   12126: <td>MYSQL_CHARSET</td>
1.293     rillig   12127: <td>MYSQL_DATADIR</td>
1.269     leot     12128: </tr>
                   12129: <tr>
1.295     rillig   12130: <td>MYSQL_EXTRA_CHARSET</td>
1.293     rillig   12131: <td>MYSQL_GROUP</td>
1.269     leot     12132: </tr>
                   12133: <tr>
1.295     rillig   12134: <td>MYSQL_PKGSRCDIR</td>
1.293     rillig   12135: <td>MYSQL_USER</td>
1.269     leot     12136: </tr>
                   12137: <tr>
1.295     rillig   12138: <td>MYSQL_VERSIONS_ACCEPTED</td>
1.293     rillig   12139: <td>MYSQL_VERSION_DEFAULT</td>
1.269     leot     12140: </tr>
                   12141: <tr>
1.295     rillig   12142: <td>NAGIOSCMD_GROUP</td>
1.293     rillig   12143: <td>NAGIOSDIR</td>
1.269     leot     12144: </tr>
                   12145: <tr>
1.295     rillig   12146: <td>NAGIOS_GROUP</td>
1.293     rillig   12147: <td>NAGIOS_USER</td>
1.269     leot     12148: </tr>
                   12149: <tr>
1.295     rillig   12150: <td>NATIVE_APPEND_ABI</td>
1.293     rillig   12151: <td>NATIVE_APPEND_ELF</td>
1.269     leot     12152: </tr>
                   12153: <tr>
1.295     rillig   12154: <td>NATIVE_EXEC_FMT</td>
1.293     rillig   12155: <td>NATIVE_MACHINE_PLATFORM</td>
1.269     leot     12156: </tr>
                   12157: <tr>
1.295     rillig   12158: <td>NATIVE_OBJECT_FMT</td>
1.293     rillig   12159: <td>NBPAX_PROGRAM_PREFIX</td>
                   12160: </tr>
                   12161: <tr>
1.295     rillig   12162: <td>NETBSD_LOGIN_NAME</td>
1.287     rillig   12163: <td>NMH_EDITOR</td>
1.269     leot     12164: </tr>
                   12165: <tr>
1.295     rillig   12166: <td>NMH_MTA</td>
1.287     rillig   12167: <td>NMH_PAGER</td>
1.269     leot     12168: </tr>
                   12169: <tr>
1.295     rillig   12170: <td>NOLOGIN</td>
1.292     leot     12171: <td>NOTE</td>
1.269     leot     12172: </tr>
                   12173: <tr>
1.295     rillig   12174: <td>NOT_FOR_PLATFORM</td>
1.292     leot     12175: <td>NOT_PAX_ASLR_SAFE</td>
1.269     leot     12176: </tr>
                   12177: <tr>
1.295     rillig   12178: <td>NOT_PAX_MPROTECT_SAFE</td>
1.292     leot     12179: <td>NO_BUILD</td>
1.269     leot     12180: </tr>
                   12181: <tr>
1.295     rillig   12182: <td>NO_CHECKSUM</td>
1.292     leot     12183: <td>NO_CONFIGURE</td>
1.269     leot     12184: </tr>
                   12185: <tr>
1.295     rillig   12186: <td>NO_SKIP</td>
1.292     leot     12187: <td>NS_PREFERRED</td>
1.269     leot     12188: </tr>
                   12189: <tr>
1.295     rillig   12190: <td>NULLMAILER_GROUP</td>
1.292     leot     12191: <td>NULLMAILER_USER</td>
1.269     leot     12192: </tr>
                   12193: <tr>
1.295     rillig   12194: <td>OASIS</td>
1.292     leot     12195: <td>OASIS_BUILD_ARGS</td>
1.269     leot     12196: </tr>
                   12197: <tr>
1.295     rillig   12198: <td>OBJHOSTNAME</td>
1.292     leot     12199: <td>OBJMACHINE</td>
1.269     leot     12200: </tr>
                   12201: <tr>
1.295     rillig   12202: <td>OCAML_FINDLIB_DIRS</td>
1.292     leot     12203: <td>OCAML_FINDLIB_REGISTER</td>
1.269     leot     12204: </tr>
                   12205: <tr>
1.295     rillig   12206: <td>OCAML_FINDLIB_REGISTER_VERBOSE</td>
1.292     leot     12207: <td>OCAML_SITELIBDIR</td>
1.269     leot     12208: </tr>
                   12209: <tr>
1.295     rillig   12210: <td>OCAML_TOPKG_DOCDIR</td>
1.292     leot     12211: <td>OCAML_USE_DUNE</td>
1.269     leot     12212: </tr>
                   12213: <tr>
1.295     rillig   12214: <td>OCAML_USE_FINDLIB</td>
1.292     leot     12215: <td>OCAML_USE_JBUILDER</td>
1.269     leot     12216: </tr>
                   12217: <tr>
1.295     rillig   12218: <td>OCAML_USE_OASIS</td>
1.292     leot     12219: <td>OCAML_USE_OASIS_DYNRUN</td>
1.269     leot     12220: </tr>
                   12221: <tr>
1.295     rillig   12222: <td>OCAML_USE_OPAM</td>
1.292     leot     12223: <td>OCAML_USE_OPT_COMPILER</td>
1.269     leot     12224: </tr>
                   12225: <tr>
1.295     rillig   12226: <td>OCAML_USE_TOPKG</td>
1.292     leot     12227: <td>OMF</td>
1.269     leot     12228: </tr>
                   12229: <tr>
1.295     rillig   12230: <td>ONLY_FOR_COMPILER</td>
1.292     leot     12231: <td>ONLY_FOR_PLATFORM</td>
1.269     leot     12232: </tr>
                   12233: <tr>
1.295     rillig   12234: <td>OPENSSH_CHROOT</td>
1.292     leot     12235: <td>OPENSSH_GROUP</td>
1.269     leot     12236: </tr>
                   12237: <tr>
1.295     rillig   12238: <td>OPENSSH_USER</td>
1.292     leot     12239: <td>OPSYS</td>
1.269     leot     12240: </tr>
                   12241: <tr>
1.295     rillig   12242: <td>OPSYS_EMULDIR</td>
1.292     leot     12243: <td>OSS_TYPE</td>
1.269     leot     12244: </tr>
                   12245: <tr>
1.295     rillig   12246: <td>OSX</td>
1.292     leot     12247: <td>OSX_TOLERATE_SDK_SKEW</td>
                   12248: </tr>
                   12249: <tr>
1.295     rillig   12250: <td>OS_HAVE_ALSA</td>
1.292     leot     12251: <td>OS_HAVE_RCD</td>
1.269     leot     12252: </tr>
                   12253: <tr>
1.295     rillig   12254: <td>OS_VARIANT</td>
1.292     leot     12255: <td>OS_VERSION</td>
1.269     leot     12256: </tr>
                   12257: <tr>
1.295     rillig   12258: <td>OTF_FONTS_DIR</td>
1.292     leot     12259: <td>OVERRIDE_DIRDEPTH</td>
1.269     leot     12260: </tr>
                   12261: <tr>
1.295     rillig   12262: <td>OVERRIDE_GEMSPEC</td>
1.292     leot     12263: <td>OVERRIDE_GNU_CONFIG_SCRIPTS</td>
1.269     leot     12264: </tr>
                   12265: <tr>
1.295     rillig   12266: <td>OVERRIDE_ROCKSPEC</td>
1.290     gutterid 12267: <td>OWN_DIRS</td>
1.269     leot     12268: </tr>
                   12269: <tr>
1.295     rillig   12270: <td>OWN_DIRS_PERMS</td>
1.290     gutterid 12271: <td>P4GROUP</td>
1.269     leot     12272: </tr>
                   12273: <tr>
1.295     rillig   12274: <td>P4PORT</td>
1.290     gutterid 12275: <td>P4ROOT</td>
1.269     leot     12276: </tr>
                   12277: <tr>
1.295     rillig   12278: <td>P4USER</td>
1.290     gutterid 12279: <td>PACKAGES</td>
1.269     leot     12280: </tr>
                   12281: <tr>
1.295     rillig   12282: <td>PALMOS_DEFAULT_SDK</td>
1.290     gutterid 12283: <td>PAMBASE</td>
1.269     leot     12284: </tr>
                   12285: <tr>
1.295     rillig   12286: <td>PAM_DEFAULT</td>
1.290     gutterid 12287: <td>PAPERSIZE</td>
1.269     leot     12288: </tr>
                   12289: <tr>
1.295     rillig   12290: <td>PASSIVE_FETCH</td>
1.290     gutterid 12291: <td>PATCHDIR</td>
1.269     leot     12292: </tr>
                   12293: <tr>
1.295     rillig   12294: <td>PATCHFILES</td>
1.290     gutterid 12295: <td>PATCH_ARGS</td>
1.269     leot     12296: </tr>
                   12297: <tr>
1.295     rillig   12298: <td>PATCH_DEBUG</td>
1.290     gutterid 12299: <td>PATCH_DIST_ARGS</td>
1.284     rillig   12300: </tr>
                   12301: <tr>
1.295     rillig   12302: <td>PATCH_DIST_CAT</td>
1.290     gutterid 12303: <td>PATCH_DIST_STRIP</td>
1.269     leot     12304: </tr>
                   12305: <tr>
1.295     rillig   12306: <td>PATCH_FUZZ_FACTOR</td>
1.290     gutterid 12307: <td>PATCH_STRIP</td>
1.269     leot     12308: </tr>
                   12309: <tr>
1.295     rillig   12310: <td>PATH</td>
1.284     rillig   12311: <td>PCCBASE</td>
1.269     leot     12312: </tr>
                   12313: <tr>
1.295     rillig   12314: <td>PEAR</td>
1.292     leot     12315: <td>PEAR_CHANNEL</td>
                   12316: </tr>
                   12317: <tr>
1.295     rillig   12318: <td>PEAR_CHANNEL_ALIAS</td>
1.292     leot     12319: <td>PEAR_CHANNEL_VERSION</td>
                   12320: </tr>
                   12321: <tr>
1.295     rillig   12322: <td>PEAR_CMD</td>
1.290     gutterid 12323: <td>PEAR_LIB</td>
1.274     rillig   12324: </tr>
                   12325: <tr>
1.295     rillig   12326: <td>PEAR_PACKAGE_XML</td>
1.290     gutterid 12327: <td>PERL5</td>
1.274     rillig   12328: </tr>
                   12329: <tr>
1.295     rillig   12330: <td>PERL5_CONFIGURE</td>
1.290     gutterid 12331: <td>PERL5_CONFIGURE_DIRS</td>
1.269     leot     12332: </tr>
                   12333: <tr>
1.295     rillig   12334: <td>PERL5_LDFLAGS</td>
1.290     gutterid 12335: <td>PERL5_LICENSE</td>
1.269     leot     12336: </tr>
                   12337: <tr>
1.295     rillig   12338: <td>PERL5_MODULE_TYPE</td>
1.290     gutterid 12339: <td>PERL5_PACKLIST</td>
1.269     leot     12340: </tr>
                   12341: <tr>
1.295     rillig   12342: <td>PERL5_PACKLIST_DIR</td>
1.290     gutterid 12343: <td>PERL5_PERLBASE</td>
1.269     leot     12344: </tr>
                   12345: <tr>
1.295     rillig   12346: <td>PERL5_SITEBASE</td>
1.290     gutterid 12347: <td>PERL5_USE_PACKLIST</td>
1.269     leot     12348: </tr>
                   12349: <tr>
1.295     rillig   12350: <td>PERL5_VENDORBASE</td>
1.290     gutterid 12351: <td>PFCTL</td>
1.269     leot     12352: </tr>
                   12353: <tr>
1.295     rillig   12354: <td>PFVAR_H</td>
1.290     gutterid 12355: <td>PF_VERSION</td>
1.269     leot     12356: </tr>
                   12357: <tr>
1.295     rillig   12358: <td>PGGROUP</td>
1.290     gutterid 12359: <td>PGHOME</td>
1.269     leot     12360: </tr>
                   12361: <tr>
1.295     rillig   12362: <td>PGPKGSRCDIR</td>
1.290     gutterid 12363: <td>PGSQL_TYPE</td>
1.269     leot     12364: </tr>
                   12365: <tr>
1.295     rillig   12366: <td>PGSQL_VERSIONS_ACCEPTED</td>
1.290     gutterid 12367: <td>PGSQL_VERSION_DEFAULT</td>
1.269     leot     12368: </tr>
                   12369: <tr>
1.295     rillig   12370: <td>PGUSER</td>
1.290     gutterid 12371: <td>PG_LIB_EXT</td>
1.269     leot     12372: </tr>
                   12373: <tr>
1.295     rillig   12374: <td>PHP</td>
1.290     gutterid 12375: <td>PHPCOMMON_MK</td>
1.269     leot     12376: </tr>
                   12377: <tr>
1.295     rillig   12378: <td>PHPPKGSRCDIR</td>
1.290     gutterid 12379: <td>PHP_BASE_VERS</td>
1.269     leot     12380: </tr>
                   12381: <tr>
1.295     rillig   12382: <td>PHP_CHECK_INSTALLED</td>
1.290     gutterid 12383: <td>PHP_EXTENSION_DIR</td>
1.269     leot     12384: </tr>
                   12385: <tr>
1.295     rillig   12386: <td>PHP_INITIAL_TEENY</td>
1.290     gutterid 12387: <td>PHP_PKG_PREFIX</td>
1.269     leot     12388: </tr>
                   12389: <tr>
1.295     rillig   12390: <td>PHP_VERSION</td>
1.290     gutterid 12391: <td>PHP_VERSIONS_ACCEPTED</td>
1.269     leot     12392: </tr>
                   12393: <tr>
1.295     rillig   12394: <td>PHP_VERSIONS_INCOMPATIBLE</td>
1.290     gutterid 12395: <td>PHP_VERSION_DEFAULT</td>
1.269     leot     12396: </tr>
                   12397: <tr>
1.295     rillig   12398: <td>PHP_VERSION_REQD</td>
1.290     gutterid 12399: <td>PILRC_USE_GTK</td>
1.269     leot     12400: </tr>
                   12401: <tr>
1.295     rillig   12402: <td>PKGCONFIG_BASE</td>
1.290     gutterid 12403: <td>PKGCONFIG_FILE</td>
1.269     leot     12404: </tr>
                   12405: <tr>
1.295     rillig   12406: <td>PKGCONFIG_OVERRIDE</td>
1.290     gutterid 12407: <td>PKGCONFIG_OVERRIDE_STAGE</td>
1.269     leot     12408: </tr>
                   12409: <tr>
1.295     rillig   12410: <td>PKGDIR</td>
1.290     gutterid 12411: <td>PKGGNUDIR</td>
1.269     leot     12412: </tr>
                   12413: <tr>
1.295     rillig   12414: <td>PKGINFODIR</td>
1.290     gutterid 12415: <td>PKGLOCALEDIR</td>
1.269     leot     12416: </tr>
                   12417: <tr>
1.295     rillig   12418: <td>PKGMANDIR</td>
1.290     gutterid 12419: <td>PKGNAME</td>
1.269     leot     12420: </tr>
                   12421: <tr>
1.295     rillig   12422: <td>PKGNAME_REQD</td>
1.290     gutterid 12423: <td>PKGPATH</td>
1.269     leot     12424: </tr>
                   12425: <tr>
1.295     rillig   12426: <td>PKGREVISION</td>
1.292     leot     12427: <td>PKGSRC_BLAS_TYPES</td>
                   12428: </tr>
                   12429: <tr>
1.295     rillig   12430: <td>PKGSRC_CHANGES</td>
1.292     leot     12431: <td>PKGSRC_COMPILER</td>
1.269     leot     12432: </tr>
                   12433: <tr>
1.295     rillig   12434: <td>PKGSRC_KEEP_BIN_PKGS</td>
1.292     leot     12435: <td>PKGSRC_LOCKTYPE</td>
1.274     rillig   12436: </tr>
                   12437: <tr>
1.295     rillig   12438: <td>PKGSRC_MAKE_ENV</td>
1.292     leot     12439: <td>PKGSRC_MESSAGE_RECIPIENTS</td>
1.269     leot     12440: </tr>
                   12441: <tr>
1.295     rillig   12442: <td>PKGSRC_MKPIE</td>
1.292     leot     12443: <td>PKGSRC_MKREPRO</td>
1.269     leot     12444: </tr>
                   12445: <tr>
1.295     rillig   12446: <td>PKGSRC_RUN_TEST</td>
1.292     leot     12447: <td>PKGSRC_SETENV</td>
1.269     leot     12448: </tr>
                   12449: <tr>
1.295     rillig   12450: <td>PKGSRC_SLEEPSECS</td>
1.292     leot     12451: <td>PKGSRC_TODO</td>
1.269     leot     12452: </tr>
                   12453: <tr>
1.295     rillig   12454: <td>PKGSRC_USE_CTF</td>
1.292     leot     12455: <td>PKGSRC_USE_FORTIFY</td>
1.269     leot     12456: </tr>
                   12457: <tr>
1.295     rillig   12458: <td>PKGSRC_USE_RELRO</td>
1.292     leot     12459: <td>PKGSRC_USE_SSP</td>
1.269     leot     12460: </tr>
                   12461: <tr>
1.295     rillig   12462: <td>PKGSRC_USE_STACK_CHECK</td>
1.292     leot     12463: <td>PKGTASKS_DATAFILE</td>
1.269     leot     12464: </tr>
                   12465: <tr>
1.295     rillig   12466: <td>PKGTOOLS_ARGS</td>
1.292     leot     12467: <td>PKGTOOLS_ENV</td>
1.269     leot     12468: </tr>
                   12469: <tr>
1.295     rillig   12470: <td>PKG_ALTERNATIVES</td>
1.292     leot     12471: <td>PKG_APACHE</td>
1.269     leot     12472: </tr>
                   12473: <tr>
1.295     rillig   12474: <td>PKG_APACHE_ACCEPTED</td>
1.292     leot     12475: <td>PKG_APACHE_DEFAULT</td>
1.269     leot     12476: </tr>
                   12477: <tr>
1.295     rillig   12478: <td>PKG_BEST_EXISTS</td>
1.292     leot     12479: <td>PKG_BUILD_OPTIONS</td>
1.269     leot     12480: </tr>
                   12481: <tr>
1.295     rillig   12482: <td>PKG_COMPRESSION</td>
1.292     leot     12483: <td>PKG_CONFIG</td>
1.269     leot     12484: </tr>
                   12485: <tr>
1.295     rillig   12486: <td>PKG_CONFIG_PERMS</td>
1.292     leot     12487: <td>PKG_CREATE_USERGROUP</td>
1.269     leot     12488: </tr>
                   12489: <tr>
1.295     rillig   12490: <td>PKG_DB_TMPDIR</td>
1.292     leot     12491: <td>PKG_DEBUG_LEVEL</td>
1.269     leot     12492: </tr>
                   12493: <tr>
1.295     rillig   12494: <td>PKG_DEFAULT_OPTIONS</td>
1.292     leot     12495: <td>PKG_DESTDIR_SUPPORT</td>
1.269     leot     12496: </tr>
                   12497: <tr>
1.295     rillig   12498: <td>PKG_DEVELOPER</td>
1.292     leot     12499: <td>PKG_DISABLED_OPTIONS</td>
1.269     leot     12500: </tr>
                   12501: <tr>
1.295     rillig   12502: <td>PKG_FATAL_ERRORS</td>
1.292     leot     12503: <td>PKG_FC</td>
1.269     leot     12504: </tr>
                   12505: <tr>
1.295     rillig   12506: <td>PKG_FILELIST_CMD</td>
1.292     leot     12507: <td>PKG_GECOS</td>
1.269     leot     12508: </tr>
                   12509: <tr>
1.295     rillig   12510: <td>PKG_GID</td>
1.292     leot     12511: <td>PKG_GROUPS</td>
1.269     leot     12512: </tr>
                   12513: <tr>
1.295     rillig   12514: <td>PKG_GROUPS_VARS</td>
1.292     leot     12515: <td>PKG_HOME</td>
1.269     leot     12516: </tr>
                   12517: <tr>
1.295     rillig   12518: <td>PKG_INIT_SCRIPTS</td>
1.292     leot     12519: <td>PKG_JAVA_HOME</td>
1.269     leot     12520: </tr>
                   12521: <tr>
1.295     rillig   12522: <td>PKG_JVM</td>
1.292     leot     12523: <td>PKG_JVMS_ACCEPTED</td>
1.269     leot     12524: </tr>
                   12525: <tr>
1.295     rillig   12526: <td>PKG_JVM_DEFAULT</td>
1.292     leot     12527: <td>PKG_LEGACY_OPTIONS</td>
1.269     leot     12528: </tr>
                   12529: <tr>
1.295     rillig   12530: <td>PKG_LIBTOOL</td>
1.292     leot     12531: <td>PKG_OPTIONS</td>
1.269     leot     12532: </tr>
                   12533: <tr>
1.295     rillig   12534: <td>PKG_OPTIONS_DEPRECATED_WARNINGS</td>
1.292     leot     12535: <td>PKG_OPTIONS_LEGACY_OPTS</td>
1.269     leot     12536: </tr>
                   12537: <tr>
1.295     rillig   12538: <td>PKG_OPTIONS_LEGACY_VARS</td>
1.292     leot     12539: <td>PKG_OPTIONS_NONEMPTY_SETS</td>
1.269     leot     12540: </tr>
                   12541: <tr>
1.295     rillig   12542: <td>PKG_OPTIONS_OPTIONAL_GROUPS</td>
1.292     leot     12543: <td>PKG_OPTIONS_REQUIRED_GROUPS</td>
1.269     leot     12544: </tr>
                   12545: <tr>
1.295     rillig   12546: <td>PKG_OPTIONS_VAR</td>
1.292     leot     12547: <td>PKG_PHP</td>
1.269     leot     12548: </tr>
                   12549: <tr>
1.295     rillig   12550: <td>PKG_PHP_MAJOR_VERS</td>
1.292     leot     12551: <td>PKG_PHP_VERSION</td>
1.269     leot     12552: </tr>
                   12553: <tr>
1.295     rillig   12554: <td>PKG_RCD_SCRIPTS</td>
1.292     leot     12555: <td>PKG_REFCOUNT_DBDIR</td>
1.269     leot     12556: </tr>
                   12557: <tr>
1.295     rillig   12558: <td>PKG_REGISTER_SHELLS</td>
1.292     leot     12559: <td>PKG_RESUME_TRANSFERS</td>
1.269     leot     12560: </tr>
                   12561: <tr>
1.295     rillig   12562: <td>PKG_SHELL</td>
1.292     leot     12563: <td>PKG_SUGGESTED_OPTIONS</td>
1.269     leot     12564: </tr>
                   12565: <tr>
1.295     rillig   12566: <td>PKG_SUPPORTED_OPTIONS</td>
1.292     leot     12567: <td>PKG_SYSCONFBASE</td>
1.269     leot     12568: </tr>
                   12569: <tr>
1.295     rillig   12570: <td>PKG_SYSCONFBASEDIR</td>
1.292     leot     12571: <td>PKG_SYSCONFDIR</td>
1.269     leot     12572: </tr>
                   12573: <tr>
1.295     rillig   12574: <td>PKG_SYSCONFDIR_PERMS</td>
1.292     leot     12575: <td>PKG_SYSCONFSUBDIR</td>
1.269     leot     12576: </tr>
                   12577: <tr>
1.295     rillig   12578: <td>PKG_SYSCONFVAR</td>
1.292     leot     12579: <td>PKG_TOOLS_BIN</td>
1.269     leot     12580: </tr>
                   12581: <tr>
1.295     rillig   12582: <td>PKG_UID</td>
1.292     leot     12583: <td>PKG_UPDATE_FONTS_DB</td>
1.269     leot     12584: </tr>
                   12585: <tr>
1.295     rillig   12586: <td>PKG_USERS</td>
1.292     leot     12587: <td>PKG_USERS_VARS</td>
1.269     leot     12588: </tr>
                   12589: <tr>
1.295     rillig   12590: <td>PKG_VERBOSE</td>
1.292     leot     12591: <td>PLIST</td>
1.269     leot     12592: </tr>
                   12593: <tr>
1.295     rillig   12594: <td>PLIST_AWK</td>
1.292     leot     12595: <td>PLIST_AWK_ENV</td>
1.269     leot     12596: </tr>
                   12597: <tr>
1.295     rillig   12598: <td>PLIST_SRC</td>
1.292     leot     12599: <td>PLIST_SUBST</td>
1.269     leot     12600: </tr>
                   12601: <tr>
1.295     rillig   12602: <td>PLIST_TYPE</td>
1.292     leot     12603: <td>PLIST_VARS</td>
1.269     leot     12604: </tr>
                   12605: <tr>
1.295     rillig   12606: <td>POPTOP_USE_MPPE</td>
1.292     leot     12607: <td>POSSIBLE_GFORTRAN_VERSION</td>
1.269     leot     12608: </tr>
                   12609: <tr>
1.295     rillig   12610: <td>POST_FETCH_HOOK</td>
1.292     leot     12611: <td>PREFER</td>
1.269     leot     12612: </tr>
                   12613: <tr>
1.295     rillig   12614: <td>PREFER_NATIVE</td>
1.292     leot     12615: <td>PREFER_NATIVE_PTHREADS</td>
1.269     leot     12616: </tr>
                   12617: <tr>
1.295     rillig   12618: <td>PREFER_PKGSRC</td>
1.292     leot     12619: <td>PREFIX</td>
1.269     leot     12620: </tr>
                   12621: <tr>
1.295     rillig   12622: <td>PREPEND_PATH</td>
1.292     leot     12623: <td>PRE_ROOT_CMD</td>
1.269     leot     12624: </tr>
                   12625: <tr>
1.295     rillig   12626: <td>PRIVILEGED_STAGES</td>
1.292     leot     12627: <td>PS</td>
1.269     leot     12628: </tr>
                   12629: <tr>
1.295     rillig   12630: <td>PTHREAD_AUTO_VARS</td>
1.292     leot     12631: <td>PTHREAD_CFLAGS</td>
1.269     leot     12632: </tr>
                   12633: <tr>
1.295     rillig   12634: <td>PTHREAD_LDFLAGS</td>
1.292     leot     12635: <td>PTHREAD_LIBS</td>
1.269     leot     12636: </tr>
                   12637: <tr>
1.295     rillig   12638: <td>PTHREAD_OPTS</td>
1.292     leot     12639: <td>PTHREAD_TYPE</td>
1.269     leot     12640: </tr>
                   12641: <tr>
1.295     rillig   12642: <td>PVM_SSH</td>
1.292     leot     12643: <td>PYPKGPREFIX</td>
1.269     leot     12644: </tr>
                   12645: <tr>
1.295     rillig   12646: <td>PYTHON_FOR_BUILD_ONLY</td>
1.292     leot     12647: <td>PYTHON_SELF_CONFLICT</td>
1.269     leot     12648: </tr>
                   12649: <tr>
1.295     rillig   12650: <td>PYTHON_VERSIONED_DEPENDENCIES</td>
1.292     leot     12651: <td>PYTHON_VERSIONS_ACCEPTED</td>
1.269     leot     12652: </tr>
                   12653: <tr>
1.295     rillig   12654: <td>PYTHON_VERSIONS_INCOMPATIBLE</td>
1.292     leot     12655: <td>PYTHON_VERSION_DEFAULT</td>
1.269     leot     12656: </tr>
                   12657: <tr>
1.295     rillig   12658: <td>PYTHON_VERSION_REQD</td>
1.292     leot     12659: <td>PYVERSSUFFIX</td>
1.269     leot     12660: </tr>
                   12661: <tr>
1.295     rillig   12662: <td>PY_NO_EGG</td>
1.292     leot     12663: <td>QMAILDIR</td>
1.269     leot     12664: </tr>
                   12665: <tr>
1.295     rillig   12666: <td>QMAIL_ALIAS_USER</td>
1.292     leot     12667: <td>QMAIL_DAEMON_USER</td>
1.269     leot     12668: </tr>
                   12669: <tr>
1.295     rillig   12670: <td>QMAIL_LOG_USER</td>
1.292     leot     12671: <td>QMAIL_NOFILES_GROUP</td>
1.269     leot     12672: </tr>
                   12673: <tr>
1.295     rillig   12674: <td>QMAIL_PASSWD_USER</td>
1.292     leot     12675: <td>QMAIL_QMAIL_GROUP</td>
1.269     leot     12676: </tr>
                   12677: <tr>
1.295     rillig   12678: <td>QMAIL_QUEUE_DIR</td>
1.292     leot     12679: <td>QMAIL_QUEUE_EXTRA</td>
1.269     leot     12680: </tr>
                   12681: <tr>
1.295     rillig   12682: <td>QMAIL_QUEUE_USER</td>
1.292     leot     12683: <td>QMAIL_REMOTE_USER</td>
1.269     leot     12684: </tr>
                   12685: <tr>
1.295     rillig   12686: <td>QMAIL_ROOT_USER</td>
1.292     leot     12687: <td>QMAIL_SEND_USER</td>
1.269     leot     12688: </tr>
                   12689: <tr>
1.295     rillig   12690: <td>QPOPPER_FAC</td>
1.292     leot     12691: <td>QPOPPER_SPOOL_DIR</td>
1.269     leot     12692: </tr>
                   12693: <tr>
1.295     rillig   12694: <td>QPOPPER_USER</td>
1.292     leot     12695: <td>RAKE_NAME</td>
1.269     leot     12696: </tr>
                   12697: <tr>
1.295     rillig   12698: <td>RASMOL_DEPTH</td>
1.292     leot     12699: <td>RCD_DIR</td>
1.269     leot     12700: </tr>
                   12701: <tr>
1.295     rillig   12702: <td>RCD_ORDER</td>
1.289     leot     12703: <td>RCD_SCRIPTS</td>
1.292     leot     12704: </tr>
                   12705: <tr>
1.295     rillig   12706: <td>RCD_SCRIPTS_DIR</td>
1.292     leot     12707: <td>RCD_SCRIPTS_EXAMPLEDIR</td>
1.269     leot     12708: </tr>
                   12709: <tr>
1.295     rillig   12710: <td>RCD_SCRIPTS_MODE</td>
1.292     leot     12711: <td>RCD_SCRIPTS_SHELL</td>
1.269     leot     12712: </tr>
                   12713: <tr>
1.295     rillig   12714: <td>RCD_SCRIPT_SRC</td>
1.292     leot     12715: <td>RCD_SUBR</td>
1.269     leot     12716: </tr>
                   12717: <tr>
1.295     rillig   12718: <td>RDOC</td>
1.290     gutterid 12719: <td>READLINE_DEFAULT</td>
1.269     leot     12720: </tr>
                   12721: <tr>
1.295     rillig   12722: <td>READLINE_TYPE</td>
1.290     gutterid 12723: <td>REAL_ROOT_GROUP</td>
1.269     leot     12724: </tr>
                   12725: <tr>
1.295     rillig   12726: <td>REAL_ROOT_USER</td>
1.290     gutterid 12727: <td>RECURSIVE_MAKE</td>
1.269     leot     12728: </tr>
                   12729: <tr>
1.295     rillig   12730: <td>RELAY_CTRL_DIR</td>
1.290     gutterid 12731: <td>REPLACE_AWK</td>
1.269     leot     12732: </tr>
                   12733: <tr>
1.295     rillig   12734: <td>REPLACE_BASH</td>
1.290     gutterid 12735: <td>REPLACE_CSH</td>
1.269     leot     12736: </tr>
                   12737: <tr>
1.295     rillig   12738: <td>REPLACE_KSH</td>
1.290     gutterid 12739: <td>REPLACE_PERL</td>
1.269     leot     12740: </tr>
                   12741: <tr>
1.295     rillig   12742: <td>REPLACE_PERL6</td>
1.290     gutterid 12743: <td>REPLACE_PHP</td>
1.269     leot     12744: </tr>
                   12745: <tr>
1.295     rillig   12746: <td>REPLACE_PYTHON</td>
1.290     gutterid 12747: <td>REPLACE_RUBY</td>
1.281     leot     12748: </tr>
                   12749: <tr>
1.295     rillig   12750: <td>REPLACE_RUBY_DIRS</td>
1.290     gutterid 12751: <td>REPLACE_RUBY_PAT</td>
1.269     leot     12752: </tr>
                   12753: <tr>
1.295     rillig   12754: <td>REPLACE_SH</td>
1.290     gutterid 12755: <td>REPLACE_TEXLUA</td>
1.269     leot     12756: </tr>
                   12757: <tr>
1.295     rillig   12758: <td>REQD_DIRS</td>
1.290     gutterid 12759: <td>REQD_DIRS_PERMS</td>
1.269     leot     12760: </tr>
                   12761: <tr>
1.295     rillig   12762: <td>REQD_FILES</td>
1.290     gutterid 12763: <td>REQD_FILES_MODE</td>
1.269     leot     12764: </tr>
                   12765: <tr>
1.295     rillig   12766: <td>REQD_FILES_PERMS</td>
1.290     gutterid 12767: <td>RESOLV_AUTO_VARS</td>
1.269     leot     12768: </tr>
                   12769: <tr>
1.295     rillig   12770: <td>RESOLV_LDFLAGS</td>
1.290     gutterid 12771: <td>RESOLV_LIBS</td>
1.269     leot     12772: </tr>
                   12773: <tr>
1.295     rillig   12774: <td>RM</td>
1.292     leot     12775: <td>ROCKSPEC_NAME</td>
                   12776: </tr>
                   12777: <tr>
1.295     rillig   12778: <td>ROCKSPEC_SPECFILE</td>
1.290     gutterid 12779: <td>ROOT_CMD</td>
1.269     leot     12780: </tr>
                   12781: <tr>
1.295     rillig   12782: <td>ROOT_GROUP</td>
1.290     gutterid 12783: <td>ROOT_USER</td>
1.274     rillig   12784: </tr>
                   12785: <tr>
1.295     rillig   12786: <td>RPCGEN</td>
1.290     gutterid 12787: <td>RPM</td>
1.269     leot     12788: </tr>
                   12789: <tr>
1.295     rillig   12790: <td>RPM2PKG_PLIST</td>
1.290     gutterid 12791: <td>RPM2PKG_PREFIX</td>
1.269     leot     12792: </tr>
                   12793: <tr>
1.295     rillig   12794: <td>RPM2PKG_STAGE</td>
1.290     gutterid 12795: <td>RPM2PKG_STRIP</td>
1.269     leot     12796: </tr>
                   12797: <tr>
1.295     rillig   12798: <td>RPM2PKG_SUBPREFIX</td>
1.290     gutterid 12799: <td>RPMFILES</td>
1.269     leot     12800: </tr>
                   12801: <tr>
1.295     rillig   12802: <td>RPMIGNOREPATH</td>
1.290     gutterid 12803: <td>RPM_DB_PREFIX</td>
1.269     leot     12804: </tr>
                   12805: <tr>
1.295     rillig   12806: <td>RSSH_CVS_PATH</td>
1.290     gutterid 12807: <td>RSSH_RDIST_PATH</td>
1.269     leot     12808: </tr>
                   12809: <tr>
1.295     rillig   12810: <td>RSSH_RSYNC_PATH</td>
1.290     gutterid 12811: <td>RSSH_SCP_PATH</td>
1.269     leot     12812: </tr>
                   12813: <tr>
1.295     rillig   12814: <td>RSSH_SFTP_SERVER_PATH</td>
1.290     gutterid 12815: <td>RUBY</td>
1.269     leot     12816: </tr>
                   12817: <tr>
1.295     rillig   12818: <td>RUBYGEM</td>
1.290     gutterid 12819: <td>RUBYGEM_NAME</td>
1.269     leot     12820: </tr>
                   12821: <tr>
1.295     rillig   12822: <td>RUBYGEM_OPTIONS</td>
1.290     gutterid 12823: <td>RUBY_ABI_VERSION</td>
1.269     leot     12824: </tr>
                   12825: <tr>
1.295     rillig   12826: <td>RUBY_ARCH</td>
1.290     gutterid 12827: <td>RUBY_ARCHINC</td>
1.269     leot     12828: </tr>
                   12829: <tr>
1.295     rillig   12830: <td>RUBY_ARCHLIB</td>
1.290     gutterid 12831: <td>RUBY_BASE</td>
1.269     leot     12832: </tr>
                   12833: <tr>
1.295     rillig   12834: <td>RUBY_BASERIDIR</td>
1.290     gutterid 12835: <td>RUBY_BUILD_DOCUMENT</td>
1.269     leot     12836: </tr>
                   12837: <tr>
1.295     rillig   12838: <td>RUBY_DLEXT</td>
1.290     gutterid 12839: <td>RUBY_DOC</td>
1.269     leot     12840: </tr>
                   12841: <tr>
1.295     rillig   12842: <td>RUBY_DYNAMIC_DIRS</td>
1.290     gutterid 12843: <td>RUBY_EG</td>
1.269     leot     12844: </tr>
                   12845: <tr>
1.295     rillig   12846: <td>RUBY_ENCODING_ARG</td>
1.290     gutterid 12847: <td>RUBY_EXTCONF</td>
1.269     leot     12848: </tr>
                   12849: <tr>
1.295     rillig   12850: <td>RUBY_EXTCONF_CHECK</td>
1.290     gutterid 12851: <td>RUBY_EXTCONF_DEBUG</td>
1.269     leot     12852: </tr>
                   12853: <tr>
1.295     rillig   12854: <td>RUBY_EXTCONF_MAKEFILE</td>
1.290     gutterid 12855: <td>RUBY_GEM_BASE</td>
1.269     leot     12856: </tr>
                   12857: <tr>
1.295     rillig   12858: <td>RUBY_INC</td>
1.290     gutterid 12859: <td>RUBY_LIB</td>
1.269     leot     12860: </tr>
                   12861: <tr>
1.295     rillig   12862: <td>RUBY_LIB_BASE</td>
1.290     gutterid 12863: <td>RUBY_NAME</td>
1.269     leot     12864: </tr>
                   12865: <tr>
1.295     rillig   12866: <td>RUBY_NOVERSION</td>
1.290     gutterid 12867: <td>RUBY_PKGPREFIX</td>
1.269     leot     12868: </tr>
                   12869: <tr>
1.295     rillig   12870: <td>RUBY_RAILS</td>
1.290     gutterid 12871: <td>RUBY_RAILS51_VERSION</td>
1.269     leot     12872: </tr>
                   12873: <tr>
1.295     rillig   12874: <td>RUBY_RAILS52_VERSION</td>
1.290     gutterid 12875: <td>RUBY_RAILS60_VERSION</td>
1.269     leot     12876: </tr>
                   12877: <tr>
1.295     rillig   12878: <td>RUBY_RAILS_ACCEPTED</td>
1.290     gutterid 12879: <td>RUBY_RAILS_DEFAULT</td>
1.289     leot     12880: </tr>
                   12881: <tr>
1.295     rillig   12882: <td>RUBY_RAILS_REQD</td>
1.290     gutterid 12883: <td>RUBY_RAILS_STRICT_DEP</td>
1.269     leot     12884: </tr>
                   12885: <tr>
1.295     rillig   12886: <td>RUBY_RIDIR</td>
1.290     gutterid 12887: <td>RUBY_SETUP</td>
1.269     leot     12888: </tr>
                   12889: <tr>
1.295     rillig   12890: <td>RUBY_SHLIB</td>
1.290     gutterid 12891: <td>RUBY_SHLIBALIAS</td>
1.269     leot     12892: </tr>
                   12893: <tr>
1.295     rillig   12894: <td>RUBY_SHLIBVER</td>
1.290     gutterid 12895: <td>RUBY_SIMPLE_INSTALL</td>
1.269     leot     12896: </tr>
                   12897: <tr>
1.295     rillig   12898: <td>RUBY_SITEARCHLIB</td>
1.290     gutterid 12899: <td>RUBY_SITELIB</td>
1.269     leot     12900: </tr>
                   12901: <tr>
1.295     rillig   12902: <td>RUBY_SITELIB_BASE</td>
1.290     gutterid 12903: <td>RUBY_SITERIDIR</td>
1.269     leot     12904: </tr>
                   12905: <tr>
1.295     rillig   12906: <td>RUBY_SLEXT</td>
1.290     gutterid 12907: <td>RUBY_SRCDIR</td>
1.269     leot     12908: </tr>
                   12909: <tr>
1.295     rillig   12910: <td>RUBY_STATICLIB</td>
1.290     gutterid 12911: <td>RUBY_SUFFIX</td>
1.269     leot     12912: </tr>
                   12913: <tr>
1.295     rillig   12914: <td>RUBY_SYSRIDIR</td>
1.290     gutterid 12915: <td>RUBY_USE_PTHREAD</td>
1.269     leot     12916: </tr>
                   12917: <tr>
1.295     rillig   12918: <td>RUBY_VENDORARCHLIB</td>
1.290     gutterid 12919: <td>RUBY_VENDORLIB</td>
1.269     leot     12920: </tr>
                   12921: <tr>
1.295     rillig   12922: <td>RUBY_VENDORLIB_BASE</td>
1.290     gutterid 12923: <td>RUBY_VER</td>
1.269     leot     12924: </tr>
                   12925: <tr>
1.295     rillig   12926: <td>RUBY_VERSION</td>
1.290     gutterid 12927: <td>RUBY_VERSIONS_ACCEPTED</td>
1.269     leot     12928: </tr>
                   12929: <tr>
1.295     rillig   12930: <td>RUBY_VERSIONS_INCOMPATIBLE</td>
1.290     gutterid 12931: <td>RUBY_VERSION_DEFAULT</td>
1.269     leot     12932: </tr>
                   12933: <tr>
1.295     rillig   12934: <td>RUBY_VERSION_REQD</td>
1.290     gutterid 12935: <td>RUBY_VER_DIR</td>
1.269     leot     12936: </tr>
                   12937: <tr>
1.295     rillig   12938: <td>RUN</td>
1.290     gutterid 12939: <td>RUN_LDCONFIG</td>
1.269     leot     12940: </tr>
                   12941: <tr>
1.295     rillig   12942: <td>SAWFISH_THEMES</td>
1.290     gutterid 12943: <td>SCO</td>
1.269     leot     12944: </tr>
                   12945: <tr>
1.295     rillig   12946: <td>SCREWS_GROUP</td>
1.290     gutterid 12947: <td>SCREWS_USER</td>
1.269     leot     12948: </tr>
                   12949: <tr>
1.295     rillig   12950: <td>SCRIPTS_ENV</td>
1.290     gutterid 12951: <td>SCROLLKEEPER_DATADIR</td>
1.269     leot     12952: </tr>
                   12953: <tr>
1.295     rillig   12954: <td>SCROLLKEEPER_REBUILDDB</td>
1.290     gutterid 12955: <td>SCROLLKEEPER_UPDATEDB</td>
1.269     leot     12956: </tr>
                   12957: <tr>
1.295     rillig   12958: <td>SDIST_PAWD</td>
1.290     gutterid 12959: <td>SERIAL_DEVICES</td>
1.269     leot     12960: </tr>
                   12961: <tr>
1.295     rillig   12962: <td>SETGIDGAME</td>
1.290     gutterid 12963: <td>SETGID_GAMES_PERMS</td>
1.269     leot     12964: </tr>
                   12965: <tr>
1.295     rillig   12966: <td>SETUID_ROOT_PERMS</td>
1.290     gutterid 12967: <td>SH</td>
1.269     leot     12968: </tr>
                   12969: <tr>
1.295     rillig   12970: <td>SHLIB</td>
1.292     leot     12971: <td>SHORTNAME</td>
                   12972: </tr>
                   12973: <tr>
1.295     rillig   12974: <td>SIGN_PACKAGES</td>
1.292     leot     12975: <td>SILC_CLIENT_WITH_PERL</td>
1.269     leot     12976: </tr>
                   12977: <tr>
1.295     rillig   12978: <td>SITE_SPECIFIC_PKGS</td>
1.292     leot     12979: <td>SKIP_DEPENDS</td>
1.269     leot     12980: </tr>
                   12981: <tr>
1.295     rillig   12982: <td>SMF_INSTANCES</td>
1.292     leot     12983: <td>SMF_MANIFEST</td>
1.274     rillig   12984: </tr>
                   12985: <tr>
1.295     rillig   12986: <td>SMF_METHODS</td>
1.292     leot     12987: <td>SMF_METHOD_SHELL</td>
1.269     leot     12988: </tr>
                   12989: <tr>
1.295     rillig   12990: <td>SMF_METHOD_SRC</td>
1.292     leot     12991: <td>SMF_NAME</td>
1.269     leot     12992: </tr>
                   12993: <tr>
1.295     rillig   12994: <td>SMF_PREFIX</td>
1.292     leot     12995: <td>SMF_SRCDIR</td>
1.269     leot     12996: </tr>
                   12997: <tr>
1.295     rillig   12998: <td>SNIPROXY_GROUP</td>
1.292     leot     12999: <td>SNIPROXY_USER</td>
1.269     leot     13000: </tr>
                   13001: <tr>
1.295     rillig   13002: <td>SOURCE_BUFFSIZE</td>
1.292     leot     13003: <td>SPECIAL_PERMS</td>
1.269     leot     13004: </tr>
                   13005: <tr>
1.295     rillig   13006: <td>SPECIFIC_PKGS</td>
1.292     leot     13007: <td>SSH_SUID</td>
1.269     leot     13008: </tr>
                   13009: <tr>
1.295     rillig   13010: <td>SSP_SUPPORTED</td>
1.292     leot     13011: <td>SSYNC_PAWD</td>
1.269     leot     13012: </tr>
                   13013: <tr>
1.295     rillig   13014: <td>STEP_MSG</td>
1.292     leot     13015: <td>STRIP</td>
1.269     leot     13016: </tr>
                   13017: <tr>
1.295     rillig   13018: <td>STRIP_DBG</td>
1.292     leot     13019: <td>STRIP_DEBUG</td>
1.269     leot     13020: </tr>
                   13021: <tr>
1.295     rillig   13022: <td>STRIP_DEBUG_SUPPORTED</td>
1.292     leot     13023: <td>STRIP_FILES_SKIP</td>
1.269     leot     13024: </tr>
                   13025: <tr>
1.295     rillig   13026: <td>SU</td>
1.292     leot     13027: <td>SUBDIR</td>
1.269     leot     13028: </tr>
                   13029: <tr>
1.295     rillig   13030: <td>SUBST</td>
1.292     leot     13031: <td>SUBST_CLASSES</td>
1.289     leot     13032: </tr>
                   13033: <tr>
1.295     rillig   13034: <td>SUBST_FILES</td>
1.292     leot     13035: <td>SUBST_FILTER_CMD</td>
1.269     leot     13036: </tr>
                   13037: <tr>
1.295     rillig   13038: <td>SUBST_MESSAGE</td>
1.292     leot     13039: <td>SUBST_NOOP_OK</td>
1.269     leot     13040: </tr>
                   13041: <tr>
1.295     rillig   13042: <td>SUBST_SED</td>
1.292     leot     13043: <td>SUBST_SHOW_DIFF</td>
1.269     leot     13044: </tr>
                   13045: <tr>
1.295     rillig   13046: <td>SUBST_SKIP_TEXT_CHECK</td>
1.292     leot     13047: <td>SUBST_STAGE</td>
1.269     leot     13048: </tr>
                   13049: <tr>
1.295     rillig   13050: <td>SUBST_VARS</td>
1.292     leot     13051: <td>SUNWSPROBASE</td>
1.269     leot     13052: </tr>
                   13053: <tr>
1.295     rillig   13054: <td>SUSE_PREFER</td>
1.292     leot     13055: <td>SU_CMD</td>
                   13056: </tr>
                   13057: <tr>
1.295     rillig   13058: <td>SVN_EXTRACTDIR</td>
1.292     leot     13059: <td>SVN_REPO</td>
                   13060: </tr>
                   13061: <tr>
1.295     rillig   13062: <td>SVN_REPOSITORIES</td>
1.292     leot     13063: <td>SVN_REVISION</td>
1.269     leot     13064: </tr>
                   13065: <tr>
1.295     rillig   13066: <td>TERMCAP_TYPE</td>
1.292     leot     13067: <td>TERMINFO_DEFAULT</td>
1.274     rillig   13068: </tr>
                   13069: <tr>
1.295     rillig   13070: <td>TERMINFO_TYPE</td>
1.292     leot     13071: <td>TEST</td>
1.269     leot     13072: </tr>
                   13073: <tr>
1.295     rillig   13074: <td>TEST_DEPENDS</td>
1.292     leot     13075: <td>TEST_DIRS</td>
1.269     leot     13076: </tr>
                   13077: <tr>
1.295     rillig   13078: <td>TEST_ENV</td>
1.292     leot     13079: <td>TEST_ENV_SHELL</td>
1.269     leot     13080: </tr>
                   13081: <tr>
1.295     rillig   13082: <td>TEST_MAKE_CMD</td>
1.292     leot     13083: <td>TEST_MAKE_FLAGS</td>
1.269     leot     13084: </tr>
                   13085: <tr>
1.295     rillig   13086: <td>TEST_TARGET</td>
1.292     leot     13087: <td>TEXLIVE_IGNORE_PATTERNS</td>
1.269     leot     13088: </tr>
                   13089: <tr>
1.295     rillig   13090: <td>TEXLIVE_REV</td>
1.292     leot     13091: <td>TEXLIVE_UNVERSIONED</td>
1.269     leot     13092: </tr>
                   13093: <tr>
1.295     rillig   13094: <td>TEXMFSITE</td>
1.292     leot     13095: <td>TEX_FORMATS</td>
1.269     leot     13096: </tr>
                   13097: <tr>
1.295     rillig   13098: <td>TEX_HYPHEN_DAT</td>
1.292     leot     13099: <td>TEX_HYPHEN_DEF</td>
1.269     leot     13100: </tr>
                   13101: <tr>
1.295     rillig   13102: <td>TEX_TEXMF_DIRS</td>
1.292     leot     13103: <td>THTTPD_LOG_FACILITY</td>
1.269     leot     13104: </tr>
                   13105: <tr>
1.295     rillig   13106: <td>TO</td>
1.292     leot     13107: <td>TOOLS_ALIASES</td>
1.269     leot     13108: </tr>
                   13109: <tr>
1.295     rillig   13110: <td>TOOLS_ALWAYS_WRAP</td>
1.284     rillig   13111: <td>TOOLS_ARGS</td>
1.269     leot     13112: </tr>
                   13113: <tr>
1.295     rillig   13114: <td>TOOLS_BROKEN</td>
1.284     rillig   13115: <td>TOOLS_CMD</td>
1.269     leot     13116: </tr>
                   13117: <tr>
1.295     rillig   13118: <td>TOOLS_CREATE</td>
1.284     rillig   13119: <td>TOOLS_DIR</td>
1.269     leot     13120: </tr>
                   13121: <tr>
1.295     rillig   13122: <td>TOOLS_FAIL</td>
1.284     rillig   13123: <td>TOOLS_GNU_MISSING</td>
1.269     leot     13124: </tr>
                   13125: <tr>
1.295     rillig   13126: <td>TOOLS_LDCONFIG</td>
1.284     rillig   13127: <td>TOOLS_NOOP</td>
1.269     leot     13128: </tr>
                   13129: <tr>
1.295     rillig   13130: <td>TOOLS_PATH</td>
1.284     rillig   13131: <td>TOOLS_SCRIPT</td>
1.269     leot     13132: </tr>
                   13133: <tr>
1.295     rillig   13134: <td>TOOL_DEPENDS</td>
1.292     leot     13135: <td>TTF_FONTDIR</td>
1.269     leot     13136: </tr>
                   13137: <tr>
1.295     rillig   13138: <td>TTF_FONTS_DIR</td>
1.284     rillig   13139: <td>TYPE</td>
1.269     leot     13140: </tr>
                   13141: <tr>
1.295     rillig   13142: <td>UAC_REQD_EXECS</td>
1.284     rillig   13143: <td>UCSPI_SSL_GROUP</td>
1.269     leot     13144: </tr>
                   13145: <tr>
1.295     rillig   13146: <td>UCSPI_SSL_USER</td>
1.284     rillig   13147: <td>UNLIMIT_RESOURCES</td>
1.269     leot     13148: </tr>
                   13149: <tr>
1.295     rillig   13150: <td>UNPRIVILEGED</td>
1.284     rillig   13151: <td>UNPRIVILEGED_GROUP</td>
1.269     leot     13152: </tr>
                   13153: <tr>
1.295     rillig   13154: <td>UNPRIVILEGED_GROUPS</td>
1.284     rillig   13155: <td>UNPRIVILEGED_USER</td>
1.269     leot     13156: </tr>
                   13157: <tr>
1.295     rillig   13158: <td>UNWRAP_FILES</td>
1.284     rillig   13159: <td>UNWRAP_PATTERNS</td>
1.269     leot     13160: </tr>
                   13161: <tr>
1.295     rillig   13162: <td>UPDATE_GEMSPEC</td>
1.284     rillig   13163: <td>UPDATE_TARGET</td>
1.269     leot     13164: </tr>
                   13165: <tr>
1.295     rillig   13166: <td>URI</td>
1.290     gutterid 13167: <td>USERGROUP_PHASE</td>
1.269     leot     13168: </tr>
                   13169: <tr>
1.295     rillig   13170: <td>USERPPP_GROUP</td>
1.290     gutterid 13171: <td>USER_SPECIFIC_PKGS</td>
1.269     leot     13172: </tr>
                   13173: <tr>
1.295     rillig   13174: <td>USE_ABI_DEPENDS</td>
1.290     gutterid 13175: <td>USE_APR</td>
1.269     leot     13176: </tr>
                   13177: <tr>
1.295     rillig   13178: <td>USE_BSD_MAKEFILE</td>
1.290     gutterid 13179: <td>USE_BUILTIN</td>
1.269     leot     13180: </tr>
                   13181: <tr>
1.295     rillig   13182: <td>USE_CROSS_COMPILE</td>
1.290     gutterid 13183: <td>USE_CURSES</td>
1.269     leot     13184: </tr>
                   13185: <tr>
1.295     rillig   13186: <td>USE_CWRAPPERS</td>
1.290     gutterid 13187: <td>USE_DB185</td>
1.269     leot     13188: </tr>
                   13189: <tr>
1.295     rillig   13190: <td>USE_FEATURES</td>
1.290     gutterid 13191: <td>USE_GAMESGROUP</td>
1.269     leot     13192: </tr>
                   13193: <tr>
1.295     rillig   13194: <td>USE_GCC_RUNTIME</td>
1.290     gutterid 13195: <td>USE_IMAKE</td>
1.269     leot     13196: </tr>
                   13197: <tr>
1.295     rillig   13198: <td>USE_JAVA</td>
1.290     gutterid 13199: <td>USE_JAVA2</td>
1.269     leot     13200: </tr>
                   13201: <tr>
1.295     rillig   13202: <td>USE_LANGUAGES</td>
1.290     gutterid 13203: <td>USE_LIBTOOL</td>
1.269     leot     13204: </tr>
                   13205: <tr>
1.295     rillig   13206: <td>USE_NATIVE_GCC</td>
1.290     gutterid 13207: <td>USE_NETBSD_REPO</td>
1.269     leot     13208: </tr>
                   13209: <tr>
1.295     rillig   13210: <td>USE_PKGSRC_GCC</td>
1.290     gutterid 13211: <td>USE_PKGSRC_GCC_RUNTIME</td>
1.269     leot     13212: </tr>
                   13213: <tr>
1.295     rillig   13214: <td>USE_PKGTASKS</td>
1.290     gutterid 13215: <td>USE_PKG_ADMIN_DIGEST</td>
1.269     leot     13216: </tr>
                   13217: <tr>
1.295     rillig   13218: <td>USE_RUBY_EXTCONF</td>
1.290     gutterid 13219: <td>USE_RUBY_INSTALL</td>
1.269     leot     13220: </tr>
                   13221: <tr>
1.295     rillig   13222: <td>USE_RUBY_SETUP</td>
1.290     gutterid 13223: <td>USE_RUBY_SETUP_PKG</td>
1.269     leot     13224: </tr>
                   13225: <tr>
1.295     rillig   13226: <td>USE_TOOLS</td>
1.290     gutterid 13227: <td>UUCP_GROUP</td>
1.269     leot     13228: </tr>
                   13229: <tr>
1.295     rillig   13230: <td>UUCP_USER</td>
1.290     gutterid 13231: <td>VARBASE</td>
1.269     leot     13232: </tr>
                   13233: <tr>
1.295     rillig   13234: <td>VARNAME</td>
1.290     gutterid 13235: <td>VIM_EXTRA_OPTS</td>
1.269     leot     13236: </tr>
                   13237: <tr>
1.295     rillig   13238: <td>WARNING_MSG</td>
1.290     gutterid 13239: <td>WCALC_CGIDIR</td>
1.269     leot     13240: </tr>
                   13241: <tr>
1.295     rillig   13242: <td>WCALC_CGIPATH</td>
1.290     gutterid 13243: <td>WCALC_HTMLDIR</td>
1.269     leot     13244: </tr>
                   13245: <tr>
1.295     rillig   13246: <td>WCALC_HTMLPATH</td>
1.290     gutterid 13247: <td>WDM_MANAGERS</td>
1.269     leot     13248: </tr>
                   13249: <tr>
1.295     rillig   13250: <td>WRAPPER_REORDER_CMDS</td>
1.290     gutterid 13251: <td>WRKDIR</td>
1.269     leot     13252: </tr>
                   13253: <tr>
1.295     rillig   13254: <td>WRKDIR_BASENAME</td>
1.290     gutterid 13255: <td>WRKDIR_LOCKTYPE</td>
1.269     leot     13256: </tr>
                   13257: <tr>
1.295     rillig   13258: <td>WRKLOG</td>
1.290     gutterid 13259: <td>WRKOBJDIR</td>
1.269     leot     13260: </tr>
                   13261: <tr>
1.295     rillig   13262: <td>WRKSRC</td>
1.290     gutterid 13263: <td>X10_PORT</td>
1.269     leot     13264: </tr>
                   13265: <tr>
1.295     rillig   13266: <td>X11</td>
1.290     gutterid 13267: <td>X11BASE</td>
1.269     leot     13268: </tr>
                   13269: <tr>
1.295     rillig   13270: <td>X11_PKGSRCDIR</td>
1.290     gutterid 13271: <td>X11_TYPE</td>
1.269     leot     13272: </tr>
                   13273: <tr>
1.295     rillig   13274: <td>X509_CERTIFICATE</td>
1.290     gutterid 13275: <td>X509_KEY</td>
1.269     leot     13276: </tr>
                   13277: <tr>
1.295     rillig   13278: <td>XAW_TYPE</td>
1.290     gutterid 13279: <td>XLOCK_DEFAULT_MODE</td>
1.269     leot     13280: </tr>
                   13281: <tr>
1.295     rillig   13282: <td>XMKMF_FLAGS</td>
1.287     rillig   13283: <td>XXX</td>
1.269     leot     13284: </tr>
                   13285: <tr>
1.295     rillig   13286: <td>XXXX</td>
1.287     rillig   13287: <td>YES</td>
1.274     rillig   13288: </tr>
                   13289: <tr>
1.295     rillig   13290: <td>ZSH_STATIC</td>
1.289     leot     13291: <td>__stdc__</td>
1.269     leot     13292: </tr>
                   13293: <tr>
1.295     rillig   13294: <td>_vargroups</td>
1.289     leot     13295: <td>accept</td>
                   13296: </tr>
                   13297: <tr>
1.295     rillig   13298: <td>acquire-localbase-lock</td>
1.289     leot     13299: <td>acquire-lock</td>
1.269     leot     13300: </tr>
                   13301: <tr>
1.295     rillig   13302: <td>add</td>
1.289     leot     13303: <td>administrator</td>
1.269     leot     13304: </tr>
                   13305: <tr>
1.295     rillig   13306: <td>alloca</td>
1.274     rillig   13307: <td>alternatives</td>
1.289     leot     13308: </tr>
                   13309: <tr>
1.295     rillig   13310: <td>aslr</td>
1.289     leot     13311: <td>asprintf</td>
1.269     leot     13312: </tr>
                   13313: <tr>
1.295     rillig   13314: <td>atlas</td>
1.289     leot     13315: <td>autoconf</td>
1.269     leot     13316: </tr>
                   13317: <tr>
1.295     rillig   13318: <td>automake</td>
1.289     leot     13319: <td>autoreconf</td>
1.269     leot     13320: </tr>
                   13321: <tr>
1.295     rillig   13322: <td>awk</td>
1.289     leot     13323: <td>bash</td>
1.271     brook    13324: </tr>
                   13325: <tr>
1.295     rillig   13326: <td>big-endian</td>
1.289     leot     13327: <td>bin-install</td>
1.269     leot     13328: </tr>
                   13329: <tr>
1.295     rillig   13330: <td>bind</td>
1.287     rillig   13331: <td>binpkg-list</td>
1.292     leot     13332: </tr>
                   13333: <tr>
1.295     rillig   13334: <td>blas</td>
1.287     rillig   13335: <td>bootstrap-depends</td>
1.274     rillig   13336: </tr>
                   13337: <tr>
1.295     rillig   13338: <td>broken</td>
1.287     rillig   13339: <td>broken_on_platform</td>
1.269     leot     13340: </tr>
                   13341: <tr>
1.295     rillig   13342: <td>bsd</td>
1.289     leot     13343: <td>bsd.prog.mk</td>
                   13344: </tr>
                   13345: <tr>
1.295     rillig   13346: <td>build</td>
1.287     rillig   13347: <td>build-env</td>
1.269     leot     13348: </tr>
                   13349: <tr>
1.295     rillig   13350: <td>buildlink-directories</td>
1.287     rillig   13351: <td>buildlink-oss-soundcard-h</td>
1.269     leot     13352: </tr>
                   13353: <tr>
1.295     rillig   13354: <td>c</td>
1.287     rillig   13355: <td>c++</td>
1.269     leot     13356: </tr>
                   13357: <tr>
1.295     rillig   13358: <td>ccache</td>
1.287     rillig   13359: <td>cce</td>
1.269     leot     13360: </tr>
                   13361: <tr>
1.295     rillig   13362: <td>cdefs</td>
1.289     leot     13363: <td>ceil</td>
                   13364: </tr>
                   13365: <tr>
1.295     rillig   13366: <td>changes</td>
1.289     leot     13367: <td>changes-entry</td>
1.269     leot     13368: </tr>
                   13369: <tr>
1.295     rillig   13370: <td>changes-entry-noupdate</td>
1.289     leot     13371: <td>check</td>
1.269     leot     13372: </tr>
                   13373: <tr>
1.295     rillig   13374: <td>check-clean</td>
1.289     leot     13375: <td>check-files</td>
1.269     leot     13376: </tr>
                   13377: <tr>
1.295     rillig   13378: <td>check-files-clean</td>
1.289     leot     13379: <td>check-vulnerable</td>
1.269     leot     13380: </tr>
                   13381: <tr>
1.295     rillig   13382: <td>checksum</td>
1.289     leot     13383: <td>checksum-phase</td>
1.269     leot     13384: </tr>
                   13385: <tr>
1.295     rillig   13386: <td>clean</td>
1.289     leot     13387: <td>clean-depends</td>
1.269     leot     13388: </tr>
                   13389: <tr>
1.295     rillig   13390: <td>cleandir</td>
1.289     leot     13391: <td>commit</td>
1.269     leot     13392: </tr>
                   13393: <tr>
1.295     rillig   13394: <td>commit-changes-entry</td>
1.289     leot     13395: <td>compact</td>
1.269     leot     13396: </tr>
                   13397: <tr>
1.295     rillig   13398: <td>compiler</td>
1.289     leot     13399: <td>conf</td>
1.269     leot     13400: </tr>
                   13401: <tr>
1.295     rillig   13402: <td>config.guess</td>
1.289     leot     13403: <td>config.sub</td>
1.269     leot     13404: </tr>
                   13405: <tr>
1.295     rillig   13406: <td>configuration</td>
1.289     leot     13407: <td>configure</td>
1.269     leot     13408: </tr>
                   13409: <tr>
1.295     rillig   13410: <td>configure-env</td>
1.289     leot     13411: <td>configure-help</td>
1.269     leot     13412: </tr>
                   13413: <tr>
1.295     rillig   13414: <td>configure_args</td>
1.289     leot     13415: <td>connect</td>
1.269     leot     13416: </tr>
                   13417: <tr>
1.295     rillig   13418: <td>cos</td>
1.281     leot     13419: <td>cputime</td>
1.289     leot     13420: </tr>
                   13421: <tr>
1.295     rillig   13422: <td>create-usergroup</td>
1.289     leot     13423: <td>csh</td>
1.269     leot     13424: </tr>
                   13425: <tr>
1.295     rillig   13426: <td>ctf</td>
1.292     leot     13427: <td>cvs</td>
1.269     leot     13428: </tr>
                   13429: <tr>
1.295     rillig   13430: <td>debug</td>
1.289     leot     13431: <td>declaration</td>
1.269     leot     13432: </tr>
                   13433: <tr>
1.295     rillig   13434: <td>declare</td>
1.289     leot     13435: <td>defined</td>
1.269     leot     13436: </tr>
                   13437: <tr>
1.295     rillig   13438: <td>depend</td>
1.289     leot     13439: <td>dependencies</td>
1.269     leot     13440: </tr>
                   13441: <tr>
1.295     rillig   13442: <td>depends</td>
1.289     leot     13443: <td>depends-checksum</td>
1.269     leot     13444: </tr>
                   13445: <tr>
1.295     rillig   13446: <td>depends-fetch</td>
1.289     leot     13447: <td>deps</td>
1.269     leot     13448: </tr>
                   13449: <tr>
1.295     rillig   13450: <td>describe</td>
1.289     leot     13451: <td>destdir</td>
1.269     leot     13452: </tr>
                   13453: <tr>
1.295     rillig   13454: <td>disable</td>
1.289     leot     13455: <td>distclean</td>
1.277     rillig   13456: </tr>
                   13457: <tr>
1.295     rillig   13458: <td>distinfo</td>
1.289     leot     13459: <td>dl</td>
1.269     leot     13460: </tr>
                   13461: <tr>
1.295     rillig   13462: <td>dlopen</td>
1.289     leot     13463: <td>do-build</td>
1.269     leot     13464: </tr>
                   13465: <tr>
1.295     rillig   13466: <td>do-buildlink</td>
1.289     leot     13467: <td>do-clean</td>
1.269     leot     13468: </tr>
                   13469: <tr>
1.295     rillig   13470: <td>do-configure</td>
1.289     leot     13471: <td>do-configure-post-hook</td>
1.285     rillig   13472: </tr>
                   13473: <tr>
1.295     rillig   13474: <td>do-extract</td>
1.289     leot     13475: <td>do-fetch</td>
1.292     leot     13476: </tr>
                   13477: <tr>
1.295     rillig   13478: <td>do-install</td>
1.289     leot     13479: <td>emul</td>
                   13480: </tr>
                   13481: <tr>
1.295     rillig   13482: <td>emul-distinfo</td>
1.289     leot     13483: <td>emul-fetch</td>
1.269     leot     13484: </tr>
                   13485: <tr>
1.295     rillig   13486: <td>emulation</td>
1.289     leot     13487: <td>emulator</td>
1.274     rillig   13488: </tr>
                   13489: <tr>
1.295     rillig   13490: <td>enable</td>
1.289     leot     13491: <td>endian</td>
1.269     leot     13492: </tr>
                   13493: <tr>
1.295     rillig   13494: <td>endif</td>
1.285     rillig   13495: <td>enomem</td>
1.269     leot     13496: </tr>
                   13497: <tr>
1.295     rillig   13498: <td>err</td>
1.285     rillig   13499: <td>errx</td>
1.269     leot     13500: </tr>
                   13501: <tr>
1.295     rillig   13502: <td>etc</td>
1.289     leot     13503: <td>exp</td>
                   13504: </tr>
                   13505: <tr>
1.295     rillig   13506: <td>extract-rpm</td>
1.289     leot     13507: <td>fabs</td>
1.269     leot     13508: </tr>
                   13509: <tr>
1.295     rillig   13510: <td>feature</td>
1.274     rillig   13511: <td>features</td>
1.269     leot     13512: </tr>
                   13513: <tr>
1.295     rillig   13514: <td>fetch</td>
1.274     rillig   13515: <td>fetch-list</td>
1.269     leot     13516: </tr>
                   13517: <tr>
1.295     rillig   13518: <td>follows</td>
1.274     rillig   13519: <td>forbids</td>
1.269     leot     13520: </tr>
                   13521: <tr>
1.295     rillig   13522: <td>form</td>
1.274     rillig   13523: <td>format</td>
1.269     leot     13524: </tr>
                   13525: <tr>
1.295     rillig   13526: <td>fortify</td>
1.274     rillig   13527: <td>fortify_source</td>
1.292     leot     13528: </tr>
                   13529: <tr>
1.295     rillig   13530: <td>fossil</td>
1.270     leot     13531: <td>friend</td>
1.269     leot     13532: </tr>
                   13533: <tr>
1.295     rillig   13534: <td>fts</td>
1.285     rillig   13535: <td>fts_close</td>
1.269     leot     13536: </tr>
                   13537: <tr>
1.295     rillig   13538: <td>fts_open</td>
1.285     rillig   13539: <td>fts_read</td>
1.269     leot     13540: </tr>
                   13541: <tr>
1.295     rillig   13542: <td>fts_set</td>
1.289     leot     13543: <td>gcc</td>
                   13544: </tr>
                   13545: <tr>
1.295     rillig   13546: <td>gethostbyaddr</td>
1.289     leot     13547: <td>gethostbyname</td>
1.269     leot     13548: </tr>
                   13549: <tr>
1.295     rillig   13550: <td>gethostbyname2</td>
1.285     rillig   13551: <td>getopt_long</td>
1.269     leot     13552: </tr>
                   13553: <tr>
1.295     rillig   13554: <td>getprogname</td>
1.289     leot     13555: <td>getservbyname</td>
                   13556: </tr>
                   13557: <tr>
1.295     rillig   13558: <td>getservbyport</td>
1.289     leot     13559: <td>getservent</td>
                   13560: </tr>
                   13561: <tr>
1.295     rillig   13562: <td>gettext</td>
1.292     leot     13563: <td>git</td>
1.269     leot     13564: </tr>
                   13565: <tr>
1.295     rillig   13566: <td>github</td>
1.292     leot     13567: <td>gitlab</td>
                   13568: </tr>
                   13569: <tr>
1.295     rillig   13570: <td>glob</td>
1.290     gutterid 13571: <td>gnu</td>
1.274     rillig   13572: </tr>
                   13573: <tr>
1.295     rillig   13574: <td>gnu_configure_strict</td>
1.290     gutterid 13575: <td>go</td>
1.269     leot     13576: </tr>
                   13577: <tr>
1.295     rillig   13578: <td>go-deps</td>
1.290     gutterid 13579: <td>golang</td>
1.269     leot     13580: </tr>
                   13581: <tr>
1.295     rillig   13582: <td>guess-license</td>
1.290     gutterid 13583: <td>hashbang</td>
1.269     leot     13584: </tr>
                   13585: <tr>
1.295     rillig   13586: <td>heimdal</td>
1.285     rillig   13587: <td>help</td>
1.269     leot     13588: </tr>
                   13589: <tr>
1.295     rillig   13590: <td>hg</td>
1.285     rillig   13591: <td>imake</td>
1.269     leot     13592: </tr>
                   13593: <tr>
1.295     rillig   13594: <td>increment</td>
1.289     leot     13595: <td>inet_aton</td>
1.269     leot     13596: </tr>
                   13597: <tr>
1.295     rillig   13598: <td>interp</td>
1.270     leot     13599: <td>interpreter</td>
1.269     leot     13600: </tr>
                   13601: <tr>
1.295     rillig   13602: <td>intl</td>
1.270     leot     13603: <td>iso</td>
1.269     leot     13604: </tr>
                   13605: <tr>
1.295     rillig   13606: <td>kerberos</td>
1.270     leot     13607: <td>krb</td>
1.269     leot     13608: </tr>
                   13609: <tr>
1.295     rillig   13610: <td>krb5</td>
1.270     leot     13611: <td>ksh</td>
1.292     leot     13612: </tr>
                   13613: <tr>
1.295     rillig   13614: <td>lapack</td>
1.290     gutterid 13615: <td>latex</td>
1.269     leot     13616: </tr>
                   13617: <tr>
1.295     rillig   13618: <td>libintl_bindtextdomain</td>
1.290     gutterid 13619: <td>libintl_gettext</td>
1.289     leot     13620: </tr>
                   13621: <tr>
1.295     rillig   13622: <td>libintl_textdomain</td>
1.290     gutterid 13623: <td>libnbcompat</td>
1.274     rillig   13624: </tr>
                   13625: <tr>
1.295     rillig   13626: <td>libs</td>
1.290     gutterid 13627: <td>libtool</td>
1.271     brook    13628: </tr>
                   13629: <tr>
1.295     rillig   13630: <td>licence</td>
1.290     gutterid 13631: <td>license</td>
1.269     leot     13632: </tr>
                   13633: <tr>
1.295     rillig   13634: <td>lintl</td>
1.290     gutterid 13635: <td>little-endian</td>
1.269     leot     13636: </tr>
                   13637: <tr>
1.295     rillig   13638: <td>lock</td>
1.290     gutterid 13639: <td>locking</td>
1.269     leot     13640: </tr>
                   13641: <tr>
1.295     rillig   13642: <td>lvalue</td>
1.290     gutterid 13643: <td>make</td>
1.269     leot     13644: </tr>
                   13645: <tr>
1.295     rillig   13646: <td>makesum</td>
1.289     leot     13647: <td>memory</td>
1.269     leot     13648: </tr>
                   13649: <tr>
1.295     rillig   13650: <td>mercurial</td>
1.289     leot     13651: <td>meta</td>
1.269     leot     13652: </tr>
                   13653: <tr>
1.295     rillig   13654: <td>meta-package</td>
1.289     leot     13655: <td>meta_package</td>
1.269     leot     13656: </tr>
                   13657: <tr>
1.295     rillig   13658: <td>mit-krb5</td>
1.289     leot     13659: <td>mk.conf</td>
1.292     leot     13660: </tr>
                   13661: <tr>
1.295     rillig   13662: <td>mkl</td>
1.290     gutterid 13663: <td>mount</td>
1.274     rillig   13664: </tr>
                   13665: <tr>
1.295     rillig   13666: <td>mprotect</td>
1.290     gutterid 13667: <td>mremap</td>
1.269     leot     13668: </tr>
                   13669: <tr>
1.295     rillig   13670: <td>nb</td>
1.290     gutterid 13671: <td>nbcompat</td>
1.269     leot     13672: </tr>
                   13673: <tr>
1.295     rillig   13674: <td>obstack</td>
1.290     gutterid 13675: <td>obstack_ptr_grow</td>
1.269     leot     13676: </tr>
                   13677: <tr>
1.295     rillig   13678: <td>occurs</td>
1.274     rillig   13679: <td>only</td>
1.269     leot     13680: </tr>
                   13681: <tr>
1.295     rillig   13682: <td>openblas</td>
1.273     brook    13683: <td>options</td>
1.269     leot     13684: </tr>
                   13685: <tr>
1.295     rillig   13686: <td>options.mk</td>
1.273     brook    13687: <td>order</td>
1.271     brook    13688: </tr>
                   13689: <tr>
1.295     rillig   13690: <td>override</td>
1.273     brook    13691: <td>override-intltool</td>
1.269     leot     13692: </tr>
                   13693: <tr>
1.295     rillig   13694: <td>override-message-intltool</td>
1.273     brook    13695: <td>package</td>
1.269     leot     13696: </tr>
                   13697: <tr>
1.295     rillig   13698: <td>parallel</td>
1.285     rillig   13699: <td>path</td>
1.269     leot     13700: </tr>
                   13701: <tr>
1.295     rillig   13702: <td>pax</td>
1.285     rillig   13703: <td>paxctl</td>
1.269     leot     13704: </tr>
                   13705: <tr>
1.295     rillig   13706: <td>pbulk-index</td>
1.285     rillig   13707: <td>pc</td>
1.269     leot     13708: </tr>
                   13709: <tr>
1.295     rillig   13710: <td>perl</td>
1.285     rillig   13711: <td>perl5</td>
1.269     leot     13712: </tr>
                   13713: <tr>
1.295     rillig   13714: <td>perms</td>
1.285     rillig   13715: <td>php</td>
1.269     leot     13716: </tr>
                   13717: <tr>
1.295     rillig   13718: <td>pkg-build-options</td>
1.285     rillig   13719: <td>pkg-config</td>
1.269     leot     13720: </tr>
                   13721: <tr>
1.295     rillig   13722: <td>pkg_build_options</td>
1.285     rillig   13723: <td>platform</td>
1.269     leot     13724: </tr>
                   13725: <tr>
1.295     rillig   13726: <td>plist</td>
1.285     rillig   13727: <td>post-extract</td>
1.269     leot     13728: </tr>
                   13729: <tr>
1.295     rillig   13730: <td>post-fetch</td>
1.285     rillig   13731: <td>post-wrapper</td>
1.269     leot     13732: </tr>
                   13733: <tr>
1.295     rillig   13734: <td>pre-build-checks-hook</td>
1.273     brook    13735: <td>pre-configure</td>
1.289     leot     13736: </tr>
                   13737: <tr>
1.295     rillig   13738: <td>pre-configure-checks-hook</td>
1.285     rillig   13739: <td>pre-extract</td>
1.269     leot     13740: </tr>
                   13741: <tr>
1.295     rillig   13742: <td>pre-fetch</td>
1.285     rillig   13743: <td>print-go-deps</td>
1.269     leot     13744: </tr>
                   13745: <tr>
1.295     rillig   13746: <td>print-plist</td>
1.285     rillig   13747: <td>print-summary-data</td>
1.269     leot     13748: </tr>
                   13749: <tr>
1.295     rillig   13750: <td>privileged-install-hook</td>
1.285     rillig   13751: <td>pypi</td>
1.269     leot     13752: </tr>
                   13753: <tr>
1.295     rillig   13754: <td>python</td>
1.285     rillig   13755: <td>readme-all</td>
1.269     leot     13756: </tr>
                   13757: <tr>
1.295     rillig   13758: <td>recv</td>
1.289     leot     13759: <td>recvfrom</td>
                   13760: </tr>
                   13761: <tr>
1.295     rillig   13762: <td>regcomp</td>
1.289     leot     13763: <td>release-localbase-lock</td>
                   13764: </tr>
                   13765: <tr>
1.295     rillig   13766: <td>release-lock</td>
1.285     rillig   13767: <td>relro</td>
1.269     leot     13768: </tr>
                   13769: <tr>
1.295     rillig   13770: <td>rename</td>
1.285     rillig   13771: <td>reorder</td>
1.269     leot     13772: </tr>
                   13773: <tr>
1.295     rillig   13774: <td>replace</td>
1.285     rillig   13775: <td>replace_interpreter</td>
1.269     leot     13776: </tr>
                   13777: <tr>
1.295     rillig   13778: <td>reproducible</td>
1.285     rillig   13779: <td>resolv</td>
1.269     leot     13780: </tr>
                   13781: <tr>
1.295     rillig   13782: <td>root</td>
1.285     rillig   13783: <td>ruby</td>
1.289     leot     13784: </tr>
                   13785: <tr>
1.295     rillig   13786: <td>send</td>
1.289     leot     13787: <td>sendfile</td>
1.269     leot     13788: </tr>
                   13789: <tr>
1.295     rillig   13790: <td>sendto</td>
1.273     brook    13791: <td>setenv</td>
1.269     leot     13792: </tr>
                   13793: <tr>
1.295     rillig   13794: <td>setgid</td>
1.273     brook    13795: <td>setprogname</td>
1.269     leot     13796: </tr>
                   13797: <tr>
1.295     rillig   13798: <td>setuid</td>
1.273     brook    13799: <td>sh</td>
1.269     leot     13800: </tr>
                   13801: <tr>
1.296     rillig   13802: <td>shebang</td>
1.295     rillig   13803: <td>show</td>
1.296     rillig   13804: </tr>
                   13805: <tr>
1.273     brook    13806: <td>show-all</td>
1.296     rillig   13807: <td>show-build-defs</td>
1.269     leot     13808: </tr>
                   13809: <tr>
1.273     brook    13810: <td>show-depends</td>
1.296     rillig   13811: <td>show-deps</td>
1.269     leot     13812: </tr>
                   13813: <tr>
1.273     brook    13814: <td>show-distfiles</td>
1.296     rillig   13815: <td>show-downlevel</td>
1.269     leot     13816: </tr>
                   13817: <tr>
1.273     brook    13818: <td>show-subdir-var</td>
1.296     rillig   13819: <td>show-tools</td>
1.269     leot     13820: </tr>
                   13821: <tr>
1.273     brook    13822: <td>show-var</td>
1.296     rillig   13823: <td>show-vars</td>
1.269     leot     13824: </tr>
                   13825: <tr>
1.273     brook    13826: <td>snprintf</td>
1.296     rillig   13827: <td>socket</td>
1.289     leot     13828: </tr>
                   13829: <tr>
1.285     rillig   13830: <td>ssp</td>
1.296     rillig   13831: <td>st_mode</td>
1.269     leot     13832: </tr>
                   13833: <tr>
1.285     rillig   13834: <td>stage-install</td>
1.296     rillig   13835: <td>strcasestr</td>
1.269     leot     13836: </tr>
                   13837: <tr>
1.277     rillig   13838: <td>strict</td>
1.296     rillig   13839: <td>strip</td>
1.277     rillig   13840: </tr>
                   13841: <tr>
1.289     leot     13842: <td>strndup</td>
1.296     rillig   13843: <td>strnlen</td>
1.269     leot     13844: </tr>
                   13845: <tr>
1.289     leot     13846: <td>strsep</td>
1.296     rillig   13847: <td>subst</td>
1.289     leot     13848: </tr>
                   13849: <tr>
                   13850: <td>substitutions</td>
1.296     rillig   13851: <td>subversion</td>
1.292     leot     13852: </tr>
                   13853: <tr>
1.290     gutterid 13854: <td>sun</td>
1.296     rillig   13855: <td>sunpro</td>
1.269     leot     13856: </tr>
                   13857: <tr>
1.276     leot     13858: <td>sunwspro</td>
1.296     rillig   13859: <td>svn</td>
1.269     leot     13860: </tr>
                   13861: <tr>
1.276     leot     13862: <td>symlink</td>
1.296     rillig   13863: <td>test</td>
1.269     leot     13864: </tr>
                   13865: <tr>
1.289     leot     13866: <td>test-env</td>
1.296     rillig   13867: <td>tex</td>
1.269     leot     13868: </tr>
                   13869: <tr>
1.289     leot     13870: <td>texlive</td>
1.296     rillig   13871: <td>tmp</td>
1.269     leot     13872: </tr>
                   13873: <tr>
1.289     leot     13874: <td>tool</td>
1.296     rillig   13875: <td>tools</td>
1.269     leot     13876: </tr>
                   13877: <tr>
1.289     leot     13878: <td>tools-libtool-m4-override</td>
1.296     rillig   13879: <td>type</td>
1.269     leot     13880: </tr>
                   13881: <tr>
1.289     leot     13882: <td>ulimit</td>
1.296     rillig   13883: <td>undefined</td>
1.269     leot     13884: </tr>
                   13885: <tr>
1.289     leot     13886: <td>undo-replace</td>
1.296     rillig   13887: <td>unlimit</td>
1.269     leot     13888: </tr>
                   13889: <tr>
1.289     leot     13890: <td>unprivileged</td>
1.296     rillig   13891: <td>unprivileged-install-hook</td>
1.269     leot     13892: </tr>
                   13893: <tr>
1.289     leot     13894: <td>unstripped</td>
1.296     rillig   13895: <td>update</td>
1.269     leot     13896: </tr>
                   13897: <tr>
1.289     leot     13898: <td>upload</td>
1.296     rillig   13899: <td>upload-distfiles</td>
1.269     leot     13900: </tr>
                   13901: <tr>
1.270     leot     13902: <td>use_tools</td>
1.296     rillig   13903: <td>user</td>
1.269     leot     13904: </tr>
                   13905: <tr>
1.270     leot     13906: <td>utimes</td>
1.296     rillig   13907: <td>vasprintf</td>
1.269     leot     13908: </tr>
                   13909: <tr>
1.270     leot     13910: <td>verbose</td>
1.296     rillig   13911: <td>vsnprintf</td>
1.269     leot     13912: </tr>
                   13913: <tr>
1.270     leot     13914: <td>warn</td>
1.296     rillig   13915: <td>warning</td>
1.269     leot     13916: </tr>
                   13917: <tr>
1.270     leot     13918: <td>warnings</td>
1.296     rillig   13919: <td>warnx</td>
1.269     leot     13920: </tr>
                   13921: <tr>
1.289     leot     13922: <td>wattr_off</td>
1.296     rillig   13923: <td>wattr_on</td>
1.269     leot     13924: </tr>
                   13925: <tr>
1.289     leot     13926: <td>work</td>
1.296     rillig   13927: <td>wrapper</td>
1.269     leot     13928: </tr>
                   13929: <tr>
1.289     leot     13930: <td>wrkdir</td>
1.296     rillig   13931: <td> </td>
1.269     leot     13932: </tr>
                   13933: </table>
1.267     rillig   13934: </div>
                   13935: <div class="appendix">
                   13936: <div class="titlepage"><div><div><h1 class="title">
                   13937: <a name="editing"></a>Appendix E. Editing guidelines for the pkgsrc guide</h1></div></div></div>
1.75      rillig   13938: <div class="toc">
                   13939: <p><b>Table of Contents</b></p>
1.210     leot     13940: <dl class="toc">
1.267     rillig   13941: <dt><span class="sect1"><a href="#targets">E.1. Make targets</a></span></dt>
                   13942: <dt><span class="sect1"><a href="#procedure">E.2. Procedure</a></span></dt>
1.75      rillig   13943: </dl>
                   13944: </div>
1.79      rillig   13945: <p>This section contains information on editing the pkgsrc
                   13946:        guide itself.</p>
1.148     asau     13947: <div class="sect1">
1.75      rillig   13948: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   13949: <a name="targets"></a>E.1. Make targets</h2></div></div></div>
1.79      rillig   13950: <p>The pkgsrc guide's source code is stored in
                   13951:        <code class="filename">pkgsrc/doc/guide/files</code>, and several files
                   13952:        are created from it:</p>
1.148     asau     13953: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      13954: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
                   13955: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
1.289     leot     13956: <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>
                   13957: <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   13958:        The PDF version of the pkgsrc guide.</p></li>
1.289     leot     13959: <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   13960:        PostScript version of the pkgsrc guide.</p></li>
1.75      rillig   13961: </ul></div>
                   13962: </div>
1.148     asau     13963: <div class="sect1">
1.75      rillig   13964: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   13965: <a name="procedure"></a>E.2. Procedure</h2></div></div></div>
1.79      rillig   13966: <p>The procedure to edit the pkgsrc guide is:</p>
1.128     wiz      13967: <div class="procedure"><ol class="procedure" type="1">
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>