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

1.75      rillig      1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
                      2: <html>
1.1       grant       3: <head>
1.75      rillig      4: <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
                      5: <title>The pkgsrc guide</title>
1.132     spz         6: <link rel="stylesheet" type="text/css" href="/global.css">
1.75      rillig      7: <meta name="generator" content="DocBook XSL Stylesheets VX.X.X">
1.91      rillig      8: <meta name="description" content="pkgsrc is a centralized package management system for Unix-like operating systems. This guide provides information for users and developers of pkgsrc. It covers installation of binary and source packages, creation of binary and source packages and a high-level overview about the infrastructure.">
1.75      rillig      9: </head>
1.148     asau       10: <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book">
1.75      rillig     11: <div class="titlepage">
                     12: <div>
                     13: <div><h1 class="title">
                     14: <a name="the-pkgsrc-guide"></a>The pkgsrc guide</h1></div>
                     15: <div><h2 class="subtitle">Documentation on the NetBSD packages system</h2></div>
                     16: <div><div class="authorgroup">
                     17: <div class="author">
                     18: <h3 class="author">
                     19: <span class="firstname">Alistair</span> <span class="surname">Crooks</span>
                     20: </h3>
1.110     hubertf    21: <div class="affiliation"><div class="address"><p><code class="email">&lt;<a class="email" href="mailto:agc@NetBSD.org">agc@NetBSD.org</a>&gt;</code></p></div></div>
1.75      rillig     22: </div>
                     23: <div class="author">
                     24: <h3 class="author">
                     25: <span class="firstname">Hubert</span> <span class="surname">Feyrer</span>
                     26: </h3>
1.110     hubertf    27: <div class="affiliation"><div class="address"><p><code class="email">&lt;<a class="email" href="mailto:hubertf@NetBSD.org">hubertf@NetBSD.org</a>&gt;</code></p></div></div>
1.75      rillig     28: </div>
                     29: <h3 class="corpauthor">
                     30:         The pkgsrc Developers
                     31:       </h3>
                     32: </div></div>
1.310     jnemeth    33: <div><p class="copyright">Copyright © 1994-2021 The NetBSD Foundation, Inc</p></div>
                     34: <div><p class="pubdate">$NetBSD: pkgsrc.xml,v 1.39 2021/01/02 08:32:15 jnemeth Exp $</p></div>
1.148     asau       35: <div><div class="abstract">
1.75      rillig     36: <p class="title"><b>Abstract</b></p>
                     37: <p>pkgsrc is a centralized package management system for
                     38:        Unix-like operating systems. This guide provides information for
                     39:        users and developers of pkgsrc. It covers installation of binary
                     40:        and source packages, creation of binary and source packages and
                     41:        a high-level overview about the infrastructure.</p>
                     42: </div></div>
                     43: </div>
                     44: <hr>
                     45: </div>
                     46: <div class="toc">
                     47: <p><b>Table of Contents</b></p>
1.210     leot       48: <dl class="toc">
1.75      rillig     49: <dt><span class="chapter"><a href="#introduction">1. What is pkgsrc?</a></span></dt>
                     50: <dd><dl>
                     51: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82      rillig     52: <dd><dl>
                     53: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
                     54: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
                     55: </dl></dd>
1.75      rillig     56: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
                     57: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88      wiz        58: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
1.75      rillig     59: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
                     60: </dl></dd>
                     61: <dt><span class="part"><a href="#users-guide">I. The pkgsrc user's guide</a></span></dt>
                     62: <dd><dl>
1.267     rillig     63: <dt><span class="chapter"><a href="#help-user">2. Getting help</a></span></dt>
                     64: <dt><span class="chapter"><a href="#getting">3. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
1.75      rillig     65: <dd><dl>
1.267     rillig     66: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.75      rillig     67: <dd><dl>
1.267     rillig     68: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
                     69: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.75      rillig     70: </dl></dd>
1.267     rillig     71: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.75      rillig     72: <dd><dl>
1.267     rillig     73: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
                     74: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.75      rillig     75: </dl></dd>
                     76: </dl></dd>
1.267     rillig     77: <dt><span class="chapter"><a href="#platforms">4. Using pkgsrc on systems other than NetBSD</a></span></dt>
1.75      rillig     78: <dd><dl>
1.267     rillig     79: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
                     80: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.75      rillig     81: </dl></dd>
1.267     rillig     82: <dt><span class="chapter"><a href="#using">5. Using pkgsrc</a></span></dt>
1.75      rillig     83: <dd><dl>
1.267     rillig     84: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.75      rillig     85: <dd><dl>
1.267     rillig     86: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
                     87: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
                     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.305     bacon     617: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.macOS" target="_top">README.macOS</a></td>
1.82      rillig    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.311     leot     1006:        <code class="literal">2020Q4</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.311     leot     1032: <p>The tar file for the stable branch 2020Q4 is in the
                   1033:        directory <code class="filename">pkgsrc-2020Q4</code> and is also called <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/pkgsrc-2020Q4/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.311     leot     1036: <code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2020Q4/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.311     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-2020Q4 -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.311     leot     1136:        <span class="quote">&#8220;<span class="quote">-rpkgsrc-2020Q4</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.311     leot     1386:       to the root users <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/crontab.5"><span class="citerefentry"><span class="refentrytitle">crontab</span>(5)</span></a> entry.  For example the entry
1.125     wiz      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.311     leot     1415:       see <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/daily.conf.5"><span class="citerefentry"><span class="refentrytitle">daily.conf</span>(5)</span></a> and <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/security.conf.5"><span class="citerefentry"><span class="refentrytitle">security.conf</span>(5)</span></a> for more details.
1.88      wiz      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.311     leot     1606: <p>If you invoke the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> command with
1.88      wiz      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.311     leot     1614: <p>If you want to know the value of a certain <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88      wiz      1615:        definition, then the <code class="varname">VARNAME</code> definition
                   1616:        should be used, in conjunction with the show-var
1.311     leot     1617:        target. e.g. to show the expansion of the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88      wiz      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.311     leot     1630:     install a binary package - if available - via <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>,
1.110     hubertf  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.311     leot     1634:     ftp.NetBSD.org. Any flags that should be added to <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>
1.88      wiz      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.311     leot     1673: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> from the base system, it is in the directory
1.89      rillig   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.312   ! gdt      1768: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><code class="varname">PKGSRC_KEEP_BIN_PKGS</code>:
1.256     maya     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.311     leot     1815:     privileges using <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/su.1"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a>
1.118     imil     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.311     leot     2055:     another system with <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. This saves having to build
1.87      wiz      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.311     leot     2906: don't have a NetBSD-compatible <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/ftp.1"><span class="citerefentry"><span class="refentrytitle">ftp</span>(1)</span></a> (like tnftp) at work, don't
1.75      rillig   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.311     leot     2958: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/su.1"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a> feature of pkgsrc, it can become annoying to type in the root
1.75      rillig   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.311     leot     3032:        scripts and to <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>. Some package authors ignore the
1.75      rillig   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>:
1.311     leot     3483:     an argument to <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/patch.1"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> that sets the pathname strip count to
1.299     rillig   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
1.311     leot     3493:     this package which have been reported with <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/send-pr.1"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a>.
1.299     rillig   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>
1.311     leot     3846: <p>This shell script is invoked twice by <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>.
1.299     rillig   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
1.311     leot     3851:            <code class="filename">PLIST</code>. See <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> and
                   3852:            <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/pkg_create.1"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information.  See also <a class="xref" href="#files-and-dirs-outside-prefix" title="20.1. Files and directories outside the installation prefix">Section 20.1, &#8220;Files and directories outside the installation prefix&#8221;</a>.
1.299     rillig   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.
1.311     leot     3872:            See <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
                   3873:            and <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/pkg_create.1"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information.
1.299     rillig   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.
1.312   ! gdt      3879:            While this was used often in the past, it has two
        !          3880:            problems: the display will be missed if many packages are
        !          3881:            intalled at once, and the person installing the package
        !          3882:            and the one using or configuring it may be different.  It
        !          3883:            should therefore be used only in exceptional circumstances
        !          3884:            where lasting negative consequences would result from
        !          3885:            someone not reading it.</p>
        !          3886: <p>MESSAGE should not be used for:</p>
        !          3887: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
        !          3888: <li class="listitem"><p>exhortations to read the documentation</p></li>
        !          3889: <li class="listitem"><p>reminders to install rc.d files and set variables</p></li>
        !          3890: <li class="listitem"><p>anything that should be explained in the
        !          3891:              installation/configuration documentation that should
        !          3892:              come with the package</p></li>
        !          3893: </ul></div>
        !          3894: <p>If the documentation provided by upstream needs
        !          3895:            enhancing, create e.g. files/README.pkgsrc and install it.        
        !          3896:            </p>
        !          3897: <p>Note that MESSAGE is shown for all operating
        !          3898:            systems and all init systems.  If a MESSAGE is necessary,
        !          3899:            it sbould be narrowed to only those operating systems and
        !          3900:            init systems to which it applies.</p>
        !          3901: <p>Note that you can modify variables in it easily by using
1.299     rillig   3902:            <code class="varname">MESSAGE_SUBST</code> in the package's
                   3903:            <code class="filename">Makefile</code>:</p>
1.91      rillig   3904: <pre class="programlisting">
1.299     rillig   3905: MESSAGE_SUBST+=  SOMEVAR="somevalue"
1.91      rillig   3906: </pre>
1.299     rillig   3907: <p>replaces "${SOMEVAR}" with <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span> in
                   3908:            <code class="filename">MESSAGE</code>.  By default, substitution is
                   3909:            performed for <code class="varname">PKGNAME</code>,
                   3910:            <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
                   3911:            <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
                   3912:            <code class="varname">PKG_SYSCONFDIR</code>,
                   3913:            <code class="varname">ROOT_GROUP</code>, and
                   3914:            <code class="varname">ROOT_USER</code>.</p>
                   3915: <p>You can display a different or additional files by
                   3916:            setting the <code class="varname">MESSAGE_SRC</code> variable.  Its
                   3917:            default is <code class="filename">MESSAGE</code>, if the file
                   3918:            exists.</p>
                   3919: </dd>
                   3920: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
                   3921: <dd>
                   3922: <p>This file is used by the alternatives framework.
                   3923:            It creates, configures, and destroys generic wrappers used to
                   3924:            run programs with similar interfaces.
                   3925:            See pkg_alternatives(8) from pkgtools/pkg_alternatives
                   3926:             for more information.</p>
                   3927: <p>Each line of the file contains two filenames, first
                   3928:            the wrapper and then the alternative provided by the package.
                   3929:            Both paths are relative to <code class="varname">PREFIX</code>.</p>
                   3930: </dd>
                   3931: </dl></div>
                   3932: </div>
                   3933: <div class="sect2">
                   3934: <div class="titlepage"><div><div><h3 class="title">
                   3935: <a name="components.optional.build"></a>12.5.2. Files affecting the build process</h3></div></div></div>
                   3936: <div class="variablelist"><dl class="variablelist">
                   3937: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
                   3938: <dd><p>This file contains arbitrary things that could
                   3939:        also go into a <code class="filename">Makefile</code>, but its purpose is
                   3940:        to be used by more than one package. This file should only be
                   3941:        used when the packages that will use the file are known in
                   3942:        advance. For other purposes it is often better to write a
                   3943:        <code class="filename">*.mk</code> file and give it a good name that
                   3944:        describes what it does.</p></dd>
                   3945: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
                   3946: <dd><p>This file contains the dependency information
                   3947:        for the buildlink3 framework (see <a class="xref" href="#buildlink" title="Chapter 18. Buildlink methodology">Chapter 18, <i>Buildlink methodology</i></a>).</p></dd>
                   3948: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
                   3949: <dd><p>This file contains workarounds for compiler bugs
                   3950:        and similar things. It is included automatically by the pkgsrc
                   3951:        infrastructure, so you don't need an extra
                   3952:        <code class="literal">.include</code> line for
                   3953:        it.</p></dd>
                   3954: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
                   3955: <dd><p>This file contains the code for the
                   3956:        package-specific options (see <a class="xref" href="#options" title="Chapter 16. Options handling">Chapter 16, <i>Options handling</i></a>) that can be
                   3957:        selected by the user. If a package has only one or two options,
                   3958:        it is equally acceptable to put the code directly into the
                   3959:        <code class="filename">Makefile</code>.</p></dd>
                   3960: </dl></div>
                   3961: </div>
                   3962: <div class="sect2">
                   3963: <div class="titlepage"><div><div><h3 class="title">
                   3964: <a name="components.optional.none"></a>12.5.3. Files affecting nothing at all</h3></div></div></div>
                   3965: <div class="variablelist"><dl class="variablelist">
                   3966: <dt><span class="term"><code class="filename">README*</code></span></dt>
                   3967: <dd><p>These files do not take place in the creation of
                   3968:        a package and thus are purely informative to the package
                   3969:        developer.</p></dd>
                   3970: <dt><span class="term"><code class="filename">TODO</code></span></dt>
                   3971: <dd><p>This file contains things that need to be done
                   3972:        to make the package even
                   3973:        better.</p></dd>
                   3974: </dl></div>
                   3975: </div>
                   3976: </div>
                   3977: <div class="sect1">
                   3978: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   3979: <a name="work-dir"></a>12.6. <code class="filename">work*</code>
                   3980: </h2></div></div></div>
                   3981: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
                   3982:     unpacked into the directory denoted by
                   3983:     <code class="varname">WRKDIR</code>. It can be removed by running
                   3984:     <span class="command"><strong>make clean</strong></span>. Besides the sources, this
                   3985:     directory is also used to keep various timestamp files.
                   3986:     The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
                   3987:     The default is <code class="filename">${.CURDIR}/work</code>
                   3988:     or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
                   3989:     if <code class="varname">OBJMACHINE</code> is set.</p>
1.91      rillig   3990: </div>
1.299     rillig   3991: <div class="sect1">
                   3992: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   3993: <a name="files-dir"></a>12.7. <code class="filename">files/*</code>
                   3994: </h2></div></div></div>
                   3995: <p>If you have any files that you wish to be placed in the package
                   3996:     prior to configuration or building, you can place these files here
                   3997:     and use a <span class="command"><strong>${CP}</strong></span> command in the
                   3998:     <span class="quote">&#8220;<span class="quote">post-extract</span>&#8221;</span> target to achieve this.</p>
                   3999: <p>If you want to share files in this way with other
                   4000:     packages, set the <code class="varname">FILESDIR</code> variable to point
                   4001:     to the other package's <code class="filename">files</code> directory,
                   4002:     e.g.:</p>
1.91      rillig   4003: <pre class="programlisting">
1.299     rillig   4004: FILESDIR=       ../../editors/xemacs/files
1.91      rillig   4005: </pre>
                   4006: </div>
                   4007: </div>
1.148     asau     4008: <div class="chapter">
1.75      rillig   4009: <div class="titlepage"><div><div><h2 class="title">
1.299     rillig   4010: <a name="build"></a>Chapter 13. The build process</h2></div></div></div>
1.75      rillig   4011: <div class="toc">
                   4012: <p><b>Table of Contents</b></p>
1.210     leot     4013: <dl class="toc">
1.299     rillig   4014: <dt><span class="sect1"><a href="#build.intro">13.1. Introduction</a></span></dt>
                   4015: <dt><span class="sect1"><a href="#build.prefix">13.2. Program location</a></span></dt>
                   4016: <dt><span class="sect1"><a href="#build.builddirs">13.3. Directories used during the build process</a></span></dt>
                   4017: <dt><span class="sect1"><a href="#build.running">13.4. Running a phase</a></span></dt>
                   4018: <dt><span class="sect1"><a href="#build.fetch">13.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                   4019: <dd><dl>
                   4020: <dt><span class="sect2"><a href="#build.fetch.what">13.5.1. What to fetch and where to get it from</a></span></dt>
                   4021: <dt><span class="sect2"><a href="#build.fetch.how">13.5.2. How are the files fetched?</a></span></dt>
                   4022: </dl></dd>
                   4023: <dt><span class="sect1"><a href="#build.checksum">13.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                   4024: <dt><span class="sect1"><a href="#build.extract">13.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                   4025: <dt><span class="sect1"><a href="#build.patch">13.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                   4026: <dt><span class="sect1"><a href="#build.tools">13.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                   4027: <dt><span class="sect1"><a href="#build.wrapper">13.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                   4028: <dt><span class="sect1"><a href="#build.configure">13.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   4029: <dt><span class="sect1"><a href="#build.build">13.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   4030: <dt><span class="sect1"><a href="#build.test">13.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                   4031: <dt><span class="sect1"><a href="#build.install">13.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   4032: <dt><span class="sect1"><a href="#build.package">13.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
                   4033: <dt><span class="sect1"><a href="#build.clean">13.16. Cleaning up</a></span></dt>
                   4034: <dt><span class="sect1"><a href="#build.helpful-targets">13.17. Other helpful targets</a></span></dt>
1.75      rillig   4035: </dl>
                   4036: </div>
1.148     asau     4037: <div class="sect1">
1.75      rillig   4038: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4039: <a name="build.intro"></a>13.1. Introduction</h2></div></div></div>
                   4040: <p>This chapter gives a detailed description on how a package is
                   4041:     built. Building a package is separated into different
                   4042:     <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
                   4043:     <code class="varname">build</code>, <code class="varname">install</code>), all of which are
                   4044:     described in the following sections. Each phase is split into
                   4045:     so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
                   4046:     containing phase, prefixed by one of <code class="varname">pre-</code>,
                   4047:     <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
                   4048:     <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
                   4049:     of the actual work is done in the <code class="varname">do-*</code> stages.</p>
                   4050: <p>Never override the regular targets (like
                   4051:     <code class="varname">fetch</code>), if you have to, override the
                   4052:     <code class="varname">do-*</code> ones instead.</p>
                   4053: <p>The basic steps for building a program are always the same.  First
                   4054:     the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
                   4055:     the local system and then extracted. After any pkgsrc-specific patches
                   4056:     to compile properly are applied, the software can be configured, then
                   4057:     built (usually by compiling), and finally the generated binaries, etc.
                   4058:     can be put into place on the system.</p>
                   4059: <p>To get more details about what is happening at each step,
                   4060:     you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
                   4061:     <code class="varname">PATCH_DEBUG</code> variable if you are just interested
                   4062:     in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
                   4063: </div>
                   4064: <div class="sect1">
                   4065: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   4066: <a name="build.prefix"></a>13.2. Program location</h2></div></div></div>
                   4067: <p>Before outlining the process performed by the NetBSD package system in
                   4068:     the next section, here's a brief discussion on where programs are
                   4069:     installed, and which variables influence this.</p>
                   4070: <p>The automatic variable <code class="varname">PREFIX</code> indicates
                   4071:     where all files of the final program shall be installed. It is
                   4072:     usually set to <code class="varname">LOCALBASE</code>
                   4073:     (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
                   4074:     for pkgs in the <code class="filename">cross</code> category.  The value of
                   4075:     <code class="varname">PREFIX</code> needs to be put
                   4076:     into the various places in the program's source where paths to
                   4077:     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>
                   4078: <p>When choosing which of these variables to use,
                   4079:     follow the following rules:</p>
1.148     asau     4080: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.299     rillig   4081: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
                   4082:        where the current pkg will be installed.  When referring to a
                   4083:        pkg's own installation path, use
                   4084:        <span class="quote">&#8220;<span class="quote">${PREFIX}</span>&#8221;</span>.</p></li>
                   4085: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
                   4086:        are installed.  If you need to construct a -I or -L argument
                   4087:        to the compiler to find includes and libraries installed by
                   4088:        another non-X11 pkg, use <span class="quote">&#8220;<span class="quote">${LOCALBASE}</span>&#8221;</span>. The name
                   4089:        <code class="varname">LOCALBASE</code> stems from FreeBSD, which
                   4090:        installed all packages in <code class="filename">/usr/local</code>. As
                   4091:        pkgsrc leaves <code class="filename">/usr/local</code> for the system
                   4092:        administrator, this variable is a misnomer.</p></li>
                   4093: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
                   4094:        distribution (from xsrc, etc.) is installed. When looking for
                   4095:        <span class="emphasis"><em>standard</em></span> X11 includes (not those
                   4096:        installed by a package), use <span class="quote">&#8220;<span class="quote">${X11BASE}</span>&#8221;</span>.</p></li>
                   4097: <li class="listitem"><p>X11-based packages using imake must set
                   4098:        <code class="varname">USE_IMAKE</code> to be installed correctly under
                   4099:        <code class="varname">LOCALBASE</code>.</p></li>
                   4100: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.311     leot     4101:        install files according to <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/hier.7"><span class="citerefentry"><span class="refentrytitle">hier</span>(7)</span></a>, with the exception that
1.299     rillig   4102:        manual pages go into <code class="filename">${PREFIX}/man</code>, not
                   4103:        <code class="filename">${PREFIX}/share/man</code>.</p></li>
                   4104: </ul></div>
                   4105: </div>
                   4106: <div class="sect1">
                   4107: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   4108: <a name="build.builddirs"></a>13.3. Directories used during the build process</h2></div></div></div>
                   4109: <p>When building a package, various directories are used to store
                   4110:     source files, temporary files, pkgsrc-internal files, and so on. These
                   4111:     directories are explained here.</p>
                   4112: <p>Some of the directory variables contain relative pathnames. There
                   4113:     are two common base directories for these relative directories:
                   4114:     <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
                   4115:     pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
                   4116:     inside the package itself.</p>
                   4117: <div class="variablelist"><dl class="variablelist">
                   4118: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
                   4119: <dd><p>This is an absolute pathname that points to the pkgsrc
                   4120:       root directory. Generally, you don't need
                   4121:       it.</p></dd>
                   4122: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
                   4123: <dd><p>This is an absolute pathname that points to the
                   4124:       current package.</p></dd>
                   4125: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
                   4126: <dd><p>This is a pathname relative to
                   4127:       <code class="varname">PKGSRCDIR</code> that points to the current
                   4128:       package.</p></dd>
                   4129: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
                   4130: <dd><p>This is an absolute pathname pointing to the directory
                   4131:       where all work takes place. The distfiles are extracted to this
                   4132:       directory. It also contains temporary directories and log files used by
                   4133:       the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
                   4134:       the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
                   4135: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
                   4136: <dd><p>This is an absolute pathname pointing to the directory
                   4137:       where the distfiles are extracted. It is usually a direct subdirectory
                   4138:       of <code class="varname">WRKDIR</code>, and often it's the only directory entry
                   4139:       that isn't hidden. This variable may be changed by a package
                   4140:       <code class="filename">Makefile</code>.</p></dd>
                   4141: </dl></div>
                   4142: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
                   4143:     the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
                   4144:     to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
                   4145:     <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
                   4146:     If users would like to have their pkgsrc trees behave in a
                   4147:     read-only manner, then the value of
                   4148:     <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
                   4149:     <span class="emphasis"><em>no</em></span>.</p>
1.75      rillig   4150: </div>
1.148     asau     4151: <div class="sect1">
1.75      rillig   4152: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4153: <a name="build.running"></a>13.4. Running a phase</h2></div></div></div>
                   4154: <p>You can run a particular phase by typing <span class="command"><strong>make
                   4155:     phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
                   4156:     phase. This will automatically run all phases that are required for this
                   4157:     phase. The default phase is <code class="varname">build</code>, that is, when you
                   4158:     run <span class="command"><strong>make</strong></span> without parameters in a package directory,
                   4159:     the package will be built, but not installed.</p>
1.75      rillig   4160: </div>
1.148     asau     4161: <div class="sect1">
1.75      rillig   4162: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4163: <a name="build.fetch"></a>13.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
                   4164: <p>The first step in building a package is to fetch the
                   4165:     distribution files (distfiles) from the sites that are providing
                   4166:     them. This is the task of the <span class="emphasis"><em>fetch</em></span>
                   4167:     phase.</p>
1.148     asau     4168: <div class="sect2">
1.93      rillig   4169: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   4170: <a name="build.fetch.what"></a>13.5.1. What to fetch and where to get it from</h3></div></div></div>
                   4171: <p>In simple cases, <code class="varname">MASTER_SITES</code>
                   4172:       defines all URLs from where the distfile, whose name is
                   4173:       derived from the <code class="varname">DISTNAME</code> variable, is
                   4174:       fetched. The more complicated cases are described
                   4175:       below.</p>
                   4176: <p>The variable <code class="varname">DISTFILES</code> specifies
                   4177:       the list of distfiles that have to be fetched. Its value
                   4178:       defaults to <code class="literal">${DEFAULT_DISTFILES}</code> and
                   4179:       its value is <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
                   4180:       so that most packages don't need to define it at all.
                   4181:       <code class="varname">EXTRACT_SUFX</code> is
                   4182:       <code class="literal">.tar.gz</code> by default, but can be changed
                   4183:       freely. Note that if your package requires additional
                   4184:       distfiles to the default one, you cannot just append the
                   4185:       additional filenames using the <code class="literal">+=</code>
                   4186:       operator, but you have write for example:</p>
                   4187: <pre class="programlisting">
                   4188: DISTFILES=      ${DEFAULT_DISTFILES} additional-files.tar.gz
                   4189: </pre>
                   4190: <p>Each distfile is fetched from a list of sites, usually
                   4191:       <code class="varname">MASTER_SITES</code>. If the package has multiple
                   4192:       <code class="varname">DISTFILES</code> or multiple
                   4193:       <code class="varname">PATCHFILES</code> from different sites, you can
                   4194:       set
                   4195:       <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
                   4196:       to the list of URLs where the file
                   4197:       <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
                   4198:       (including the suffix) can be found.</p>
                   4199: <pre class="programlisting">
                   4200: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX}
                   4201: DISTFILES+=     foo-file.tar.gz
                   4202: SITES.foo-file.tar.gz= \
                   4203: https://www.somewhere.com/somehow/ \
                   4204: https://www.somewhereelse.com/mirror/somehow/
                   4205: </pre>
                   4206: <p>When actually fetching the distfiles, each item from
                   4207:       <code class="varname">MASTER_SITES</code> or
                   4208:       <code class="varname">SITES.*</code> gets the name of each distfile
                   4209:       appended to it, without an intermediate slash. Therefore,
                   4210:       all site values have to end with a slash or other separator
                   4211:       character. This allows for example to set
                   4212:       <code class="varname">MASTER_SITES</code> to a URL of a CGI script
                   4213:       that gets the name of the distfile as a parameter. In this
                   4214:       case, the definition would look like:</p>
                   4215: <pre class="programlisting">
                   4216: MASTER_SITES=   https://www.example.com/download.cgi?file=
                   4217: </pre>
                   4218: <p> The exception to this rule are URLs starting with a dash.
                   4219:       In that case the URL is taken as is, fetched and the result
                   4220:       stored under the name of the distfile. You can use this style
                   4221:       for the case when the download URL style does not match the
                   4222:       above common case. For example, if permanent download URL is a
                   4223:       redirector to the real download URL, or the download file name
                   4224:       is offered by an HTTP Content-Disposition header. In the
                   4225:       following example, <code class="filename">foo-1.0.0.tar.gz</code> will be
                   4226:       created instead of the default
                   4227:       <code class="filename">v1.0.0.tar.gz</code>.</p>
                   4228: <pre class="programlisting">
                   4229: DISTNAME=       foo-1.0.0
                   4230: MASTER_SITES=   -https://www.example.com/archive/v1.0.0.tar.gz
                   4231: </pre>
                   4232: <p>There are some predefined values for
                   4233:       <code class="varname">MASTER_SITES</code>, which can be used in
                   4234:       packages.  The names of the variables should speak for
                   4235:       themselves.</p>
                   4236: <table border="0" summary="Simple list" class="simplelist">
                   4237: <tr>
                   4238: <td>MASTER_SITE_APACHE</td>
                   4239: <td>MASTER_SITE_BACKUP</td>
                   4240: </tr>
                   4241: <tr>
                   4242: <td>MASTER_SITE_CRATESIO</td>
                   4243: <td>MASTER_SITE_CYGWIN</td>
                   4244: </tr>
                   4245: <tr>
                   4246: <td>MASTER_SITE_DEBIAN</td>
                   4247: <td>MASTER_SITE_FREEBSD</td>
                   4248: </tr>
                   4249: <tr>
                   4250: <td>MASTER_SITE_FREEBSD_LOCAL</td>
                   4251: <td>MASTER_SITE_GENTOO</td>
                   4252: </tr>
                   4253: <tr>
                   4254: <td>MASTER_SITE_GITHUB</td>
                   4255: <td>MASTER_SITE_GNOME</td>
                   4256: </tr>
                   4257: <tr>
                   4258: <td>MASTER_SITE_GNU</td>
                   4259: <td>MASTER_SITE_GNUSTEP</td>
                   4260: </tr>
                   4261: <tr>
                   4262: <td>MASTER_SITE_HASKELL_HACKAGE</td>
                   4263: <td>MASTER_SITE_IFARCHIVE</td>
                   4264: </tr>
                   4265: <tr>
                   4266: <td>MASTER_SITE_KDE</td>
                   4267: <td>MASTER_SITE_MOZILLA</td>
                   4268: </tr>
                   4269: <tr>
                   4270: <td>MASTER_SITE_MOZILLA_ALL</td>
                   4271: <td>MASTER_SITE_MYSQL</td>
                   4272: </tr>
                   4273: <tr>
                   4274: <td>MASTER_SITE_NETLIB</td>
                   4275: <td>MASTER_SITE_OPENBSD</td>
                   4276: </tr>
                   4277: <tr>
                   4278: <td>MASTER_SITE_OPENOFFICE</td>
                   4279: <td>MASTER_SITE_OSDN</td>
                   4280: </tr>
                   4281: <tr>
                   4282: <td>MASTER_SITE_PERL_CPAN</td>
                   4283: <td>MASTER_SITE_PGSQL</td>
                   4284: </tr>
                   4285: <tr>
                   4286: <td>MASTER_SITE_PYPI</td>
                   4287: <td>MASTER_SITE_RUBYGEMS</td>
                   4288: </tr>
                   4289: <tr>
                   4290: <td>MASTER_SITE_R_CRAN</td>
                   4291: <td>MASTER_SITE_SOURCEFORGE</td>
                   4292: </tr>
1.85      jmmv     4293: <tr>
1.299     rillig   4294: <td>MASTER_SITE_SUNSITE</td>
                   4295: <td>MASTER_SITE_SUSE</td>
1.85      jmmv     4296: </tr>
                   4297: <tr>
1.299     rillig   4298: <td>MASTER_SITE_TEX_CTAN</td>
                   4299: <td>MASTER_SITE_XCONTRIB</td>
1.85      jmmv     4300: </tr>
                   4301: <tr>
1.299     rillig   4302: <td>MASTER_SITE_XEMACS</td>
                   4303: <td>MASTER_SITE_XORG</td>
                   4304: </tr>
                   4305: </table>
                   4306: <p>Some explanations for the less self-explaining ones:
                   4307:       <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
                   4308:       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
                   4309:       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>
                   4310: <p>If you choose one of these predefined sites, you may
                   4311:       want to specify a subdirectory of that site. Since these
                   4312:       macros may expand to more than one actual site, you
                   4313:       <span class="emphasis"><em>must</em></span> use the following construct to
                   4314:       specify a subdirectory:</p>
1.100     rillig   4315: <pre class="programlisting">
1.299     rillig   4316: MASTER_SITES=   ${MASTER_SITE_GNU:=subdirectory/name/}
                   4317: MASTER_SITES=   ${MASTER_SITE_SOURCEFORGE:=project_name/}
1.100     rillig   4318: </pre>
1.299     rillig   4319: <p>Note the trailing slash after the subdirectory
                   4320:       name.</p>
                   4321: </div>
                   4322: <div class="sect2">
                   4323: <div class="titlepage"><div><div><h3 class="title">
                   4324: <a name="build.fetch.how"></a>13.5.2. How are the files fetched?</h3></div></div></div>
                   4325: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
                   4326:       all the distfiles exist in a local directory
                   4327:       (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
                   4328:       user). If the files do not exist, they are fetched using
                   4329:       commands of the form</p>
1.100     rillig   4330: <pre class="programlisting">
1.299     rillig   4331: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
                   4332: </pre>
                   4333: <p>where <code class="literal">${site}</code> varies through
                   4334:       several possibilities in turn: first,
                   4335:       <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
                   4336:       sites specified in either <code class="varname">SITES.file</code> if
                   4337:       defined, else <code class="varname">MASTER_SITES</code> or
                   4338:       <code class="varname">PATCH_SITES</code>, as applies, then finally the
                   4339:       value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
                   4340:       all except the first and the last can be optionally sorted
                   4341:       by the user, via setting either
                   4342:       <code class="varname">MASTER_SORT_RANDOM</code>, and
                   4343:       <code class="varname">MASTER_SORT_AWK</code> or
                   4344:       <code class="varname">MASTER_SORT_REGEX</code>.</p>
                   4345: <p> The specific command and arguments used depend on the
                   4346:       <code class="varname">FETCH_USING</code> parameter. The example above is
                   4347:       for <code class="literal">FETCH_USING=custom</code>.</p>
                   4348: <p>The distfiles mirror run by the NetBSD Foundation uses the
                   4349:       <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
                   4350:       distfiles, if they are freely distributable.  Packages setting
                   4351:       <code class="varname">NO_SRC_ON_FTP</code> (usually to
                   4352:       <span class="quote">&#8220;<span class="quote">${RESTRICTED}</span>&#8221;</span>) will not have their distfiles
                   4353:       mirrored.</p>
1.85      jmmv     4354: </div>
                   4355: </div>
1.299     rillig   4356: <div class="sect1">
                   4357: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   4358: <a name="build.checksum"></a>13.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
                   4359: <p>After the distfile(s) are fetched, their checksum is
                   4360:     generated and compared with the checksums stored in the
                   4361:     distinfo file. If the checksums don't match, the build is
                   4362:     aborted. This is to ensure the same distfile is used for
                   4363:     building, and that the distfile wasn't changed, e.g. by some
                   4364:     malign force, deliberately changed distfiles on the master
                   4365:     distribution site or network lossage.</p>
1.75      rillig   4366: </div>
1.148     asau     4367: <div class="sect1">
1.75      rillig   4368: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4369: <a name="build.extract"></a>13.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
                   4370: <p>When the distfiles are present on the local system, they
                   4371:     need to be extracted, as they usually come in the form of some
                   4372:     compressed archive format.</p>
                   4373: <p>By default, all <code class="varname">DISTFILES</code> are
                   4374:     extracted. If you only need some of them, you can set the
                   4375:     <code class="varname">EXTRACT_ONLY</code> variable to the list of those
                   4376:     files.</p>
                   4377: <p>Extracting the files is usually done by a little
                   4378:     program, <code class="filename">mk/extract/extract</code>, which
                   4379:     already knows how to extract various archive formats, so most
                   4380:     likely you will not need to change anything here. But if you
                   4381:     need, the following variables may help you:</p>
1.148     asau     4382: <div class="variablelist"><dl class="variablelist">
1.299     rillig   4383: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
                   4384: <dd><p>Use these variables to override the default
                   4385:       options for an extract command, which are defined in
                   4386:       <code class="filename">mk/extract/extract</code>.</p></dd>
                   4387: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
                   4388: <dd><p>This variable can be set to
                   4389:       <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
                   4390:       (which is the default value), <code class="literal">pax</code>, or an
                   4391:       absolute pathname pointing to the command with which tar
                   4392:       archives should be extracted.  It is preferred to choose bsdtar over gtar
                   4393:       if NetBSD's pax-as-tar is not good enough.</p></dd>
1.75      rillig   4394: </dl></div>
1.299     rillig   4395: <p>If the <code class="filename">extract</code> program doesn't
                   4396:     serve your needs, you can also override the
                   4397:     <code class="varname">EXTRACT_CMD</code> variable, which holds the
                   4398:     command used for extracting the files. This command is
                   4399:     executed in the <code class="filename">${WRKSRC}</code>
                   4400:     directory. During execution of this command, the shell
                   4401:     variable <code class="varname">extract_file</code> holds the absolute
                   4402:     pathname of the file that is going to be extracted.</p>
                   4403: <p>And if that still does not suffice, you can override the
                   4404:     <code class="varname">do-extract</code> target in the package
                   4405:     Makefile.</p>
1.75      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.patch"></a>13.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
                   4410: <p>After extraction, all the patches named by the
                   4411:     <code class="varname">PATCHFILES</code>, those present in the patches
                   4412:     subdirectory of the package as well as in
                   4413:     $LOCALPATCHES/$PKGPATH (e.g.
                   4414:     <code class="filename">/usr/local/patches/graphics/png</code>) are
                   4415:     applied.  Patchfiles ending in <code class="filename">.Z</code> or
                   4416:     <code class="filename">.gz</code> are uncompressed before they are
                   4417:     applied, files ending in <code class="filename">.orig</code> or
                   4418:     <code class="filename">.rej</code> are ignored. Any special options to
1.311     leot     4419:     <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/patch.1"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> can be handed in
1.299     rillig   4420:     <code class="varname">PATCH_DIST_ARGS</code>.  See <a class="xref" href="#components.patches" title="12.3. patches/*">Section 12.3, &#8220;<code class="filename">patches/*</code>&#8221;</a> for more details.</p>
1.311     leot     4421: <p>By default <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/patch.1"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> is given special arguments to make it
1.299     rillig   4422:     fail if the expected text from the patch context is not found in the
                   4423:     patched file. If that happens, fix the patch file by comparing it
                   4424:     with the actual text in the file to be patched.</p>
1.78      rillig   4425: </div>
1.148     asau     4426: <div class="sect1">
1.75      rillig   4427: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4428: <a name="build.tools"></a>13.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
                   4429: <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>.
                   4430:     </p>
1.75      rillig   4431: </div>
1.148     asau     4432: <div class="sect1">
1.75      rillig   4433: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4434: <a name="build.wrapper"></a>13.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
                   4435: <p>This phase creates wrapper programs for the compilers and
                   4436:     linkers. The following variables can be used to tweak the
                   4437:     wrappers.</p>
                   4438: <div class="variablelist"><dl class="variablelist">
                   4439: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
                   4440: <dd><p>The command used to print progress
                   4441:       messages. Does nothing by default. Set to
                   4442:       <code class="literal">${ECHO}</code> to see the progress
                   4443:       messages.</p></dd>
                   4444: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
                   4445: <dd><p>This variable can be set to
                   4446:       <code class="literal">yes</code> (default) or <code class="literal">no</code>,
                   4447:       depending on whether you want additional information in the
                   4448:       wrapper log file.</p></dd>
                   4449: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
                   4450: <dd><p>This variable can be set to
                   4451:       <code class="literal">yes</code> or <code class="literal">no</code>, depending
                   4452:       on whether the wrapper should use its cache, which will
                   4453:       improve the speed. The default value is
                   4454:       <code class="literal">yes</code>, but is forced to
                   4455:       <code class="literal">no</code> if the platform does not support
                   4456:       it.</p></dd>
                   4457: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
                   4458: <dd><p>A list of reordering commands. A reordering
                   4459:       command has the form
                   4460:       <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
                   4461:       It ensures that that
                   4462:       <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
                   4463:       before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
                   4464:       </p></dd>
                   4465: </dl></div>
                   4466: </div>
                   4467: <div class="sect1">
                   4468: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   4469: <a name="build.configure"></a>13.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
                   4470: <p>Most pieces of software need information on the header
                   4471:     files, system calls, and library routines which are available
                   4472:     on the platform they run on. The process of determining this
                   4473:     information is known as configuration, and is usually
                   4474:     automated. In most cases, a script is supplied with the
                   4475:     distfiles, and its invocation results in generation of header
                   4476:     files, Makefiles, etc.</p>
                   4477: <p>If the package contains a configure script, this can be
                   4478:     invoked by setting <code class="varname">HAS_CONFIGURE</code> to
                   4479:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. If the configure script is a GNU autoconf
                   4480:     script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.301     rillig   4481:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> instead.</p>
                   4482: <p>In the <code class="literal">do-configure</code> stage, a rough
                   4483:     equivalent of the following command is run. See
                   4484:     <code class="filename">mk/configure/configure.mk</code>, target
                   4485:     <code class="literal">do-configure-script</code> for the exact
                   4486:     definition.</p>
                   4487: <pre class="programlisting">
                   4488: .for dir in ${CONFIGURE_DIRS}
                   4489:         cd ${WRKSRC} &amp;&amp; cd ${dir} \
                   4490:         &amp;&amp; env ${CONFIGURE_ENV} \
                   4491:             ${CONFIG_SHELL} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
1.299     rillig   4492: .endfor
1.100     rillig   4493: </pre>
1.299     rillig   4494: <p><code class="varname">CONFIGURE_DIRS</code> (default:
                   4495:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span>) is a list of pathnames relative to
                   4496:     <code class="varname">WRKSRC</code>. In each of these directories, the
                   4497:     configure script is run with the environment
                   4498:     <code class="varname">CONFIGURE_ENV</code> and arguments
                   4499:     <code class="varname">CONFIGURE_ARGS</code>. The variables
                   4500:     <code class="varname">CONFIGURE_ENV</code>,
                   4501:     <code class="varname">CONFIGURE_SCRIPT</code> (default:
                   4502:     <span class="quote">&#8220;<span class="quote">./configure</span>&#8221;</span>) and
                   4503:     <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
                   4504:     package.</p>
                   4505: <p>If the program uses the Perl way of configuration (mainly Perl
                   4506:     modules, but not only), i.e. a file called
                   4507:     <code class="filename">Makefile.PL</code>, it should include
                   4508:     <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
                   4509:     <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
                   4510:     variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
                   4511: <p>If the program uses an <code class="filename">Imakefile</code>
                   4512:     for configuration, the appropriate steps can be invoked by
                   4513:     setting <code class="varname">USE_IMAKE</code> to
                   4514:     <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>.
                   4515:     You can add variables to xmkmf's environment by adding them to the
                   4516:     <code class="varname">SCRIPTS_ENV</code> variable.</p>
                   4517: <p>If the program uses <code class="filename">cmake</code>
                   4518:     for configuration, the appropriate steps can be invoked by
                   4519:     setting <code class="varname">USE_CMAKE</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.
                   4520:     You can add variables to cmake's environment by adding them to the
                   4521:     <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
                   4522:     by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
                   4523:     The top directory argument is given by the
                   4524:     <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
                   4525:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span> (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
                   4526: <p>If there is no configure step at all, set
                   4527:     <code class="varname">NO_CONFIGURE</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.</p>
1.75      rillig   4528: </div>
1.148     asau     4529: <div class="sect1">
1.75      rillig   4530: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4531: <a name="build.build"></a>13.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.301     rillig   4532: <p>For building a package, a rough equivalent of the following
                   4533:     code is executed; see <code class="filename">mk/build/build.mk</code>, target
                   4534:     <code class="literal">do-build</code> for the exact definition.</p>
1.97      rillig   4535: <pre class="programlisting">
1.301     rillig   4536: .for dir in ${BUILD_DIRS}
                   4537:         cd ${WRKSRC} &amp;&amp; cd ${dir} \
1.299     rillig   4538:         &amp;&amp; env ${MAKE_ENV} \
1.301     rillig   4539:             ${MAKE_PROGRAM} ${MAKE_FLAGS} ${BUILD_MAKE_FLAGS} \
1.299     rillig   4540:                 -f ${MAKE_FILE} \
                   4541:                 ${BUILD_TARGET}
                   4542: .endfor
1.97      rillig   4543: </pre>
1.299     rillig   4544: <p><code class="varname">BUILD_DIRS</code> (default:
                   4545:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span>) is a list of pathnames relative to
                   4546:     <code class="varname">WRKSRC</code>. In each of these directories,
                   4547:     <code class="varname">MAKE_PROGRAM</code> is run with the environment
                   4548:     <code class="varname">MAKE_ENV</code> and arguments
                   4549:     <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
                   4550:     <code class="varname">MAKE_ENV</code>,
                   4551:     <code class="varname">BUILD_MAKE_FLAGS</code>,
                   4552:     <code class="varname">MAKE_FILE</code> and
                   4553:     <code class="varname">BUILD_TARGET</code> may all be changed by the
                   4554:     package.</p>
                   4555: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
                   4556:     <span class="quote">&#8220;<span class="quote">gmake</span>&#8221;</span> if <code class="varname">USE_TOOLS</code> contains
                   4557:     <span class="quote">&#8220;<span class="quote">gmake</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">make</span>&#8221;</span> otherwise. The
                   4558:     default value of <code class="varname">MAKE_FILE</code> is
                   4559:     <span class="quote">&#8220;<span class="quote">Makefile</span>&#8221;</span>, and <code class="varname">BUILD_TARGET</code>
                   4560:     defaults to <span class="quote">&#8220;<span class="quote">all</span>&#8221;</span>.</p>
                   4561: <p>If there is no build step at all, set
                   4562:     <code class="varname">NO_BUILD</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.</p>
1.97      rillig   4563: </div>
1.148     asau     4564: <div class="sect1">
1.97      rillig   4565: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4566: <a name="build.test"></a>13.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
                   4567: <p>[TODO]</p>
1.75      rillig   4568: </div>
1.148     asau     4569: <div class="sect1">
1.75      rillig   4570: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4571: <a name="build.install"></a>13.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
                   4572: <p>Once the build stage has completed, the final step is to
                   4573:     install the software in public directories, so users can
                   4574:     access the programs and files.</p>
1.301     rillig   4575: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough equivalent
                   4576:     of the following code is executed; see
                   4577:     <code class="filename">mk/install/install.mk</code>, target
                   4578:     <code class="literal">do-install</code> for the exact definition. Additionally,
                   4579:     before and after this code, several consistency checks are run
                   4580:     against the files-to-be-installed, see
                   4581:     <code class="filename">mk/check/*.mk</code> for details.</p>
                   4582: <pre class="programlisting">
                   4583: .for dir in ${INSTALL_DIRS}
                   4584:         cd ${WRKSRC} &amp;&amp; cd ${dir} \
                   4585:         &amp;&amp; env ${INSTALL_ENV} ${MAKE_ENV} \
                   4586:             ${MAKE_PROGRAM} ${MAKE_FLAGS} ${INSTALL_MAKE_FLAGS} \
                   4587:                 -f ${MAKE_FILE} ${INSTALL_TARGET}
1.299     rillig   4588: .endfor
1.220     wiz      4589: </pre>
1.299     rillig   4590: <p>The variable's meanings are analogous to the ones in the
                   4591:     <span class="emphasis"><em>build</em></span> phase.
                   4592:     <code class="varname">INSTALL_DIRS</code> defaults to
                   4593:     <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
                   4594:     is <span class="quote">&#8220;<span class="quote">install</span>&#8221;</span> by default, plus
                   4595:     <span class="quote">&#8220;<span class="quote">install.man</span>&#8221;</span> if <code class="varname">USE_IMAKE</code> is
                   4596:     defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
                   4597:     defined.</p>
                   4598: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
                   4599:     variables are useful. They are all variations of the
1.311     leot     4600:     <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/install.1"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a> command that have the owner, group and
1.299     rillig   4601:     permissions preset. <code class="varname">INSTALL</code> is the plain
                   4602:     install command. The specialized variants, together with their
                   4603:     intended use, are:</p>
                   4604: <div class="variablelist"><dl class="variablelist">
                   4605: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
                   4606: <dd><p>directories that contain
                   4607:       binaries</p></dd>
                   4608: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
                   4609: <dd><p>directories that contain
                   4610:       scripts</p></dd>
                   4611: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
                   4612: <dd><p>directories that contain shared and static
                   4613:       libraries</p></dd>
                   4614: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
                   4615: <dd><p>directories that contain data
                   4616:       files</p></dd>
                   4617: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
                   4618: <dd><p>directories that contain man
                   4619:       pages</p></dd>
                   4620: <dt><span class="term"><code class="varname">INSTALL_GAME_DIR</code></span></dt>
                   4621: <dd><p>directories that contain data files for games
                   4622:       </p></dd>
                   4623: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
                   4624: <dd><p>binaries that can be stripped from debugging
                   4625:       symbols</p></dd>
                   4626: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
                   4627: <dd><p>binaries that cannot be
                   4628:       stripped</p></dd>
                   4629: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
                   4630: <dd><p>game
                   4631:       binaries</p></dd>
                   4632: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
                   4633: <dd><p>shared and static
                   4634:       libraries</p></dd>
                   4635: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
                   4636: <dd><p>data files</p></dd>
                   4637: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
                   4638: <dd><p>data files for
                   4639:       games</p></dd>
                   4640: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
                   4641: <dd><p>man pages</p></dd>
                   4642: </dl></div>
                   4643: <p>Some other variables are:</p>
                   4644: <div class="variablelist"><dl class="variablelist">
                   4645: <dt><span class="term"><code class="varname">INSTALL_UNSTRIPPED</code></span></dt>
1.311     leot     4646: <dd><p>If set to <code class="literal">yes</code>, do not run <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/strip.1"><span class="citerefentry"><span class="refentrytitle">strip</span>(1)</span></a>
1.299     rillig   4647:       when installing binaries. Any debugging sections and symbols present in
                   4648:       binaries will be preserved.
                   4649:       </p></dd>
                   4650: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
                   4651: <dd><p>A list of directories relative to
                   4652:       <code class="varname">PREFIX</code> that are created by pkgsrc at the
                   4653:       beginning of the <span class="emphasis"><em>install</em></span> phase.
                   4654:       The package is supposed to create all needed directories itself
                   4655:       before installing files to it and list all other directories here.
                   4656:       </p></dd>
                   4657: </dl></div>
                   4658: <p>In the rare cases that a package shouldn't install anything,
                   4659:     set <code class="varname">NO_INSTALL</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. This is
                   4660:     mostly relevant for packages in the <code class="filename">regress</code>
                   4661:     category.</p>
1.75      rillig   4662: </div>
1.148     asau     4663: <div class="sect1">
1.75      rillig   4664: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4665: <a name="build.package"></a>13.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
                   4666: <p>Once the install stage has completed, a binary package of
                   4667:     the installed files can be built.  These binary packages can be
                   4668:     used for quick installation without previous compilation, e.g. by
                   4669:     the <span class="command"><strong>make bin-install</strong></span> or by using
                   4670:     <span class="command"><strong>pkg_add</strong></span>.</p>
                   4671: <p>By default, the binary packages are created in
                   4672:     <code class="filename">${PACKAGES}/All</code> and symlinks are created in
                   4673:     <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
                   4674:     one for each category in the <code class="varname">CATEGORIES</code>
                   4675:     variable.  <code class="varname">PACKAGES</code> defaults to
                   4676:     <code class="filename">pkgsrc/packages</code>.</p>
1.75      rillig   4677: </div>
1.148     asau     4678: <div class="sect1">
1.75      rillig   4679: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4680: <a name="build.clean"></a>13.16. Cleaning up</h2></div></div></div>
                   4681: <p>Once you're finished with a package, you can clean the work
                   4682:     directory by running <span class="command"><strong>make clean</strong></span>.  If you want
                   4683:     to clean the work directories of all dependencies too, use
                   4684:     <span class="command"><strong>make clean-depends</strong></span>.</p>
1.75      rillig   4685: </div>
1.148     asau     4686: <div class="sect1">
1.75      rillig   4687: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   4688: <a name="build.helpful-targets"></a>13.17. Other helpful targets</h2></div></div></div>
1.148     asau     4689: <div class="variablelist"><dl class="variablelist">
1.299     rillig   4690: <dt><span class="term">pre/post-*</span></dt>
                   4691: <dd>
                   4692: <p>For any of the main targets described in the previous
                   4693:          section (configure, build, install, etc.), two auxiliary
                   4694:          targets exist with
                   4695:          <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
                   4696:          prefix for the main target's name.  These targets are
                   4697:          invoked before and after the main target is called,
                   4698:          allowing extra configuration or installation steps be
                   4699:          performed from a package's Makefile, for example, which
                   4700:          a program's configure script or install target
                   4701:          omitted.</p>
                   4702: <p>About 5% of the pkgsrc packages define their custom
                   4703:          post-extract target, another 5% define pre-configure, and 10%
                   4704:          define post-install. The other pre/post-* targets are defined
                   4705:          even less often.</p>
                   4706: </dd>
                   4707: <dt><span class="term">do-*</span></dt>
1.75      rillig   4708: <dd>
1.299     rillig   4709: <p>Should one of the main targets do the wrong thing,
                   4710:          and should there be no variable to fix this, you can
                   4711:          redefine it with the do-* target.  (Note that redefining
                   4712:          the target itself instead of the do-* target is a bad
                   4713:          idea, as the pre-* and post-* targets won't be called
                   4714:          anymore, etc.)</p>
                   4715: <p>About 15% of the pkgsrc packages override the default
                   4716:          do-install, the other do-* targets are overridden even less
                   4717:          often.</p>
1.75      rillig   4718: </dd>
1.299     rillig   4719: <dt><span class="term">reinstall</span></dt>
1.75      rillig   4720: <dd>
1.299     rillig   4721: <p>If you did a <span class="command"><strong>make install</strong></span> and
                   4722:          you noticed some file was not installed properly, you
                   4723:          can repeat the installation with this target, which will
                   4724:          ignore the <span class="quote">&#8220;<span class="quote">already installed</span>&#8221;</span> flag.</p>
                   4725: <p>This is the default value of
                   4726:          <code class="varname">DEPENDS_TARGET</code> except in the case of
                   4727:          <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
                   4728:          package</strong></span>, where the defaults are
                   4729:          <span class="quote">&#8220;<span class="quote">package</span>&#8221;</span> and <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span>,
                   4730:          respectively.</p>
1.75      rillig   4731: </dd>
1.299     rillig   4732: <dt><span class="term">deinstall</span></dt>
                   4733: <dd>
1.311     leot     4734: <p>This target does a <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> in the
1.299     rillig   4735:          current directory, effectively de-installing the
                   4736:          package. The following variables can be used to tune the
                   4737:          behaviour:</p>
                   4738: <div class="variablelist"><dl class="variablelist">
                   4739: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.311     leot     4740: <dd><p>Add a "-v" to the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> command.</p></dd>
1.299     rillig   4741: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
                   4742: <dd><p>Remove all packages that require (depend on)
                   4743:                the given package.  This can be used to remove any
                   4744:                packages that may have been pulled in by a given
                   4745:                package, e.g. if <span class="command"><strong>make deinstall
                   4746:                DEINSTALLDEPENDS=1</strong></span> is done in
                   4747:                <code class="filename">pkgsrc/x11/kde</code>, this is
                   4748:                likely to remove whole KDE. Works by adding
1.311     leot     4749:                <span class="quote">&#8220;<span class="quote">-R</span>&#8221;</span> to the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
1.299     rillig   4750:                command line.</p></dd>
                   4751: </dl></div>
                   4752: </dd>
                   4753: <dt><span class="term">bin-install</span></dt>
                   4754: <dd><p>Install a binary package from local disk and via FTP
                   4755:          from a list of sites (see the
                   4756:          <code class="varname">BINPKG_SITES</code> variable), and do a
                   4757:          <span class="command"><strong>make package</strong></span> if no binary package is
                   4758:          available anywhere.  The arguments given to
                   4759:          <span class="command"><strong>pkg_add</strong></span> can be set via
                   4760:          <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
                   4761:          operation, etc.</p></dd>
                   4762: <dt><span class="term">install-clean</span></dt>
                   4763: <dd><p>This target removes the state files for the "install" and later
                   4764:          phases so that the "install" target may be re-invoked. This can be
                   4765:          used after editing the PLIST to install the package without
                   4766:          rebuilding it.</p></dd>
                   4767: <dt><span class="term">build-clean</span></dt>
                   4768: <dd><p>This target removes the state files for the "build" and later
                   4769:          phases so that the "build" target may be re-invoked.</p></dd>
                   4770: <dt><span class="term">update</span></dt>
                   4771: <dd>
                   4772: <p>This target causes the current package to be
                   4773:          updated to the latest version.  The package and all
                   4774:          depending packages first get de-installed, then current
                   4775:          versions of the corresponding packages get compiled and
                   4776:          installed.  This is similar to manually noting which
                   4777:          packages are currently installed, then performing a
                   4778:          series of <span class="command"><strong>make deinstall</strong></span> and
                   4779:          <span class="command"><strong>make install</strong></span> (or whatever
                   4780:          <code class="varname">UPDATE_TARGET</code> is set to) for these
                   4781:          packages.</p>
                   4782: <p>You can use the <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> target to
                   4783:          resume package updating in case a previous <span class="command"><strong>make
                   4784:          update</strong></span> was interrupted for some reason.
                   4785:          However, in this case, make sure you don't call
                   4786:          <span class="command"><strong>make clean</strong></span> or otherwise remove the
                   4787:          list of dependent packages in <code class="varname">WRKDIR</code>.
                   4788:          Otherwise, you lose the ability to automatically update
                   4789:          the current package along with the dependent packages
                   4790:          you have installed.</p>
                   4791: <p>Resuming an interrupted <span class="command"><strong>make
                   4792:          update</strong></span> will only work as long as the package
                   4793:          tree remains unchanged.  If the source code for one of
                   4794:          the packages to be updated has been changed, resuming
                   4795:          <span class="command"><strong>make update</strong></span> will most certainly
                   4796:          fail!</p>
                   4797: <p>The following variables can be used either on the
                   4798:          command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
                   4799:          alter the behaviour of <span class="command"><strong>make
                   4800:          update</strong></span>:</p>
                   4801: <div class="variablelist"><dl class="variablelist">
                   4802: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
                   4803: <dd><p>Install target to recursively use for the
                   4804:                updated package and the dependent packages.
                   4805:                Defaults to <code class="varname">DEPENDS_TARGET</code> if
                   4806:                set, <span class="quote">&#8220;<span class="quote">install</span>&#8221;</span> otherwise for
                   4807:                <span class="command"><strong>make update</strong></span>.  Other good
                   4808:                targets are <span class="quote">&#8220;<span class="quote">package</span>&#8221;</span> or
                   4809:                <span class="quote">&#8220;<span class="quote">bin-install</span>&#8221;</span>.  Do not set this to
                   4810:                <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> or you will get stuck in an
                   4811:                endless loop!</p></dd>
                   4812: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
                   4813: <dd><p>Don't clean up after updating.  Useful if
                   4814:                you want to leave the work sources of the updated
                   4815:                packages around for inspection or other purposes.
                   4816:                Be sure you eventually clean up the source tree
                   4817:                (see the <span class="quote">&#8220;<span class="quote">clean-update</span>&#8221;</span> target below)
                   4818:                or you may run into troubles with old source code
                   4819:                still lying around on your next
                   4820:                <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
                   4821:                update</strong></span>.</p></dd>
                   4822: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
                   4823: <dd><p>Deinstall each package before installing
                   4824:                (making <code class="varname">DEPENDS_TARGET</code>). This
                   4825:                may be necessary if the
                   4826:                <span class="quote">&#8220;<span class="quote">clean-update</span>&#8221;</span> target (see below) was
                   4827:                called after interrupting a running <span class="command"><strong>make
                   4828:                update</strong></span>.</p></dd>
                   4829: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
                   4830: <dd><p>Allows you to disable recursion and hardcode
                   4831:                the target for packages.  The default is
                   4832:                <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> for the update target,
                   4833:                facilitating a recursive update of prerequisite
                   4834:                packages.  Only set
                   4835:                <code class="varname">DEPENDS_TARGET</code> if you want to
                   4836:                disable recursive updates. Use
                   4837:                <code class="varname">UPDATE_TARGET</code> instead to just
                   4838:                set a specific target for each package to be
                   4839:                installed during <span class="command"><strong>make update</strong></span>
                   4840:                (see above).</p></dd>
                   4841: </dl></div>
                   4842: </dd>
                   4843: <dt><span class="term">clean-update</span></dt>
                   4844: <dd>
                   4845: <p>Clean the source tree for all packages that would
                   4846:          get updated if <span class="command"><strong>make update</strong></span> was called
                   4847:          from the current directory.  This target should not be
                   4848:          used if the current package (or any of its depending
                   4849:          packages) have already been de-installed (e.g., after
                   4850:          calling <span class="command"><strong>make update</strong></span>) or you may lose
                   4851:          some packages you intended to update. As a rule of
                   4852:          thumb: only use this target <span class="emphasis"><em>before</em></span>
                   4853:          the first time you run <span class="command"><strong>make update</strong></span>
                   4854:          and only if you have a dirty package tree (e.g., if you
                   4855:          used <code class="varname">NOCLEAN</code>).</p>
                   4856: <p>If you are unsure about whether your tree is
                   4857:          clean, you can either perform a <span class="command"><strong>make
                   4858:          clean</strong></span> at the top of the tree, or use the
                   4859:          following sequence of commands from the directory of the
                   4860:          package you want to update (<span class="emphasis"><em>before</em></span>
                   4861:          running <span class="command"><strong>make update</strong></span> for the first
                   4862:          time, otherwise you lose all the packages you wanted to
                   4863:          update!):</p>
                   4864: <pre class="screen">
                   4865: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
                   4866: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
                   4867: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
                   4868:          </pre>
                   4869: <p>The following variables can be used either on the
                   4870:          command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
                   4871:          <span class="command"><strong>make clean-update</strong></span>:</p>
                   4872: <div class="variablelist"><dl class="variablelist">
                   4873: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
                   4874: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
                   4875:                reconstruct the list of directories to update for
                   4876:                this package.  Only use this if <span class="command"><strong>make
                   4877:                update</strong></span> successfully installed all
                   4878:                packages you wanted to update.  Normally, this is
                   4879:                done automatically on <span class="command"><strong>make
                   4880:                update</strong></span>, but may have been suppressed by
                   4881:                the <code class="varname">NOCLEAN</code> variable (see
                   4882:                above).</p></dd>
                   4883: </dl></div>
                   4884: </dd>
                   4885: <dt><span class="term">replace</span></dt>
                   4886: <dd>
                   4887: <p>Update the installation of the current package.  This
                   4888:          differs from update in that it does not replace dependent
                   4889:          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
                   4890:          target to work.</p>
                   4891: <p><span class="emphasis"><em>Be careful when using this
                   4892:          target!</em></span> There are no guarantees that dependent
                   4893:          packages will still work, in particular they will most
                   4894:          certainly break if you <span class="command"><strong>make replace</strong></span> a
                   4895:          library package whose shared library major version changed
                   4896:          between your installed version and the new one.  For this
                   4897:          reason, this target is not officially supported and only
                   4898:          recommended for advanced users.</p>
                   4899: </dd>
                   4900: <dt><span class="term">info</span></dt>
1.311     leot     4901: <dd><p>This target invokes <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/pkg_info.1"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a> for the current
1.299     rillig   4902:          package. You can use this to check which version of a
                   4903:          package is installed.</p></dd>
                   4904: <dt><span class="term">index</span></dt>
                   4905: <dd>
                   4906: <p>This is a top-level command, i.e. it should be used in
                   4907:          the <code class="filename">pkgsrc</code> directory.  It creates a
                   4908:          database of all packages in the local pkgsrc tree, including
                   4909:          dependencies, comment, maintainer, and some other useful
                   4910:          information.  Individual entries are created by running
                   4911:          <span class="command"><strong>make describe</strong></span> in the packages'
                   4912:          directories.  This index file is saved as
                   4913:          <code class="filename">pkgsrc/INDEX</code>.  It can be displayed in
                   4914:          verbose format by running <span class="command"><strong>make
                   4915:          print-index</strong></span>.  You can search in it with
                   4916:          <span class="command"><strong>make search
                   4917:          key=<em class="replaceable"><code>something</code></em></strong></span>.  You can
                   4918:          extract a list of all packages that depend on a particular
                   4919:          one by running <span class="command"><strong>make show-deps
                   4920:          PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
                   4921: <p>Running this command takes a very long time, some
                   4922:          hours even on fast machines!</p>
                   4923: </dd>
                   4924: <dt><span class="term">readme</span></dt>
                   4925: <dd>
                   4926: <p>This target generates a
                   4927:          <code class="filename">README.html</code> file, which can be
                   4928:          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
                   4929:          contain references to any packages which are in the
                   4930:          <code class="varname">PACKAGES</code> directory on the local
                   4931:          host. The generated files can be made to refer to URLs
                   4932:          based on <code class="varname">FTP_PKG_URL_HOST</code> and
                   4933:          <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
                   4934:          wanted to generate <code class="filename">README.html</code>
                   4935:          files which pointed to binary packages on the local
                   4936:          machine, in the directory
                   4937:          <code class="filename">/usr/packages</code>, set
                   4938:          <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
                   4939:          <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
                   4940:          <code class="varname">${PACKAGES}</code> directory and its
                   4941:          subdirectories will be searched for all the binary
                   4942:          packages.</p>
                   4943: <p>The target can be run at the toplevel or in category
                   4944:          directories, in which case it descends recursively.</p>
                   4945: </dd>
                   4946: <dt><span class="term">readme-all</span></dt>
                   4947: <dd><p>This is a top-level command, run it in
                   4948:          <code class="filename">pkgsrc</code>.  Use this target to create a
                   4949:          file <code class="filename">README-all.html</code> which contains a
                   4950:          list of all packages currently available in the NetBSD
                   4951:          Packages Collection, together with the category they belong
                   4952:          to and a short description. This file is compiled from the
                   4953:          <code class="filename">pkgsrc/*/README.html</code> files, so be sure
                   4954:          to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
                   4955:          readme</strong></span>.</p></dd>
                   4956: <dt><span class="term">cdrom-readme</span></dt>
                   4957: <dd><p>This is very much the same as the
                   4958:          <span class="quote">&#8220;<span class="quote">readme</span>&#8221;</span> target (see above), but is to be
                   4959:          used when generating a pkgsrc tree to be written to a
                   4960:          CD-ROM.  This target also produces
                   4961:          <code class="filename">README.html</code> files, and can be made
                   4962:          to refer to URLs based on
                   4963:          <code class="varname">CDROM_PKG_URL_HOST</code> and
                   4964:          <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
                   4965: <dt><span class="term">show-distfiles</span></dt>
                   4966: <dd><p>This target shows which distfiles and patchfiles
                   4967:          are needed to build the package
                   4968:          (<code class="varname">ALLFILES</code>, which contains all
                   4969:          <code class="varname">DISTFILES</code> and
                   4970:          <code class="varname">PATCHFILES</code>, but not
                   4971:          <code class="filename">patches/*</code>).</p></dd>
                   4972: <dt><span class="term">show-downlevel</span></dt>
                   4973: <dd><p>This target shows nothing if the package is not
                   4974:          installed. If a version of this package is installed,
                   4975:          but is not the version provided in this version of
                   4976:          pkgsrc, then a warning message is displayed. This target
                   4977:          can be used to show which of your installed packages are
                   4978:          downlevel, and so the old versions can be deleted, and
                   4979:          the current ones added.</p></dd>
                   4980: <dt><span class="term">show-pkgsrc-dir</span></dt>
                   4981: <dd><p>This target shows the directory in the pkgsrc
                   4982:          hierarchy from which the package can be built and
                   4983:          installed. This may not be the same directory as the one
                   4984:          from which the package was installed. This target is
                   4985:          intended to be used by people who may wish to upgrade
                   4986:          many packages on a single host, and can be invoked from
                   4987:          the top-level pkgsrc Makefile by using the
                   4988:          <span class="quote">&#8220;<span class="quote">show-host-specific-pkgs</span>&#8221;</span> target.</p></dd>
                   4989: <dt><span class="term">show-installed-depends</span></dt>
                   4990: <dd><p>This target shows which installed packages match
                   4991:          the current package's <code class="varname">DEPENDS</code>. Useful
                   4992:          if out of date dependencies are causing build
                   4993:          problems.</p></dd>
                   4994: <dt><span class="term">print-build-depends-list</span></dt>
                   4995: <dd><p>This target shows the list of packages that the current package
                   4996:            depends on for building.</p></dd>
                   4997: <dt><span class="term">print-run-depends-list</span></dt>
                   4998: <dd><p>This target shows the list of packages that the current package
                   4999:            depends on for running.</p></dd>
                   5000: <dt><span class="term">check-shlibs</span></dt>
                   5001: <dd><p>After a package is installed, check all its
                   5002:          binaries and (on ELF platforms) shared libraries to see
                   5003:          if they find the shared libs they need.  Run by default
                   5004:          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>
                   5005: <dt><span class="term">print-PLIST</span></dt>
                   5006: <dd>
                   5007: <p>After a <span class="quote">&#8220;<span class="quote">make install</span>&#8221;</span> from a new or
                   5008:          upgraded pkg, this prints out an attempt to generate a
                   5009:          new <code class="filename">PLIST</code> from a <span class="command"><strong>find
                   5010:          -newer work/.extract_done</strong></span>.  An attempt is made
                   5011:          to care for shared libs etc., but it is
                   5012:          <span class="emphasis"><em>strongly</em></span> recommended to review the
                   5013:          result before putting it into
                   5014:          <code class="filename">PLIST</code>. On upgrades, it's useful to
                   5015:          diff the output of this command against an already
                   5016:          existing <code class="filename">PLIST</code> file.</p>
1.311     leot     5017: <p>If the package installs files via <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/tar.1"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a> or
1.299     rillig   5018:          other methods that don't update file access times, be
                   5019:          sure to add these files manually to your
                   5020:          <code class="filename">PLIST</code>, as the <span class="quote">&#8220;<span class="quote">find
                   5021:          -newer</span>&#8221;</span> command used by this target won't catch
                   5022:          them!</p>
                   5023: <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
                   5024:          information on this target.</p>
                   5025: </dd>
                   5026: </dl></div>
                   5027: </div>
                   5028: </div>
                   5029: <div class="chapter">
                   5030: <div class="titlepage"><div><div><h2 class="title">
                   5031: <a name="creating"></a>Chapter 14. Creating a new pkgsrc package from scratch</h2></div></div></div>
                   5032: <div class="toc">
                   5033: <p><b>Table of Contents</b></p>
                   5034: <dl class="toc">
                   5035: <dt><span class="sect1"><a href="#creating.common">14.1. Common types of packages</a></span></dt>
                   5036: <dd><dl>
                   5037: <dt><span class="sect2"><a href="#creating.perl-module">14.1.1. Perl modules</a></span></dt>
                   5038: <dt><span class="sect2"><a href="#creating.python-module">14.1.2. Python modules and programs</a></span></dt>
                   5039: <dt><span class="sect2"><a href="#creating.R-package">14.1.3. R packages</a></span></dt>
                   5040: <dt><span class="sect2"><a href="#creating.TeX-package">14.1.4. TeXlive packages</a></span></dt>
                   5041: </dl></dd>
                   5042: <dt><span class="sect1"><a href="#creating.examples">14.2. Examples</a></span></dt>
                   5043: <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>
                   5044: </dl>
                   5045: </div>
                   5046: <p>When you find a package that is not yet in pkgsrc, you
                   5047: most likely have a URL from where you can download the source
                   5048: code. Starting with this URL, creating a package involves only a
                   5049: few steps.</p>
                   5050: <div class="procedure"><ol class="procedure" type="1">
                   5051: <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
                   5052: enable the basic quality checks.</p></li>
                   5053: <li class="step">
                   5054: <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
                   5055: install the utilities <span class="command"><strong>url2pkg</strong></span>,
                   5056: <span class="command"><strong>pkglint</strong></span>, <span class="command"><strong>pkgvi</strong></span> and
                   5057: <span class="command"><strong>mkpatches</strong></span>:</p>
                   5058: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   5059: <code class="prompt">$</code> <strong class="userinput"><code>(cd meta-pkgs/pkg_developer &amp;&amp; bmake update)</code></strong></pre>
                   5060: </li>
                   5061: <li class="step">
                   5062: <p>Choose one of the top-level directories as the category in
                   5063: which you want to place your package. You can also create a directory of
                   5064: your own (maybe called <code class="filename">local</code>). In that category
                   5065: directory, create another directory for your package and change into
                   5066: it:</p>
                   5067: <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>
                   5068: <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>
                   5069: </li>
                   5070: <li class="step">
                   5071: <p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
                   5072: you for a URL. Enter the URL of the distribution file (in most cases a
                   5073: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
                   5074: of your package are created automatically. The distribution file is
                   5075: extracted automatically to fill in some details in the
                   5076: <code class="filename">Makefile</code> that would otherwise have to be done
                   5077: manually:</p>
                   5078: <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>
                   5079: </li>
                   5080: <li class="step">
                   5081: <p>Examine the extracted files to determine the dependencies of
                   5082: your package. Ideally, this is mentioned in some
                   5083: <code class="filename">README</code> file, but things may differ. For each of
                   5084: these dependencies, look where it exists in pkgsrc, and if there is a
                   5085: file called <code class="filename">buildlink3.mk</code> in that directory, add a
                   5086: line to your package <code class="filename">Makefile</code> which includes that
                   5087: file just before the last line. If the
                   5088: <code class="filename">buildlink3.mk</code> file does not exist, it must be
                   5089: created first. The <code class="filename">buildlink3.mk</code> file makes sure
                   5090: that the package's include files and libraries are provided.</p>
                   5091: <p>If you just need binaries from a package, add a
                   5092: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
                   5093: version of the dependency and where it can be found in pkgsrc. This line
                   5094: should be placed in the third paragraph. If the dependency is only
                   5095: needed for building the package, but not when using it, use
                   5096: <code class="varname">TOOL_DEPENDS</code> or <code class="varname">BUILD_DEPENDS</code>
                   5097: instead of <code class="varname">DEPENDS</code>.
                   5098: The difference between <code class="varname">TOOL_DEPENDS</code> and
                   5099: <code class="varname">BUILD_DEPENDS</code> occurs when cross-compiling:
                   5100: <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
                   5101: packages, i.e. packages for the architecture where the package
                   5102: is built;
                   5103: <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
                   5104: packages, i.e. packages for the architecture for which the package
                   5105: is built. There is also <code class="varname">TEST_DEPENDS</code>, which is used
                   5106: to specify a dependency used only for testing the resulting package
                   5107: built, using the upstream project's included test suite.
                   5108: Your package may then look like this:</p>
                   5109: <pre class="programlisting">
                   5110: [...]
                   5111: 
                   5112: TOOL_DEPENDS+=  libxslt-[0-9]*:../../textproc/libxslt
                   5113: DEPENDS+=       screen-[0-9]*:../../misc/screen
                   5114: DEPENDS+=       screen&gt;=4.0:../../misc/screen
                   5115: 
                   5116: [...]
                   5117: 
                   5118: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
                   5119: .include "../../devel/glib2/buildlink3.mk"
                   5120: .include "../../mk/bsd.pkg.mk"
                   5121: </pre>
                   5122: </li>
                   5123: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
                   5124: to be done to make your package a <span class="quote">&#8220;<span class="quote">good</span>&#8221;</span> one. If you don't
                   5125: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
                   5126: --explain</strong></span> or <span class="command"><strong>pkglint -e</strong></span>, which outputs
                   5127: additional explanations.</p></li>
                   5128: <li class="step"><p>In many cases the package is not yet ready to build. You can
                   5129: 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
                   5130: over there, you can hopefully continue here.</p></li>
                   5131: <li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
                   5132: directory from the extracted files. Besides these files, a lot of cache
                   5133: files and other system information has been saved in the working
                   5134: directory, which may become wrong after you edited the
                   5135: <code class="filename">Makefile</code>.</p></li>
                   5136: <li class="step">
                   5137: <p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
                   5138: 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>
                   5139: <p>If the extracted files from the package need to be fixed, run multiple rounds of these commands:</p>
                   5140: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>make</code></strong>
                   5141: <code class="prompt">$</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
                   5142: <code class="prompt">$</code> <strong class="userinput"><code>mkpatches</code></strong>
                   5143: <code class="prompt">$</code> <strong class="userinput"><code>make mps</code></strong>
                   5144: <code class="prompt">$</code> <strong class="userinput"><code>make clean</code></strong></pre>
                   5145: </li>
                   5146: <li class="step"><p>When the package builds fine, the next step is to install
                   5147: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
                   5148: everything works.</p></li>
                   5149: <li class="step"><p>Up to now, the file <code class="filename">PLIST</code>, which
                   5150: contains a list of the files that are installed by the package, is
                   5151: nearly empty. Run <span class="command"><strong>bmake print-PLIST
                   5152: &gt;PLIST</strong></span> to generate a probably correct list. Check
                   5153: the file using your preferred text editor to see if the list of
                   5154: files looks plausible.</p></li>
                   5155: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
                   5156: <code class="filename">PLIST</code> contains garbage or not.</p></li>
                   5157: <li class="step"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
                   5158: had been registered in the database of installed files, but with an
                   5159: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
                   5160: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
                   5161: registered with the list of files from
                   5162: <code class="filename">PLIST</code>.</p></li>
                   5163: <li class="step"><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
                   5164: package from the set of installed files.</p></li>
                   5165: <li class="step"><p>Run <span class="command"><strong>bmake clean update</strong></span> to run everything
                   5166: from above again in a single step, making sure that the PLIST is correct
                   5167: and the whole package is created as intended.</p></li>
                   5168: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see if there's anything left to do.</p></li>
                   5169: <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>
                   5170: </ol></div>
                   5171: <div class="sect1">
                   5172: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   5173: <a name="creating.common"></a>14.1. Common types of packages</h2></div></div></div>
                   5174: <div class="sect2">
                   5175: <div class="titlepage"><div><div><h3 class="title">
                   5176: <a name="creating.perl-module"></a>14.1.1. Perl modules</h3></div></div></div>
                   5177: <p>Simple Perl modules are handled automatically by
                   5178: <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
                   5179: </div>
                   5180: <div class="sect2">
                   5181: <div class="titlepage"><div><div><h3 class="title">
                   5182: <a name="creating.python-module"></a>14.1.2. Python modules and programs</h3></div></div></div>
                   5183: <p>Python modules and programs packages are easily created using a
                   5184: set of predefined variables.</p>
                   5185: <p>
                   5186: If some Python versions are not supported by the software, set the
                   5187: <code class="varname">PYTHON_VERSIONS_INCOMPATIBLE</code> variable to the Python versions
                   5188: that are not supported, e.g.
                   5189: </p>
                   5190: <pre class="programlisting">
                   5191: PYTHON_VERSIONS_INCOMPATIBLE=       27
                   5192: </pre>
                   5193: <p>
                   5194: If the packaged software is a Python module, include one of
                   5195: <code class="filename">../../lang/python/egg.mk</code>,
                   5196: <code class="filename">../../lang/python/distutils.mk</code>, or
                   5197: <code class="filename">../../lang/python/extension.mk</code>.</p>
                   5198: <p>Most Python packages use either <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span> or
                   5199: easy-setup/setuptools (<span class="quote">&#8220;<span class="quote">eggs</span>&#8221;</span>).
                   5200: If the packaged software is using setuptools, you only need
                   5201: to include <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>&#8221;</span>.
                   5202: Otherwise, if the software uses <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span>, include 
                   5203: <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/distutils.mk</code></span>&#8221;</span>,
                   5204: so pkgsrc will use this framework.
                   5205: <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span> uses a script called <code class="filename">setup.py</code>;
                   5206: if the <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span> driver is not called
                   5207: <code class="filename">setup.py</code>, set the <code class="varname">PYSETUP</code> variable
                   5208: to the name of the script.</p>
                   5209: <p>Either way, the package directory should be called
                   5210: <span class="quote">&#8220;<span class="quote">py-software</span>&#8221;</span> and <code class="varname">PKGNAME</code> should be set to
                   5211: <span class="quote">&#8220;<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>&#8221;</span>, e.g.
                   5212: </p>
                   5213: <pre class="programlisting">
                   5214: DISTNAME=   foopymodule-1.2.10
                   5215: PKGNAME=    ${PYPKGPREFIX}-${DISTNAME}
                   5216: </pre>
                   5217: <p>If it is an application, include
                   5218: <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>&#8221;</span>.
                   5219: In order to correctly set the path to the Python interpreter, use the
                   5220: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
                   5221: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
                   5222: For example:
                   5223: </p>
                   5224: <pre class="programlisting">
                   5225: REPLACE_PYTHON=   *.py
                   5226: </pre>
                   5227: <p>Some Python modules have separate distributions for Python-2.x
                   5228: and Python-3.x support. In pkgsrc this is handled by the
                   5229: <code class="filename">versioned_dependencies.mk</code> file. Set
                   5230: <code class="varname">PYTHON_VERSIONED_DEPENDENCIES</code> to the list of
                   5231: packages that should be depended upon and include
                   5232: <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/versioned_dependencies.mk</code></span>&#8221;</span>,
                   5233: then the pkgsrc infrastructure will depend on the appropriate package
                   5234: version. For example:
                   5235: </p>
                   5236: <pre class="programlisting">
                   5237: PYTHON_VERSIONED_DEPENDENCIES=dialog
                   5238: </pre>
                   5239: <p>
                   5240: Look inside <code class="filename">versioned_dependencies.mk</code> for a list
                   5241: of supported packages.</p>
                   5242: </div>
                   5243: <div class="sect2">
                   5244: <div class="titlepage"><div><div><h3 class="title">
                   5245: <a name="creating.R-package"></a>14.1.3. R packages</h3></div></div></div>
                   5246: <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>
                   5247: are handled automatically by <span class="command"><strong>R2pkg</strong></span>, which is
                   5248: 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>.
                   5249: Individual packages (and optionally their dependencies) may be created
                   5250: and updated.  R packages generally follow the same form, and most of
                   5251: the relevant information needed is contained in a
                   5252: <code class="filename">DESCRIPTION</code> file as part of each R package on
                   5253: <a class="ulink" href="https://cran.r-project.org/web/packages/available_packages_by_name.html" target="_top">CRAN</a>.
                   5254: Consequently, <span class="command"><strong>R2pkg</strong></span> downloads that information and
                   5255: creates or updates a package in the canonical form.  The resulting
                   5256: package should be reviewed for correctness.</p>
                   5257: </div>
                   5258: <div class="sect2">
                   5259: <div class="titlepage"><div><div><h3 class="title">
                   5260: <a name="creating.TeX-package"></a>14.1.4. TeXlive packages</h3></div></div></div>
                   5261: <p>TeXlive packages from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> are handled automatically by
                   5262: <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>
                   5263: <p>If the TeXlive package name is not known, it may be useful to
                   5264: search <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>.  A
                   5265: <span class="quote">&#8220;<span class="quote">Contained in</span>&#8221;</span> field on the package page typically
                   5266: 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
                   5267: archive</a>.</p>
                   5268: <p>If the TeXlive package name is known, download the files from
                   5269: the <a class="ulink" href="https://www.ctan.org/tex-archive/systems/texlive/tlnet/archive" target="_top">TeXlive
                   5270: archive</a>.  For package <code class="filename">foo</code>, you will need
                   5271: to download <code class="filename">foo.tar.xz</code>.  Most TeXlive packages
                   5272: also have associated documentation packages, so download
                   5273: <code class="filename">foo.doc.tar.xz</code> at the same time.  These files
                   5274: should be placed in the appropriate category directory, which is often
                   5275: but not always <code class="filename">print</code>.  Then run the following
                   5276: command in the category directory.</p>
                   5277: <pre class="programlisting">
                   5278: texlive2pkg foo.tar.xz foo.doc.tar.xz
                   5279: </pre>
                   5280: <p>This will create two packages, <code class="filename">tex-foo</code> and
                   5281: <code class="filename">tex-foo-doc</code>.  Be sure to check that both packages
                   5282: are correct.</p>
                   5283: <p>Finally, <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>
                   5284: currently does not include version information in package filenames
                   5285: and changes their contents periodically when updates occur.
                   5286: Consequently, pkgsrc avoids downloading distfiles directly from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> and instead relies on the
                   5287: pkgsrc archives.  For each new or updated TeXlive package, e.g., the
                   5288: main one and the corresponding documentation, upload the distfiles
                   5289: with the following command in each package directory.</p>
                   5290: <pre class="programlisting">
                   5291: make upload-distfiles
                   5292: </pre>
                   5293: </div>
                   5294: </div>
                   5295: <div class="sect1">
                   5296: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   5297: <a name="creating.examples"></a>14.2. Examples</h2></div></div></div>
                   5298: <div class="sect2">
                   5299: <div class="titlepage"><div><div><h3 class="title">
                   5300: <a name="creating.nvu"></a>14.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
                   5301: <div class="sect3">
                   5302: <div class="titlepage"><div><div><h4 class="title">
                   5303: <a name="creating.nvu.init"></a>14.2.1.1. The initial package</h4></div></div></div>
                   5304: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
                   5305: that the <span class="quote">&#8220;<span class="quote">nvu</span>&#8221;</span> package has not yet been imported into
                   5306: pkgsrc. As the description says it has to do with the web, the obvious
                   5307: choice for the category is <span class="quote">&#8220;<span class="quote">www</span>&#8221;</span>.</p>
                   5308: <pre class="programlisting">
                   5309: <code class="prompt">$</code> mkdir www/nvu
                   5310: <code class="prompt">$</code> cd www/nvu
                   5311: </pre>
                   5312: <p>The web site says that the sources are available as a tar file, so
                   5313: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
                   5314: <pre class="programlisting">
                   5315: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
                   5316: </pre>
                   5317: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
                   5318: below the <code class="varname">DISTNAME</code> line, as the package name should
                   5319: not have the word <span class="quote">&#8220;<span class="quote">sources</span>&#8221;</span> in it. I also filled in the
                   5320: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
                   5321: <code class="varname">COMMENT</code> fields. Then the package
                   5322: <code class="filename">Makefile</code> looked like that:</p>
                   5323: <pre class="programlisting">
                   5324: # $NetBSD $
                   5325: #
                   5326: 
                   5327: DISTNAME=       nvu-1.0-sources
                   5328: PKGNAME=        nvu-1.0
                   5329: CATEGORIES=     www
                   5330: MASTER_SITES=   http://cvs.nvu.com/download/
                   5331: EXTRACT_SUFX=   .tar.bz2
                   5332: 
                   5333: MAINTAINER=     rillig@NetBSD.org
                   5334: HOMEPAGE=       http://cvs.nvu.com/
                   5335: COMMENT=        Web Authoring System
                   5336: 
                   5337: # url2pkg-marker (please do not remove this line.)
                   5338: .include "../../mk/bsd.pkg.mk"
                   5339: </pre>
                   5340: <p>On the first line of output above, an artificial space has been added between NetBSD and $,
                   5341: this is a workaround to prevent CVS expanding to the filename of the
                   5342: guide.</p>
                   5343: <p>Then, I quit the editor and watched pkgsrc downloading a large
                   5344: source archive:</p>
                   5345: <pre class="programlisting">
                   5346: url2pkg&gt; Running "make makesum" ...
                   5347: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   5348: =&gt; Fetching nvu-1.0-sources.tar.bz2
                   5349: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
                   5350: 100% |*************************************| 28992 KB  150.77 KB/s00:00 ETA
                   5351: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
                   5352: url2pkg&gt; Running "make extract" ...
                   5353: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   5354: =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   5355: =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   5356: work.bacc -&gt; /tmp/roland/pkgsrc/www/nvu/work.bacc
                   5357: ===&gt; Installing dependencies for nvu-1.0
                   5358: ===&gt; Overriding tools for nvu-1.0
                   5359: ===&gt; Extracting for nvu-1.0
                   5360: url2pkg&gt; Adjusting the Makefile.
                   5361: 
                   5362: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
                   5363: 
                   5364: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
                   5365: </pre>
                   5366: </div>
                   5367: <div class="sect3">
                   5368: <div class="titlepage"><div><div><h4 class="title">
                   5369: <a name="creating.nvu.problems"></a>14.2.1.2. Fixing all kinds of problems to make the package work</h4></div></div></div>
                   5370: <p>Now that the package has been extracted, let's see what's inside
                   5371: it. The package has a <code class="filename">README.txt</code>, but that only
                   5372: says something about mozilla, so it's probably useless for seeing what
                   5373: dependencies this package has. But since there is a GNU configure script
                   5374: in the package, let's hope that it will complain about everything it
                   5375: needs.</p>
                   5376: <pre class="programlisting">
                   5377: <code class="prompt">$</code> bmake
                   5378: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   5379: =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   5380: =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   5381: ===&gt; Patching for nvu-1.0
                   5382: ===&gt; Creating toolchain wrappers for nvu-1.0
                   5383: ===&gt; Configuring for nvu-1.0
                   5384: [...]
                   5385: configure: error: Perl 5.004 or higher is required.
                   5386: [...]
                   5387: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
                   5388: [...]
                   5389: </pre>
                   5390: <p>That worked quite well. So I opened the package Makefile in my
                   5391: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
                   5392: just appended <span class="quote">&#8220;<span class="quote">perl</span>&#8221;</span> to it. Since the dependencies of the
                   5393: package have changed now, and since a perl wrapper is automatically
                   5394: installed in the <span class="quote">&#8220;<span class="quote">tools</span>&#8221;</span> phase, I need to build the package
                   5395: from scratch.</p>
                   5396: <pre class="programlisting">
                   5397: <code class="prompt">$</code> bmake clean
                   5398: ===&gt; Cleaning for nvu-1.0
                   5399: <code class="prompt">$</code> bmake
                   5400: [...]
                   5401: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
                   5402: GNU Make.  You will not be able to build Mozilla without GNU Make.
                   5403: [...]
                   5404: </pre>
                   5405: <p>So I added <span class="quote">&#8220;<span class="quote">gmake</span>&#8221;</span> to the
                   5406: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
                   5407: <pre class="programlisting">
                   5408: [...]
                   5409: checking for GTK - version &gt;= 1.2.0... no
                   5410: *** Could not run GTK test program, checking why...
                   5411: [...]
                   5412: </pre>
                   5413: <p>Now to the other dependencies. The first question is: Where is the
                   5414: GTK package hidden in pkgsrc?</p>
                   5415: <pre class="programlisting">
                   5416: <code class="prompt">$</code> echo ../../*/gtk*
                   5417: [many packages ...]
                   5418: <code class="prompt">$</code> echo ../../*/gtk
                   5419: ../../x11/gtk
                   5420: <code class="prompt">$</code> echo ../../*/gtk2
                   5421: ../../x11/gtk2
                   5422: <code class="prompt">$</code> echo ../../*/gtk2/bui*
                   5423: ../../x11/gtk2/buildlink3.mk
                   5424: </pre>
                   5425: <p>The first try was definitely too broad. The second one had exactly
                   5426: one result, which is very good. But there is one pitfall with GNOME
                   5427: packages. Before GNOME 2 had been released, there were already many
                   5428: GNOME 1 packages in pkgsrc. To be able to continue to use these
                   5429: packages, the GNOME 2 packages were imported as separate packages, and
                   5430: their names usually have a <span class="quote">&#8220;<span class="quote">2</span>&#8221;</span> appended. So I checked
                   5431: whether this was the case here, and indeed it was.</p>
                   5432: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
                   5433: file, adding the dependency is very easy. I just inserted an
                   5434: <code class="literal">.include</code> line before the last line of the package
                   5435: <code class="filename">Makefile</code>, so that it now looks like this:</p>
                   5436: <pre class="programlisting">
                   5437: [...]
                   5438: .include "../../x11/gtk2/buildlink3.mk"
                   5439: .include "../../mk/bsd.pkg.mk
                   5440: </pre>
                   5441: <p>After another <span class="command"><strong>bmake clean &amp;&amp; bmake</strong></span>, the answer
                   5442: was:</p>
1.75      rillig   5443: <pre class="programlisting">
1.299     rillig   5444: [...]
                   5445: checking for gtk-config... /home/roland/pkg/bin/gtk-config
                   5446: checking for GTK - version &gt;= 1.2.0... no
                   5447: *** Could not run GTK test program, checking why...
                   5448: *** The test program failed to compile or link. See the file config.log for the
                   5449: *** exact error that occured. This usually means GTK was incorrectly installed
                   5450: *** or that you have moved GTK since it was installed. In the latter case, you
                   5451: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
                   5452: configure: error: Test for GTK failed.
                   5453: [...]
1.222     sevan    5454: </pre>
1.299     rillig   5455: <p>In this particular case, the assumption that <span class="quote">&#8220;<span class="quote">every package
                   5456: prefers GNOME 2</span>&#8221;</span> had been wrong. The first of the lines above
                   5457: told me that this package really wanted to have the GNOME 1 version of
                   5458: GTK. If the package had looked for GTK2, it would have looked for
                   5459: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
                   5460: So I changed the <code class="literal">x11/gtk2</code> to
                   5461: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
                   5462: and tried again.</p>
1.119     mishka   5463: <pre class="programlisting">
1.299     rillig   5464: [...]
                   5465: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\"  [...]
                   5466: In file included from xpidl.c:42:
                   5467: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
                   5468: In file included from xpidl.c:42:
                   5469: xpidl.h:132: error: parse error before "IDL_ns"
                   5470: [...]
1.222     sevan    5471: </pre>
1.299     rillig   5472: <p>The package still does not find all of its dependencies. Now the
                   5473: question is: Which package provides the
                   5474: <code class="filename">libIDL/IDL.h</code> header file?</p>
1.119     mishka   5475: <pre class="programlisting">
1.299     rillig   5476: <code class="prompt">$</code> echo ../../*/*idl*
                   5477: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
                   5478: <code class="prompt">$</code> echo ../../*/*IDL*
                   5479: ../../net/libIDL
1.222     sevan    5480: </pre>
1.299     rillig   5481: <p>Let's take the one from the second try. So I included the
                   5482: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
                   5483: again. But the error didn't change. After digging through some of the
                   5484: code, I concluded that the build process of the package was broken and
                   5485: couldn't have ever worked, but since the Mozilla source tree is quite
                   5486: large, I didn't want to fix it. So I added the following to the package
                   5487: <code class="filename">Makefile</code> and tried again:</p>
1.197     wiz      5488: <pre class="programlisting">
1.299     rillig   5489: CPPFLAGS+=              -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
                   5490: BUILDLINK_TRANSFORM+=   l:IDL:IDL-2
1.222     sevan    5491: </pre>
1.299     rillig   5492: <p>The latter line is needed because the package expects the library
                   5493: <code class="filename">libIDL.so</code>, but only
                   5494: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
                   5495: wrapper to rewrite that on the fly.</p>
                   5496: <p>The next problem was related to a recent change of the FreeType
                   5497: 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>
                   5498: which patch files were relevant for this issue and copied them to the
                   5499: <code class="filename">patches</code> directory. Then I retried, fixed the
                   5500: patches so that they applied cleanly and retried again. This time,
                   5501: everything worked.</p>
1.197     wiz      5502: </div>
1.299     rillig   5503: <div class="sect3">
                   5504: <div class="titlepage"><div><div><h4 class="title">
                   5505: <a name="creating.nvu.inst"></a>14.2.1.3. Installing the package</h4></div></div></div>
1.87      wiz      5506: <pre class="programlisting">
1.299     rillig   5507: <code class="prompt">$</code> bmake CHECK_FILES=no install
                   5508: [...]
                   5509: <code class="prompt">$</code> bmake print-PLIST &gt;PLIST
                   5510: <code class="prompt">$</code> bmake deinstall
                   5511: <code class="prompt">$</code> bmake install
1.222     sevan    5512: </pre>
1.299     rillig   5513: </div>
                   5514: </div>
1.75      rillig   5515: </div>
                   5516: </div>
1.148     asau     5517: <div class="chapter">
1.75      rillig   5518: <div class="titlepage"><div><div><h2 class="title">
1.299     rillig   5519: <a name="makefile"></a>Chapter 15. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.75      rillig   5520: <div class="toc">
                   5521: <p><b>Table of Contents</b></p>
1.210     leot     5522: <dl class="toc">
1.299     rillig   5523: <dt><span class="sect1"><a href="#makefile.style">15.1. Caveats</a></span></dt>
                   5524: <dt><span class="sect1"><a href="#makefile.variables">15.2. <code class="filename">Makefile</code> variables</a></span></dt>
                   5525: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">15.2.1. Naming conventions</a></span></dt></dl></dd>
                   5526: <dt><span class="sect1"><a href="#makefile.code">15.3. Code snippets</a></span></dt>
                   5527: <dd><dl>
                   5528: <dt><span class="sect2"><a href="#adding-to-list">15.3.1. Adding things to a list</a></span></dt>
                   5529: <dt><span class="sect2"><a href="#echo-literal">15.3.2. Echoing a string exactly as-is</a></span></dt>
                   5530: <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>
                   5531: <dt><span class="sect2"><a href="#empty-variables">15.3.4. Handling possibly empty variables</a></span></dt>
1.75      rillig   5532: </dl></dd>
                   5533: </dl>
                   5534: </div>
1.299     rillig   5535: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
                   5536:   each of which forms a well-defined part of the pkgsrc system. Using
1.311     leot     5537:   the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> system as a programming language for a big system
1.299     rillig   5538:   like pkgsrc requires some discipline to keep the code correct and
                   5539:   understandable.</p>
                   5540: <p>The basic ingredients for <code class="filename">Makefile</code>
                   5541:   programming are variables and shell
                   5542:   commands. Among these shell commands may even be more complex ones
1.311     leot     5543:   like <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/awk.1"><span class="citerefentry"><span class="refentrytitle">awk</span>(1)</span></a> programs. To make sure that every shell command runs
1.299     rillig   5544:   as intended it is necessary to quote all variables correctly when they
                   5545:   are used.</p>
                   5546: <p>This chapter describes some patterns that appear quite often in
                   5547:   <code class="filename">Makefile</code>s, including the pitfalls that come along
                   5548:   with them.</p>
1.148     asau     5549: <div class="sect1">
1.75      rillig   5550: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   5551: <a name="makefile.style"></a>15.1. Caveats</h2></div></div></div>
                   5552: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
                   5553: <p>When you are creating a file as a
                   5554:     target of a rule, always write the data to a temporary file first
                   5555:     and finally rename that file. Otherwise there might occur an error
                   5556:     in the middle of generating the file, and when the user runs
1.311     leot     5557:     <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> for the second time, the file exists and will not be
1.299     rillig   5558:     regenerated properly. Example:</p>
1.75      rillig   5559: <pre class="programlisting">
1.299     rillig   5560: wrong:
                   5561:         @echo "line 1" &gt; ${.TARGET}
                   5562:         @echo "line 2" &gt;&gt; ${.TARGET}
                   5563:         @false
                   5564: 
                   5565: correct:
                   5566:         @echo "line 1" &gt; ${.TARGET}.tmp
                   5567:         @echo "line 2" &gt;&gt; ${.TARGET}.tmp
                   5568:         @false
                   5569:         @mv ${.TARGET}.tmp ${.TARGET}
1.100     rillig   5570: </pre>
1.299     rillig   5571: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
                   5572:     <code class="filename">wrong</code> will exist, although there was an error
                   5573:     message in the first run. On the other hand, running <span class="command"><strong>make
                   5574:     correct</strong></span> gives an error message twice, as expected.</p>
1.311     leot     5575: <p>You might remember that <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> sometimes removes
1.299     rillig   5576:     <code class="literal">${.TARGET}</code> in case of error, but this only
                   5577:     happens when it is interrupted, for example by pressing
                   5578:     <code class="literal">Ctrl+C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.311     leot     5579:     when one of the commands fails (like <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/false.1"><span class="citerefentry"><span class="refentrytitle">false</span>(1)</span></a> above).</p>
1.299     rillig   5580: </li></ul></div>
                   5581: </div>
                   5582: <div class="sect1">
                   5583: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   5584: <a name="makefile.variables"></a>15.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
                   5585: <p><code class="filename">Makefile</code> variables contain strings that
                   5586:     can be processed using the five operators <code class="code">=</code>,
                   5587:     <code class="code">+=</code>, <code class="code">?=</code>, <code class="code">:=</code> and
1.311     leot     5588:     <code class="code">!=</code>, which are described in the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man
1.299     rillig   5589:     page.</p>
                   5590: <p>When a variable's value is parsed from a
                   5591:     <code class="filename">Makefile</code>, the hash character <code class="code">#</code> and
                   5592:     the backslash character <code class="code">\</code> are handled specially. If a
                   5593:     backslash is the last character in a line, that backslash is removed
                   5594:     from the line and the line continues with the next line of the file.</p>
                   5595: <p>The <code class="code">#</code> character starts a comment that reaches
                   5596:     until the end of the line. To get an actual <code class="code">#</code> character,
                   5597:     such as in a URL, write <code class="code">\#</code> instead.</p>
                   5598: <p>The evaluation of variables either happens immediately or lazy.
                   5599:     It happens immediately when the variable occurs on the right-hand
                   5600:     side of the <code class="code">:=</code> or the <code class="code">!=</code> operator, in a
                   5601:     <code class="varname">.if</code> condition or a <code class="varname">.for</code> loop.
                   5602:     In the other cases, it is evaluated lazily.</p>
                   5603: <p>Some of the modifiers split the string into words and then
                   5604:     operate on the words, others operate on the string as a whole. When a
                   5605:     string is split into words, double quotes and single quotes are
1.311     leot     5606:     interpreted as delimiters, just like in <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/sh.1"><span class="citerefentry"><span class="refentrytitle">sh</span>(1)</span></a>.</p>
1.299     rillig   5607: <div class="sect2">
                   5608: <div class="titlepage"><div><div><h3 class="title">
                   5609: <a name="makefile.variables.names"></a>15.2.1. Naming conventions</h3></div></div></div>
                   5610: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   5611: <li class="listitem"><p>All variable names starting with an underscore
                   5612:        are reserved for use by the pkgsrc infrastructure. They shall
                   5613:        not be used by packages.</p></li>
                   5614: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
                   5615:        lowercase variable names for the iteration
                   5616:        variables.</p></li>
                   5617: <li class="listitem"><p>All list variables should have a plural name,
                   5618:        such as <code class="varname">PKG_OPTIONS</code> or
                   5619:        <code class="varname">DISTFILES</code>.</p></li>
                   5620: </ul></div>
                   5621: </div>
                   5622: </div>
                   5623: <div class="sect1">
                   5624: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   5625: <a name="makefile.code"></a>15.3. Code snippets</h2></div></div></div>
                   5626: <div class="sect2">
                   5627: <div class="titlepage"><div><div><h3 class="title">
                   5628: <a name="adding-to-list"></a>15.3.1. Adding things to a list</h3></div></div></div>
                   5629: <p>When adding a string that possibly contains whitespace or quotes to
                   5630: a list (example 1), it must be quoted using the <code class="code">:Q</code>
                   5631: modifier.</p>
                   5632: <p>When adding another list to a list (example 2), it must not be
                   5633: quoted, since its elements are already quoted.</p>
1.75      rillig   5634: <pre class="programlisting">
1.299     rillig   5635: STRING=         foo * bar `date`
                   5636: LIST=           # empty
                   5637: ANOTHER_LIST=   a=b c=d
                   5638: 
                   5639: LIST+=          ${STRING:Q}       # 1
                   5640: LIST+=          ${ANOTHER_LIST}   # 2
1.100     rillig   5641: </pre>
1.299     rillig   5642: </div>
                   5643: <div class="sect2">
                   5644: <div class="titlepage"><div><div><h3 class="title">
                   5645: <a name="echo-literal"></a>15.3.2. Echoing a string exactly as-is</h3></div></div></div>
                   5646: <p>Echoing a string containing special characters needs special
                   5647: work.</p>
1.75      rillig   5648: <pre class="programlisting">
1.299     rillig   5649: STRING=         foo bar &lt;    &gt; * `date` $$HOME ' "
                   5650: EXAMPLE_ENV=    string=${STRING:Q} x=multiple\ quoted\ words
                   5651: 
                   5652: all:
                   5653:         echo ${STRING}                  # 1
                   5654:         echo ${STRING:Q}                # 2
                   5655:         printf '%s\n' ${STRING:Q}''     # 3
                   5656:         env ${EXAMPLE_ENV} sh -c 'echo "$$string"; echo "$$x"'   # 4
1.100     rillig   5657: </pre>
1.299     rillig   5658: <p>Example 1 leads to a syntax error in the shell, as the characters
                   5659: are just copied.</p>
                   5660: <p>Example 2 quotes the string so that the shell interprets it
                   5661: correctly. But the echo command may additionally interpret strings with a
                   5662: leading dash or those containing backslashes.</p>
1.311     leot     5663: <p>Example 3 can handle arbitrary strings, since <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/printf.1"><span class="citerefentry"><span class="refentrytitle">printf</span>(1)</span></a> only
1.299     rillig   5664: interprets the format string, but not the next argument. The trailing
                   5665: single quotes handle the case when the string is empty. In that case, the
                   5666: :Q modifier would result in an empty string too, which would then be
1.311     leot     5667: skipped by the shell. For <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/printf.1"><span class="citerefentry"><span class="refentrytitle">printf</span>(1)</span></a> this doesn't make a difference,
1.299     rillig   5668: but other programs may care.</p>
                   5669: <p>In example 4, the <code class="varname">EXAMPLE_ENV</code> does not
                   5670: need to be quoted because the quoting has already been done
                   5671: when adding elements to the list.</p>
1.75      rillig   5672: </div>
1.148     asau     5673: <div class="sect2">
1.75      rillig   5674: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   5675: <a name="cflags-gnu-configure"></a>15.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</h3></div></div></div>
                   5676: <p>When passing <code class="varname">CFLAGS</code> or similar variables to a
                   5677: GNU-style configure script (especially those that call other configure
                   5678: scripts), it must not have leading or trailing whitespace, since
                   5679: otherwise the configure script gets confused. To trim leading and
                   5680: trailing whitespace, use the <code class="code">:M</code> modifier, as in the
                   5681: following example:</p>
1.75      rillig   5682: <pre class="programlisting">
1.299     rillig   5683: CPPFLAGS=               # empty
                   5684: CPPFLAGS+=              -Wundef -DPREFIX=\"${PREFIX}\"
                   5685: CPPFLAGS+=              ${MY_CPPFLAGS}
1.1       grant    5686: 
1.299     rillig   5687: CONFIGURE_ARGS+=        CPPFLAGS=${CPPFLAGS:M*:Q}
1.1       grant    5688: 
1.299     rillig   5689: all:
                   5690:         echo x${CPPFLAGS:Q}x            # leading and trailing whitespace
                   5691:         echo x${CONFIGURE_ARGS:Q}x      # properly trimmed
                   5692: </pre>
                   5693: <p>In this example, <code class="varname">CPPFLAGS</code> has both leading and
                   5694: trailing whitespace because the <code class="code">+=</code> operator always adds a
                   5695: space.</p>
                   5696: </div>
                   5697: <div class="sect2">
                   5698: <div class="titlepage"><div><div><h3 class="title">
                   5699: <a name="empty-variables"></a>15.3.4. Handling possibly empty variables</h3></div></div></div>
                   5700: <p>When a possibly empty variable is used in a shell program, it may
                   5701: lead to a syntax error.</p>
                   5702: <pre class="programlisting">
                   5703: EGFILES=        # empty
1.87      wiz      5704: 
1.299     rillig   5705: install-examples:   # produces a syntax error in the shell
                   5706:         for egfile in ${EGFILES}; do            \
                   5707:                 echo "Installing $$egfile";     \
                   5708:         done
                   5709: </pre>
                   5710: <p>The shell only sees the text <code class="code">for egfile in ; do</code>, since
1.311     leot     5711: <code class="code">${EGFILES}</code> is replaced with an empty string by <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>.
1.299     rillig   5712: To fix this syntax error, use one of the snippets below.</p>
                   5713: <pre class="programlisting">
                   5714: EMPTY=          # empty
1.87      wiz      5715: 
1.299     rillig   5716: install-examples:
                   5717:         for egfile in ${EGFILES} ""; do         \
                   5718:                 [ -n "$$egfile" ] || continue;  \
                   5719:                 echo "Installing $$egfile";     \
                   5720:         done
                   5721: </pre>
                   5722: <p>In this case, an empty string is appended to the iteration list (to
                   5723: prevent the syntax error) and filtered out later.</p>
                   5724: <pre class="programlisting">
                   5725: EGFILES=        # empty
1.87      wiz      5726: 
1.299     rillig   5727: install-examples:
                   5728: .for egfile in ${EGFILES}
                   5729:         echo "Installing ${egfile}"
                   5730: .endfor
1.100     rillig   5731: </pre>
1.299     rillig   5732: <p>If one of the filenames contains special characters, it should be
                   5733: enclosed in single or double quotes.</p>
                   5734: <p>To have a shell command test whether a make variable is empty, use
                   5735: the following code: <code class="code">${TEST} -z ${POSSIBLY_EMPTY:Q}""</code>.</p>
                   5736: </div>
                   5737: </div>
                   5738: </div>
                   5739: <div class="chapter">
                   5740: <div class="titlepage"><div><div><h2 class="title">
                   5741: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
                   5742: <div class="toc">
                   5743: <p><b>Table of Contents</b></p>
                   5744: <dl class="toc">
                   5745: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
                   5746: <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>
                   5747: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
                   5748: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
                   5749: </dl>
1.75      rillig   5750: </div>
1.299     rillig   5751: <p>Many packages have the ability to be built to support different
                   5752: sets of features.  <code class="filename">bsd.options.mk</code> is a framework
                   5753: in pkgsrc that provides generic handling of those options that
                   5754: determine different ways in which the packages can be built.  It's
                   5755: possible for the user to specify exactly which sets of options will be
                   5756: built into a package or to allow a set of global default options
                   5757: apply.</p>
                   5758: <p>There are two broad classes of behaviors that one might want to
                   5759: control via options.  One is whether some particular feature is
                   5760: enabled in a program that will be built anyway, often by including or
                   5761: not including a dependency on some other package.  The other is
                   5762: whether or not an additional program will be built as part of the
                   5763: package.  Generally, it is better to make a split package for such
                   5764: additional programs instead of using options, because it enables
                   5765: binary packages to be built which can then be added separately.  For
                   5766: example, the foo package might have minimal dependencies (those
                   5767: packages without which foo doesn't make sense), and then the foo-gfoo
                   5768: package might include the GTK frontend program gfoo.  This is better
                   5769: than including a gtk option to foo that adds gfoo, because either that
                   5770: option is default, in which case binary users can't get foo without
                   5771: gfoo, or not default, in which case they can't get gfoo.  With split
                   5772: packages, they can install foo without having GTK, and later decide to
                   5773: install gfoo (pulling in GTK at that time).  This is an advantage to
                   5774: source users too, avoiding the need for rebuilds.</p>
                   5775: <p>Plugins with widely varying dependencies should usually be split
                   5776: instead of options.</p>
                   5777: <p>It is often more work to maintain split packages, especially if
                   5778: the upstream package does not support this.  The decision of split
                   5779: vs. option should be made based on the likelihood that users will want
                   5780: or object to the various pieces, the size of the dependencies that are
                   5781: included, and the amount of work.</p>
                   5782: <p>A further consideration is licensing.  Non-free parts, or parts
                   5783: that depend on non-free dependencies (especially plugins) should
                   5784: almost always be split if feasible.</p>
                   5785: <div class="sect1">
                   5786: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   5787: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
                   5788: <p>Global default options are listed in
                   5789: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
                   5790: that should be built into every package if that option is supported.
                   5791: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75      rillig   5792: </div>
1.148     asau     5793: <div class="sect1">
1.75      rillig   5794: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   5795: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
                   5796: </h2></div></div></div>
                   5797: <p>The following example shows how
                   5798: <code class="filename">bsd.options.mk</code> should be used
                   5799: by the hypothetical ``wibble'' package, either in the package
                   5800: <code class="filename">Makefile</code>, or in a file,
                   5801: e.g. <code class="filename">options.mk</code>, that is included by the
                   5802: main package <code class="filename">Makefile</code>.</p>
1.75      rillig   5803: <pre class="programlisting">
1.299     rillig   5804: PKG_OPTIONS_VAR=                PKG_OPTIONS.wibble
                   5805: PKG_SUPPORTED_OPTIONS=          wibble-foo ldap
                   5806: PKG_OPTIONS_OPTIONAL_GROUPS=    database
                   5807: PKG_OPTIONS_GROUP.database=     mysql pgsql
                   5808: PKG_SUGGESTED_OPTIONS=          wibble-foo
                   5809: PKG_OPTIONS_LEGACY_VARS+=       WIBBLE_USE_OPENLDAP:ldap
                   5810: PKG_OPTIONS_LEGACY_OPTS+=       foo:wibble-foo
                   5811: 
                   5812: .include "../../mk/bsd.prefs.mk"
                   5813: 
                   5814: # this package was previously named wibble2
                   5815: .if defined(PKG_OPTIONS.wibble2)
                   5816: PKG_LEGACY_OPTIONS+=            ${PKG_OPTIONS.wibble2}
                   5817: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
                   5818:         "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
                   5819: .endif
                   5820: 
                   5821: .include "../../mk/bsd.options.mk"
                   5822: 
                   5823: # Package-specific option-handling
1.100     rillig   5824: 
1.299     rillig   5825: ###
                   5826: ### FOO support
                   5827: ###
                   5828: .if !empty(PKG_OPTIONS:Mwibble-foo)
                   5829: CONFIGURE_ARGS+=    --enable-foo
                   5830: .endif
1.100     rillig   5831: 
1.299     rillig   5832: ###
                   5833: ### LDAP support
                   5834: ###
                   5835: .if !empty(PKG_OPTIONS:Mldap)
                   5836: .  include "../../databases/openldap-client/buildlink3.mk"
                   5837: CONFIGURE_ARGS+=    --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
                   5838: .endif
1.100     rillig   5839: 
1.299     rillig   5840: ###
                   5841: ### database support
                   5842: ###
                   5843: .if !empty(PKG_OPTIONS:Mmysql)
                   5844: .  include "../../mk/mysql.buildlink3.mk"
                   5845: .endif
                   5846: .if !empty(PKG_OPTIONS:Mpgsql)
                   5847: .  include "../../mk/pgsql.buildlink3.mk"
                   5848: .endif
                   5849: </pre>
                   5850: <p>The first section contains the information about which build
                   5851: options are supported by the package, and any default options settings
                   5852: if needed.</p>
                   5853: <div class="orderedlist"><ol class="orderedlist" type="1">
                   5854: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.311     leot     5855: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> variable that the user can set to override the default
1.299     rillig   5856: options.  It should be set to
                   5857: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
                   5858: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
                   5859: at the point where the options are processed.</p></li>
                   5860: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
                   5861: build options supported by the package.</p></li>
                   5862: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
                   5863: list of names of groups of mutually exclusive options.  The options in
                   5864: each group are listed in
                   5865: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
                   5866: The most specific setting of any option from the group takes
                   5867: precedence over all other options in the group.  Options from the
                   5868: groups will be automatically added to
                   5869: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
                   5870: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
                   5871: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
                   5872: packages will fail if no option from the group is
                   5873: selected.</p></li>
                   5874: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
                   5875: of names of sets of options.  At least one option from each set must
                   5876: be selected.  The options in each set are listed in
                   5877: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
                   5878: Options from the sets will be automatically added to
                   5879: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.  Building the package will
                   5880: fail if no option from the set is selected.</p></li>
                   5881: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
                   5882: build options which are enabled by default.</p></li>
                   5883: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
                   5884: of
                   5885: <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>
                   5886: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
                   5887: their option counterparts.  Pairs should be added with
                   5888: <span class="quote">&#8220;<span class="quote">+=</span>&#8221;</span> to keep the listing of global legacy variables.  A
                   5889: warning will be issued if the user uses a legacy
                   5890: variable.</p></li>
                   5891: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
                   5892: of
                   5893: <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>
                   5894: pairs that map options that have been renamed to their new
                   5895: counterparts.  Pairs should be added with <span class="quote">&#8220;<span class="quote">+=</span>&#8221;</span> to keep
                   5896: the listing of global legacy options.  A warning will be issued if
                   5897: the user uses a legacy option.</p></li>
                   5898: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
                   5899: options implied by deprecated variables used.  This can be used for
                   5900: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
                   5901: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
                   5902: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
                   5903: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
                   5904: a list of warnings about deprecated variables or options used, and
                   5905: what to use instead.</p></li>
                   5906: </ol></div>
                   5907: <p>A package should never modify
                   5908: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
                   5909: <code class="varname">PKG_OPTIONS_VAR</code>.  These are strictly user-settable.
                   5910: To suggest a default set of options, use
                   5911: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
                   5912: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
                   5913: including <code class="filename">bsd.options.mk</code>.  If none of
                   5914: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
                   5915: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
                   5916: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
                   5917: happen with platform-specific options if none of them is supported on
                   5918: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
                   5919: empty list and the package is otherwise treated as not using the
                   5920: options framework.</p>
                   5921: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
                   5922: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
                   5923: build options, properly filtered to remove unsupported and duplicate
                   5924: options.</p>
                   5925: <p>The remaining sections contain the logic that is specific to
                   5926: each option.  The correct way to check for an option is to check
                   5927: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
                   5928: <pre class="programlisting">
                   5929: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
1.100     rillig   5930: </pre>
1.75      rillig   5931: </div>
1.299     rillig   5932: <div class="sect1">
                   5933: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   5934: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
                   5935: <p>Options that enable similar features in different packages (like
                   5936: optional support for a library) should use a common name in all
                   5937: packages that support it (like the name of the library).  If another
                   5938: package already has an option with the same meaning, use the same
                   5939: name.</p>
                   5940: <p>Options that enable features specific to one package, where it's
                   5941: unlikely that another (unrelated) package has the same (or a similar)
                   5942: optional feature, should use a name prefixed with
                   5943: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
                   5944: <p>If a group of related packages share an optional feature
                   5945: specific to that group, prefix it with the name of the
                   5946: <span class="quote">&#8220;<span class="quote">main</span>&#8221;</span> package
                   5947: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
                   5948: <p>For new options, add a line to
                   5949: <code class="filename">mk/defaults/options.description</code>.  Lines have two
                   5950: fields, separated by tab.  The first field is the option name, the
                   5951: second its description.  The description should be a whole sentence
                   5952: (starting with an uppercase letter and ending with a period) that
                   5953: describes what enabling the option does.  E. g. <span class="quote">&#8220;<span class="quote">Enable ispell
                   5954: support.</span>&#8221;</span> The file is sorted by option names.</p>
                   5955: </div>
                   5956: <div class="sect1">
                   5957: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   5958: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
                   5959: <p>When writing <a class="link" href="#buildlink3.mk"><code class="filename">buildlink3.mk</code></a> files, it is often necessary to list
                   5960: different dependencies based on the options with which the package was
                   5961: built. For querying these options, the file
                   5962: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
                   5963: typical example looks like this:</p>
1.87      wiz      5964: <pre class="programlisting">
1.299     rillig   5965: pkgbase := libpurple
                   5966: .include "../../mk/pkg-build-options.mk"
                   5967: 
                   5968: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
                   5969: ...
                   5970: .endif
1.229     sevan    5971: </pre>
1.299     rillig   5972: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
                   5973: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
                   5974: options of the libpurple package, which can then be queried like
                   5975: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
                   5976: file. See the file <code class="filename">pkg-build-options.mk</code> for more
                   5977: details.</p>
1.75      rillig   5978: </div>
                   5979: </div>
1.148     asau     5980: <div class="chapter">
1.75      rillig   5981: <div class="titlepage"><div><div><h2 class="title">
1.299     rillig   5982: <a name="tools"></a>Chapter 17. Tools needed for building or running</h2></div></div></div>
1.75      rillig   5983: <div class="toc">
                   5984: <p><b>Table of Contents</b></p>
1.210     leot     5985: <dl class="toc">
1.299     rillig   5986: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
                   5987: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
                   5988: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
1.75      rillig   5989: </dl>
                   5990: </div>
1.299     rillig   5991: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
                   5992: by pkgsrc and also for individual packages to define what commands
                   5993: are needed for building a package (like <code class="varname">TOOL_DEPENDS</code>)
                   5994: or for later run-time of an installed packaged (such as
                   5995: <code class="varname">DEPENDS</code>).
                   5996: If the native system provides an adequate tool, then in many cases, a pkgsrc
                   5997: package will not be used.</p>
                   5998: <p>When building a package, the replacement tools are
                   5999: made available in a directory (as symlinks or wrapper scripts)
                   6000: that is early in the executable search path. Just like the buildlink
                   6001: system, this helps with consistent builds.</p>
                   6002: <p>A tool may be needed to help build a specific package. For example,
                   6003: perl, GNU make (gmake) or yacc may be needed.</p>
                   6004: <p>Also a tool may be needed, for example, because the native system's supplied
                   6005: tool may be inefficient for building a package with pkgsrc.
                   6006: For example, a package may need GNU awk, bison (instead of
                   6007: yacc) or a better sed.</p>
                   6008: <p>The tools used by a package can be listed by running
                   6009: <span class="command"><strong>make show-tools</strong></span>.</p>
1.148     asau     6010: <div class="sect1">
1.75      rillig   6011: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6012: <a name="pkgsrc-tools"></a>17.1. Tools for pkgsrc builds</h2></div></div></div>
                   6013: <p>The default set of tools used by pkgsrc is defined in
                   6014: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
                   6015: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
                   6016: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
                   6017: These can be seen by running:
                   6018: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
                   6019: <p>If a package needs a specific program to build
                   6020: then the <code class="varname">USE_TOOLS</code> variable can be used
                   6021: to define the tools needed.</p>
1.75      rillig   6022: </div>
1.299     rillig   6023: <div class="sect1">
                   6024: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   6025: <a name="package-tools"></a>17.2. Tools needed by packages</h2></div></div></div>
                   6026: <p>In the following examples, the :run means that it is needed at
                   6027: run-time (and becomes a DEPENDS).
                   6028: The default is a build dependency which can be set with
                   6029: :build. (So in this example, it is the same as gmake:build
                   6030: and pkg-config:build.)</p>
1.75      rillig   6031: <pre class="programlisting">
1.299     rillig   6032: USE_TOOLS+=     gmake perl:run pkg-config
1.1       grant    6033: </pre>
1.299     rillig   6034: <p>When using the tools framework, a
                   6035: <code class="varname">TOOLS_PATH.foo</code> variable is defined
                   6036: which contains the full path to the appropriate tool. For example,
                   6037: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">&#8220;<span class="quote">/bin/bash</span>&#8221;</span>
                   6038: on Linux systems.</p>
                   6039: <p>If you always need a pkgsrc version of the
                   6040: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
                   6041: </p>
1.75      rillig   6042: </div>
1.299     rillig   6043: <div class="sect1">
                   6044: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   6045: <a name="platform-tools"></a>17.3. Tools provided by platforms</h2></div></div></div>
                   6046: <p>When improving or porting pkgsrc to a new platform, have a look
                   6047: at (or create) the corresponding platform specific make file fragment under
                   6048: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
                   6049: the name of the common tools. For example:</p>
1.75      rillig   6050: <pre class="programlisting">
1.299     rillig   6051: .if exists(/usr/bin/bzcat)
                   6052: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzcat
                   6053: .elif exists(/usr/bin/bzip2)
                   6054: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzip2 -cd
                   6055: .endif
                   6056: 
                   6057: TOOLS_PLATFORM.true?=           true                    # shell builtin
1.1       grant    6058: </pre>
1.75      rillig   6059: </div>
                   6060: </div>
1.299     rillig   6061: <div class="chapter">
                   6062: <div class="titlepage"><div><div><h2 class="title">
                   6063: <a name="buildlink"></a>Chapter 18. Buildlink methodology</h2></div></div></div>
                   6064: <div class="toc">
                   6065: <p><b>Table of Contents</b></p>
                   6066: <dl class="toc">
                   6067: <dt><span class="sect1"><a href="#converting-to-buildlink3">18.1. Converting packages to use buildlink3</a></span></dt>
                   6068: <dt><span class="sect1"><a href="#creating-buildlink3.mk">18.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
                   6069: <dd><dl>
                   6070: <dt><span class="sect2"><a href="#anatomy-of-bl3">18.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
                   6071: <dt><span class="sect2"><a href="#updating-buildlink-depends">18.2.2. Updating
                   6072:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6073:       and
                   6074:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6075:       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
                   6076: </dl></dd>
                   6077: <dt><span class="sect1"><a href="#writing-builtin.mk">18.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
                   6078: <dd><dl>
                   6079: <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>
                   6080: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">18.3.2. Global preferences for native or pkgsrc software</a></span></dt>
                   6081: </dl></dd>
                   6082: </dl>
1.75      rillig   6083: </div>
1.299     rillig   6084: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
                   6085:   are seen by a package's configure and build processes.  This is implemented
                   6086:   in a two step process:</p>
                   6087: <div class="orderedlist"><ol class="orderedlist" type="1">
                   6088: <li class="listitem"><p>Symlink headers and libraries for dependencies into
                   6089:       <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
                   6090:       of <code class="varname">WRKDIR</code>.</p></li>
                   6091: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
                   6092:       tools that translate <code class="option">-I${LOCALBASE}/include</code> and
                   6093:       <code class="option">-L${LOCALBASE}/lib</code> into references to
                   6094:       <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
                   6095:       native compiler on some operating systems look like GCC, so that
                   6096:       packages that expect GCC won't require modifications to build with
                   6097:       those native compilers.</p></li>
                   6098: </ol></div>
                   6099: <p>This normalizes the environment in which a package is built so that the
                   6100:   package may be built consistently despite what other software may be
                   6101:   installed. Please note that the normal system header and library paths,
                   6102:   e.g. <code class="filename">/usr/include</code>,
                   6103:   <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
                   6104:   designed to insulate the package build from non-system-supplied
                   6105:   software.</p>
1.148     asau     6106: <div class="sect1">
1.75      rillig   6107: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6108: <a name="converting-to-buildlink3"></a>18.1. Converting packages to use buildlink3</h2></div></div></div>
                   6109: <p>The process of converting packages to use the buildlink3
                   6110:     framework (<span class="quote">&#8220;<span class="quote">bl3ifying</span>&#8221;</span>) is fairly straightforward.
                   6111:     The things to keep in mind are:</p>
1.128     wiz      6112: <div class="orderedlist"><ol class="orderedlist" type="1">
1.299     rillig   6113: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
                   6114:        instead of the actual toolchain.  Some packages are tricky,
                   6115:        and the only way to know for sure is the check
                   6116:        <code class="filename">${WRKDIR}/.work.log</code> to see if the
                   6117:        wrappers are being invoked.</p></li>
                   6118: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
                   6119:        the package Makefile, e.g. Java VMs, standalone shells,
                   6120:        etc., because the code to symlink files into
                   6121:        <code class="filename">${BUILDLINK_DIR}</code> looks for files
                   6122:        relative to <span class="quote">&#8220;<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>&#8221;</span>.
                   6123:        </p></li>
                   6124: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
                   6125:        <code class="filename">buildlink3.mk</code> files that you list in a
                   6126:        package's Makefile are added as dependencies for that package.
                   6127:        </p></li>
                   6128: </ol></div>
                   6129: <p>If a dependency on a particular package is required for its libraries and
                   6130:     headers, then we replace:</p>
                   6131: <pre class="programlisting">
                   6132: DEPENDS+=       foo&gt;=1.1.0:../../category/foo
                   6133: </pre>
                   6134: <p>with</p>
                   6135: <pre class="programlisting">
                   6136: .include "../../category/foo/buildlink3.mk"
                   6137: </pre>
                   6138: <p>The buildlink3.mk files usually define the required dependencies.
                   6139:     If you need a newer version of the dependency when using buildlink3.mk
                   6140:     files, then you can define it in your Makefile; for example:</p>
1.75      rillig   6141: <pre class="programlisting">
1.299     rillig   6142: BUILDLINK_API_DEPENDS.foo+=   foo&gt;=1.1.0
                   6143: .include "../../category/foo/buildlink3.mk"
1.1       grant    6144: </pre>
1.299     rillig   6145: <p>There are several <code class="filename">buildlink3.mk</code>
                   6146:     files in <code class="filename">pkgsrc/mk</code>
                   6147:     that handle special package issues:</p>
                   6148: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6149: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
                   6150:        the native or a pkgsrc Berkeley DB implementation based on
                   6151:        the values of <code class="varname">BDB_ACCEPTED</code> and
                   6152:        <code class="varname">BDB_DEFAULT</code>.</p></li>
                   6153: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
                   6154:        comes with neither Curses nor NCurses, this will take care
                   6155:        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>
                   6156: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
                   6157:        of <code class="varname">KRB5_ACCEPTED</code> to choose between
                   6158:        adding a dependency on Heimdal or MIT-krb5 for packages that
                   6159:        require a Kerberos 5 implementation.</p></li>
                   6160: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
                   6161:        system-provided Motif installation or adds a dependency on
                   6162:        <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
                   6163:        <code class="varname">MOTIF_TYPE</code> to <span class="quote">&#8220;<span class="quote">dt</span>&#8221;</span>,
                   6164:        <span class="quote">&#8220;<span class="quote">lesstif</span>&#8221;</span> or <span class="quote">&#8220;<span class="quote">motif</span>&#8221;</span>
                   6165:        to choose which Motif version will be used.</p></li>
                   6166: <li class="listitem"><p><code class="filename">readline.buildlink3.mk</code> checks for a
                   6167:        system-provided GNU readline or editline (libedit) installation,
                   6168:        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>,
                   6169:        <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
                   6170:        <code class="varname">READLINE_DEFAULT</code> to choose readline implementation.
                   6171:        If your package really needs GNU readline library, its Makefile
                   6172:        should include <code class="filename">devel/readline/buildlink3.mk</code>
                   6173:        instead of <code class="filename">readline.buildlink3.mk</code>.</p></li>
                   6174: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
                   6175:        variables that may be used by packages that use the
                   6176:        Open Sound System (OSS) API.</p></li>
                   6177: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
                   6178:        any of the Postgres versions in the variable
                   6179:        <code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
                   6180:        the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
                   6181:        the file for more information.</p></li>
                   6182: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
                   6183:        <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
                   6184:        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>
                   6185: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
                   6186:        <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
                   6187:        library.</p></li>
                   6188: </ul></div>
                   6189: <p>The comments in those <code class="filename">buildlink3.mk</code>
                   6190:     files provide a more complete
                   6191:     description of how to use them properly.</p>
1.75      rillig   6192: </div>
1.148     asau     6193: <div class="sect1">
1.75      rillig   6194: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6195: <a name="creating-buildlink3.mk"></a>18.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
                   6196: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
                   6197:     included by Makefiles to indicate the need to compile and link
                   6198:     against header files and libraries provided by the package.  A
                   6199:     <code class="filename">buildlink3.mk</code> file should always provide
                   6200:     enough information to add the correct type of dependency
                   6201:     relationship and include any other
                   6202:     <code class="filename">buildlink3.mk</code> files that it needs to find
                   6203:     headers and libraries that it needs in turn.</p>
                   6204: <p>To generate an initial <code class="filename">buildlink3.mk</code>
                   6205:     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>
                   6206:     package is highly recommended.  For most packages, the following
                   6207:     command will generate a good starting point for
                   6208:     <code class="filename">buildlink3.mk</code> files:</p>
                   6209: <pre class="screen">
                   6210: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
                   6211: <code class="prompt">%</code> createbuildlink &gt;buildlink3.mk</code></strong>
                   6212:     </pre>
1.148     asau     6213: <div class="sect2">
1.75      rillig   6214: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   6215: <a name="anatomy-of-bl3"></a>18.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
                   6216: <p>The following real-life example
                   6217:       <code class="filename">buildlink3.mk</code> is taken
                   6218:       from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
1.75      rillig   6219: <pre class="programlisting">
1.299     rillig   6220: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
                   6221: 
                   6222: BUILDLINK_TREE+=        tiff
                   6223: 
                   6224: .if !defined(TIFF_BUILDLINK3_MK)
                   6225: TIFF_BUILDLINK3_MK:=
                   6226: 
                   6227: BUILDLINK_API_DEPENDS.tiff+=    tiff&gt;=3.6.1
                   6228: BUILDLINK_ABI_DEPENDS.tiff+=    tiff&gt;=3.7.2nb1
                   6229: BUILDLINK_PKGSRCDIR.tiff?=      ../../graphics/tiff
                   6230: 
                   6231: .include "../../devel/zlib/buildlink3.mk"
                   6232: .include "../../graphics/jpeg/buildlink3.mk"
                   6233: .endif # TIFF_BUILDLINK3_MK
                   6234: 
                   6235: BUILDLINK_TREE+=        -tiff
1.1       grant    6236: </pre>
1.299     rillig   6237: <p>The header and footer manipulate
                   6238:       <code class="varname">BUILDLINK_TREE</code>, which is common across all
                   6239:       <code class="filename">buildlink3.mk</code> files and is used to track
                   6240:       the dependency tree.</p>
                   6241: <p>The main section is protected from multiple inclusion
                   6242:       and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
                   6243:       added.  Several important variables are set in the section:</p>
                   6244: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6245: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300     wiz      6246:          is the dependency version recorded in the installed
1.299     rillig   6247:          package; this should always be set using
                   6248:          <span class="command"><strong>+=</strong></span> to ensure that
                   6249:          we're appending to any pre-existing list of values.  This
1.300     wiz      6250:          variable should be set to the last version of the
1.299     rillig   6251:          package that had an backwards-incompatible API change.
                   6252:          </p></li>
                   6253: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
                   6254:          is the location of the <em class="replaceable"><code>pkg</code></em>
                   6255:          pkgsrc directory.</p></li>
                   6256: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
                   6257:          (not shown above) controls whether we use
                   6258:          <code class="varname">BUILD_DEPENDS</code> or
                   6259:          <code class="varname">DEPENDS</code> to add the dependency on
                   6260:          <em class="replaceable"><code>pkg</code></em>.  The build dependency is
                   6261:          selected by setting
                   6262:          <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
                   6263:          to <span class="quote">&#8220;<span class="quote">build</span>&#8221;</span>.  By default, the full dependency is
                   6264:          used.</p></li>
                   6265: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
                   6266:            and
                   6267:            <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
                   6268:            (not shown above) are lists of subdirectories of
                   6269:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
                   6270:            to add to the header and library search paths.  These
                   6271:            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>
                   6272:          respectively.</p></li>
                   6273: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
                   6274:            (not shown above) is the list of preprocessor flags to add
                   6275:            to <code class="varname">CPPFLAGS</code>, which are passed on to the
                   6276:            configure and build phases.  The <span class="quote">&#8220;<span class="quote">-I</span>&#8221;</span> option
                   6277:            should be avoided and instead be handled using
                   6278:            <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
                   6279:          above.</p></li>
                   6280: </ul></div>
                   6281: <p>The following variables are all optionally defined within
                   6282:       this second section (protected against multiple inclusion) and
                   6283:       control which package files are symlinked into
                   6284:       <code class="filename">${BUILDLINK_DIR}</code> and how their names are
                   6285:       transformed during the symlinking:</p>
                   6286: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6287: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
                   6288:            (not shown above) is a shell glob pattern relative to
                   6289:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
                   6290:            to be symlinked into
                   6291:            <code class="filename">${BUILDLINK_DIR}</code>,
                   6292:          e.g. <code class="filename">include/*.h</code>.</p></li>
                   6293: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
                   6294:            (not shown above) is a shell pipeline that
                   6295:            outputs to stdout a list of files relative to
                   6296:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
                   6297:            The resulting files are to be symlinked
                   6298:            into <code class="filename">${BUILDLINK_DIR}</code>.  By default,
                   6299:            this takes the <code class="filename">+CONTENTS</code> of a
                   6300:            <em class="replaceable"><code>pkg</code></em> and filters it through
                   6301:            <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
                   6302: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
                   6303:            (not shown above) is a filter command that filters
                   6304:            <code class="filename">+CONTENTS</code> input into a list of files
                   6305:            relative to
                   6306:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
                   6307:            on stdout.  By default,
                   6308:            <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
                   6309:            outputs the contents of the <code class="filename">include</code>
                   6310:            and <code class="filename">lib</code> directories in the package
                   6311:            <code class="filename">+CONTENTS</code>.</p></li>
                   6312: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
                   6313:            (not shown above) is a list of sed arguments used to
                   6314:            transform the name of the source filename into a
                   6315:            destination filename, e.g. <span class="command"><strong>-e
                   6316:            "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
                   6317: </ul></div>
                   6318: <p>This section can additionally include any
                   6319:       <code class="filename">buildlink3.mk</code> needed for
                   6320:       <em class="replaceable"><code>pkg</code></em>'s library dependencies.
                   6321:       Including these <code class="filename">buildlink3.mk</code> files
                   6322:       means that the headers and libraries for these
                   6323:       dependencies are also symlinked into
                   6324:       <code class="filename">${BUILDLINK_DIR}</code>
                   6325:       whenever the <em class="replaceable"><code>pkg</code></em>
                   6326:       <code class="filename">buildlink3.mk</code>
                   6327:       file is included. Dependencies are only added for directly
                   6328:       include <code class="filename">buildlink3.mk</code> files.</p>
                   6329: <p>When providing a <code class="filename">buildlink3.mk</code> and
                   6330:       including other <code class="filename">buildlink3.mk</code> files in it,
                   6331:       please only add necessary ones, i.e., those whose libraries or
                   6332:       header files are automatically exposed when the package is
                   6333:       use.</p>
                   6334: <p>In particular, if only an executable
                   6335:       (<code class="filename">bin/foo</code>) is linked against a library, that
                   6336:       library does not need to be propagated in the
                   6337:       <code class="filename">buildlink3.mk</code> file.</p>
                   6338: <p>The following steps should help you decide if a
                   6339:       <code class="filename">buildlink3.mk</code> file needs to be included:
                   6340:       </p>
                   6341: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6342: <li class="listitem"><p>Look at the installed header files: What
                   6343:        headers do they include? The packages providing these files
                   6344:        must be buildlinked.</p></li>
                   6345: <li class="listitem"><p>Run <code class="filename">ldd</code> on all installed
                   6346:        libraries and look against what other libraries they link.
                   6347:        Some of the packages providing these probably need to be
                   6348:        buildlinked; however, it's not automatic, since e.g. GTK on
                   6349:        some systems pulls in the X libraries, so they will show up in
                   6350:        the <code class="filename">ldd</code> output, while on others (like OS
                   6351:        X) it won't. <code class="filename">ldd</code> output can thus only be
                   6352:        used as a hint.</p></li>
                   6353: </ul></div>
                   6354: <p>
                   6355:       </p>
                   6356: </div>
1.148     asau     6357: <div class="sect2">
1.75      rillig   6358: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   6359: <a name="updating-buildlink-depends"></a>18.2.2. Updating
                   6360:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6361:       and
                   6362:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6363:       in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
1.300     wiz      6364: <p>Both variables set lower bounds for a version of this package.
                   6365:       The two variables differ in that one describes source
1.299     rillig   6366:       compatibility (API) and the other binary compatibility (ABI).
                   6367:       The difference is that a change in the API breaks compilation of
                   6368:       programs while changes in the ABI stop compiled programs from
                   6369:       running.</p>
1.300     wiz      6370: <p>The
                   6371:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6372:       variable in a <code class="filename">buildlink3.mk</code> should be
                   6373:       changed very rarely.  (One possible scenario: If all packages
                   6374:       using this package need a higher version than defined in the
                   6375:       <code class="filename">buildlink3.mk</code>,
1.299     rillig   6376:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300     wiz      6377:       could be updated to that higher version.)</p>
                   6378: <p>On the other hand, changes to
1.299     rillig   6379:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300     wiz      6380:       are more common.  The variable will need to be updated every
                   6381:       time the major version of one of its shared libraries is changed,
                   6382:       or any other change where a binary built against the previous
                   6383:       version of the package will not run against the new version any
                   6384:       longer.</p>
                   6385: <p>In such a case, the package's
1.299     rillig   6386:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300     wiz      6387:       must be increased to require the new package version.  Then the
                   6388:       <code class="varname">PKGREVISION</code> of all packages
                   6389:       <em class="replaceable"><code>foo</code></em> that depend on this package need
                   6390:       to be increased, and if they have
                   6391:       <code class="filename">buildlink3.mk</code> files,
                   6392:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>foo</code></em></code>
                   6393:       in their <code class="filename">buildlink3.mk</code> files must be
                   6394:       increased to the new version as well. This is required so that a
                   6395:       package will pull in the versions of the packages that use the
                   6396:       new ABI and that the packages' <code class="varname">PKGREVISION</code>s
                   6397:       uniquely identify the packages built against the new ABI. The
                   6398:       <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
                   6399:       help with these updates.</p>
                   6400: <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
                   6401:       about dependencies on other packages, including the
                   6402:       <code class="varname">BUILDLINK_API_DEPENDS</code> definitions.</p>
1.299     rillig   6403: <p>Please take careful consideration before adjusting
                   6404:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6405:       or
                   6406:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.300     wiz      6407:       in a <code class="filename">buildlink3.mk</code> file as we don't want to
                   6408:       cause unneeded package deletions and rebuilds.  In many cases,
                   6409:       new versions of packages work just fine with older
                   6410:       dependencies.</p>
1.299     rillig   6411: <p>Also it is not needed to set
                   6412:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6413:       when it is identical to
                   6414:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.        </p>
1.75      rillig   6415: </div>
                   6416: </div>
1.148     asau     6417: <div class="sect1">
1.75      rillig   6418: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6419: <a name="writing-builtin.mk"></a>18.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
                   6420: <p>Some packages in pkgsrc install headers and libraries that
                   6421:       coincide with headers and libraries present in the base system.
                   6422:       Aside from a <code class="filename">buildlink3.mk</code> file, these
                   6423:       packages should also include a <code class="filename">builtin.mk</code>
                   6424:       file that includes the necessary checks to decide whether using
                   6425:       the built-in software or the pkgsrc software is
                   6426:     appropriate.</p>
                   6427: <p>The only requirements of a builtin.mk file for
                   6428:     <em class="replaceable"><code>pkg</code></em> are:</p>
                   6429: <div class="orderedlist"><ol class="orderedlist" type="1">
                   6430: <li class="listitem"><p>It should set
                   6431:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6432:        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>
                   6433:        after it is included.</p></li>
                   6434: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
                   6435:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6436:        which is already set before the
                   6437:        <code class="filename">builtin.mk</code> file is included.</p></li>
                   6438: <li class="listitem"><p>It should be written to allow multiple inclusion.  This
                   6439:        is <span class="emphasis"><em>very</em></span> important and takes careful
                   6440:        attention to <code class="filename">Makefile</code> coding.</p></li>
                   6441: </ol></div>
                   6442: <div class="sect2">
                   6443: <div class="titlepage"><div><div><h3 class="title">
                   6444: <a name="anatomy-of-builtin.mk"></a>18.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</h3></div></div></div>
                   6445: <p>The following is the recommended template for builtin.mk
                   6446:       files:</p>
1.75      rillig   6447: <pre class="programlisting">
1.299     rillig   6448: .if !defined(IS_BUILTIN.foo)
                   6449: #
                   6450: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
                   6451: # genuinely exists in the system or not.
                   6452: #
                   6453: IS_BUILTIN.foo?=        no
1.100     rillig   6454: 
1.299     rillig   6455: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
                   6456: # version can be determined.
                   6457: #
                   6458: .  if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
                   6459: BUILTIN_PKG.foo?=       foo-1.0
                   6460: .  endif
                   6461: .endif  # IS_BUILTIN.foo
1.100     rillig   6462: 
1.299     rillig   6463: .if !defined(USE_BUILTIN.foo)
                   6464: USE_BUILTIN.foo?=       ${IS_BUILTIN.foo}
                   6465: .  if defined(BUILTIN_PKG.foo)
                   6466: .    for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
                   6467: .      if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
                   6468: USE_BUILTIN.foo!=                                                       \
                   6469:         ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo}            \
                   6470:         &amp;&amp; ${ECHO} "yes" || ${ECHO} "no"
                   6471: .      endif
                   6472: .    endfor
                   6473: .  endif
                   6474: .endif  # USE_BUILTIN.foo
1.100     rillig   6475: 
1.299     rillig   6476: CHECK_BUILTIN.foo?=     no
                   6477: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
                   6478: #
                   6479: # Here we place code that depends on whether USE_BUILTIN.foo is set to
                   6480: # "yes" or "no".
                   6481: #
                   6482: .endif  # CHECK_BUILTIN.foo
1.75      rillig   6483: </pre>
1.299     rillig   6484: <p>The first section sets
                   6485:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6486:       depending on if <em class="replaceable"><code>pkg</code></em> really exists
                   6487:       in the base system.  This should not be a base system software
                   6488:       with similar functionality to <em class="replaceable"><code>pkg</code></em>;
                   6489:       it should only be <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> if the actual package is
                   6490:       included as part of the base system.  This variable is only
                   6491:       used internally within the <code class="filename">builtin.mk</code>
                   6492:       file.</p>
                   6493: <p>The second section sets
                   6494:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   6495:       to the version of <em class="replaceable"><code>pkg</code></em> in the base
                   6496:       system if it exists (if
                   6497:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6498:       is <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>).  This variable is only used internally
                   6499:       within the <code class="filename">builtin.mk</code> file.</p>
                   6500: <p>The third section sets
                   6501:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6502:       and is <span class="emphasis"><em>required</em></span> in all
                   6503:       <code class="filename">builtin.mk</code> files.  The code in this
                   6504:       section must make the determination whether the built-in
                   6505:       software is adequate to satisfy the dependencies listed in
                   6506:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   6507:       This is typically done by comparing
                   6508:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   6509:       against each of the dependencies in
                   6510:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   6511:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6512:       <span class="emphasis"><em>must</em></span> be set to the correct value by the
                   6513:       end of the <code class="filename">builtin.mk</code> file.  Note that
                   6514:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6515:       may be <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> even if
                   6516:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6517:       is <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span> because we may make the determination
                   6518:       that the built-in version of the software is similar enough to
                   6519:       be used as a replacement.</p>
                   6520: <p>The last section is guarded by
                   6521:       <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
                   6522:       and includes code that uses the value of
                   6523:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6524:       set in the previous section.  This typically includes, e.g.,
                   6525:       adding additional dependency restrictions and listing additional
                   6526:       files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
                   6527:       <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
                   6528: </div>
                   6529: <div class="sect2">
                   6530: <div class="titlepage"><div><div><h3 class="title">
                   6531: <a name="native-or-pkgsrc-preference"></a>18.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
                   6532: <p>When building packages, it's possible to choose whether to set
                   6533:        a global preference for using either the built-in (native)
                   6534:        version or the pkgsrc version of software to satisfy a
                   6535:        dependency.  This is controlled by setting
                   6536:        <code class="varname">PREFER_PKGSRC</code> and
                   6537:        <code class="varname">PREFER_NATIVE</code>.  These variables take values
                   6538:        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
                   6539:        packages.  <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
                   6540:        use the pkgsrc versions of software, while
                   6541:        <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
                   6542:        built-in versions.  Preferences are determined by the most
                   6543:        specific instance of the package in either
                   6544:        <code class="varname">PREFER_PKGSRC</code> or
                   6545:        <code class="varname">PREFER_NATIVE</code>.  If a package is specified
                   6546:        in neither or in both variables, then
                   6547:        <code class="varname">PREFER_PKGSRC</code> has precedence over
                   6548:        <code class="varname">PREFER_NATIVE</code>.  For example, to require
                   6549:        using pkgsrc versions of software for all but the most basic
                   6550:       bits on a NetBSD system, you can set:</p>
1.75      rillig   6551: <pre class="programlisting">
1.299     rillig   6552: PREFER_PKGSRC=  yes
                   6553: PREFER_NATIVE=  getopt skey tcp_wrappers
                   6554: </pre>
                   6555: <p>A package <span class="emphasis"><em>must</em></span> have a
                   6556:       <code class="filename">builtin.mk</code>
                   6557:       file to be listed in <code class="varname">PREFER_NATIVE</code>,
                   6558:       otherwise it is simply ignored in that list.</p>
1.305     bacon    6559: <p><code class="varname">PREFER_PKGSRC</code> and
                   6560:       <code class="varname">PREFER_NATIVE</code> should be set during bootstrap
                   6561:       to ensure that the bootstrap process does not use inapropriate
                   6562:       native tools as dependencies for core packages.
                   6563: 
                   6564: </p>
                   6565: <pre class="screen">
                   6566: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap --prefer-pkgsrc yes --prefer-native openssl</code></strong>
                   6567: </pre>
                   6568: <p>
                   6569: 
1.299     rillig   6570:       Switching between settings globally at a later date can introduce
                   6571:       complications with dependency resolution. This is caused by packages
1.305     bacon    6572:       built with the opposite preference being installed alongside each
                   6573:       other.  Hence, any changes to these variables after bootstrap will
                   6574:       necessitate rebuilding all packages depending on one whose preference
                   6575:       has been changed.  This is not trivial and should be avoided.</p>
                   6576: <p>When using pkgsrc on Linux systems, there is high risk of
                   6577:       "leakage", where programs installed by pkgsrc may inadvertently use a
                   6578:       command or library not installed by pkgsrc, e.g. those installed by
                   6579:       yum or apt.  Such foreign dependencies may be installed, removed, or
                   6580:       upgraded to a version incompatible with the pkgsrc package at any
                   6581:       time, causing pkgsrc packages to subsequently malfunction.  Pkgsrc
                   6582:       cannot prevent this, as it has no control over other package managers.
                   6583:       Another potential problem is that under Redhat Enterprise and related
                   6584:       Linux systems, yum packages are only patched and never upgraded, so
                   6585:       eventually they may become too outdated for use by pkgsrc.  Even
                   6586:       intentionally using foreign dependencies, not considered leakage, can
                   6587:       lead to these problems, so it is generally discouraged.  In order to
                   6588:       minimize such problems, PREFER_PKGSRC defaults to "yes" on Linux systems.
                   6589:       This ensures that pkgsrc is aware of any changes to dependency packages
                   6590:       and can rebuild or upgrade the entire dependency tree as needed.  This
                   6591:       default can be overridden by setting --prefer-pkgsrc to "no" or a list of
                   6592:       packages, or by setting --prefer-native to "yes".</p>
1.75      rillig   6593: </div>
1.107     rillig   6594: </div>
1.75      rillig   6595: </div>
1.148     asau     6596: <div class="chapter">
1.75      rillig   6597: <div class="titlepage"><div><div><h2 class="title">
1.299     rillig   6598: <a name="plist"></a>Chapter 19. PLIST issues</h2></div></div></div>
1.75      rillig   6599: <div class="toc">
                   6600: <p><b>Table of Contents</b></p>
1.210     leot     6601: <dl class="toc">
1.299     rillig   6602: <dt><span class="sect1"><a href="#rcs-id">19.1. RCS ID</a></span></dt>
                   6603: <dt><span class="sect1"><a href="#automatic-plist-generation">19.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                   6604: <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>
                   6605: <dt><span class="sect1"><a href="#plist.misc">19.4. Variable substitution in PLIST</a></span></dt>
                   6606: <dt><span class="sect1"><a href="#manpage-compression">19.5. Man page compression</a></span></dt>
                   6607: <dt><span class="sect1"><a href="#using-PLIST_SRC">19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
                   6608: <dt><span class="sect1"><a href="#platform-specific-plist">19.7. Platform-specific and differing PLISTs</a></span></dt>
                   6609: <dt><span class="sect1"><a href="#build-plist">19.8. Build-specific PLISTs</a></span></dt>
                   6610: <dt><span class="sect1"><a href="#faq.common-dirs">19.9. Sharing directories between packages</a></span></dt>
1.75      rillig   6611: </dl>
                   6612: </div>
1.299     rillig   6613: <p>The <code class="filename">PLIST</code> file contains a package's
                   6614:   <span class="quote">&#8220;<span class="quote">packing list</span>&#8221;</span>, i.e. a list of files that belong to
                   6615:   the package (relative to the <code class="filename">${PREFIX}</code>
                   6616:   directory it's been installed in) plus some additional statements
1.311     leot     6617:   - see the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/pkg_create.1"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> man page for a full list.
1.299     rillig   6618:   This chapter addresses some issues that need attention when
                   6619:   dealing with the <code class="filename">PLIST</code> file (or files, see
                   6620:   below!).</p>
1.148     asau     6621: <div class="sect1">
1.75      rillig   6622: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6623: <a name="rcs-id"></a>19.1. RCS ID</h2></div></div></div>
                   6624: <p>Be sure to add a RCS ID line as the first thing in any
                   6625:     <code class="filename">PLIST</code> file you write:</p>
                   6626: <pre class="programlisting">
                   6627: @comment $NetBSD $
                   6628: </pre>
                   6629: <p>An artificial space has been added between NetBSD and $, this is a
                   6630: workaround here to prevent CVS expanding to the filename of the guide. When
                   6631: adding the RCS ID the space should be omitted.</p>
1.75      rillig   6632: </div>
1.148     asau     6633: <div class="sect1">
1.75      rillig   6634: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6635: <a name="automatic-plist-generation"></a>19.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
                   6636: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
                   6637:     to output a PLIST that matches any new files since the package
                   6638:     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
                   6639:     more information on this target.</p>
1.75      rillig   6640: </div>
1.148     asau     6641: <div class="sect1">
1.75      rillig   6642: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6643: <a name="print-PLIST"></a>19.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
                   6644: </h2></div></div></div>
                   6645: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
                   6646:     of AWK patterns and actions that are used to filter the output of
                   6647:     print-PLIST.  You can <span class="emphasis"><em>append</em></span> any chunk of AWK
                   6648:     scripting you like to it, but be careful with quoting.</p>
                   6649: <p>For example, to get all files inside the
                   6650:     <code class="filename">libdata/foo</code> directory removed from the
                   6651:     resulting PLIST:</p>
1.88      wiz      6652: <pre class="programlisting">
1.299     rillig   6653: PRINT_PLIST_AWK+=       /^libdata\/foo/ { next; }
1.100     rillig   6654: </pre>
1.300     wiz      6655: <p>The <code class="varname">PRINT_PLIST_AWK</code> transformations are
                   6656:     evaluated after the file list and directory list are sorted.
                   6657:     <code class="varname">EARLY_PRINT_PLIST_AWK</code> is like
                   6658:     <code class="varname">PRINT_PLIST_AWK</code> except it operates before the file
                   6659:     list and directory list are sorted.</p>
1.299     rillig   6660: </div>
                   6661: <div class="sect1">
                   6662: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   6663: <a name="plist.misc"></a>19.4. Variable substitution in PLIST</h2></div></div></div>
                   6664: <p>A number of variables are substituted automatically in
                   6665:     PLISTs when a package is installed on a system. This includes the
                   6666:     following variables:</p>
                   6667: <div class="variablelist"><dl class="variablelist">
                   6668: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
                   6669: <dd>
                   6670: <p>Some packages like emacs and perl embed information
                   6671:          about which architecture they were built on into the
                   6672:          pathnames where they install their files. To handle this
                   6673:          case, PLIST will be preprocessed before actually used, and
                   6674:          the symbol
                   6675:          <span class="quote">&#8220;<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>&#8221;</span> will be
                   6676:          replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
                   6677:          same is done if the string
                   6678:          <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
                   6679:          PLIST somewhere - use this on packages that have GNU
                   6680:          autoconf-created configure scripts.</p>
                   6681: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   6682: <h3 class="title">Legacy note</h3>
                   6683: <p>There used to be a symbol
                   6684:            <span class="quote">&#8220;<span class="quote"><code class="varname">$ARCH</code></span>&#8221;</span> that
                   6685:            was replaced by the output of <span class="command"><strong>uname
                   6686:            -m</strong></span>, but that's no longer supported and has
                   6687:            been removed.</p>
                   6688: </div>
                   6689: </dd>
                   6690: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
                   6691: <dd>
                   6692: <p>Some packages want to embed the OS name and version
                   6693:          into some paths.  To do this, use these variables in the
                   6694:          <code class="filename">PLIST</code>:
                   6695:          </p>
                   6696: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6697: <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>
                   6698: <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>
                   6699: <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>
                   6700: </ul></div>
                   6701: </dd>
                   6702: </dl></div>
                   6703: <p>For a list of values which are replaced by
                   6704:     default, the output of <span class="command"><strong>make help topic=PLIST_SUBST</strong></span> as
                   6705: well as searching the <code class="filename">pkgsrc/mk</code> directory with <span class="command"><strong>grep</strong></span> for
                   6706: <code class="varname">PLIST_SUBST</code> should help.</p>
                   6707: <p>If you want to change other variables not listed above, you
                   6708:     can add variables and their expansions to this variable in the
                   6709:     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   6710: <pre class="programlisting">
1.299     rillig   6711: PLIST_SUBST+=   SOMEVAR="somevalue"
1.100     rillig   6712: </pre>
1.299     rillig   6713: <p>This replaces all occurrences of <span class="quote">&#8220;<span class="quote">${SOMEVAR}</span>&#8221;</span>
                   6714:     in the <code class="filename">PLIST</code> with
                   6715:     <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span>.</p>
                   6716: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
                   6717:     the common case of conditionally including some
                   6718:     <code class="filename">PLIST</code> entries. It can be done by adding
                   6719:     <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
                   6720:     setting the corresponding <code class="varname">PLIST.foo</code> variable
                   6721:     to <code class="literal">yes</code> if the entry should be included.
                   6722:     This will substitute <span class="quote">&#8220;<span class="quote"><code class="varname">${PLIST.foo}</code></span>&#8221;</span>
                   6723:     in the <code class="filename">PLIST</code> with either
                   6724:     <span class="quote">&#8220;<span class="quote"><code class="literal">""</code></span>&#8221;</span> or
                   6725:     <span class="quote">&#8220;<span class="quote"><code class="literal">"@comment "</code></span>&#8221;</span>.
                   6726:     For example, in <code class="filename">Makefile</code>:</p>
1.174     asau     6727: <pre class="programlisting">
1.299     rillig   6728: PLIST_VARS+=    foo
                   6729: .if <em class="replaceable"><code>condition</code></em>
                   6730: PLIST.foo=      yes
                   6731: .else
1.174     asau     6732: </pre>
1.299     rillig   6733: <p>And then in <code class="filename">PLIST</code>:</p>
1.81      rillig   6734: <pre class="programlisting">
1.299     rillig   6735: @comment $NetBSD $
                   6736: bin/bar
                   6737: man/man1/bar.1
                   6738: ${PLIST.foo}bin/foo
                   6739: ${PLIST.foo}man/man1/foo.1
                   6740: ${PLIST.foo}share/bar/foo.data
1.100     rillig   6741: </pre>
1.299     rillig   6742: <p>An artificial space has been added between NetBSD and $, this is a
                   6743: workaround here to prevent CVS expanding to the filename of the guide. When
1.309     gutterid 6744: adding the RCS ID the space should be omitted.</p>
1.81      rillig   6745: </div>
1.299     rillig   6746: <div class="sect1">
                   6747: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   6748: <a name="manpage-compression"></a>19.5. Man page compression</h2></div></div></div>
                   6749: <p>Man pages should be installed in compressed form if
                   6750:     <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
                   6751:     and uncompressed otherwise. To handle this in the
                   6752:     <code class="filename">PLIST</code> file, the suffix <span class="quote">&#8220;<span class="quote">.gz</span>&#8221;</span> is
                   6753:     appended/removed automatically for man pages according to
                   6754:     <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
                   6755:     or not, see above for details. This modification of the
                   6756:     <code class="filename">PLIST</code> file is done on a copy of it, not
                   6757:     <code class="filename">PLIST</code> itself.</p>
1.75      rillig   6758: </div>
1.148     asau     6759: <div class="sect1">
1.75      rillig   6760: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6761: <a name="using-PLIST_SRC"></a>19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
                   6762: </h2></div></div></div>
                   6763: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
                   6764:     in generating the binary package, set the variable
                   6765:     <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.311     leot     6766:     The files are later concatenated using <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/cat.1"><span class="citerefentry"><span class="refentrytitle">cat</span>(1)</span></a>, and the order of things is
1.299     rillig   6767:     important. The default for <code class="varname">PLIST_SRC</code> is
                   6768:     <code class="filename">${PKGDIR}/PLIST</code>.</p>
1.75      rillig   6769: </div>
1.148     asau     6770: <div class="sect1">
1.75      rillig   6771: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6772: <a name="platform-specific-plist"></a>19.7. Platform-specific and differing PLISTs</h2></div></div></div>
                   6773: <p>Some packages decide to install a different set of files based on
                   6774:     the operating system being used. These differences can be
                   6775:     automatically handled by using the following files:</p>
                   6776: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6777: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
                   6778: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
                   6779: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
                   6780: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
                   6781: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
                   6782: </ul></div>
1.75      rillig   6783: </div>
1.148     asau     6784: <div class="sect1">
1.75      rillig   6785: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6786: <a name="build-plist"></a>19.8. Build-specific PLISTs</h2></div></div></div>
                   6787: <p>Some packages decide to generate hard-to-guess file names
                   6788:     during installation that are hard to wire down.</p>
                   6789: <p>In such cases, you can set the
                   6790:     <code class="varname">GENERATE_PLIST</code> variable to shell code
                   6791:     terminated (with a semicolon) that will output PLIST entries which
                   6792:     will be appended to the PLIST</p>
                   6793: <p>You can find one example in editors/xemacs:</p>
                   6794: <pre class="programlisting">
                   6795: GENERATE_PLIST+=        ${ECHO} bin/${DISTNAME}-`${WRKSRC}/src/xemacs -sd`.dmp ;
                   6796: </pre>
                   6797: <p>which will append something like
                   6798:     <code class="filename">bin/xemacs-21.4.23-54e8ea71.dmp</code> to the
                   6799:     <code class="filename">PLIST</code>.
                   6800:     </p>
1.75      rillig   6801: </div>
1.148     asau     6802: <div class="sect1">
1.75      rillig   6803: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6804: <a name="faq.common-dirs"></a>19.9. Sharing directories between packages</h2></div></div></div>
                   6805: <p>A <span class="quote">&#8220;<span class="quote">shared directory</span>&#8221;</span> is a directory where
                   6806:     multiple (and unrelated) packages install files.  These
                   6807:     directories were problematic because you had to add special
                   6808:     tricks in the PLIST to conditionally remove them, or have some
                   6809:     centralized package handle them.</p>
                   6810: <p>In pkgsrc, it is now easy: Each package should create
                   6811:     directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
                   6812:     will remove any directories left empty after uninstalling a
                   6813:     package.</p>
                   6814: <p>If a package needs an empty directory to work, create
                   6815:     the directory during installation as usual, and also add an
                   6816:     entry to the PLIST:
                   6817: 
                   6818: </p>
                   6819: <pre class="programlisting">
                   6820: @pkgdir path/to/empty/directory
                   6821: </pre>
                   6822: <p>
                   6823: 
                   6824:     or take a look at <code class="varname">MAKE_DIRS</code> and
                   6825:     <code class="varname">OWN_DIRS</code>.
1.88      wiz      6826:     </p>
1.75      rillig   6827: </div>
1.299     rillig   6828: </div>
                   6829: <div class="chapter">
                   6830: <div class="titlepage"><div><div><h2 class="title">
                   6831: <a name="pkginstall"></a>Chapter 20. The pkginstall framework</h2></div></div></div>
                   6832: <div class="toc">
                   6833: <p><b>Table of Contents</b></p>
                   6834: <dl class="toc">
                   6835: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">20.1. Files and directories outside the installation prefix</a></span></dt>
                   6836: <dd><dl>
                   6837: <dt><span class="sect2"><a href="#dirs-outside-prefix">20.1.1. Directory manipulation</a></span></dt>
                   6838: <dt><span class="sect2"><a href="#files-outside-prefix">20.1.2. File manipulation</a></span></dt>
                   6839: </dl></dd>
                   6840: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
                   6841: <dd><dl>
                   6842: <dt><span class="sect2"><a href="#conf-files-sysconfdir">20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
                   6843: <dt><span class="sect2"><a href="#conf-files-configure">20.2.2. Telling the software where configuration files are</a></span></dt>
                   6844: <dt><span class="sect2"><a href="#conf-files-patching">20.2.3. Patching installations</a></span></dt>
                   6845: <dt><span class="sect2"><a href="#conf-files-disable">20.2.4. Disabling handling of configuration files</a></span></dt>
                   6846: </dl></dd>
                   6847: <dt><span class="sect1"><a href="#rcd-scripts">20.3. System startup scripts</a></span></dt>
                   6848: <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>
                   6849: <dt><span class="sect1"><a href="#users-and-groups">20.4. System users and groups</a></span></dt>
                   6850: <dt><span class="sect1"><a href="#shells">20.5. System shells</a></span></dt>
                   6851: <dd><dl><dt><span class="sect2"><a href="#shells-disable">20.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   6852: <dt><span class="sect1"><a href="#fonts">20.6. Fonts</a></span></dt>
                   6853: <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>
                   6854: </dl>
                   6855: </div>
                   6856: <p>This chapter describes the framework known as
                   6857: <code class="literal">pkginstall</code>, whose key features are:</p>
                   6858: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6859: <li class="listitem"><p>Generic installation and manipulation of directories and files
                   6860:     outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
                   6861: <li class="listitem"><p>Automatic handling of configuration files during installation,
                   6862:     provided that packages are correctly designed.</p></li>
                   6863: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
                   6864: <li class="listitem"><p>Registration of system users and groups.</p></li>
                   6865: <li class="listitem"><p>Registration of system shells.</p></li>
                   6866: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
                   6867: </ul></div>
                   6868: <p>The following sections inspect each of the above points in detail.</p>
                   6869: <p>You may be thinking that many of the things described here could be
                   6870: easily done with simple code in the package's post-installation target
                   6871: (<code class="literal">post-install</code>).  <span class="emphasis"><em>This is incorrect</em></span>,
                   6872: as the code in them is only executed when building from source.  Machines
                   6873: using binary packages could not benefit from it at all (as the code itself
                   6874: could be unavailable).  Therefore, the only way to achieve any of the items
                   6875: described above is by means of the installation scripts, which are
                   6876: automatically generated by pkginstall.</p>
1.148     asau     6877: <div class="sect1">
1.75      rillig   6878: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6879: <a name="files-and-dirs-outside-prefix"></a>20.1. Files and directories outside the installation prefix</h2></div></div></div>
                   6880: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
                   6881: of files and directories that belong to a package.  The names used in it
                   6882: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
                   6883: which means that it cannot register files outside this directory (absolute
                   6884: path names are not allowed).  Despite this restriction, some packages need
                   6885: to install files outside this location; e.g., under
                   6886: <code class="filename">${VARBASE}</code> or
                   6887: <code class="filename">${PKG_SYSCONFDIR}</code>.  The only way to achieve this
                   6888: is to create such files during installation time by using
                   6889: installation scripts.</p>
                   6890: <p>The generic installation scripts are shell scripts that can
                   6891: contain arbitrary code.  The list of scripts to execute is taken from
                   6892: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
                   6893: <code class="filename">INSTALL</code>.  A similar variable exists for package
                   6894: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
                   6895: <code class="filename">DEINSTALL</code>).  These scripts can run arbitrary
                   6896: commands, so they have the potential to create and manage files
                   6897: anywhere in the file system.</p>
                   6898: <p>Using these general installation files is not recommended, but
                   6899: may be needed in some special cases.  One reason for avoiding them is
                   6900: that the user has to trust the packager that there is no unwanted or
                   6901: simply erroneous code included in the installation script. Also,
                   6902: previously there were many similar scripts for the same functionality,
                   6903: and fixing a common error involved finding and changing all of
                   6904: them.</p>
                   6905: <p>The pkginstall framework offers another, standardized way.  It
                   6906: provides generic scripts to abstract the manipulation of such files
                   6907: and directories based on variables set in the package's
                   6908: <code class="filename">Makefile</code>.  The rest of this section describes
                   6909: these variables.</p>
                   6910: <div class="sect2">
                   6911: <div class="titlepage"><div><div><h3 class="title">
                   6912: <a name="dirs-outside-prefix"></a>20.1.1. Directory manipulation</h3></div></div></div>
                   6913: <p>The following variables can be set to request the creation of
                   6914: directories anywhere in the file system:</p>
                   6915: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6916: <li class="listitem">
                   6917: <p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
                   6918:     contain a list of directories that should be created and should attempt
                   6919:     to be destroyed by the installation scripts.  The difference between
                   6920:     the two is that the latter prompts the administrator to remove any
                   6921:     directories that may be left after deinstallation (because they were
                   6922:     not empty), while the former does not.  Example:</p>
                   6923: <pre class="programlisting">
                   6924: MAKE_DIRS+=             ${VARBASE}/foo/private
                   6925: </pre>
                   6926: </li>
                   6927: <li class="listitem">
                   6928: <p><code class="varname">MAKE_DIRS_PERMS</code> and
                   6929:     <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
                   6930:     which directories should be created and should attempt to be destroyed
                   6931:     by the installation scripts.  Each tuple holds the following values,
                   6932:     separated by spaces: the directory name, its owner, its group and its
                   6933:     numerical mode.  For example:</p>
                   6934: <pre class="programlisting">
                   6935: MAKE_DIRS_PERMS+=       ${VARBASE}/foo/private \
                   6936:                         ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
                   6937: </pre>
                   6938: <p>The difference between the two is exactly the same as their
                   6939:     non-<code class="varname">PERMS</code> counterparts.</p>
                   6940: </li>
                   6941: </ul></div>
1.75      rillig   6942: </div>
1.299     rillig   6943: <div class="sect2">
                   6944: <div class="titlepage"><div><div><h3 class="title">
                   6945: <a name="files-outside-prefix"></a>20.1.2. File manipulation</h3></div></div></div>
                   6946: <p>Creating non-empty files outside the installation prefix is tricky
                   6947: because the <code class="filename">PLIST</code> forces all files to be inside it.
                   6948: To overcome this problem, the only solution is to extract the file in the
                   6949: known place (i.e., inside the installation prefix) and copy it to the
                   6950: appropriate location during installation (done by the installation scripts
                   6951: generated by pkginstall).  We will call the former the <span class="emphasis"><em>master
                   6952: file</em></span> in the following paragraphs, which describe the variables
                   6953: that can be used to automatically and consistently handle files outside the
                   6954: installation prefix:</p>
                   6955: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6956: <li class="listitem">
                   6957: <p><code class="varname">CONF_FILES</code> and
                   6958:     <code class="varname">REQD_FILES</code> are pairs of master and target files.
                   6959:     During installation time, the master file is copied to the target one
                   6960:     if and only if the latter does not exist.  Upon deinstallation, the
                   6961:     target file is removed provided that it was not modified by the
                   6962:     installation.</p>
                   6963: <p>The difference between the two is that the latter prompts the
                   6964:     administrator to remove any files that may be left after
                   6965:     deinstallation (because they were not empty), while the former does
                   6966:     not.</p>
                   6967: </li>
                   6968: <li class="listitem">
                   6969: <p><code class="varname">CONF_FILES_PERMS</code> and
                   6970:     <code class="varname">REQD_FILES_PERMS</code> contain tuples describing master
                   6971:     files as well as their target locations.  For each of them, it also
                   6972:     specifies their owner, their group and their numeric permissions, in
                   6973:     this order.  For example:</p>
1.88      wiz      6974: <pre class="programlisting">
1.299     rillig   6975: REQD_FILES_PERMS+=      ${PREFIX}/share/somefile ${VARBASE}/somefile \
                   6976:                         ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.100     rillig   6977: </pre>
1.299     rillig   6978: <p>The difference between the two is exactly the same as their
                   6979:     non-<code class="varname">PERMS</code> counterparts.</p>
                   6980: </li>
                   6981: </ul></div>
                   6982: </div>
1.75      rillig   6983: </div>
1.148     asau     6984: <div class="sect1">
1.75      rillig   6985: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   6986: <a name="conf-files"></a>20.2. Configuration files</h2></div></div></div>
                   6987: <p>Configuration files are special in the sense that they are installed
                   6988: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
                   6989: need special treatment during installation (most of which is automated by
                   6990: pkginstall).  The main concept you must bear in mind is that files marked
                   6991: as configuration files are automatically copied to the right place (somewhere
                   6992: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
                   6993: and only if</em></span> they didn't exist before.  Similarly, they will not
                   6994: be removed if they have local modifications.  This ensures that
                   6995: administrators never lose any custom changes they may have made.</p>
                   6996: <div class="sect2">
                   6997: <div class="titlepage"><div><div><h3 class="title">
                   6998: <a name="conf-files-sysconfdir"></a>20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</h3></div></div></div>
                   6999: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
                   7000: specifies where configuration files shall be installed.  Its contents are
                   7001: set based upon the following variables:</p>
                   7002: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   7003: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
                   7004:     directory.  Defaults to <code class="filename">${PREFIX}/etc</code> although it may
                   7005:     be overridden by the user to point to his preferred location (e.g.,
                   7006:     <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
                   7007:     Packages must not use it directly.</p></li>
                   7008: <li class="listitem">
                   7009: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
                   7010:     <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
                   7011:     for the package being built shall be installed.  The definition of this
                   7012:     variable only makes sense in the package's
                   7013:     <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
                   7014: <p>As an example, consider the Apache package,
                   7015:     <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
                   7016:     configuration files under the
                   7017:     <code class="filename">httpd/</code> subdirectory of
                   7018:     <code class="varname">PKG_SYSCONFBASE</code>.  This should be set in the package
                   7019:     Makefile.</p>
                   7020: </li>
                   7021: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
                   7022:     variable that holds this package's configuration directory (if
                   7023:     different from <code class="varname">PKG_SYSCONFBASE</code>).  It defaults to
                   7024:     <code class="varname">PKGBASE</code>'s value, and is always prefixed with
                   7025:     <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
                   7026: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
                   7027:     directory where the configuration files for the package identified by
                   7028:     <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
                   7029: </ul></div>
                   7030: <p>Based on the above variables, pkginstall determines the value of
                   7031: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
                   7032: variable that can be used within a package to refer to its configuration
                   7033: directory.  The algorithm used to set its value is basically the
                   7034: following:</p>
                   7035: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7036: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
                   7037:     its value is used.</p></li>
                   7038: <li class="listitem"><p>If the previous variable is not defined but
                   7039:     <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
                   7040:     <code class="filename">Makefile</code>, the resulting value is
                   7041:     <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
                   7042: <li class="listitem"><p>Otherwise, it is set to
                   7043:     <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
                   7044: </ol></div>
                   7045: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
                   7046: 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
                   7047: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
                   7048: be created with OWN_DIRS or MAKE_DIRS.</p>
                   7049: </div>
                   7050: <div class="sect2">
                   7051: <div class="titlepage"><div><div><h3 class="title">
                   7052: <a name="conf-files-configure"></a>20.2.2. Telling the software where configuration files are</h3></div></div></div>
                   7053: <p>Given that pkgsrc (and users!) expect configuration files to be in a
                   7054: known place, you need to teach each package where it shall install its
                   7055: files.  In some cases you will have to patch the package Makefiles to
                   7056: achieve it.  If you are lucky, though, it may be as easy as passing an
                   7057: extra flag to the configuration script; this is the case of GNU Autoconf-
                   7058: generated files:</p>
1.75      rillig   7059: <pre class="programlisting">
1.299     rillig   7060: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.100     rillig   7061: </pre>
1.299     rillig   7062: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
                   7063: for</em></span> its configuration files, not where they will be originally
                   7064: installed (although the difference is never explicit,
                   7065: unfortunately).</p>
1.75      rillig   7066: </div>
1.299     rillig   7067: <div class="sect2">
                   7068: <div class="titlepage"><div><div><h3 class="title">
                   7069: <a name="conf-files-patching"></a>20.2.3. Patching installations</h3></div></div></div>
                   7070: <p>As said before, pkginstall automatically handles configuration files.
                   7071: This means that <span class="strong"><strong>the packages themselves must not
                   7072: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
                   7073: directly</strong></span>.  Bad news is that many software installation scripts
                   7074: will, out of the box, mess with the contents of that directory.  So what is
                   7075: the correct procedure to fix this issue?</p>
                   7076: <p>You must teach the package (usually by manually patching it) to
                   7077: install any configuration files under the examples hierarchy,
                   7078: <code class="filename">share/examples/${PKGBASE}/</code>.  This way, the
                   7079: <code class="filename">PLIST</code> registers them and the administrator always
                   7080: has the original copies available.</p>
                   7081: <p>Once the required configuration files are in place (i.e., under the
                   7082: examples hierarchy), the pkginstall framework can use them as master copies
                   7083: during the package installation to update what is in
                   7084: <code class="filename">${PKG_SYSCONFDIR}</code>.  To achieve this, the variables
                   7085: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
                   7086: 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
                   7087: about their syntax and their purpose.  Here is an example, taken from the
                   7088: <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      7089: <pre class="programlisting">
1.299     rillig   7090: EGDIR=        ${PREFIX}/share/doc/mutt/samples
                   7091: CONF_FILES=   ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
1.100     rillig   7092: </pre>
1.299     rillig   7093: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
                   7094: package and has no meaning outside it.</p>
1.75      rillig   7095: </div>
1.299     rillig   7096: <div class="sect2">
                   7097: <div class="titlepage"><div><div><h3 class="title">
                   7098: <a name="conf-files-disable"></a>20.2.4. Disabling handling of configuration files</h3></div></div></div>
                   7099: <p>The automatic copying of config files can be toggled by setting the
                   7100: environment variable <code class="varname">PKG_CONFIG</code> prior to package
                   7101: installation.</p>
1.88      wiz      7102: </div>
1.75      rillig   7103: </div>
1.148     asau     7104: <div class="sect1">
1.75      rillig   7105: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   7106: <a name="rcd-scripts"></a>20.3. System startup scripts</h2></div></div></div>
                   7107: <p>System startup scripts are special files because they must be
                   7108: installed in a place known by the underlying OS, usually outside the
                   7109: 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
                   7110: can be used.  However, pkginstall provides a special mechanism to handle
                   7111: these files.</p>
                   7112: <p>In order to provide system startup scripts, the package has
                   7113: to:</p>
                   7114: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7115: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
                   7116:     the <code class="literal">.sh</code> suffix appended.  Considering the
                   7117:     <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
                   7118:     <code class="filename">cupsd.sh</code> in its files directory.</p></li>
                   7119: <li class="listitem">
                   7120: <p>Tell pkginstall to handle it, appending the name of the script,
                   7121:     without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
                   7122:     Continuing the previous example:</p>
                   7123: <pre class="programlisting">
                   7124: RCD_SCRIPTS+=   cupsd
                   7125: </pre>
                   7126: </li>
                   7127: </ol></div>
                   7128: <p>Once this is done, pkginstall will do the following steps for each
                   7129: script in an automated fashion:</p>
                   7130: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7131: <li class="listitem"><p>Process the file found in the files directory applying all the
                   7132:     substitutions described in the <code class="filename">FILES_SUBST</code>
                   7133:     variable.</p></li>
                   7134: <li class="listitem"><p>Copy the script from the files directory to the examples
                   7135:     hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>.  Note
                   7136:     that this master file must be explicitly registered in the
                   7137:     <code class="filename">PLIST</code>.</p></li>
                   7138: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
                   7139:     from the examples hierarchy into the system-wide startup scripts
                   7140:     directory.</p></li>
                   7141: </ol></div>
                   7142: <div class="sect2">
                   7143: <div class="titlepage"><div><div><h3 class="title">
                   7144: <a name="rcd-scripts-disable"></a>20.3.1. Disabling handling of system startup scripts</h3></div></div></div>
                   7145: <p>The automatic copying of config files can be toggled by setting the
                   7146: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
                   7147: installation.  Note that the scripts will be always copied inside the
                   7148: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
                   7149: matter what the value of this variable is.</p>
1.75      rillig   7150: </div>
                   7151: </div>
1.299     rillig   7152: <div class="sect1">
                   7153: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   7154: <a name="users-and-groups"></a>20.4. System users and groups</h2></div></div></div>
                   7155: <p>If a package needs to create special users and/or groups during
                   7156: installation, it can do so by using the pkginstall framework.</p>
                   7157: <p>Users can be created by adding entries to the
                   7158: <code class="varname">PKG_USERS</code> variable.  Each entry has the following
                   7159: syntax:</p>
                   7160: <pre class="programlisting">
                   7161: user:group
                   7162: </pre>
                   7163: <p>Further specification of user details may be done by setting
                   7164: per-user variables.
                   7165: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
                   7166: numeric UID for the user.
                   7167: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
                   7168: user's description or comment.
                   7169: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
                   7170: user's home directory, and defaults to
                   7171: <code class="filename">/nonexistent</code> if not specified.
                   7172: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
                   7173: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
                   7174: not specified.</p>
                   7175: <p>Similarly, groups can be created by adding entries to the
                   7176: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
                   7177: <pre class="programlisting">
                   7178: group
                   7179: </pre>
                   7180: <p>The numeric GID of the group may be set by defining
                   7181: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
                   7182: <p>If a package needs to create the users and groups at an earlier
                   7183: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to either
                   7184: <code class="literal">configure</code>,<code class="literal">build</code>, or
                   7185: <code class="literal">pre-install</code> to indicate the phase before which the
                   7186: users and groups are created. In this case, the numeric UIDs and GIDs
                   7187: of the created users and groups are automatically hardcoded into the
                   7188: final installation scripts.</p>
1.75      rillig   7189: </div>
1.148     asau     7190: <div class="sect1">
1.75      rillig   7191: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   7192: <a name="shells"></a>20.5. System shells</h2></div></div></div>
                   7193: <p>Packages that install system shells should register them in the shell
                   7194: database, <code class="filename">/etc/shells</code>, to make things easier to the
                   7195: administrator.  This must be done from the installation scripts to keep
                   7196: binary packages working on any system.  pkginstall provides an easy way to
                   7197: accomplish this task.</p>
                   7198: <p>When a package provides a shell interpreter, it has to set the
                   7199: <code class="varname">PKG_SHELL</code> variable to its absolute file name.  This will
                   7200: add some hooks to the installation scripts to handle it.  Consider the
                   7201: 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>
                   7202: <pre class="programlisting">
                   7203: PKG_SHELL=      ${PREFIX}/bin/zsh
                   7204: </pre>
                   7205: <div class="sect2">
                   7206: <div class="titlepage"><div><div><h3 class="title">
                   7207: <a name="shells-disable"></a>20.5.1. Disabling shell registration</h3></div></div></div>
                   7208: <p>The automatic registration of shell interpreters can be disabled by
                   7209: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
                   7210: environment variable to <code class="literal">NO</code>.</p>
                   7211: </div>
1.75      rillig   7212: </div>
1.148     asau     7213: <div class="sect1">
1.75      rillig   7214: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   7215: <a name="fonts"></a>20.6. Fonts</h2></div></div></div>
                   7216: <p>Packages that install X11 fonts should update the database files
                   7217: that index the fonts within each fonts directory.  This can easily be
                   7218: accomplished within the pkginstall framework.</p>
                   7219: <p>When a package installs X11 fonts, it must list the directories in
                   7220: which fonts are installed in the
                   7221: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
                   7222: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">&#8220;<span class="quote">ttf</span>&#8221;</span>,
                   7223: <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
                   7224: installation scripts to run the appropriate commands to update the fonts
                   7225: database files within each of those directories.  For convenience, if the
                   7226: directory path is relative, it is taken to be relative to the package's
                   7227: 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   7228: <pre class="programlisting">
1.299     rillig   7229: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF
1.75      rillig   7230: </pre>
1.299     rillig   7231: <div class="sect2">
                   7232: <div class="titlepage"><div><div><h3 class="title">
                   7233: <a name="fonts-disable"></a>20.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
                   7234: <p>The automatic update of fonts databases can be disabled by
                   7235: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
                   7236: environment variable to <code class="literal">NO</code>.</p>
1.75      rillig   7237: </div>
                   7238: </div>
                   7239: </div>
1.148     asau     7240: <div class="chapter">
1.75      rillig   7241: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   7242: <a name="fixes"></a>Chapter 21. Making your package work</h2></div></div></div>
1.75      rillig   7243: <div class="toc">
                   7244: <p><b>Table of Contents</b></p>
1.210     leot     7245: <dl class="toc">
1.267     rillig   7246: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
1.75      rillig   7247: <dd><dl>
1.267     rillig   7248: <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>
                   7249: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
                   7250: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
                   7251: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
                   7252: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
                   7253: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
                   7254: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
                   7255: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
                   7256: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
                   7257: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
                   7258: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                   7259: </dl></dd>
                   7260: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                   7261: <dd><dl>
                   7262: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   7263: <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>
                   7264: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
                   7265: </dl></dd>
                   7266: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   7267: <dd><dl>
                   7268: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
                   7269: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   7270: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
                   7271: </dl></dd>
                   7272: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
                   7273: <dd><dl>
                   7274: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
                   7275: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
                   7276: <dt><span class="sect2"><a href="#perl-scripts">21.4.3. Packages containing perl scripts</a></span></dt>
                   7277: <dt><span class="sect2"><a href="#shell-scripts">21.4.4. Packages containing shell scripts</a></span></dt>
                   7278: <dt><span class="sect2"><a href="#other-programming-languages">21.4.5. Other programming languages</a></span></dt>
                   7279: </dl></dd>
                   7280: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   7281: <dd><dl>
                   7282: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   7283: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.287     rillig   7284: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
                   7285: <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>
                   7286: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.267     rillig   7287: </dl></dd>
                   7288: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   7289: <dd><dl>
                   7290: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
                   7291: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
                   7292: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
                   7293: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
                   7294: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
                   7295: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing perl modules</a></span></dt>
                   7296: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
                   7297: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
                   7298: <dt><span class="sect2"><a href="#gconf-data-files">21.6.9. Packages installing GConf data files</a></span></dt>
                   7299: <dt><span class="sect2"><a href="#scrollkeeper-data-files">21.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
                   7300: <dt><span class="sect2"><a href="#x11-fonts">21.6.11. Packages installing X11 fonts</a></span></dt>
                   7301: <dt><span class="sect2"><a href="#gtk2-modules">21.6.12. Packages installing GTK2 modules</a></span></dt>
                   7302: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.13. Packages installing SGML or XML data</a></span></dt>
                   7303: <dt><span class="sect2"><a href="#mime-database">21.6.14. Packages installing extensions to the MIME database</a></span></dt>
                   7304: <dt><span class="sect2"><a href="#intltool">21.6.15. Packages using intltool</a></span></dt>
                   7305: <dt><span class="sect2"><a href="#startup-scripts">21.6.16. Packages installing startup scripts</a></span></dt>
                   7306: <dt><span class="sect2"><a href="#tex-packages">21.6.17. Packages installing TeX modules</a></span></dt>
                   7307: <dt><span class="sect2"><a href="#emulation-packages">21.6.18. Packages supporting running binaries in
1.87      wiz      7308:     emulation</a></span></dt>
1.267     rillig   7309: <dt><span class="sect2"><a href="#hicolor-theme">21.6.19. Packages installing hicolor theme icons</a></span></dt>
                   7310: <dt><span class="sect2"><a href="#desktop-files">21.6.20. Packages installing desktop files</a></span></dt>
1.75      rillig   7311: </dl></dd>
1.267     rillig   7312: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.75      rillig   7313: </dl>
                   7314: </div>
1.148     asau     7315: <div class="sect1">
1.75      rillig   7316: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   7317: <a name="general-operation"></a>21.1. General operation</h2></div></div></div>
1.78      rillig   7318: <p>One appealing feature of pkgsrc is that it runs on many
1.218     rillig   7319:   different platforms. As a result, it is important to ensure,
                   7320:   where possible, that packages in pkgsrc are portable. This
                   7321:   chapter mentions some particular details you should pay
                   7322:   attention to while working on pkgsrc.</p>
1.148     asau     7323: <div class="sect2">
1.78      rillig   7324: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7325: <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   7326: </h3></div></div></div>
1.78      rillig   7327: <p>The pkgsrc user can configure pkgsrc by overriding several
1.87      wiz      7328:     variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.110     hubertf  7329:     which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.87      wiz      7330:     want to use those variables in the preprocessor directives of
1.311     leot     7331:     <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> (for example <code class="literal">.if</code> or
1.87      wiz      7332:     <code class="literal">.for</code>), you need to include the file
                   7333:     <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
                   7334:     loads the user preferences.</p>
1.78      rillig   7335: <p>But note that some variables may not be completely defined
1.219     rillig   7336:     after <code class="filename">../../mk/bsd.prefs.mk</code> has been
                   7337:     included, as they may contain references to variables that are
                   7338:     not yet defined. In shell commands (the lines in
                   7339:     <code class="filename">Makefile</code> that are indented with a tab) this
                   7340:     is no problem, since variables are only expanded when they are
                   7341:     used. But in the preprocessor directives mentioned above and in
                   7342:     dependency lines (of the form <code class="literal">target:
                   7343:     dependencies</code>) the variables are expanded at load
                   7344:     time.</p>
1.148     asau     7345: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.78      rillig   7346: <h3 class="title">Note</h3>
1.218     rillig   7347: <p>To check whether a variable can be used at load time,
                   7348:     run <span class="command"><strong>pkglint -Wall</strong></span> on your package.</p>
1.78      rillig   7349: </div>
                   7350: </div>
1.148     asau     7351: <div class="sect2">
1.78      rillig   7352: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7353: <a name="user-interaction"></a>21.1.2. User interaction</h3></div></div></div>
1.88      wiz      7354: <p>Occasionally, packages require interaction from the user,
                   7355:     and this can be in a number of ways:</p>
1.148     asau     7356: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      7357: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.87      wiz      7358:        interaction such as entering username/password or accepting a
                   7359:        license on a web page.</p></li>
1.128     wiz      7360: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.88      wiz      7361:        passwords.</p></li>
1.128     wiz      7362: <li class="listitem"><p>help to configure the package before it is built</p></li>
                   7363: <li class="listitem"><p>help during the build process</p></li>
                   7364: <li class="listitem"><p>help during the installation of a package</p></li>
1.78      rillig   7365: </ul></div>
1.218     rillig   7366: <p>A package can set the <code class="varname">INTERACTIVE_STAGE</code>
                   7367:     variable to define which stages need interaction. This should be
                   7368:     done in the package's <code class="filename">Makefile</code>, e.g.:</p>
1.75      rillig   7369: <pre class="programlisting">
1.100     rillig   7370: INTERACTIVE_STAGE=      configure install
1.222     sevan    7371: </pre>
1.88      wiz      7372: <p>The user can then decide to skip this package by setting the
1.218     rillig   7373:     <code class="varname">BATCH</code> variable. Packages that require interaction
                   7374:     are also excluded from bulk builds.</p>
1.75      rillig   7375: </div>
1.148     asau     7376: <div class="sect2">
1.75      rillig   7377: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7378: <a name="handling-licenses"></a>21.1.3. Handling licenses</h3></div></div></div>
1.222     sevan    7379: <p>Authors of software can choose the licence under which software
                   7380:     can be copied.  The Free Software Foundation has declared some
                   7381:     licenses "Free", and the Open Source Initiative has a definition of
                   7382:     "Open Source".</p>
                   7383: <p>By default, pkgsrc allows packages with Free or Open Source
                   7384:     licenses to be built.  To allow packages with other licenses to be
                   7385:     built as well, the pkgsrc user needs to add these licenses to the
                   7386:     <code class="varname">ACCEPTABLE_LICENSES</code> variable in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  Note
                   7387:     that this variable only affects which packages may be
                   7388:     <span class="emphasis"><em>built</em></span>, while the license terms often also
                   7389:     restrict the actual use of the package and its redistribution.</p>
1.98      wiz      7390: <p>One might want to only install packages with a BSD license,
1.218     rillig   7391:     or the GPL, and not the other.  The free licenses are added to the
1.222     sevan    7392:     default <code class="varname">ACCEPTABLE_LICENSES</code> variable.  The pkgsrc
1.121     jnemeth  7393:     user can override the default by setting the
                   7394:     <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
1.222     sevan    7395:     of "+=".  The licenses accepted by default are defined in the
                   7396:     <code class="varname">DEFAULT_ACCEPTABLE_LICENSES</code> variable in the file
                   7397:     <code class="filename">pkgsrc/mk/license.mk</code>.</p>
1.78      rillig   7398: <p>The license tag mechanism is intended to address
1.87      wiz      7399:     copyright-related issues surrounding building, installing and
                   7400:     using a package, and not to address redistribution issues (see
                   7401:     <code class="varname">RESTRICTED</code> and
1.222     sevan    7402:     <code class="varname">NO_SRC_ON_FTP</code>, etc.).
1.121     jnemeth  7403:     Packages with redistribution restrictions should set these
                   7404:     tags.</p>
1.98      wiz      7405: <p>Denoting that a package may be copied according to a
                   7406:     particular license is done by placing the license in
1.87      wiz      7407:     <code class="filename">pkgsrc/licenses</code> and setting the
                   7408:     <code class="varname">LICENSE</code> variable to a string identifying the
1.250     leot     7409:     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      7410: <pre class="programlisting">
1.100     rillig   7411: LICENSE=        xv-license
1.222     sevan    7412: </pre>
1.87      wiz      7413: <p>When trying to build, the user will get a notice that the
1.98      wiz      7414:     package is covered by a license which has not been placed in the
                   7415:     <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
1.87      wiz      7416: <pre class="programlisting">
1.100     rillig   7417: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   7418: ===&gt; xv-3.10anb9 has an unacceptable license: xv-license.
                   7419: ===&gt;     To view the license, enter "/usr/bin/make show-license".
                   7420: ===&gt;     To indicate acceptance, add this line to your /etc/mk.conf:
                   7421: ===&gt;     ACCEPTABLE_LICENSES+=xv-license
                   7422: *** Error code 1
1.222     sevan    7423: </pre>
1.110     hubertf  7424: <p>The license can be viewed with <span class="command"><strong>make
1.98      wiz      7425:     show-license</strong></span>, and if the user so chooses, the line
1.110     hubertf  7426:     printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.98      wiz      7427:     convey to pkgsrc that it should not in the future fail because of
                   7428:     that license:</p>
1.78      rillig   7429: <pre class="programlisting">
1.100     rillig   7430: ACCEPTABLE_LICENSES+=xv-license
1.222     sevan    7431: </pre>
                   7432: <p>The use of <code class="varname">LICENSE=shareware</code>,
                   7433:     <code class="varname">LICENSE=no-commercial-use</code>, and similar language
                   7434:     is deprecated because it does not crisply refer to a particular
                   7435:     license text.  Another problem with such usage is that it does not
                   7436:     enable a user to tell pkgsrc to proceed for a single package
                   7437:     without also telling pkgsrc to proceed for all packages with that
                   7438:     tag.</p>
                   7439: <div class="sect3">
                   7440: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   7441: <a name="new-license"></a>21.1.3.1. Adding a package with a new license</h4></div></div></div>
1.154     rodent   7442: <p>When adding a package with a new license, the following steps
                   7443:     are required:</p>
                   7444: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7445: <li class="listitem">
1.284     rillig   7446: <p>Check whether the license qualifies as Free or Open Source by
                   7447:     referencing <a class="ulink" href="https://www.gnu.org/licenses/license-list.en.html" target="_top">Various
                   7448:     Licenses and Comments about Them</a> and <a class="ulink" href="https://opensource.org/licenses/alphabetical" target="_top">Licenses by Name |
1.222     sevan    7449:     Open Source Initiative</a>.  If this is the case, the filename in
                   7450:     <code class="filename">pkgsrc/licenses/</code> does not need the
                   7451:     <code class="filename">-license</code> suffix, and the license name should be
                   7452:     added to:</p>
1.154     rodent   7453: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.284     rillig   7454: <li class="listitem"><p>DEFAULT_ACCEPTABLE_LICENSES in
                   7455:     <code class="filename">pkgsrc/mk/license.mk</code></p></li>
                   7456: <li class="listitem"><p>default_acceptable_licenses in
                   7457:     <code class="filename">pkgsrc/pkgtools/pkg_install/files/lib/license.c</code></p></li>
1.154     rodent   7458: </ul></div>
                   7459: </li>
1.284     rillig   7460: <li class="listitem"><p>The license text should be added to
                   7461:     <code class="filename">pkgsrc/licenses</code> for displaying.  A list of known
                   7462:     licenses can be seen in this directory.</p></li>
1.154     rodent   7463: </ol></div>
1.222     sevan    7464: </div>
                   7465: <div class="sect3">
                   7466: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   7467: <a name="change-license"></a>21.1.3.2. Change to the license</h4></div></div></div>
1.98      wiz      7468: <p>When the license changes (in a way other than formatting),
1.222     sevan    7469:     make sure that the new license has a different name (e.g.,
1.98      wiz      7470:     append the version number if it exists, or the date).  Just
                   7471:     because a user told pkgsrc to build programs under a previous
                   7472:     version of a license does not mean that pkgsrc should build
1.99      rillig   7473:     programs under the new licenses.  The higher-level point is that
1.98      wiz      7474:     pkgsrc does not evaluate licenses for reasonableness; the only
                   7475:     test is a mechanistic test of whether a particular text has been
1.222     sevan    7476:     approved by either of two bodies (FSF or OSI).</p>
                   7477: </div>
1.75      rillig   7478: </div>
1.148     asau     7479: <div class="sect2">
1.75      rillig   7480: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7481: <a name="restricted-packages"></a>21.1.4. Restricted packages</h3></div></div></div>
1.75      rillig   7482: <p>Some licenses restrict how software may be re-distributed.
1.222     sevan    7483:     By declaring the restrictions, package tools can
1.98      wiz      7484:     automatically refrain from e.g. placing binary packages on FTP
                   7485:     sites.</p>
1.222     sevan    7486: <p>There are four possible restrictions, which are
1.98      wiz      7487:     the cross product of sources (distfiles) and binaries not being
                   7488:     placed on FTP sites and CD-ROMs.  Because this is rarely the exact
                   7489:     language in any license, and because non-Free licenses tend to be
                   7490:     different from each other, pkgsrc adopts a definition of FTP and
1.222     sevan    7491:     CD-ROM.
                   7492: 
                   7493:     "FTP" means making the source or binary file available over the
                   7494:     Internet at no charge.
                   7495: 
                   7496:     "CD-ROM" means making the source or binary available on some kind of
                   7497:     media, together with other source and binary packages, which is sold
                   7498:     for a distribution charge.
1.98      wiz      7499:     </p>
                   7500: <p>In order to encode these restrictions, the package system
1.87      wiz      7501:     defines five make variables that can be set to note these
                   7502:     restrictions:</p>
1.148     asau     7503: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      7504: <li class="listitem">
1.75      rillig   7505: <p><code class="varname">RESTRICTED</code></p>
                   7506: <p>This variable should be set whenever a restriction
1.87      wiz      7507:        exists (regardless of its kind).  Set this variable to a
1.98      wiz      7508:        string containing the reason for the restriction.  It should
                   7509:        be understood that those wanting to understand the restriction
                   7510:        will have to read the license, and perhaps seek advice of
                   7511:        counsel.</p>
1.75      rillig   7512: </li>
1.128     wiz      7513: <li class="listitem">
1.75      rillig   7514: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
1.98      wiz      7515: <p>Binaries may not be placed on CD-ROM containing other
                   7516:        binary packages, for which a distribution charge may be made.
                   7517:        In this case, set this variable to
                   7518:        <code class="varname">${RESTRICTED}</code>.</p>
1.75      rillig   7519: </li>
1.128     wiz      7520: <li class="listitem">
1.75      rillig   7521: <p><code class="varname">NO_BIN_ON_FTP</code></p>
1.98      wiz      7522: <p>Binaries may not made available on the Internet without
                   7523:        charge.  In this case, set this variable to
                   7524:        <code class="varname">${RESTRICTED}</code>.  If this variable is set,
                   7525:        binary packages will not be included on ftp.NetBSD.org.</p>
1.75      rillig   7526: </li>
1.128     wiz      7527: <li class="listitem">
1.75      rillig   7528: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
1.98      wiz      7529: <p>Distfiles may not be placed on CD-ROM, together with
                   7530:        other distfiles, for which a fee may be charged.  In this
                   7531:        case, set this variable to <code class="varname">${RESTRICTED}</code>.
                   7532:        </p>
1.75      rillig   7533: </li>
1.128     wiz      7534: <li class="listitem">
1.75      rillig   7535: <p><code class="varname">NO_SRC_ON_FTP</code></p>
1.98      wiz      7536: <p>Distfiles may not made available via FTP at no charge.
                   7537:        In this case, set this variable to
                   7538:        <code class="varname">${RESTRICTED}</code>.  If this variable is set,
                   7539:        the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
1.75      rillig   7540: </li>
                   7541: </ul></div>
1.222     sevan    7542: <p>Please note that packages will be removed from pkgsrc when the
                   7543:     distfiles are not distributable and cannot be obtained for a period
                   7544:     of one full quarter branch. Packages with manual/interactive fetch
                   7545:     must have a maintainer and it is his/her responsibility to ensure
                   7546:     this.</p>
1.75      rillig   7547: </div>
1.148     asau     7548: <div class="sect2">
1.75      rillig   7549: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7550: <a name="dependencies"></a>21.1.5. Handling dependencies</h3></div></div></div>
1.290     gutterid 7551: <p>Your package may depend on some other package being present,
                   7552:     and there are various ways of expressing this dependency.
                   7553:     pkgsrc supports the <code class="varname">DEPENDS</code>,
                   7554:     <code class="varname">BUILD_DEPENDS</code>,
                   7555:     <code class="varname">TOOL_DEPENDS</code>, and
                   7556:     <code class="varname">TEST_DEPENDS</code> definitions, the
1.88      wiz      7557:     <code class="varname">USE_TOOLS</code> definition, as well as dependencies
                   7558:     via <code class="filename">buildlink3.mk</code>, which is the preferred way
                   7559:     to handle dependencies, and which uses the variables named above.
1.299     rillig   7560:     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 7561: <p>The basic difference is that the <code class="varname">DEPENDS</code>
                   7562:     definition registers that pre-requisite in the binary package so it
                   7563:     will be pulled in when the binary package is later installed, whilst
                   7564:     the <code class="varname">BUILD_DEPENDS</code>, <code class="varname">TOOL_DEPENDS</code>,
                   7565:     and <code class="varname">TEST_DEPENDS</code> definitions do not, marking a
                   7566:     dependency that is only needed for building or testing the resulting
1.299     rillig   7567:     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   7568: <p>This means that if you only need a package present whilst
1.290     gutterid 7569:     you are building or testing, it should be noted as a
                   7570:     <code class="varname">TOOL_DEPENDS</code>,
                   7571:     <code class="varname">BUILD_DEPENDS</code>, or
                   7572:     <code class="varname">TEST_DEPENDS</code>.  When cross-compiling,
1.269     leot     7573:     <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
                   7574:     packages, i.e. packages for the architecture where the package
                   7575:     is built;
                   7576:     <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
1.290     gutterid 7577:     packages, i.e., packages for the architecture for which the package
1.269     leot     7578:     is built.</p>
1.290     gutterid 7579: <p>The format for a <code class="varname">DEPENDS</code>,
                   7580:     <code class="varname">BUILD_DEPENDS</code>, <code class="varname">TOOL_DEPENDS</code>,
                   7581:     and <code class="varname">TEST_DEPENDS</code> definition is:</p>
1.75      rillig   7582: <pre class="programlisting">
1.100     rillig   7583: &lt;pre-req-package-name&gt;:../../&lt;category&gt;/&lt;pre-req-package&gt;
1.222     sevan    7584: </pre>
1.128     wiz      7585: <p>Please note that the <span class="quote">&#8220;<span class="quote">pre-req-package-name</span>&#8221;</span>
1.87      wiz      7586:     may include any of the wildcard version numbers recognized by
1.311     leot     7587:     <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/pkg_info.1"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a>.</p>
1.128     wiz      7588: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7589: <li class="listitem">
1.75      rillig   7590: <p>If your package needs another package's binaries or
1.160     wiz      7591:        libraries to build and run, and if that package has a
1.87      wiz      7592:        <code class="filename">buildlink3.mk</code> file available, use it:</p>
1.75      rillig   7593: <pre class="programlisting">
1.100     rillig   7594: .include "../../graphics/jpeg/buildlink3.mk"
1.222     sevan    7595: </pre>
1.75      rillig   7596: </li>
1.128     wiz      7597: <li class="listitem">
1.160     wiz      7598: <p>If your package needs another package's binaries or
                   7599:        libraries only for building, and if that package has a
                   7600:        <code class="filename">buildlink3.mk</code> file available, use it:</p>
                   7601: <pre class="programlisting">
                   7602: .include "../../graphics/jpeg/buildlink3.mk"
1.222     sevan    7603: </pre>
1.160     wiz      7604: <p>but set
                   7605:        <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>jpeg</code></em>?=build</code>
                   7606:        to make it a build dependency only. This case is rather
                   7607:        rare.</p>
                   7608: </li>
                   7609: <li class="listitem">
1.132     spz      7610: <p>If your package needs binaries from another package to build,
1.269     leot     7611:        use the <code class="varname">TOOL_DEPENDS</code> definition:</p>
1.75      rillig   7612: <pre class="programlisting">
1.269     leot     7613: TOOL_DEPENDS+= itstool-[0-9]*:../../textproc/itstool
1.222     sevan    7614: </pre>
1.75      rillig   7615: </li>
1.269     leot     7616: <li class="listitem"><p>If your package needs static libraries to link against, header
                   7617:        files to include, etc. from another package to build,
                   7618:        use the <code class="varname">BUILD_DEPENDS</code> definition.</p></li>
1.132     spz      7619: <li class="listitem"><p>If your package needs a library with which to link and
                   7620:        there is no <code class="filename">buildlink3.mk</code> file
                   7621:        available, create one. Using
                   7622:        <code class="varname">DEPENDS</code> won't be sufficient because the
                   7623:        include files and libraries will be hidden from the compiler.</p></li>
1.128     wiz      7624: <li class="listitem">
1.132     spz      7625: <p>If your package needs some executable to be able to run
                   7626:        correctly and if there's no
                   7627:        <code class="filename">buildlink3.mk</code> file, this is specified
                   7628:        using the <code class="varname">DEPENDS</code> variable. The
1.250     leot     7629:        <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      7630:        be able to execute the latex binary from the tex-latex-bin package
1.132     spz      7631:        when it runs, and that is specified:</p>
1.75      rillig   7632: <pre class="programlisting">
1.242     wiz      7633: DEPENDS+=        tex-latex-bin-[0-9]*:../../print/tex-latex-bin
1.222     sevan    7634: </pre>
1.132     spz      7635: </li>
1.290     gutterid 7636: <li class="listitem"><p>If your package includes a test suite that has extra
                   7637:         dependencies only required for this purpose (frequently this
                   7638:         can be run as a <span class="quote">&#8220;<span class="quote">make test</span>&#8221;</span> target), use the
                   7639:         <code class="varname">TEST_DEPENDS</code> variable.</p></li>
1.132     spz      7640: <li class="listitem">
                   7641: <p>You can use wildcards in package dependencies. Note that
                   7642:        such wildcard dependencies are retained when creating binary
                   7643:        packages. The dependency is checked when installing the binary
                   7644:        package and any package which matches the pattern will be
                   7645:        used. Wildcard dependencies should be used with care.</p>
1.128     wiz      7646: <p>The <span class="quote">&#8220;<span class="quote">-[0-9]*</span>&#8221;</span> should be used instead of
                   7647:        <span class="quote">&#8220;<span class="quote">-*</span>&#8221;</span> to avoid potentially ambiguous matches
                   7648:        such as <span class="quote">&#8220;<span class="quote">tk-postgresql</span>&#8221;</span> matching a
                   7649:        <span class="quote">&#8220;<span class="quote">tk-*</span>&#8221;</span> <code class="varname">DEPENDS</code>.</p>
1.75      rillig   7650: <p>Wildcards can also be used to specify that a package
1.87      wiz      7651:        will only build against a certain minimum version of a
                   7652:        pre-requisite:</p>
1.75      rillig   7653: <pre class="programlisting">
1.132     spz      7654: DEPENDS+=       ImageMagick&gt;=6.0:../../graphics/ImageMagick
1.222     sevan    7655: </pre>
1.132     spz      7656: <p>This means that the package will build using version 6.0
                   7657:        of ImageMagick or newer. Such a dependency may be warranted
                   7658:        if, for example, the command line options of an executable
                   7659:        have changed.</p>
                   7660: <p>If you need to depend on minimum versions of libraries,
1.298     wiz      7661:        set
                   7662:        <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   7663:        to the appropriate pattern before including its
                   7664:        <code class="filename">buildlink3.mk</code> file, e.g.</p>
                   7665: <pre class="programlisting">
                   7666: BUILDLINK_API_DEPENDS.jpeg+=    jpeg&gt;=9.0
                   7667: .include "../../graphics/jpeg/buildlink3.mk"
                   7668: </pre>
1.75      rillig   7669: <p>For security fixes, please update the package
1.267     rillig   7670:        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      7671:        information.</p>
1.75      rillig   7672: </li>
                   7673: </ol></div>
                   7674: <p>If your package needs files from another package to build,
1.87      wiz      7675:     add the relevant distribution files to
                   7676:     <code class="varname">DISTFILES</code>, so they will be extracted
1.250     leot     7677:     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      7678:     (It relies on the jpeg sources being present in source form
                   7679:     during the build.)</p>
1.75      rillig   7680: </div>
1.148     asau     7681: <div class="sect2">
1.75      rillig   7682: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7683: <a name="conflicts"></a>21.1.6. Handling conflicts with other packages</h3></div></div></div>
1.75      rillig   7684: <p>Your package may conflict with other packages a user might
1.87      wiz      7685:     already have installed on his system, e.g. if your package
1.88      wiz      7686:     installs the same set of files as another package in the pkgsrc
1.190     wiz      7687:     tree or has the same <code class="varname">PKGNAME</code>.</p>
1.255     leot     7688: <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>
                   7689:     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>
                   7690:     install the same shared library, thus you set in
                   7691:     <code class="filename">pkgsrc/x11/libXaw3d/Makefile</code>:</p>
                   7692: <pre class="programlisting">
                   7693: CONFLICTS=      Xaw-Xpm-[0-9]*
                   7694:     </pre>
                   7695: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
                   7696: <pre class="programlisting">
                   7697: CONFLICTS=      libXaw3d-[0-9]*
                   7698:     </pre>
1.311     leot     7699: <p><a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/pkg_add.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> is able to detect attempts to install packages
1.255     leot     7700:     that conflict with existing packages and abort. However, in many
                   7701:     situations this is too late in the process. Binary package managers
                   7702:     will not know about the conflict until they attempt to install the
                   7703:     package after already downloading it and all its dependencies.
                   7704:     Users may also waste time building a package and its dependencies
                   7705:     only to find out at the end that it conflicts with another package
                   7706:     they have installed.</p>
                   7707: <p>To avoid these issues <code class="varname">CONFLICTS</code> entries
                   7708:     should be added in all cases where it is known that packages conflict
                   7709:     with each other.  These <code class="varname">CONFLICTS</code> entries are
1.311     leot     7710:     exported in <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/pkg_summary.5"><span class="citerefentry"><span class="refentrytitle">pkg_summary</span>(5)</span></a> files and consumed by binary package
1.255     leot     7711:     managers to inform users that packages cannot be installed onto
                   7712:     the target system.</p>
1.75      rillig   7713: </div>
1.148     asau     7714: <div class="sect2">
1.75      rillig   7715: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7716: <a name="not-building-packages"></a>21.1.7. Packages that cannot or should not be built</h3></div></div></div>
1.75      rillig   7717: <p>There are several reasons why a package might be
1.88      wiz      7718:     instructed to not build under certain circumstances.  If the
1.87      wiz      7719:     package builds and runs on most platforms, the exceptions
1.193     dholland 7720:     should be noted with <code class="varname">BROKEN_ON_PLATFORM</code>.  If
                   7721:     the package builds and runs on a small handful of platforms,
                   7722:     set <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> instead.
                   7723:     Both <code class="varname">BROKEN_ON_PLATFORM</code> and
                   7724:     <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> are OS triples
                   7725:     (OS-version-platform) that can use glob-style
                   7726:     wildcards.</p>
                   7727: <p>If a package is not appropriate for some platforms (as
1.225     maya     7728:     opposed to merely broken), a different set of variables should be
1.193     dholland 7729:     used as this affects failure reporting and statistics.
                   7730:     If the package is appropriate for most platforms, the exceptions
1.87      wiz      7731:     should be noted with <code class="varname">NOT_FOR_PLATFORM</code>.  If
1.193     dholland 7732:     the package is appropriate for only a small handful of platforms
                   7733:     (often exactly one), set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
1.87      wiz      7734:     Both <code class="varname">ONLY_FOR_PLATFORM</code> and
                   7735:     <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
                   7736:     (OS-version-platform) that can use glob-style
                   7737:     wildcards.</p>
1.88      wiz      7738: <p>Some packages are tightly bound to a specific version of an
1.250     leot     7739:     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      7740:     backwards compatible with other versions of the OS, and should be
                   7741:     uploaded to a version specific directory on the FTP server.  Mark
                   7742:     these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.128     wiz      7743:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.  This variable is not currently used by any of
1.88      wiz      7744:     the package system internals, but may be used in the
                   7745:     future.</p>
1.75      rillig   7746: <p>If the package should be skipped (for example, because it
1.87      wiz      7747:     provides functionality already provided by the system), set
1.88      wiz      7748:     <code class="varname">PKG_SKIP_REASON</code> to a descriptive message.  If
                   7749:     the package should fail because some preconditions are not met,
                   7750:     set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
1.87      wiz      7751:     message.</p>
1.75      rillig   7752: </div>
1.148     asau     7753: <div class="sect2">
1.75      rillig   7754: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7755: <a name="undeletable-packages"></a>21.1.8. Packages which should not be deleted, once installed</h3></div></div></div>
1.75      rillig   7756: <p>To ensure that a package may not be deleted, once it has been
1.87      wiz      7757:     installed, the <code class="varname">PKG_PRESERVE</code> definition should
                   7758:     be set in the package Makefile. This will be carried into any
                   7759:     binary package that is made from this pkgsrc entry. A
1.128     wiz      7760:     <span class="quote">&#8220;<span class="quote">preserved</span>&#8221;</span> package will
1.311     leot     7761:     not be deleted using <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/pkg_delete.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> unless the
1.128     wiz      7762:     <span class="quote">&#8220;<span class="quote">-f</span>&#8221;</span> option is used.</p>
1.75      rillig   7763: </div>
1.148     asau     7764: <div class="sect2">
1.75      rillig   7765: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7766: <a name="security-handling"></a>21.1.9. Handling packages with security problems</h3></div></div></div>
1.75      rillig   7767: <p>When a vulnerability is found, this should be noted in
1.87      wiz      7768:     <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
1.138     wiz      7769:     and after committing that file, ask pkgsrc-security@NetBSD.org to
                   7770:     update the file on ftp.NetBSD.org.</p>
1.75      rillig   7771: <p>After fixing the vulnerability by a patch, its
1.138     wiz      7772:     <code class="varname">PKGREVISION</code> should be increased (this is of
                   7773:     course not necessary if the problem is fixed by using a newer
                   7774:     release of the software), and the pattern in the
                   7775:     pkg-vulnerabilities file must be updated.</p>
1.75      rillig   7776: <p>Also, if the fix should be applied to the stable pkgsrc
1.87      wiz      7777:     branch, be sure to submit a pullup request!</p>
1.75      rillig   7778: <p>Binary packages already on ftp.NetBSD.org will be handled
1.87      wiz      7779:     semi-automatically by a weekly cron job.</p>
1.75      rillig   7780: </div>
1.148     asau     7781: <div class="sect2">
1.75      rillig   7782: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7783: <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   7784: <p>When making fixes to an existing package it can be useful
1.87      wiz      7785:     to change the version number in <code class="varname">PKGNAME</code>. To
                   7786:     avoid conflicting with future versions by the original author, a
1.128     wiz      7787:     <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      7788:     on package versions by setting <code class="varname">PKGREVISION=1</code>
1.128     wiz      7789:     (2, ...). The <span class="quote">&#8220;<span class="quote">nb</span>&#8221;</span> is treated like a
                   7790:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span> by the package tools. e.g.</p>
1.87      wiz      7791: <pre class="programlisting">
1.100     rillig   7792: DISTNAME=       foo-17.42
                   7793: PKGREVISION=    9
1.222     sevan    7794: </pre>
1.75      rillig   7795: <p>will result in a <code class="varname">PKGNAME</code> of
1.128     wiz      7796:     <span class="quote">&#8220;<span class="quote">foo-17.42nb9</span>&#8221;</span>. If you want to use the original
                   7797:     value of <code class="varname">PKGNAME</code> without the <span class="quote">&#8220;<span class="quote">nbX</span>&#8221;</span>
1.87      wiz      7798:     suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
                   7799:     <code class="varname">PKGNAME_NOREV</code>.</p>
1.75      rillig   7800: <p>When a new release of the package is released, the
1.87      wiz      7801:     <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
                   7802:     minor release of the above package, things should be like:</p>
1.75      rillig   7803: <pre class="programlisting">
1.100     rillig   7804: DISTNAME=       foo-17.43
1.222     sevan    7805: </pre>
1.87      wiz      7806: <p><code class="varname">PKGREVISION</code> should be incremented for any
                   7807:     non-trivial change in the resulting binary package.  Without a
                   7808:     <code class="varname">PKGREVISION</code> bump, someone with the previous
                   7809:     version installed has no way of knowing that their package is out
                   7810:     of date.  Thus, changes without increasing
                   7811:     <code class="varname">PKGREVISION</code> are essentially labeled "this is so
                   7812:     trivial that no reasonable person would want to upgrade", and this
                   7813:     is the rough test for when increasing
                   7814:     <code class="varname">PKGREVISION</code> is appropriate.  Examples of
                   7815:     changes that do not merit increasing
                   7816:     <code class="varname">PKGREVISION</code> are:</p>
1.148     asau     7817: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      7818: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.284     rillig   7819:       <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>, or
                   7820:       comments in Makefile.</p></li>
                   7821: <li class="listitem"><p>Changing build variables if the resulting binary
                   7822:       package is the same.</p></li>
                   7823: <li class="listitem"><p>Changing
                   7824:       <code class="filename">DESCR</code>.</p></li>
                   7825: <li class="listitem"><p>Adding <code class="varname">PKG_OPTIONS</code> if the
                   7826:       default options don't change.</p></li>
1.100     rillig   7827: </ul></div>
1.87      wiz      7828: <p>Examples of changes that do merit an increase to
                   7829:     <code class="varname">PKGREVISION</code> include:</p>
1.148     asau     7830: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.284     rillig   7831: <li class="listitem"><p>Security fixes</p></li>
                   7832: <li class="listitem"><p>Changes or additions to a patch
                   7833:       file</p></li>
                   7834: <li class="listitem"><p>Changes to the
                   7835:       <code class="filename">PLIST</code></p></li>
                   7836: <li class="listitem"><p>A dependency is changed or
                   7837:       renamed.</p></li>
1.100     rillig   7838: </ul></div>
1.78      rillig   7839: <p>PKGREVISION must also be incremented when dependencies have ABI
                   7840:     changes.</p>
1.75      rillig   7841: </div>
1.148     asau     7842: <div class="sect2">
1.79      rillig   7843: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7844: <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   7845: <p>When you want to replace the same text in multiple files, or
                   7846: multiple times in the same file, it is cumbersome to maintain a patch
                   7847: file for this. This is where the SUBST framework steps in. It provides an
                   7848: easy-to-use interface for replacing text in files. It just needs the
                   7849: following information:</p>
                   7850: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   7851: <li class="listitem"><p>In which phase of the package build cycle should the
                   7852: replacement happen?</p></li>
                   7853: <li class="listitem"><p>In which files should the replacement
1.287     rillig   7854: happen?</p></li>
1.295     rillig   7855: <li class="listitem"><p>Which text should be replaced with
                   7856: what?</p></li>
1.287     rillig   7857: </ul></div>
                   7858: <p>This information is encoded in a block of <code class="varname">SUBST</code>
1.295     rillig   7859: variables. A minimal example is:</p>
                   7860: <pre class="programlisting">
                   7861: SUBST_CLASSES+=         paths
                   7862: SUBST_STAGE.paths=      pre-configure
                   7863: SUBST_FILES.paths=      src/*.c
                   7864: SUBST_SED.paths=        -e 's,/usr/local,${PREFIX},g'
                   7865: </pre>
                   7866: <p>Translated into English, it means: In the pre-configure stage (that
                   7867: is, after applying the patches from the patches/ directory and before
                   7868: running the configure script and the portability check), replace the text
                   7869: <code class="literal">/usr/local</code> with the content of the variable
                   7870: <code class="varname">PREFIX</code>.</p>
                   7871: <p>Each SUBST block starts by appending an identifier to
                   7872: <code class="varname">SUBST_CLASSES</code> (note the <code class="literal">+=</code>). This
                   7873: identifier can be chosen freely by the package. If there should ever be
                   7874: duplicate identifiers, the pkgsrc infrastructure will catch this and fail
                   7875: early, so don't worry about name collisions.</p>
                   7876: <p>Except for <code class="varname">SUBST_CLASSES</code>, all variables in a
                   7877: SUBST block are parameterized using this identifier. In the remainder of
                   7878: this section, these parameterized variables are written as
                   7879: <code class="varname">SUBST_STAGE.*</code>.</p>
                   7880: <pre class="programlisting">
                   7881: SUBST_CLASSES+=         paths
                   7882: SUBST_STAGE.paths=      pre-configure
                   7883: SUBST_MESSAGE.paths=    Fixing absolute paths.
                   7884: SUBST_FILES.paths=      src/*.c
                   7885: SUBST_FILES.paths+=     scripts/*.sh
                   7886: SUBST_SED.paths=        -e 's,"/usr/local,"${PREFIX},g'
                   7887: SUBST_SED.paths+=       -e 's,"/var/log,"${VARBASE}/log,g'
                   7888: SUBST_VARS.paths=       LOCALBASE PREFIX PKGVERSION
                   7889: </pre>
                   7890: <p>To get a complete picture about the SUBST substitutions, run
                   7891: <span class="command"><strong>bmake show-all-subst</strong></span>. If something doesn't work as
                   7892: expected, run pkglint on the package, which detects several typical
                   7893: mistakes surrounding the SUBST blocks. For any questions that might
                   7894: remain after this, have a look at
                   7895: <code class="filename">mk/subst.mk</code>.</p>
                   7896: <div class="sect3">
                   7897: <div class="titlepage"><div><div><h4 class="title">
                   7898: <a name="fixes.subst.when"></a>21.1.11.1. Choosing the time where the substitutions happen</h4></div></div></div>
                   7899: <p>The <code class="varname">SUBST_STAGE.*</code> is one of
                   7900: {pre,do,post}-{extract,patch,configure,build,test,install}. Of these,
                   7901: <code class="literal">pre-configure</code> is used most often, by far. The most
                   7902: popular stages are, in chronological order:</p>
                   7903: <div class="variablelist"><dl class="variablelist">
                   7904: <dt><span class="term"><code class="literal">post-extract</code></span></dt>
                   7905: <dd>
                   7906: <p>The substitutions are applied immediately after the
                   7907: distfiles are extracted. Running <span class="command"><strong>bmake extract</strong></span> on the
                   7908: package will leave no traces of the original files.</p>
                   7909: <p>When the substitution applies to files for which there is also a
                   7910: patch in the <code class="filename">patches/</code> directory, this means that the
                   7911: patches will be computed based on the result of the substitution. When
                   7912: these patches are sent to the upstream maintainer later, to be fixed in
                   7913: the upstream package, these patches may no longer match what the upstream
                   7914: author is used to. Because of this, <code class="literal">pre-configure</code> is
                   7915: often a better choice.</p>
                   7916: </dd>
                   7917: <dt><span class="term"><code class="literal">pre-configure</code></span></dt>
                   7918: <dd>
                   7919: <p>The substitutions are applied after the patches from the
                   7920: <code class="filename">patches/</code> directory. This makes it possible to run
                   7921: <span class="command"><strong>bmake patch</strong></span> on the package, after which the patches
                   7922: 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>
                   7923: <p>When updating the patches, it is helpful to explicitly separate the
                   7924: <span class="command"><strong>bmake patch</strong></span> from the <span class="command"><strong>bmake
                   7925: configure</strong></span>, and to only edit the patches between these commands.
                   7926: Otherwise the substitutions from the SUBST block will end up in the patch
                   7927: file. When this happens in really obvious ways, pkglint will complain
                   7928: about patches that contain a hard-coded <code class="literal">/usr/pkg</code>
                   7929: instead of the correct and intended <code class="literal">@PREFIX@</code>, but it
                   7930: can only detect these really obvious
                   7931: cases.</p>
                   7932: </dd>
                   7933: <dt><span class="term"><code class="literal">do-configure</code></span></dt>
                   7934: <dd><p>This stage should only be used if the package defines a
                   7935: <code class="literal">pre-configure</code> action itself, and the substitution must
                   7936: happen after that. Typical examples are packages that use the
                   7937: <code class="literal">pre-configure</code> stage to regenerate the GNU configure
                   7938: script from
                   7939: <code class="filename">configure.ac</code>.</p></dd>
                   7940: <dt><span class="term"><code class="literal">post-configure</code></span></dt>
                   7941: <dd><p>This stage is used to fix up any mistakes by the
                   7942: configure stage.</p></dd>
                   7943: <dt><span class="term"><code class="literal">pre-build</code></span></dt>
                   7944: <dd><p>This stage should only be used for substitutions that are
                   7945: clearly related to building the package, not for fixing the
                   7946: configuration. Substitutions for pathnames (such as replacing
                   7947: <code class="filename">/usr/local</code> with <code class="literal">${PREFIX}</code>) or
                   7948: user names (such as replacing <code class="literal">@MY_USER@</code> with the
                   7949: actual username) belong in pre-configure or post-configure
                   7950: instead.</p></dd>
                   7951: <dt><span class="term"><code class="literal">post-build</code></span></dt>
                   7952: <dd>
                   7953: <p>Just as with pre-build, this stage should only be used
                   7954: for substitutions that are clearly related to building the package, not
                   7955: for fixing the configuration. Substitutions for pathnames (such as
                   7956: replacing <code class="filename">/usr/local</code> with
                   7957: <code class="literal">${PREFIX}</code>) or user names (such as replacing
                   7958: <code class="literal">@MY_USER@</code> with the actual username) belong in
                   7959: pre-configure or post-configure instead.</p>
                   7960: <p>A typical use is to update pkg-config files to include the rpath
                   7961: compiler options.</p>
                   7962: </dd>
                   7963: <dt><span class="term"><code class="literal">pre-install</code></span></dt>
                   7964: <dd><p>In general, the install phase should be as simple as
                   7965: possible. As with the pre-build and post-build stages, it should not be
                   7966: used to fix pathnames or user names, these belong in pre-configure
                   7967: instead. There are only few legitimate use cases for applying
                   7968: substitutions in this stage.</p></dd>
                   7969: </dl></div>
                   7970: </div>
                   7971: <div class="sect3">
                   7972: <div class="titlepage"><div><div><h4 class="title">
1.296     rillig   7973: <a name="fixes.subst.where"></a>21.1.11.2. Choosing the files where the substitutions happen</h4></div></div></div>
1.295     rillig   7974: <p>The <code class="varname">SUBST_FILES.*</code> variable contains a list of
                   7975: filename patterns. These patterns are relative to
                   7976: <code class="varname">WRKSRC</code> since that is where most substitutions happen.
                   7977: A typical example is:</p>
                   7978: <pre class="programlisting">
                   7979: SUBST_FILES.path=       Makefile */Makefile */*/Makefile *.[ch]
                   7980: </pre>
                   7981: <p>The above patterns, especially the last, are quite broad. The SUBST
                   7982: implementation checks that each filename pattern that is mentioned here
                   7983: has an effect. For example, if none of the
                   7984: <code class="filename">*/*/Makefile</code> files contains the patterns to be found
                   7985: and substituted, that filename pattern is redundant and should be left
1.296     rillig   7986: out. By default, the SUBST framework will complain with an error message.
                   7987: If the text to be substituted occurs in some of the files from a single
                   7988: pattern, but not in all of them, that is totally ok, and the SUBST
1.295     rillig   7989: framework will only print an INFO message for those files.</p>
                   7990: <p>If there is a good reason for having redundant filename patterns,
1.296     rillig   7991: set <code class="varname">SUBST_NOOP_OK.*</code> to <code class="literal">yes</code>.</p>
1.295     rillig   7992: <p>Another popular way of choosing the files for the substitutions is
                   7993: via a shell command, like this:</p>
                   7994: <pre class="programlisting">
1.296     rillig   7995: C_FILES_CMD=            cd ${WRKSRC} &amp;&amp; ${FIND} . -name '*.c'
1.295     rillig   7996: SUBST_FILES.path=       ${C_FILES_CMD:sh}
                   7997: </pre>
                   7998: <p>The variable name <code class="varname">C_FILES_CMD</code> in this example is
                   7999: freely chosen and independent of the SUBST framework.</p>
                   8000: <p>In this variant, the <code class="varname">SUBST_FILES.*</code> variable
                   8001: lists each file individually. Thereby chances are higher that there are
                   8002: filename patterns in which no substitution happens. Since the SUBST
                   8003: framework cannot know whether the filename patterns in
                   8004: <code class="varname">SUBST_FILES.*</code> have been explicitly listed in the
                   8005: Makefile (where any redundant filename pattern would be suspicious) or
                   8006: been generated by a shell command (in which redundant filename patterns
                   8007: are more likely and to be expected), it will complain about these
                   8008: redundant filename patterns. Therefore, SUBST blocks that use a shell
                   8009: command to generate the list of filename patterns often need to set
                   8010: <code class="varname">SUBST_NOOP_OK.*</code> to <code class="literal">yes</code>.</p>
                   8011: </div>
                   8012: <div class="sect3">
                   8013: <div class="titlepage"><div><div><h4 class="title">
                   8014: <a name="fixes.subst.what"></a>21.1.11.3. Choosing what to substitute</h4></div></div></div>
                   8015: <p>In most cases, the substitutions are given using one or more
1.311     leot     8016: <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/sed.1"><span class="citerefentry"><span class="refentrytitle">sed</span>(1)</span></a> commands, like this:</p>
1.295     rillig   8017: <pre class="programlisting">
                   8018: SUBST_SED.path=         -e 's|/usr/local|${PREFIX}|g'
                   8019: </pre>
                   8020: <p>Each of the sed commands needs to be preceded by the
                   8021: <code class="literal">-e</code> option and should be specified on a line of its
                   8022: own, to avoid hiding short sed commands at the end of a line.</p>
                   8023: <p>Since the sed commands often contain shell metacharacters as the
                   8024: separator (the <code class="literal">|</code> in the above example), it is common
                   8025: to enclose them in single quotes.</p>
                   8026: <p>A common substitution is to replace placeholders of the form
                   8027: <code class="literal">@VARNAME@</code> with their pkgsrc counterpart variable
                   8028: <code class="literal">${VARNAME}</code>. A typical example is:</p>
                   8029: <pre class="programlisting">
                   8030: SUBST_VARS.path=        PREFIX
                   8031: </pre>
                   8032: <p>This type of substitutions is typically done by the GNU configure
1.296     rillig   8033: scripts during the do-configure stage, but in some cases these need to be
                   8034: overridden. The same pattern is also used when a package defines patches
                   8035: that replace previously hard-coded paths like
                   8036: <code class="literal">/usr/local</code> with a <code class="literal">@PREFIX@</code>
                   8037: placeholder first, which then gets substituted by the actual
                   8038: <code class="literal">${PREFIX}</code> in the pre-configure stage. In many of these
                   8039: cases, it works equally well to just use the SUBST framework to directly
                   8040: replace <code class="literal">/usr/local</code> with <code class="literal">${PREFIX}</code>,
                   8041: thereby omitting the intermediate patch file.</p>
1.295     rillig   8042: <p>If the above is not flexible enough, it is possible to not use sed
                   8043: at all for the substitution but to specify an entirely different command,
                   8044: like this:</p>
1.87      wiz      8045: <pre class="programlisting">
1.295     rillig   8046: SUBST_FILTER_CMD.path=  LC_ALL=C ${TR} -d '\r'
                   8047: </pre>
                   8048: <p>This is used for the few remaining packages in which the
                   8049: distributed files use Windows-style line endings that need to be
                   8050: converted to UNIX-style line endings.</p>
                   8051: </div>
                   8052: <div class="sect3">
                   8053: <div class="titlepage"><div><div><h4 class="title">
                   8054: <a name="fixes.subst.other"></a>21.1.11.4. Other SUBST variables</h4></div></div></div>
                   8055: <p>When a SUBST block is applied during a package build, a message is
                   8056: logged. The default message is fine for most purposes but can be
                   8057: overridden by setting <code class="literal">SUBST_MESSAGE.*</code> to an individual
                   8058: message.</p>
                   8059: </div>
1.79      rillig   8060: </div>
1.75      rillig   8061: </div>
1.148     asau     8062: <div class="sect1">
1.75      rillig   8063: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   8064: <a name="fixes.fetch"></a>21.2. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.148     asau     8065: <div class="sect2">
1.75      rillig   8066: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8067: <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   8068: <p>If you need to download from a dynamic URL you can set
1.110     hubertf  8069:     <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.87      wiz      8070:     fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
                   8071:     with the name of each file to download as an argument, expecting
                   8072:     it to output the URL of the directory from which to download
1.250     leot     8073:     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      8074:     example of this usage.</p>
1.75      rillig   8075: <p>If the download can't be automated, because the user must
1.87      wiz      8076:     submit personal information to apply for a password, or must pay
                   8077:     for the source, or whatever, you can set
                   8078:     <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
                   8079:     displayed to the user before aborting the build. Example:</p>
                   8080: <pre class="programlisting">
1.100     rillig   8081: FETCH_MESSAGE=  "Please download the files"
                   8082: FETCH_MESSAGE+= "    "${DISTFILES:Q}
                   8083: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.222     sevan    8084: </pre>
1.75      rillig   8085: </div>
1.148     asau     8086: <div class="sect2">
1.75      rillig   8087: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8088: <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   8089: <p>Sometimes authors of a software package make some
1.87      wiz      8090:     modifications after the software was released, and they put up a
                   8091:     new distfile without changing the package's version number. If a
                   8092:     package is already in pkgsrc at that time, the checksum will
                   8093:     no longer match. The contents of the new distfile should be
                   8094:     compared against the old one before changing anything, to make
                   8095:     sure the distfile was really updated on purpose, and that
                   8096:     no trojan horse or so crept in.
1.97      rillig   8097:     Please mention that the distfiles were compared and what was found
1.159     rodent   8098:     in your commit message.</p>
1.220     wiz      8099: <p>Then, the correct way to work around this is to set
                   8100:     <code class="varname">DIST_SUBDIR</code> to a unique directory name, usually
                   8101:     based on <code class="varname">PKGNAME_NOREV</code> (but take care with
                   8102:     python or ruby packages, where <code class="varname">PKGNAME</code> includes
                   8103:     a variable prefix). All <code class="varname">DISTFILES</code> and
1.93      rillig   8104:     <code class="varname">PATCHFILES</code> for this package will be put in that
1.267     rillig   8105:     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      8106:     happens more often, <code class="varname">PKGNAME</code> can be used (thus
1.220     wiz      8107:     including the <code class="filename">nbX</code> suffix) or a date stamp can
                   8108:     be appended, like
                   8109:     <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.</p>
1.284     rillig   8110: <p><code class="varname">DIST_SUBDIR</code> is also used when a distfile's
                   8111:     name does not contain a version and the distfile is apt to change. In
                   8112:     cases where the likelihood of this is very small,
                   8113:     <code class="varname">DIST_SUBDIR</code> might not be required. Additionally,
                   8114:     <code class="varname">DIST_SUBDIR</code> must not be removed unless the
                   8115:     distfile name changes, even if a package is being moved or
                   8116:     renamed.</p>
1.159     rodent   8117: <p>Do not forget regenerating the <code class="filename">distinfo</code> file
1.87      wiz      8118:     after that, since it contains the <code class="varname">DIST_SUBDIR</code>
                   8119:     path in the filenames.
1.159     rodent   8120:     Also, increase the PKGREVISION if the installed package is different.
1.87      wiz      8121:     Furthermore, a mail to the package's authors seems appropriate
                   8122:     telling them that changing distfiles after releases without
                   8123:     changing the file names is not good practice.</p>
1.75      rillig   8124: </div>
1.199     tnn      8125: <div class="sect2">
                   8126: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8127: <a name="build.fetch.github"></a>21.2.3. Packages hosted on github.com</h3></div></div></div>
1.284     rillig   8128: <p>Helper methods exist for packages hosted on github.com which
                   8129:     will often have distfile names that clash with other packages, for
                   8130:     example <code class="filename">1.0.tar.gz</code>. Use one of the three recipes
                   8131:     from below:</p>
1.199     tnn      8132: <div class="sect3">
                   8133: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   8134: <a name="build.fetch.github.tag"></a>21.2.3.1. Fetch based on a tagged release</h4></div></div></div>
1.284     rillig   8135: <p>If your distfile URL looks similar to
1.303     bacon    8136:       <code class="literal">https://github.com/username/example/archive/v1.0.zip</code>,
1.284     rillig   8137:       then you are packaging a tagged release.</p>
1.199     tnn      8138: <pre class="programlisting">
1.303     bacon    8139: DISTNAME=       example-1.0
1.200     tnn      8140: MASTER_SITES=   ${MASTER_SITE_GITHUB:=username/}
1.303     bacon    8141: #GITHUB_PROJECT= example    # can be omitted if same as DISTNAME
1.200     tnn      8142: GITHUB_TAG=     v${PKGVERSION_NOREV}
1.199     tnn      8143: EXTRACT_SUFX=   .zip
                   8144: </pre>
                   8145: </div>
                   8146: <div class="sect3">
                   8147: <div class="titlepage"><div><div><h4 class="title">
1.303     bacon    8148: <a name="build.fetch.github.commit.prerelease"></a>21.2.3.2. Fetch based on a specific commit before the first release</h4></div></div></div>
                   8149: <p>If your distfile looks similar to
                   8150:       <code class="literal">https://github.com/username/example/archive/988881adc9fc3655077dc2d4d757d480b5ea0e11</code> and is from a commit before the first
                   8151:       release, then set the package version to 0.0.0.N, where N is the number
                   8152:       of commits to the repository, and set GITHUB_TAG to the commit hash.
                   8153:       This will (almost) ensure that the first tagged release will have a
                   8154:       version greater than this one so that package upgrades will function
                   8155:       properly.</p>
                   8156: <pre class="programlisting">
                   8157: DISTNAME=       example-0.0.0.347
                   8158: MASTER_SITES=   ${MASTER_SITE_GITHUB:=username/}
                   8159: #GITHUB_PROJECT= example    # can be omitted if same as DISTNAME
                   8160: GITHUB_TAG=     988881adc9fc3655077dc2d4d757d480b5ea0e11
                   8161: </pre>
                   8162: </div>
                   8163: <div class="sect3">
                   8164: <div class="titlepage"><div><div><h4 class="title">
                   8165: <a name="build.fetch.github.commit.postrelease"></a>21.2.3.3. Fetch based on a specific commit after a release</h4></div></div></div>
                   8166: <p>If your distfile looks similar to
                   8167:       <code class="literal">https://github.com/username/example/archive/988881adc9fc3655077dc2d4d757d480b5ea0e11</code> and is from a commit after a release,
                   8168:       then include the last release version and the commit count since that
                   8169:       release in the package version and set GITHUB_TAG to the commit hash.
                   8170:       The latest release and commit count are shown in the output of
                   8171:       "git describe --tags":
                   8172:       </p>
                   8173: <pre class="screen">
                   8174: # git clone https://github.com/username/example
                   8175: # cd example
                   8176: # git describe --tags
                   8177: 1.2.3-5-g988881a
                   8178: </pre>
1.199     tnn      8179: <pre class="programlisting">
1.303     bacon    8180: DISTNAME=       example-1.2.3.5
                   8181: MASTER_SITES=   ${MASTER_SITE_GITHUB:=username/}
                   8182: #GITHUB_PROJECT= example    # can be omitted if same as DISTNAME
1.200     tnn      8183: GITHUB_TAG=     988881adc9fc3655077dc2d4d757d480b5ea0e11
1.222     sevan    8184: </pre>
1.199     tnn      8185: </div>
                   8186: <div class="sect3">
                   8187: <div class="titlepage"><div><div><h4 class="title">
1.303     bacon    8188: <a name="build.fetch.github.release"></a>21.2.3.4. Fetch based on release</h4></div></div></div>
1.284     rillig   8189: <p>If your distfile URL looks similar to
1.303     bacon    8190:       <code class="literal">https://github.com/username/example/releases/download/rel-1.6/offensive-1.6.zip</code>,
1.284     rillig   8191:       then you are packaging a release.</p>
1.199     tnn      8192: <pre class="programlisting">
                   8193: DISTNAME=       offensive-1.6
1.200     tnn      8194: PKGNAME=        ${DISTNAME:S/offensive/proper/}
                   8195: MASTER_SITES=   ${MASTER_SITE_GITHUB:=username/}
1.303     bacon    8196: GITHUB_PROJECT= example
1.200     tnn      8197: GITHUB_RELEASE= rel-${PKGVERSION_NOREV} # usually just set this to ${DISTNAME}
                   8198: EXTRACT_SUFX=   .zip
1.222     sevan    8199: </pre>
1.199     tnn      8200: </div>
                   8201: </div>
1.75      rillig   8202: </div>
1.148     asau     8203: <div class="sect1">
1.75      rillig   8204: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   8205: <a name="fixes.configure"></a>21.3. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.148     asau     8206: <div class="sect2">
1.75      rillig   8207: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8208: <a name="fixes.libtool"></a>21.3.1. Shared libraries - libtool</h3></div></div></div>
1.75      rillig   8209: <p>pkgsrc supports many different machines, with different
1.87      wiz      8210:     object formats like a.out and ELF, and varying abilities to do
                   8211:     shared library and dynamic loading at all. To accompany this,
                   8212:     varying commands and options have to be passed to the
                   8213:     compiler, linker, etc. to get the Right Thing, which can be
                   8214:     pretty annoying especially if you don't have all the machines
                   8215:     at your hand to test things.  The
1.250     leot     8216:     <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      8217:     can help here, as it just <span class="quote">&#8220;<span class="quote">knows</span>&#8221;</span> how to build
1.87      wiz      8218:     both static and dynamic libraries from a set of source files,
                   8219:     thus being platform-independent.</p>
                   8220: <p>Here's how to use libtool in a package in seven simple
                   8221:     steps:</p>
1.128     wiz      8222: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8223: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.87      wiz      8224:        Makefile.</p></li>
1.128     wiz      8225: <li class="listitem"><p>For library objects, use <span class="quote">&#8220;<span class="quote">${LIBTOOL} --mode=compile
                   8226:        ${CC}</span>&#8221;</span> in place of <span class="quote">&#8220;<span class="quote">${CC}</span>&#8221;</span>. You could even
1.87      wiz      8227:        add it to the definition of <code class="varname">CC</code>, if only
                   8228:        libraries are being built in a given Makefile. This one command
                   8229:        will build both PIC and non-PIC library objects, so you need not
                   8230:        have separate shared and non-shared library rules.</p></li>
1.128     wiz      8231: <li class="listitem">
1.75      rillig   8232: <p>For the linking of the library, remove any
1.128     wiz      8233:        <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
                   8234:        -Bshareable</span>&#8221;</span> commands, and instead use:</p>
1.75      rillig   8235: <pre class="programlisting">
1.100     rillig   8236: ${LIBTOOL} --mode=link \
                   8237:     ${CC} -o ${.TARGET:.a=.la} \
                   8238:         ${OBJS:.o=.lo} \
                   8239:         -rpath ${PREFIX}/lib \
                   8240:         -version-info major:minor
1.222     sevan    8241: </pre>
1.75      rillig   8242: <p>Note that the library is changed to have a
1.87      wiz      8243:        <code class="filename">.la</code> extension, and the objects are
                   8244:        changed to have a <code class="filename">.lo</code>
                   8245:        extension. Change <code class="varname">OBJS</code> as
                   8246:        necessary. This automatically creates all of the
                   8247:        <code class="filename">.a</code>,
                   8248:        <code class="filename">.so.major.minor</code>, and ELF symlinks (if
                   8249:        necessary) in the build directory. Be sure to include
1.128     wiz      8250:        <span class="quote">&#8220;<span class="quote">-version-info</span>&#8221;</span>, especially when major and
1.87      wiz      8251:        minor are zero, as libtool will otherwise strip off the
                   8252:        shared library version.</p>
1.75      rillig   8253: <p>From the libtool manual:</p>
                   8254: <pre class="programlisting">
1.100     rillig   8255: So, libtool library versions are described by three integers:
1.69      rillig   8256: 
1.100     rillig   8257: CURRENT
                   8258: The most recent interface number that this library implements.
1.69      rillig   8259: 
1.100     rillig   8260: REVISION
                   8261: The implementation number of the CURRENT interface.
1.69      rillig   8262: 
1.100     rillig   8263: AGE
                   8264: The difference between the newest and oldest interfaces that
                   8265: this library implements.  In other words, the library implements
                   8266: all the interface numbers in the range from number `CURRENT -
                   8267: AGE' to `CURRENT'.
1.1       grant    8268: 
1.100     rillig   8269: If two libraries have identical CURRENT and AGE numbers, then the
                   8270: dynamic linker chooses the library with the greater REVISION number.
1.222     sevan    8271: </pre>
1.128     wiz      8272: <p>The <span class="quote">&#8220;<span class="quote">-release</span>&#8221;</span> option will produce
1.87      wiz      8273:        different results for a.out and ELF (excluding symlinks)
                   8274:        in only one case. An ELF library of the form
1.128     wiz      8275:        <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      8276:        will have a symlink of
1.128     wiz      8277:        <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      8278:        on an a.out platform. This is handled
                   8279:        automatically.</p>
1.128     wiz      8280: <p>The <span class="quote">&#8220;<span class="quote">-rpath argument</span>&#8221;</span> is the install
1.87      wiz      8281:        directory of the library being built.</p>
1.76      rillig   8282: <p>In the <code class="filename">PLIST</code>, include only the
1.87      wiz      8283:        <code class="filename">.la</code> file, the other files will be
                   8284:        added automatically.</p>
1.75      rillig   8285: </li>
1.128     wiz      8286: <li class="listitem">
1.76      rillig   8287: <p>When linking shared object (<code class="filename">.so</code>)
1.311     leot     8288:        files, i.e. files that are loaded via <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/dlopen.3"><span class="citerefentry"><span class="refentrytitle">dlopen</span>(3)</span></a>, NOT
1.128     wiz      8289:        shared libraries, use <span class="quote">&#8220;<span class="quote">-module
                   8290:        -avoid-version</span>&#8221;</span> to prevent them getting version
1.87      wiz      8291:        tacked on.</p>
1.76      rillig   8292: <p>The <code class="filename">PLIST</code> file gets the
1.87      wiz      8293:        <code class="filename">foo.so</code> entry.</p>
1.75      rillig   8294: </li>
1.128     wiz      8295: <li class="listitem">
1.75      rillig   8296: <p>When linking programs that depend on these libraries
1.87      wiz      8297:        <span class="emphasis"><em>before</em></span> they are installed, preface
1.311     leot     8298:        the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/cc.1"><span class="citerefentry"><span class="refentrytitle">cc</span>(1)</span></a> or <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/ld.1"><span class="citerefentry"><span class="refentrytitle">ld</span>(1)</span></a> line with <span class="quote">&#8220;<span class="quote">${LIBTOOL}
1.128     wiz      8299:        --mode=link</span>&#8221;</span>, and it will find the correct
1.87      wiz      8300:        libraries (static or shared), but please be aware that
                   8301:        libtool will not allow you to specify a relative path in
1.128     wiz      8302:        -L (such as <span class="quote">&#8220;<span class="quote">-L../somelib</span>&#8221;</span>), because it
1.87      wiz      8303:        expects you to change that argument to be the
                   8304:        <code class="filename">.la</code> file. e.g.</p>
1.75      rillig   8305: <pre class="programlisting">
1.100     rillig   8306: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.222     sevan    8307: </pre>
1.75      rillig   8308: <p>should be changed to:</p>
                   8309: <pre class="programlisting">
1.100     rillig   8310: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.222     sevan    8311: </pre>
1.75      rillig   8312: <p>and it will do the right thing with the libraries.</p>
                   8313: </li>
1.128     wiz      8314: <li class="listitem">
1.311     leot     8315: <p>When installing libraries, preface the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/install.1"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a>
                   8316:        or <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/cp.1"><span class="citerefentry"><span class="refentrytitle">cp</span>(1)</span></a> command with <span class="quote">&#8220;<span class="quote">${LIBTOOL}
1.128     wiz      8317:        --mode=install</span>&#8221;</span>, and change the library name to
1.87      wiz      8318:        <code class="filename">.la</code>. e.g.</p>
1.75      rillig   8319: <pre class="programlisting">
1.126     jakllsch 8320: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.222     sevan    8321: </pre>
1.76      rillig   8322: <p>This will install the static <code class="filename">.a</code>,
1.87      wiz      8323:        shared library, any needed symlinks, and run
1.311     leot     8324:        <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/ldconfig.8"><span class="citerefentry"><span class="refentrytitle">ldconfig</span>(8)</span></a>.</p>
1.75      rillig   8325: </li>
1.128     wiz      8326: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.87      wiz      8327:        the <code class="filename">.la</code>
                   8328:        file (this is a change from previous behaviour).</p></li>
1.75      rillig   8329: </ol></div>
                   8330: </div>
1.148     asau     8331: <div class="sect2">
1.75      rillig   8332: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8333: <a name="using-libtool"></a>21.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.75      rillig   8334: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
1.87      wiz      8335:     package Makefile. This will override the package's own libtool
                   8336:     in most cases.  For older libtool using packages,  libtool is
                   8337:     made by ltconfig script during the do-configure step; you can
1.110     hubertf  8338:     check the libtool script location by doing <span class="command"><strong>make
1.87      wiz      8339:     configure; find work*/ -name libtool</strong></span>.</p>
1.75      rillig   8340: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
1.87      wiz      8341:     scripts, relative to <code class="varname">WRKSRC</code>, to override.  By
1.128     wiz      8342:     default, it is set to <span class="quote">&#8220;<span class="quote">libtool */libtool
                   8343:     */*/libtool</span>&#8221;</span>.  If this does not match the location of the
1.87      wiz      8344:     package's libtool script(s), set it as appropriate.</p>
1.76      rillig   8345: <p>If you do not need <code class="filename">*.a</code> static
1.87      wiz      8346:     libraries built and installed, then use
                   8347:     <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
1.75      rillig   8348: <p>If your package makes use of the platform-independent library
1.87      wiz      8349:     for loading dynamic shared objects, that comes with libtool
                   8350:     (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
                   8351: <p>Some packages use libtool incorrectly so that the package
                   8352:     may not work or build in some circumstances. Some of the more
                   8353:     common errors are:</p>
1.148     asau     8354: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      8355: <li class="listitem">
1.75      rillig   8356: <p>The inclusion of a shared object (-module) as a dependent library in an
1.87      wiz      8357:        executable or library. This in itself isn't a problem if one of two things
                   8358:        has been done:</p>
1.128     wiz      8359: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8360: <li class="listitem"><p>The shared object is named correctly, i.e.
1.87      wiz      8361:            <code class="filename">libfoo.la</code>, not
                   8362:            <code class="filename">foo.la</code></p></li>
1.128     wiz      8363: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.75      rillig   8364: </ol></div>
                   8365: </li>
1.128     wiz      8366: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.87      wiz      8367:        The function lt_dlinit() should be called and the macro
                   8368:        <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
                   8369:        executables.</p></li>
1.75      rillig   8370: </ul></div>
                   8371: </div>
1.148     asau     8372: <div class="sect2">
1.75      rillig   8373: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8374: <a name="autoconf-automake"></a>21.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.75      rillig   8375: <p>If a package needs GNU autoconf or automake to be executed
1.87      wiz      8376:     to regenerate the configure script and Makefile.in makefile
                   8377:     templates, then they should be executed in a pre-configure
                   8378:     target.</p>
1.75      rillig   8379: <p>For packages that need only autoconf:</p>
                   8380: <pre class="programlisting">
1.100     rillig   8381: AUTOCONF_REQD=  2.50            # if default version is not good enough
                   8382: USE_TOOLS+=     autoconf        # use "autoconf213" for autoconf-2.13
                   8383: ...
1.1       grant    8384: 
1.100     rillig   8385: pre-configure:
                   8386:         cd ${WRKSRC} &amp;&amp; autoconf
1.1       grant    8387: 
1.100     rillig   8388: ...
1.222     sevan    8389: </pre>
1.75      rillig   8390: <p>and for packages that need automake and autoconf:</p>
                   8391: <pre class="programlisting">
1.100     rillig   8392: AUTOMAKE_REQD=  1.7.1           # if default version is not good enough
                   8393: USE_TOOLS+=     automake        # use "automake14" for automake-1.4
                   8394: ...
                   8395: 
                   8396: pre-configure:
                   8397:         set -e; cd ${WRKSRC}; \
                   8398:         aclocal; autoheader; automake -a --foreign -i; autoconf
1.1       grant    8399: 
1.100     rillig   8400: ...
1.222     sevan    8401: </pre>
1.75      rillig   8402: <p>Packages which use GNU Automake will almost certainly
1.87      wiz      8403:     require GNU Make.</p>
1.75      rillig   8404: <p>There are times when the configure process makes
1.87      wiz      8405:     additional changes to the generated files, which then causes
                   8406:     the build process to try to re-execute the automake sequence.
                   8407:     This is prevented by touching various files in the configure
                   8408:     stage. If this causes problems with your package you can set
                   8409:     <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
                   8410:     Makefile.</p>
1.75      rillig   8411: </div>
                   8412: </div>
1.148     asau     8413: <div class="sect1">
1.75      rillig   8414: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   8415: <a name="programming-languages"></a>21.4. Programming languages</h2></div></div></div>
1.148     asau     8416: <div class="sect2">
1.87      wiz      8417: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8418: <a name="basic-programming-languages"></a>21.4.1. C, C++, and Fortran</h3></div></div></div>
1.87      wiz      8419: <p>Compilers for the C, C++, and Fortran languages comes with
                   8420:     the NetBSD base system.  By default, pkgsrc assumes that a package
                   8421:     is written in C and will hide all other compilers (via the wrapper
1.299     rillig   8422:     framework, see <a class="xref" href="#buildlink" title="Chapter 18. Buildlink methodology">Chapter 18, <i>Buildlink methodology</i></a>).</p>
1.87      wiz      8423: <p>To declare which language's compiler a package needs, set
                   8424:     the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.128     wiz      8425:     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
                   8426:     <span class="quote">&#8220;<span class="quote">fortran</span>&#8221;</span> (and any combination).  The default is
                   8427:     <span class="quote">&#8220;<span class="quote">c</span>&#8221;</span>.  Packages using GNU configure scripts, even if
1.87      wiz      8428:     written in C++, usually need a C compiler for the configure
                   8429:     phase.</p>
                   8430: </div>
1.148     asau     8431: <div class="sect2">
1.87      wiz      8432: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8433: <a name="java-programming-language"></a>21.4.2. Java</h3></div></div></div>
1.87      wiz      8434: <p>If a program is written in Java, use the Java framework in
                   8435:     pkgsrc.  The package must include
                   8436:     <code class="filename">../../mk/java-vm.mk</code>.  This Makefile fragment
                   8437:     provides the following variables:</p>
1.148     asau     8438: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      8439: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.87      wiz      8440:       dependency on the JDK is added.  If
1.128     wiz      8441:       <code class="varname">USE_JAVA</code> is set to <span class="quote">&#8220;<span class="quote">run</span>&#8221;</span>, then
1.87      wiz      8442:       there is only a runtime dependency on the JDK.  The default is
1.128     wiz      8443:       <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>, which also adds a build dependency on the
1.87      wiz      8444:       JDK.</p></li>
1.128     wiz      8445: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.87      wiz      8446:       a package needs a Java2 implementation.  The supported values
1.128     wiz      8447:       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
                   8448:       <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
                   8449:       implementation, <span class="quote">&#8220;<span class="quote">1.4</span>&#8221;</span> insists on versions 1.4 or
                   8450:       above, and <span class="quote">&#8220;<span class="quote">1.5</span>&#8221;</span> only accepts versions 1.5 or
1.87      wiz      8451:       above. This variable is not set by default.</p></li>
1.130     wiz      8452: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
                   8453:       automatically set to the runtime location of the used Java
                   8454:       implementation dependency. It may be used to set
                   8455:       <code class="varname">JAVA_HOME</code> to a good value if the program
                   8456:       needs this variable to be defined.
                   8457:       </p></li>
1.87      wiz      8458: </ul></div>
                   8459: </div>
1.148     asau     8460: <div class="sect2">
1.87      wiz      8461: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8462: <a name="perl-scripts"></a>21.4.3. Packages containing perl scripts</h3></div></div></div>
1.87      wiz      8463: <p>If your package contains interpreted perl scripts, add
1.128     wiz      8464:     <span class="quote">&#8220;<span class="quote">perl</span>&#8221;</span> to the <code class="varname">USE_TOOLS</code> variable
1.87      wiz      8465:     and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
                   8466:     interpreter path is set. <code class="varname">REPLACE_PERL</code> should
                   8467:     contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
1.183     wiz      8468:     that you want adjusted. Every occurrence of
                   8469:     <code class="filename">*/bin/perl</code> in a she-bang line will be
                   8470:     replaced with the full path to the perl executable.</p>
1.87      wiz      8471: <p>If a particular version of perl is needed, set the
                   8472:     <code class="varname">PERL5_REQD</code> variable to the version number.  The
1.128     wiz      8473:     default is <span class="quote">&#8220;<span class="quote">5.0</span>&#8221;</span>.</p>
1.267     rillig   8474: <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      8475:     about handling perl modules.</p>
                   8476: </div>
1.148     asau     8477: <div class="sect2">
1.87      wiz      8478: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8479: <a name="shell-scripts"></a>21.4.4. Packages containing shell scripts</h3></div></div></div>
1.147     wiz      8480: <p><code class="varname">REPLACE_SH</code>,
                   8481:     <code class="varname">REPLACE_BASH</code>, <code class="varname">REPLACE_CSH</code>,
                   8482:     and <code class="varname">REPLACE_KSH</code> can be used to replace shell
1.309     gutterid 8483:     hash bangs in files. Please use the appropriate one, preferring
1.147     wiz      8484:     <code class="varname">REPLACE_SH</code> in case this shell is sufficient.
1.183     wiz      8485:     Each should contain a list of scripts, relative to
                   8486:     <code class="varname">WRKSRC</code>, that you want adjusted. Every
                   8487:     occurrence of the matching shell in a she-bang line will be
                   8488:     replaced with the full path to the shell executable.
1.147     wiz      8489:     When using <code class="varname">REPLACE_BASH</code>, don't forget to add
                   8490:     <code class="filename">bash</code> to <code class="varname">USE_TOOLS</code>.</p>
                   8491: </div>
1.148     asau     8492: <div class="sect2">
1.147     wiz      8493: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8494: <a name="other-programming-languages"></a>21.4.5. Other programming languages</h3></div></div></div>
1.87      wiz      8495: <p>Currently, there is no special handling for other languages
                   8496:     in pkgsrc.  If a compiler package provides a
                   8497:     <code class="filename">buildlink3.mk</code> file, include that, otherwise
                   8498:     just add a (build) dependency on the appropriate compiler
                   8499:     package.</p>
                   8500: </div>
                   8501: </div>
1.148     asau     8502: <div class="sect1">
1.87      wiz      8503: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   8504: <a name="fixes.build"></a>21.5. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.77      rillig   8505: <p>The most common failures when building a package are that
                   8506:        some platforms do not provide certain header files, functions or
                   8507:        libraries, or they provide the functions in a library that the
                   8508:        original package author didn't know. To work around this, you
                   8509:        can rewrite the source code in most cases so that it does not
                   8510:        use the missing functions or provides a replacement function.</p>
1.148     asau     8511: <div class="sect2">
1.77      rillig   8512: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8513: <a name="fixes.build.cpp"></a>21.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.77      rillig   8514: <p>If a package already comes with a GNU configure script, the
                   8515:        preferred way to fix the build failure is to change the
                   8516:        configure script, not the code. In the other cases, you can
                   8517:        utilize the C preprocessor, which defines certain macros
                   8518:        depending on the operating system and hardware architecture it
                   8519:        compiles for. These macros can be queried using for example
                   8520:        <code class="varname">#if defined(__i386)</code>. Almost every operating
                   8521:        system, hardware architecture and compiler has its own macro.
                   8522:        For example, if the macros <code class="varname">__GNUC__</code>,
                   8523:        <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
                   8524:        are all defined, you know that you are using NetBSD on an i386
                   8525:        compatible CPU, and your compiler is GCC.</p>
                   8526: <p>The list of the following macros for hardware and
                   8527:        operating system depends on the compiler that is used. For
                   8528:        example, if you want to conditionally compile code on Solaris,
                   8529:        don't use <code class="varname">__sun__</code>, as the SunPro compiler
                   8530:        does not define it. Use <code class="varname">__sun</code> instead.</p>
1.148     asau     8531: <div class="sect3">
1.75      rillig   8532: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   8533: <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   8534: <p>To distinguish between 4.4 BSD-derived systems and the
                   8535:         rest of the world, you should use the following code.</p>
                   8536: <pre class="programlisting">
1.100     rillig   8537: #include &lt;sys/param.h&gt;
                   8538: #if (defined(BSD) &amp;&amp; BSD &gt;= 199306)
                   8539: /* BSD-specific code goes here */
                   8540: #else
                   8541: /* non-BSD-specific code goes here */
                   8542: #endif
1.75      rillig   8543: </pre>
1.77      rillig   8544: <p>If this distinction is not fine enough, you can also test
                   8545:        for the following macros.</p>
1.75      rillig   8546: <pre class="programlisting">
1.151     obache   8547: Cygwin      __CYGWIN__
                   8548: DragonFly   __DragonFly__
1.100     rillig   8549: FreeBSD     __FreeBSD__
1.151     obache   8550: Haiku       __HAIKU__
1.100     rillig   8551: Interix     __INTERIX
                   8552: IRIX        __sgi (TODO: get a definite source for this)
                   8553: Linux       linux, __linux, __linux__
1.193     dholland 8554: Mac OS X    __APPLE__
1.151     obache   8555: MirBSD      __MirBSD__ (__OpenBSD__ is also defined)
                   8556: Minix3      __minix
1.100     rillig   8557: NetBSD      __NetBSD__
                   8558: OpenBSD     __OpenBSD__
                   8559: Solaris     sun, __sun
1.75      rillig   8560: </pre>
                   8561: </div>
1.148     asau     8562: <div class="sect3">
1.75      rillig   8563: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   8564: <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   8565: <pre class="programlisting">
1.100     rillig   8566: i386        i386, __i386, __i386__
                   8567: MIPS        __mips
                   8568: SPARC       sparc, __sparc
1.75      rillig   8569: </pre>
                   8570: </div>
1.148     asau     8571: <div class="sect3">
1.75      rillig   8572: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   8573: <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   8574: <pre class="programlisting">
1.100     rillig   8575: GCC         __GNUC__ (major version), __GNUC_MINOR__
                   8576: MIPSpro     _COMPILER_VERSION (0x741 for MIPSpro 7.41)
                   8577: SunPro      __SUNPRO_C (0x570 for Sun C 5.7)
                   8578: SunPro C++  __SUNPRO_CC (0x580 for Sun C++ 5.8)
1.75      rillig   8579: </pre>
                   8580: </div>
                   8581: </div>
1.148     asau     8582: <div class="sect2">
1.78      rillig   8583: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8584: <a name="compiler-bugs"></a>21.5.2. How to handle compiler bugs</h3></div></div></div>
1.78      rillig   8585: <p>Some source files trigger bugs in the compiler, based on
1.87      wiz      8586:         combinations of compiler version and architecture and almost
                   8587:         always relation to optimisation being enabled.  Common symptoms
                   8588:         are gcc internal errors or never finishing compiling a
1.78      rillig   8589:        file.</p>
                   8590: <p>Typically, a workaround involves testing the
                   8591:         <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
                   8592:         optimisation for that combination of file,
1.198     tnn      8593:        <code class="varname">MACHINE_ARCH</code> and compiler.</p>
                   8594: <p>This used to be a big problem in the past, but is rarely
                   8595:        needed now as compiler technology has matured. If you still need
                   8596:        to add a compiler specific workaround, please do so in the file
                   8597:        <code class="filename">hacks.mk</code> and describe the symptom and
                   8598:        compiler version as detailed as possible.</p>
1.78      rillig   8599: </div>
1.148     asau     8600: <div class="sect2">
1.78      rillig   8601: <div class="titlepage"><div><div><h3 class="title">
1.287     rillig   8602: <a name="fixes.build.header"></a>21.5.3. No such file or directory</h3></div></div></div>
                   8603: <p>Compilation sometimes fails with an error message like this:</p>
                   8604: <pre class="programlisting">
                   8605: .../x11/gtk3/work/gtk+-3.24.12/gdk/gdktypes.h:35:10:
                   8606:     fatal error: pango/pango.h: No such file or directory
                   8607: </pre>
                   8608: <p>The proper way to fix this problem depends on the type of the
                   8609: header, which is described in the following sections.</p>
                   8610: <div class="sect3">
                   8611: <div class="titlepage"><div><div><h4 class="title">
                   8612: <a name="fixes.build.header.bl3"></a>21.5.3.1. Headers from other packages</h4></div></div></div>
                   8613: <p>If the header name looks like it comes from a different package,
                   8614: that other package should be included via the buildlink3
                   8615: framework.</p>
                   8616: <p>First, look whether the header is somewhere in the buildlink3
                   8617: directory below <code class="varname">WRKDIR</code>. In the above case of
                   8618: the missing Pango header:</p>
                   8619: <pre class="programlisting">
                   8620: <code class="prompt">$</code> find work/.buildlink/ -print | grep -F pango/pango.h
                   8621: </pre>
                   8622: <p>In the case of Pango, the output is:</p>
                   8623: <pre class="programlisting">
                   8624: work/.buildlink/include/pango-1.0/pango/pango.h
                   8625: </pre>
                   8626: <p>If the <code class="filename">pango/pango.h</code> file were placed directly
                   8627: in the <code class="filename">.buildlink</code> directory, it would have been
                   8628: found automatically. There is an extra <code class="filename">pango-1.0</code>
                   8629: path component though, which means that the compiler command line must
                   8630: contain an option of the form
                   8631: <code class="literal">-I${BUILDLINK3_PREFIX.pango}/include/pango-1.0</code>. In
                   8632: most cases this option is generated by the configure script, which can be examined using:</p>
                   8633: <pre class="programlisting">
                   8634: <code class="prompt">$</code> $ grep -o '[-]I[^[:space:]]*/pango[^[:space:]]*' work/*/Makefile
                   8635: -I/usr/pkg/include/pango-1.0
                   8636: -I/usr/pkg/include/pango-1.0
                   8637: -I/usr/pkg/include/pango-1.0
                   8638: -I/usr/pkg/include/pango-1.0
                   8639: -I/usr/pkg/include/pango-1.0
                   8640: </pre>
                   8641: <p>This looks good. These options are transformed by the buildlink
                   8642: wrapper to refer to the correct path inside
                   8643: <code class="filename">work/.buildlink</code>.</p>
                   8644: <p>Since the compilation fails though, examine the compiler command
                   8645: lines in <code class="filename">work/.work.log</code> to see whether the
                   8646: <code class="literal">-I</code> option is included in the particular command
                   8647: line.</p>
                   8648: <p>To further analyze the situation, run <span class="command"><strong>bmake
                   8649: build-env</strong></span>, which sets up an interactive, realistic environment
                   8650: including all the pkgsrc wrapper commands and environment variables. From
                   8651: there, try to compile some simple example programs that use the
                   8652: header.</p>
                   8653: </div>
                   8654: <div class="sect3">
                   8655: <div class="titlepage"><div><div><h4 class="title">
                   8656: <a name="fixes.build.header.gen"></a>21.5.3.2. Headers generated during the build</h4></div></div></div>
                   8657: <p>If the name of the header seems to come from the package itself,
                   8658: and if the build is run with parallel jobs, the package may have some
                   8659: undeclared dependencies between the <code class="filename">.c</code> and the
                   8660: <code class="filename">.h</code> files, and a C file is compiled before its
                   8661: required header is generated.</p>
                   8662: <p>To see whether the build runs with parallel jobs, run
                   8663: <span class="command"><strong>bmake show-all-build | grep JOBS</strong></span>. Its output looks
                   8664: like this:</p>
                   8665: <pre class="programlisting">
                   8666:   usr   MAKE_JOBS=              7
                   8667:   pkg   MAKE_JOBS_SAFE          # undefined
                   8668:   def   _MAKE_JOBS_N=           7
                   8669: </pre>
                   8670: <p>In this case the pkgsrc user has asked pkgsrc to build packages
                   8671: with 7 jobs in parallel (<code class="varname">MAKE_JOBS</code>). The
                   8672: package could have disabled parallel builds by setting
                   8673: <code class="varname">MAKE_JOBS_SAFE</code> to <code class="literal">no</code>, but
                   8674: in this case it hasn't.</p>
                   8675: <p>To see whether the build failure is caused by parallel builds,
                   8676: first save the exact error message and a bit of context, maybe you need
                   8677: it later for reporting a bug. Next, run:</p>
                   8678: <pre class="programlisting">
                   8679: MAKE_JOBS_SAFE=no bmake clean build
                   8680: </pre>
                   8681: <p>If that succeeds, <a class="ulink" href="https://www.NetBSD.org/cgi-bin/sendpr.cgi?gndb=netbsd" target="_top">file a bug
                   8682: report</a> against the pkgsrc package, including the exact error
                   8683: message and the contents of your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file.</p>
                   8684: </div>
1.288     rillig   8685: <div class="sect3">
                   8686: <div class="titlepage"><div><div><h4 class="title">
                   8687: <a name="fixes.build.header.symlink"></a>21.5.3.3. Symlinks</h4></div></div></div>
                   8688: <p>Pkgsrc does not work reliably if any of
                   8689: <code class="varname">LOCALBASE</code>, <code class="varname">VARBASE</code> or
                   8690: <code class="varname">WRKDIR</code> contains a symlink. Since 2019Q2, the pkgsrc
                   8691: bootstrap program prevents installing pkgsrc in symlink-based
                   8692: directories. Existing pkgsrc installations are not checked for symlinks
                   8693: though.</p>
                   8694: <p>The "No such file or directory" error messages are a typical
                   8695: symptom of symlinks, and it's quite difficult to find out that this is
                   8696: the actual cause.</p>
                   8697: </div>
                   8698: <div class="sect3">
                   8699: <div class="titlepage"><div><div><h4 class="title">
                   8700: <a name="fixes.build.header.stale"></a>21.5.3.4. Stale working directories</h4></div></div></div>
                   8701: <p>When building a hierarchy of packages, it may happen that one
                   8702: package is built and then pkgsrc is updated. This situation can provoke
                   8703: various hard to diagnose build errors. To clean up the situation:</p>
                   8704: <pre class="programlisting">
                   8705: <code class="prompt">$</code> (cd ../../ &amp;&amp; test -f mk/bsd.pkg.mk &amp;&amp; rm -rf */*/work)
                   8706: </pre>
                   8707: <p>(The test for <code class="filename">bsd.pkg.mk</code> just prevents running
                   8708: this command in the wrong directory.)</p>
                   8709: <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
                   8710: that directory as well.</p>
                   8711: </div>
                   8712: <div class="sect3">
                   8713: <div class="titlepage"><div><div><h4 class="title">
                   8714: <a name="fixes.build.header.misc"></a>21.5.3.5. Other possible reasons</h4></div></div></div>
                   8715: <p>On platforms other than BSD, third-party packages are installed in
                   8716: <code class="filename">/usr/include</code>, together with the base system. This
                   8717: means that pkgsrc cannot distinguish between headers provided by the base
                   8718: system (which it needs) and headers from third-party packages (which are
                   8719: often included in pkgsrc as well). This can lead to subtle version
                   8720: mismatches.</p>
                   8721: <p>In pkgsrc installations that have been active for several years, it
                   8722: may happen that some files are manually deleted. To exclude this unlikely
                   8723: reason, run <span class="command"><strong>pkg_admin check</strong></span>.</p>
                   8724: <p>It may help to run <span class="command"><strong>pkg_admin rebuild-tree</strong></span> to
                   8725: check/fix dependencies.</p>
                   8726: <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>
                   8727: for contact information. Be prepared to describe what you have tried so
                   8728: far and what any error messages were.</p>
                   8729: </div>
1.287     rillig   8730: </div>
                   8731: <div class="sect2">
                   8732: <div class="titlepage"><div><div><h3 class="title">
                   8733: <a name="undefined-reference"></a>21.5.4. Undefined reference to <span class="quote">&#8220;<span class="quote">...</span>&#8221;</span>
1.128     wiz      8734: </h3></div></div></div>
1.92      rillig   8735: <p>This error message often means that a package did not
1.78      rillig   8736:        link to a shared library it needs. The following functions are
                   8737:        known to cause this error message over and over.</p>
                   8738: <div class="informaltable">
1.216     tnn      8739: <a name="undefined-reference-functions"></a><table class="informaltable" border="1">
1.78      rillig   8740: <colgroup>
                   8741: <col>
                   8742: <col>
                   8743: <col>
                   8744: </colgroup>
                   8745: <thead><tr>
                   8746: <th>Function</th>
                   8747: <th>Library</th>
                   8748: <th>Affected platforms</th>
                   8749: </tr></thead>
                   8750: <tbody>
                   8751: <tr>
                   8752: <td>accept, bind, connect</td>
                   8753: <td>-lsocket</td>
                   8754: <td>Solaris</td>
                   8755: </tr>
                   8756: <tr>
                   8757: <td>crypt</td>
                   8758: <td>-lcrypt</td>
                   8759: <td>DragonFly, NetBSD</td>
                   8760: </tr>
                   8761: <tr>
                   8762: <td>dlopen, dlsym</td>
                   8763: <td>-ldl</td>
                   8764: <td>Linux</td>
                   8765: </tr>
                   8766: <tr>
                   8767: <td>gethost*</td>
                   8768: <td>-lnsl</td>
                   8769: <td>Solaris</td>
                   8770: </tr>
                   8771: <tr>
                   8772: <td>inet_aton</td>
                   8773: <td>-lresolv</td>
                   8774: <td>Solaris</td>
                   8775: </tr>
                   8776: <tr>
                   8777: <td>nanosleep, sem_*, timer_*</td>
                   8778: <td>-lrt</td>
                   8779: <td>Solaris</td>
                   8780: </tr>
                   8781: <tr>
                   8782: <td>openpty</td>
                   8783: <td>-lutil</td>
                   8784: <td>Linux</td>
                   8785: </tr>
                   8786: </tbody>
                   8787: </table>
                   8788: </div>
                   8789: <p>To fix these linker errors, it is often sufficient to say
1.87      wiz      8790:     <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
                   8791:     -l<em class="replaceable"><code>foo</code></em></code> to the package
1.110     hubertf  8792:     <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
1.87      wiz      8793:     bmake</strong></span>.</p>
1.148     asau     8794: <div class="sect3">
1.92      rillig   8795: <div class="titlepage"><div><div><h4 class="title">
1.287     rillig   8796: <a name="undefined-reference-sunpro"></a>21.5.4.1. Special issue: The SunPro compiler</h4></div></div></div>
1.92      rillig   8797: <p>When you are using the SunPro compiler, there is another
                   8798: possibility. That compiler cannot handle the following code:</p>
                   8799: <pre class="programlisting">
1.100     rillig   8800: extern int extern_func(int);
1.93      rillig   8801: 
1.100     rillig   8802: static inline int
                   8803: inline_func(int x)
                   8804: {
1.92      rillig   8805:         return extern_func(x);
1.100     rillig   8806: }
1.93      rillig   8807: 
1.100     rillig   8808: int main(void)
                   8809: {
1.92      rillig   8810:         return 0;
1.100     rillig   8811: }
1.92      rillig   8812: </pre>
                   8813: <p>It generates the code for <code class="function">inline_func</code> even if
                   8814: that function is never used. This code then refers to
                   8815: <code class="function">extern_func</code>, which can usually not be resolved. To
                   8816: solve this problem you can try to tell the package to disable inlining
                   8817: of functions.</p>
                   8818: </div>
1.87      wiz      8819: </div>
1.148     asau     8820: <div class="sect2">
1.87      wiz      8821: <div class="titlepage"><div><div><h3 class="title">
1.287     rillig   8822: <a name="out-of-memory"></a>21.5.5. Running out of memory</h3></div></div></div>
1.87      wiz      8823: <p>Sometimes packages fail to build because the compiler runs
                   8824:     into an operating system specific soft limit.  With the
                   8825:     <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
1.204     wiz      8826:     to unlimit the resources.  Currently, the allowed values are any combination of
                   8827:     <span class="quote">&#8220;<span class="quote">cputime</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">datasize</span>&#8221;</span>,
                   8828:     <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      8829:     Setting this variable is similar to running the shell builtin
1.110     hubertf  8830:     <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.87      wiz      8831:     segment size or maximum stack size of a process, respectively, to
                   8832:     their hard limits.</p>
1.78      rillig   8833: </div>
1.75      rillig   8834: </div>
1.148     asau     8835: <div class="sect1">
1.75      rillig   8836: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   8837: <a name="fixes.install"></a>21.6. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.148     asau     8838: <div class="sect2">
1.75      rillig   8839: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8840: <a name="install-scripts"></a>21.6.1. Creating needed directories</h3></div></div></div>
1.110     hubertf  8841: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.87      wiz      8842:     with some operating systems cannot create more than one
                   8843:     directory at a time. As such, you should call
                   8844:     <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
                   8845: <pre class="programlisting">
1.100     rillig   8846: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
                   8847: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.222     sevan    8848: </pre>
1.128     wiz      8849: <p>You can also just append <span class="quote">&#8220;<span class="quote"><code class="literal">dir1
                   8850:     dir2</code></span>&#8221;</span> to the
1.87      wiz      8851:     <code class="varname">INSTALLATION_DIRS</code> variable, which will
                   8852:     automatically do the right thing.</p>
1.75      rillig   8853: </div>
1.148     asau     8854: <div class="sect2">
1.75      rillig   8855: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8856: <a name="where-to-install-documentation"></a>21.6.2. Where to install documentation</h3></div></div></div>
1.83      wiz      8857: <p>In general, documentation should be installed into
1.87      wiz      8858:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
                   8859:     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
                   8860:     includes the version number of the package).</p>
1.84      wiz      8861: <p>Many modern packages using GNU autoconf allow to set the
1.87      wiz      8862:     directory where HTML documentation is installed with the
1.128     wiz      8863:     <span class="quote">&#8220;<span class="quote">--with-html-dir</span>&#8221;</span> option. Sometimes using this flag
1.87      wiz      8864:     is needed because otherwise the documentation ends up in
                   8865:     <code class="filename">${PREFIX}/share/doc/html</code> or other
                   8866:     places.</p>
                   8867: <p>An exception to the above is that library API documentation
1.250     leot     8868:     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      8869:     browsers (devhelp) should be left at their default location, which
                   8870:     is <code class="filename">${PREFIX}/share/gtk-doc</code>.  Such
                   8871:     documentation can be recognized from files ending in
                   8872:     <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
                   8873:     (It is also acceptable to install such files in
                   8874:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
                   8875:     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
                   8876:     <code class="filename">.devhelp*</code> file must be directly in that
                   8877:     directory then, no additional subdirectory level is allowed in
                   8878:     this case. This is usually achieved by using
1.128     wiz      8879:     <span class="quote">&#8220;<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>&#8221;</span>.
1.87      wiz      8880:     <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
                   8881:     though.)</p>
1.75      rillig   8882: </div>
1.148     asau     8883: <div class="sect2">
1.75      rillig   8884: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8885: <a name="installing-score-files"></a>21.6.3. Installing highscore files</h3></div></div></div>
1.75      rillig   8886: <p>Certain packages, most of them in the games category, install
1.87      wiz      8887:     a score file that allows all users on the system to record their
                   8888:     highscores.  In order for this to work, the binaries need to be
                   8889:     installed setgid and the score files owned by the appropriate
1.142     wiz      8890:     group and/or owner (traditionally the "games" user/group).  Set
                   8891:     <code class="varname">USE_GAMESGROUP</code> to yes to support this. The
1.87      wiz      8892:     following variables, documented in more detail in
                   8893:     <code class="filename">mk/defaults/mk.conf</code>, control this
1.142     wiz      8894:     behaviour: <code class="varname">GAMEDATAMODE</code>,
                   8895:     <code class="varname">GAMEDIRMODE</code>, <code class="varname">GAMES_GROUP</code>,
1.210     leot     8896:     <code class="varname">GAMEMODE</code>, <code class="varname">GAME_USER</code>.
                   8897:     Other useful variables are: <code class="varname">GAMEDIR_PERMS</code>,
                   8898:     <code class="varname">GAMEDATA_PERMS</code> and
                   8899:     <code class="varname">SETGID_GAMES_PERMS</code>.</p>
                   8900: <p>An example that illustrates some of the variables described above is
                   8901:     <code class="filename">games/moon-buggy</code>. <code class="varname">OWN_DIRS_PERMS</code> is
                   8902:     used to properly set directory permissions of the directory where the
                   8903:     scorefile is saved, <code class="varname">REQD_FILES_PERMS</code> is used to create a
                   8904:     dummy scorefile (<code class="filename">mbscore</code>) with the proper permissions
                   8905:     and <code class="varname">SPECIAL_PERMS</code> is used to install setgid the game
                   8906:     binary:</p>
                   8907: <pre class="programlisting">
1.223     rillig   8908: USE_GAMESGROUP=         yes
1.210     leot     8909: 
1.223     rillig   8910: BUILD_DEFS+=            VARBASE
1.210     leot     8911: 
1.223     rillig   8912: OWN_DIRS_PERMS+=        ${VARBASE}/games/moon-buggy ${GAMEDIR_PERMS}
                   8913: REQD_FILES_PERMS+=      /dev/null ${VARBASE}/games/moon-buggy/mbscore ${GAMEDATA_PERMS}
                   8914: SPECIAL_PERMS+=         ${PREFIX}/bin/moon-buggy ${SETGID_GAMES_PERMS}
1.222     sevan    8915: </pre>
1.210     leot     8916: <p>Various <code class="varname">INSTALL_*</code> variables are also available:
                   8917:     <code class="varname">INSTALL_GAME</code> to install setgid game binaries,
                   8918:     <code class="varname">INSTALL_GAME_DIR</code> to install game directories that are
                   8919:     needed to be accessed by setgid games and
                   8920:     <code class="varname">INSTALL_GAME_DATA</code> to install scorefiles.</p>
1.114     jmcneill 8921: <p>A package should therefore never hard code file ownership or
1.210     leot     8922:     access permissions but rely on <code class="varname">*_PERMS</code> as described above
                   8923:     or alternatively on <code class="varname">INSTALL_GAME</code>,
                   8924:     <code class="varname">INSTALL_GAME_DATA</code> and
                   8925:     <code class="varname">INSTALL_GAME_DIR</code> to set these correctly.</p>
1.75      rillig   8926: </div>
1.148     asau     8927: <div class="sect2">
1.75      rillig   8928: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8929: <a name="destdir-support"></a>21.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.114     jmcneill 8930: <p><code class="varname">DESTDIR</code> support means that a package
                   8931:     installs into a staging directory, not the final location of the
                   8932:     files. Then a binary package is created which can be used for
                   8933:     installation as usual. There are two ways: Either the package must
1.128     wiz      8934:     install as root (<span class="quote">&#8220;<span class="quote">destdir</span>&#8221;</span>) or the package can
                   8935:     install as non-root user (<span class="quote">&#8220;<span class="quote">user-destdir</span>&#8221;</span>).</p>
1.148     asau     8936: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      8937: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
1.224     leot     8938:       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>.
                   8939:       By default <code class="varname">PKG_DESTDIR_SUPPORT</code>
1.145     wiz      8940:       is set to <span class="quote">&#8220;<span class="quote">user-destdir</span>&#8221;</span> to help catching more
                   8941:       potential packaging problems. If bsd.prefs.mk is included in the Makefile,
1.114     jmcneill 8942:       <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
                   8943:       the inclusion.</p></li>
1.128     wiz      8944: <li class="listitem"><p>All installation operations have to be prefixed with
1.103     wiz      8945:       <code class="filename">${DESTDIR}</code>.</p></li>
1.128     wiz      8946: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.103     wiz      8947:       automatically. Many manual rules and pre/post-install often are
                   8948:       incorrect; fix them.</p></li>
1.128     wiz      8949: <li class="listitem"><p>If files are installed with special owner/group
1.118     imil     8950:       use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.128     wiz      8951: <li class="listitem"><p>In general, packages should support
1.103     wiz      8952:       <code class="varname">UNPRIVILEGED</code> to be able to use
                   8953:       DESTDIR.</p></li>
                   8954: </ul></div>
                   8955: </div>
1.148     asau     8956: <div class="sect2">
1.103     wiz      8957: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8958: <a name="hardcoded-paths"></a>21.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.87      wiz      8959: <p>Your package may also contain scripts with hardcoded paths to
                   8960:       other interpreters besides (or as well as) perl.  To correct the
                   8961:       full pathname to the script interpreter, you need to set the
                   8962:       following definitions in your <code class="filename">Makefile</code> (we
1.110     hubertf  8963:     shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.87      wiz      8964: <pre class="programlisting">
1.100     rillig   8965: REPLACE_INTERPRETER+=   tcl
                   8966: REPLACE.tcl.old=        .*/bin/tclsh
                   8967: REPLACE.tcl.new=        ${PREFIX}/bin/tclsh
                   8968: REPLACE_FILES.tcl=      # list of tcl scripts which need to be fixed,
                   8969: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.222     sevan    8970: </pre>
1.148     asau     8971: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   8972: <h3 class="title">Note</h3>
                   8973: <p>Before March 2006, these variables were called
1.87      wiz      8974:     <code class="varname">_REPLACE.*</code> and
                   8975:     <code class="varname">_REPLACE_FILES.*</code>.</p>
1.75      rillig   8976: </div>
                   8977: </div>
1.148     asau     8978: <div class="sect2">
1.75      rillig   8979: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8980: <a name="perl-modules"></a>21.6.6. Packages installing perl modules</h3></div></div></div>
1.75      rillig   8981: <p>Makefiles of packages providing perl5 modules should include
1.87      wiz      8982:     the Makefile fragment
                   8983:     <code class="filename">../../lang/perl5/module.mk</code>.  It provides a
1.110     hubertf  8984:     <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.87      wiz      8985:     configuration for such modules as well as various hooks to tune
                   8986:     this configuration.  See comments in this file for
                   8987:     details.</p>
1.75      rillig   8988: <p>Perl5 modules will install into different places depending
1.87      wiz      8989:     on the version of perl used during the build process.  To
                   8990:     address this, pkgsrc will append lines to the
                   8991:     <code class="filename">PLIST</code> corresponding to the files listed in
                   8992:     the installed <code class="filename">.packlist</code> file generated by
                   8993:     most perl5 modules.  This is invoked by defining
                   8994:     <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
1.153     wiz      8995:     packlist files relative to <code class="varname">PERL5_PACKLIST_DIR</code>
                   8996:     (<code class="varname">PERL5_INSTALLVENDORARCH</code> by default),
                   8997:     e.g.:</p>
1.75      rillig   8998: <pre class="programlisting">
1.153     wiz      8999: PERL5_PACKLIST= auto/Pg/.packlist
1.222     sevan    9000: </pre>
1.153     wiz      9001: <p>The perl5 config variables
                   9002:     <code class="varname">installarchlib</code>,
                   9003:     <code class="varname">installscript</code>,
                   9004:     <code class="varname">installvendorbin</code>,
                   9005:     <code class="varname">installvendorscript</code>,
                   9006:     <code class="varname">installvendorarch</code>,
                   9007:     <code class="varname">installvendorlib</code>,
                   9008:     <code class="varname">installvendorman1dir</code>, and
                   9009:     <code class="varname">installvendorman3dir</code> represent those
                   9010:     locations in which components of perl5 modules may be installed,
                   9011:     provided as variable with uppercase and prefixed with
                   9012:     <code class="varname">PERL5_</code>, e.g. <code class="varname">PERL5_INSTALLARCHLIB</code>
                   9013:     and may be used by perl5 packages that don't have a packlist.
                   9014:     These variables are also substituted for in the
                   9015:     <code class="filename">PLIST</code> as uppercase prefixed with
                   9016:     <code class="varname">PERL5_SUB_</code>.</p>
1.75      rillig   9017: </div>
1.148     asau     9018: <div class="sect2">
1.75      rillig   9019: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   9020: <a name="faq.info-files"></a>21.6.7. Packages installing info files</h3></div></div></div>
1.75      rillig   9021: <p>Some packages install info files or use the
1.128     wiz      9022:     <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      9023:     commands.  <code class="varname">INFO_FILES</code> should be defined in
                   9024:     the package Makefile so that <code class="filename">INSTALL</code> and
                   9025:     <code class="filename">DEINSTALL</code> scripts will be generated to
                   9026:     handle registration of the info files in the Info directory
1.128     wiz      9027:     file. The <span class="quote">&#8220;<span class="quote">install-info</span>&#8221;</span> command used for the info
1.87      wiz      9028:     files registration is either provided by the system, or by a
                   9029:     special purpose package automatically added as dependency if
                   9030:     needed.</p>
1.75      rillig   9031: <p><code class="varname">PKGINFODIR</code> is the directory under
1.87      wiz      9032:     <code class="filename">${PREFIX}</code> where info files are primarily
                   9033:     located. <code class="varname">PKGINFODIR</code> defaults to
1.128     wiz      9034:     <span class="quote">&#8220;<span class="quote">info</span>&#8221;</span> and can be overridden by the user.</p>
1.75      rillig   9035: <p>The info files for the package should be listed in the
1.87      wiz      9036:     package <code class="filename">PLIST</code>; however any split info files
                   9037:     need not be listed.</p>
1.128     wiz      9038: <p>A package which needs the <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> command
                   9039:     at build time must add <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> to
1.87      wiz      9040:     <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.128     wiz      9041:     version of the <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> command is needed it
1.87      wiz      9042:     should be noted with the <code class="varname">TEXINFO_REQD</code>
                   9043:     variable in the package <code class="filename">Makefile</code>. By
                   9044:     default, a minimum version of 3.12 is required. If the system
1.110     hubertf  9045:     does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.87      wiz      9046:     does not match the required minimum, a build dependency on the
1.250     leot     9047:     <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      9048:     be added automatically.</p>
1.75      rillig   9049: <p>The build and installation process of the software provided
1.87      wiz      9050:     by the package should not use the
1.110     hubertf  9051:     <span class="command"><strong>install-info</strong></span> command as the registration of
1.87      wiz      9052:     info files is the task of the package
                   9053:     <code class="filename">INSTALL</code> script, and it must use the
1.110     hubertf  9054:     appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.75      rillig   9055: <p>To achieve this goal, the pkgsrc infrastructure creates
1.110     hubertf  9056:     overriding scripts for the <span class="command"><strong>install-info</strong></span> and
                   9057:     <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.87      wiz      9058:     in <code class="varname">PATH</code>.</p>
1.110     hubertf  9059: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.87      wiz      9060:     no effect except the logging of a message. The script overriding
1.110     hubertf  9061:     <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.87      wiz      9062:     value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.110     hubertf  9063:     <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.75      rillig   9064: </div>
1.148     asau     9065: <div class="sect2">
1.75      rillig   9066: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   9067: <a name="manpages"></a>21.6.8. Packages installing man pages</h3></div></div></div>
1.81      rillig   9068: <p>All packages that install manual pages should install them
1.87      wiz      9069:     into the same directory, so that there is one common place to look
                   9070:     for them. In pkgsrc, this place is
                   9071:     <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
                   9072:     should be used in packages. The default for
                   9073:     <code class="varname">PKGMANDIR</code> is
1.128     wiz      9074:     <span class="quote">&#8220;<span class="quote"><code class="filename">man</code></span>&#8221;</span>. Another often-used value
                   9075:     is <span class="quote">&#8220;<span class="quote"><code class="filename">share/man</code></span>&#8221;</span>.</p>
1.148     asau     9076: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   9077: <h3 class="title">Note</h3>
1.87      wiz      9078: <p>The support for a custom <code class="varname">PKGMANDIR</code>
                   9079:     is far from complete.</p>
1.75      rillig   9080: </div>
1.81      rillig   9081: <p>The <code class="filename">PLIST</code> files can just use
1.87      wiz      9082:     <code class="filename">man/</code> as the top level directory for the man
                   9083:     page file entries, and the pkgsrc framework will convert as
                   9084:     needed. In all other places, the correct
                   9085:     <code class="varname">PKGMANDIR</code> must be used.</p>
                   9086: <p>Packages that are
                   9087:     configured with <code class="varname">GNU_CONFIGURE</code> set as
1.128     wiz      9088:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>, by default will use the
1.87      wiz      9089:     <code class="filename">./configure</code>
                   9090:     --mandir switch to set where the man pages should be installed.
                   9091:     The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
                   9092:     to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
                   9093: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
                   9094:     use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.128     wiz      9095:     to <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span>.
1.87      wiz      9096:     Or if the <code class="filename">./configure</code> script uses
                   9097:     a non-standard use of --mandir, you can set
                   9098:     <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.299     rillig   9099: <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      9100:     information on installation of compressed manual pages.</p>
1.75      rillig   9101: </div>
1.148     asau     9102: <div class="sect2">
1.75      rillig   9103: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   9104: <a name="gconf-data-files"></a>21.6.9. Packages installing GConf data files</h3></div></div></div>
1.87      wiz      9105: <p>If a package installs <code class="filename">.schemas</code> or
1.107     rillig   9106:     <code class="filename">.entries</code> files, used by GConf,
1.87      wiz      9107:     you need to take some extra steps to make sure they get registered
                   9108:     in the database:</p>
1.128     wiz      9109: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9110: <li class="listitem"><p>Include <code class="filename">../../devel/GConf/schemas.mk</code>
1.87      wiz      9111:        instead of its <code class="filename">buildlink3.mk</code> file.  This
1.107     rillig   9112:        takes care of rebuilding the GConf database at installation and
1.87      wiz      9113:        deinstallation time, and tells the package where to install
1.107     rillig   9114:        GConf data files using some standard configure arguments.  It
1.87      wiz      9115:        also disallows any access to the database directly from the
                   9116:        package.</p></li>
1.128     wiz      9117: <li class="listitem"><p>Ensure that the package installs its
1.87      wiz      9118:        <code class="filename">.schemas</code> files under
                   9119:        <code class="filename">${PREFIX}/share/gconf/schemas</code>.  If they get
                   9120:        installed under <code class="filename">${PREFIX}/etc</code>, you will
                   9121:        need to manually patch the package.</p></li>
1.128     wiz      9122: <li class="listitem"><p>Check the PLIST and remove any entries under the etc/gconf
1.87      wiz      9123:        directory, as they will be handled automatically.  See
1.267     rillig   9124:        <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      9125: <li class="listitem"><p>Define the <code class="varname">GCONF_SCHEMAS</code> variable in
1.87      wiz      9126:        your <code class="filename">Makefile</code> with a list of all
                   9127:        <code class="filename">.schemas</code> files installed by the package, if
                   9128:        any.  Names must not contain any directories in them.</p></li>
1.128     wiz      9129: <li class="listitem"><p>Define the <code class="varname">GCONF_ENTRIES</code> variable in
1.87      wiz      9130:        your <code class="filename">Makefile</code> with a
                   9131:        list of all <code class="filename">.entries</code> files installed by the
                   9132:        package, if any. Names must not contain any directories in
                   9133:        them.</p></li>
1.75      rillig   9134: </ol></div>
                   9135: </div>
1.148     asau     9136: <div class="sect2">
1.75      rillig   9137: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   9138: <a name="scrollkeeper-data-files"></a>21.6.10. Packages installing scrollkeeper/rarian data files</h3></div></div></div>
1.87      wiz      9139: <p>If a package installs <code class="filename">.omf</code> files, used by
1.119     mishka   9140:     scrollkeeper/rarian, you need to take some extra steps to make sure they
1.87      wiz      9141:     get registered in the database:</p>
1.128     wiz      9142: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9143: <li class="listitem"><p>Include
1.119     mishka   9144:        <code class="filename">../../mk/omf-scrollkeeper.mk</code>
                   9145:        instead of rarian's <code class="filename">buildlink3.mk</code> file.  This
1.87      wiz      9146:        takes care of rebuilding the scrollkeeper database at
                   9147:        installation and deinstallation time, and disallows any access
                   9148:        to it directly from the package.</p></li>
1.128     wiz      9149: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.87      wiz      9150:        <code class="filename">libdata/scrollkeeper</code> directory, as they
                   9151:        will be handled automatically.</p></li>
1.128     wiz      9152: <li class="listitem"><p>Remove the <code class="filename">share/omf</code> directory from
1.119     mishka   9153:        the PLIST.  It will be handled by rarian. (<span class="command"><strong>make
                   9154:        print-PLIST</strong></span> does this automatically.)</p></li>
1.75      rillig   9155: </ol></div>
                   9156: </div>
1.148     asau     9157: <div class="sect2">
1.75      rillig   9158: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   9159: <a name="x11-fonts"></a>21.6.11. Packages installing X11 fonts</h3></div></div></div>
1.75      rillig   9160: <p>If a package installs font files, you will need to rebuild
1.87      wiz      9161:     the fonts database in the directory where they get installed at
                   9162:     installation and deinstallation time.  This can be automatically
                   9163:     done by using the pkginstall framework.</p>
1.75      rillig   9164: <p>You can list the directories where fonts are installed in the
1.87      wiz      9165:     <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
                   9166:     variables, where <em class="replaceable"><code>type</code></em> can be one of
1.128     wiz      9167:     <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      9168:     Also make sure that the database file
                   9169:     <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
1.75      rillig   9170: <p>Note that you should not create new directories for fonts;
1.87      wiz      9171:     instead use the standard ones to avoid that the user needs to
                   9172:     manually configure his X server to find them.</p>
1.75      rillig   9173: </div>
1.148     asau     9174: <div class="sect2">
1.75      rillig   9175: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   9176: <a name="gtk2-modules"></a>21.6.12. Packages installing GTK2 modules</h3></div></div></div>
1.75      rillig   9177: <p>If a package installs GTK2 immodules or loaders, you need to
1.87      wiz      9178:     take some extra steps to get them registered in the GTK2 database
                   9179:     properly:</p>
1.128     wiz      9180: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9181: <li class="listitem"><p>Include
1.87      wiz      9182:       <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
                   9183:       <code class="filename">buildlink3.mk</code> file.  This takes care of
                   9184:       rebuilding the database at installation and deinstallation time.</p></li>
1.128     wiz      9185: <li class="listitem"><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
1.87      wiz      9186:       your package installs GTK2 immodules.</p></li>
1.128     wiz      9187: <li class="listitem"><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
1.87      wiz      9188:       GTK2 loaders.</p></li>
1.128     wiz      9189: <li class="listitem">
1.87      wiz      9190: <p>Patch the package to not touch any of the GTK2
                   9191:       databases directly.  These are:</p>
1.148     asau     9192: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      9193: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
                   9194: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.75      rillig   9195: </ul></div>
                   9196: </li>
1.128     wiz      9197: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove
1.87      wiz      9198:       any entries under the <code class="filename">libdata/gtk-2.0</code>
                   9199:       directory, as they will be handled automatically.</p></li>
1.75      rillig   9200: </ol></div>
                   9201: </div>
1.148     asau     9202: <div class="sect2">
1.75      rillig   9203: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   9204: <a name="sgml-xml-data"></a>21.6.13. Packages installing SGML or XML data</h3></div></div></div>
1.75      rillig   9205: <p>If a package installs SGML or XML data files that need to be
1.87      wiz      9206:     registered in system-wide catalogs (like DTDs, sub-catalogs,
                   9207:     etc.), you need to take some extra steps:</p>
1.128     wiz      9208: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9209: <li class="listitem"><p>Include
1.87      wiz      9210:        <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
                   9211:        your <code class="filename">Makefile</code>, which takes care of
                   9212:        registering those files in system-wide catalogs at
                   9213:        installation and deinstallation time.</p></li>
1.128     wiz      9214: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.87      wiz      9215:        any SGML catalogs installed by the package.</p></li>
1.128     wiz      9216: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.87      wiz      9217:        any XML catalogs installed by the package.</p></li>
1.128     wiz      9218: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.87      wiz      9219:        to be added to the SGML catalog.  These come in groups of
                   9220:        three strings; see xmlcatmgr(1) for more information
                   9221:        (specifically, arguments recognized by the 'add' action).
                   9222:        Note that you will normally not use this variable.</p></li>
1.128     wiz      9223: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.87      wiz      9224:        to be added to the XML catalog.  These come in groups of three
                   9225:        strings; see xmlcatmgr(1) for more information (specifically,
                   9226:        arguments recognized by the 'add' action).  Note that you will
                   9227:        normally not use this variable.</p></li>
1.75      rillig   9228: </ol></div>
                   9229: </div>
1.148     asau     9230: <div class="sect2">
1.75      rillig   9231: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   9232: <a name="mime-database"></a>21.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
1.75      rillig   9233: <p>If a package provides extensions to the MIME database by
1.87      wiz      9234:     installing <code class="filename">.xml</code> files inside
                   9235:     <code class="filename">${PREFIX}/share/mime/packages</code>, you
                   9236:     need to take some extra steps to ensure that the database is kept
                   9237:     consistent with respect to these new files:</p>
1.128     wiz      9238: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9239: <li class="listitem"><p>Include
1.87      wiz      9240:        <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
                   9241:        (avoid using the <code class="filename">buildlink3.mk</code> file from
                   9242:        this same directory, which is reserved for inclusion from
                   9243:        other <code class="filename">buildlink3.mk</code> files).  It takes
                   9244:        care of rebuilding the MIME database at installation and
                   9245:        deinstallation time, and disallows any access to it directly
                   9246:        from the package.</p></li>
1.128     wiz      9247: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.87      wiz      9248:        <code class="filename">share/mime</code> directory,
                   9249:        <span class="emphasis"><em>except</em></span> for files saved under
                   9250:        <code class="filename">share/mime/packages</code>.  The former are
                   9251:        handled automatically by
                   9252:        the update-mime-database program, but the latter are
                   9253:        package-dependent and must be removed by the package that
                   9254:        installed them in the first place.</p></li>
1.128     wiz      9255: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.87      wiz      9256:        from the PLIST.  They will be handled by the shared-mime-info
                   9257:        package.</p></li>
1.75      rillig   9258: </ol></div>
                   9259: </div>
1.148     asau     9260: <div class="sect2">
1.75      rillig   9261: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   9262: <a name="intltool"></a>21.6.15. Packages using intltool</h3></div></div></div>
1.93      rillig   9263: <p>If a package uses intltool during its build, add
                   9264:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
1.87      wiz      9265:     which forces it to use the intltool package provided by pkgsrc,
                   9266:     instead of the one bundled with the distribution file.</p>
1.75      rillig   9267: <p>This tracks intltool's build-time dependencies and uses the
1.87      wiz      9268:     latest available version; this way, the package benefits of any
                   9269:     bug fixes that may have appeared since it was released.</p>
1.75      rillig   9270: </div>
1.148     asau     9271: <div class="sect2">
1.75      rillig   9272: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   9273: <a name="startup-scripts"></a>21.6.16. Packages installing startup scripts</h3></div></div></div>
1.75      rillig   9274: <p>If a package contains a rc.d script, it won't be copied into
1.87      wiz      9275:     the startup directory by default, but you can enable it, by adding
                   9276:     the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.110     hubertf  9277:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.87      wiz      9278:     into <code class="filename">/etc/rc.d</code> when a package is installed, and
                   9279:     it will automatically remove the scripts when the package is
                   9280:     deinstalled.</p>
1.75      rillig   9281: </div>
1.148     asau     9282: <div class="sect2">
1.75      rillig   9283: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   9284: <a name="tex-packages"></a>21.6.17. Packages installing TeX modules</h3></div></div></div>
1.75      rillig   9285: <p>If a package installs TeX packages into the texmf tree,
1.87      wiz      9286:     the <code class="filename">ls-R</code> database of the tree needs to be
                   9287:     updated.</p>
1.148     asau     9288: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   9289: <h3 class="title">Note</h3>
1.125     wiz      9290: <p>Except the main TeX packages such as kpathsea,
1.87      wiz      9291:     packages should install files
1.125     wiz      9292:     into <code class="filename">${PREFIX}/share/texmf-dist</code>,
                   9293:     not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.75      rillig   9294: </div>
1.128     wiz      9295: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9296: <li class="listitem"><p>Include
1.125     wiz      9297:       <code class="filename">../../print/kpathsea/texmf.mk</code>.  This
1.87      wiz      9298:       takes care of rebuilding the <code class="filename">ls-R</code>
                   9299:       database at installation and deinstallation time.</p></li>
1.128     wiz      9300: <li class="listitem">
1.75      rillig   9301: <p>If your package installs files into a texmf
1.87      wiz      9302:       tree other than the one
1.125     wiz      9303:       at <code class="filename">${PREFIX}/share/texmf-dist</code>,
                   9304:       set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.87      wiz      9305:       trees that need database update.</p>
1.75      rillig   9306: <p>If your package also installs font map files that need
1.110     hubertf  9307:       to be registered using <span class="command"><strong>updmap</strong></span>,
1.136     dholland 9308:       include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.125     wiz      9309:       set <code class="varname">TEX_MAP_FILES</code> and/or
                   9310:       <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.110     hubertf  9311:       such font map files.  Then <span class="command"><strong>updmap</strong></span> will
1.87      wiz      9312:       be run automatically at installation/deinstallation to
                   9313:       enable/disable font map files for TeX output
                   9314:       drivers.</p>
1.75      rillig   9315: </li>
1.128     wiz      9316: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.87      wiz      9317:       databases are included in <code class="filename">PLIST</code>, as
1.136     dholland 9318:       they will be removed only by the kpathsea package.</p></li>
1.75      rillig   9319: </ol></div>
                   9320: </div>
1.148     asau     9321: <div class="sect2">
1.85      jmmv     9322: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   9323: <a name="emulation-packages"></a>21.6.18. Packages supporting running binaries in
1.87      wiz      9324:     emulation</h3></div></div></div>
                   9325: <p>There are some packages that provide libraries and
                   9326:     executables for running binaries from a one operating system
                   9327:     on a different one (if the latter supports it).  One example
                   9328:     is running Linux binaries on NetBSD.</p>
1.250     leot     9329: <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      9330:     helps in extracting and packaging Linux rpm packages.</p>
                   9331: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.110     hubertf  9332:     avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.87      wiz      9333:     if all libraries for each installed executable can be found by
                   9334:     the dynamic linker.  Since the standard dynamic linker is run,
                   9335:     this fails for emulation packages, because the libraries used
                   9336:     by the emulation are not in the standard directories.</p>
                   9337: </div>
1.299     rillig   9338: <div class="sect2">
                   9339: <div class="titlepage"><div><div><h3 class="title">
                   9340: <a name="hicolor-theme"></a>21.6.19. Packages installing hicolor theme icons</h3></div></div></div>
                   9341: <p>If a package installs images under the
                   9342:     <code class="filename">share/icons/hicolor</code> and/or updates the
                   9343:     <code class="filename">share/icons/hicolor/icon-theme.cache</code>
                   9344:     database, you need to take some extra steps to make sure that the
                   9345:     shared theme directory is handled appropriately and that the cache
                   9346:     database is rebuilt:</p>
                   9347: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9348: <li class="listitem"><p>Include
                   9349:        <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
                   9350: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
                   9351:        entry that refers to the theme cache.</p></li>
                   9352: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
                   9353:          directories from the <code class="filename">share/icons/hicolor</code>
                   9354:          hierarchy because they will be handled automatically.</p></li>
                   9355: </ol></div>
                   9356: <p>The best way to verify that the PLIST is correct with
                   9357:       respect to the last two points is to regenerate it using
                   9358:       <span class="command"><strong>make print-PLIST</strong></span>.</p>
                   9359: </div>
                   9360: <div class="sect2">
                   9361: <div class="titlepage"><div><div><h3 class="title">
                   9362: <a name="desktop-files"></a>21.6.20. Packages installing desktop files</h3></div></div></div>
                   9363: <p>If a package installs <code class="filename">.desktop</code> files
                   9364:       under <code class="filename">share/applications</code> and these include
                   9365:       MIME information (MimeType key), you need to take extra steps to
                   9366:       ensure that they are registered into the MIME database:</p>
                   9367: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9368: <li class="listitem"><p>Include
                   9369:          <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
                   9370: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
                   9371:          <code class="filename">share/applications/mimeinfo.cache</code> file.
                   9372:          It will be handled automatically.</p></li>
                   9373: </ol></div>
                   9374: <p>The best way to verify that the PLIST is correct with
                   9375:       respect to the last point is to regenerate it using <span class="command"><strong>make
                   9376:       print-PLIST</strong></span>.</p>
                   9377: </div>
                   9378: </div>
                   9379: <div class="sect1">
                   9380: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   9381: <a name="punting"></a>21.7. Marking packages as having problems</h2></div></div></div>
                   9382: <p>In some cases one does not have the time to solve a problem
                   9383:   immediately. In this case, one can plainly mark a package as broken.  For
                   9384:   this, one just sets the variable <code class="varname">BROKEN</code> to the
                   9385:   reason why the package is broken (similar to the
                   9386:   <code class="varname">PKG_FAIL_REASON</code> variable).  A user trying to build
                   9387:   the package will immediately be shown this message, and the build
                   9388:   will not be even tried.</p>
                   9389: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
                   9390:   intervals.</p>
                   9391: </div>
                   9392: </div>
                   9393: <div class="chapter">
                   9394: <div class="titlepage"><div><div><h2 class="title">
                   9395: <a name="gnome"></a>Chapter 22. GNOME packaging and porting</h2></div></div></div>
                   9396: <div class="toc">
                   9397: <p><b>Table of Contents</b></p>
                   9398: <dl class="toc">
                   9399: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
                   9400: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
                   9401: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
                   9402: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
                   9403: </dl>
                   9404: </div>
                   9405: <p>Quoting <a class="ulink" href="https://www.gnome.org/" target="_top">GNOME's web
                   9406: site</a>:</p>
                   9407: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
                   9408:   environment, an intuitive and attractive desktop for users, and the
                   9409:   GNOME development platform, an extensive framework for building
                   9410:   applications that integrate into the rest of the desktop.</p></blockquote></div>
                   9411: <p>pkgsrc provides a seamless way to automatically build and install
                   9412: a complete GNOME environment <span class="emphasis"><em>under many different
                   9413: platforms</em></span>.  We can say with confidence that pkgsrc is one of
                   9414: the most advanced build and packaging systems for GNOME due to its
                   9415: included technologies buildlink3, the wrappers and tools framework and
                   9416: automatic configuration file management.  Lots of efforts are put into
                   9417: achieving a completely clean deinstallation of installed software
                   9418: components.</p>
                   9419: <p>Given that pkgsrc is <a class="ulink" href="https://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
                   9420: the above also means that great efforts are put into making GNOME work
                   9421: under this operating system.  Recently, <a class="ulink" href="https://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
                   9422: pkgsrc as its preferred packaging system, contributing lots of
                   9423: portability fixes to make GNOME build and install under it.</p>
                   9424: <p>This chapter is aimed at pkgsrc developers and other people
                   9425: interested in helping our GNOME porting and packaging efforts.  It
                   9426: provides instructions on how to manage the existing packages and some
                   9427: important information regarding their internals.</p>
                   9428: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   9429: <h3 class="title">We need your help!</h3>
                   9430: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
                   9431:   and GNOME and are willing to learn new exciting stuff, please jump
                   9432:   straight to the <a class="ulink" href="https://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
                   9433:   work</a> list!  There is still a long way to go to get a
                   9434:   fully-functional GNOME desktop under NetBSD and we need your help to
                   9435:   achieve it!</p>
                   9436: </div>
                   9437: <div class="sect1">
                   9438: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   9439: <a name="meta-packages"></a>22.1. Meta packages</h2></div></div></div>
                   9440: <p>pkgsrc includes three GNOME-related meta packages:</p>
                   9441: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   9442: <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
                   9443:     the core GNOME desktop environment.  It only includes the necessary
                   9444:     bits to get it to boot correctly, although it may lack important
                   9445:     functionality for daily operation.  The idea behind this package is
                   9446:     to let end users build their own configurations on top of this one,
                   9447:     first installing this meta package to achieve a functional setup and
                   9448:     then adding individual applications.</p></li>
                   9449: <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
                   9450:     complete installation of the GNOME platform and desktop as defined
                   9451:     by the GNOME project; this is based on the components distributed in
                   9452:     the <code class="filename">platform/x.y/x.y.z/sources</code> and
                   9453:     <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
                   9454:     official FTP server.  Developer-only tools found in those
                   9455:     directories are not installed unless required by some other
                   9456:     component to work properly.  Similarly, packages from the bindings
                   9457:     set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
                   9458:     in unless required as a dependency for an end-user component.  This
                   9459:     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>
                   9460: <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>:
                   9461:     Installs all the tools required to build a GNOME component when
                   9462:     fetched from the CVS repository.  These are required to let the
                   9463:     <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
                   9464: </ul></div>
                   9465: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
                   9466: sorted in a way that eases updates: a package may depend on other
                   9467: packages listed before it but not on any listed after it.  It is very
                   9468: important to keep this order to ease updates so... <span class="emphasis"><em>do not
                   9469: change it to alphabetical sorting!</em></span></p>
                   9470: </div>
                   9471: <div class="sect1">
                   9472: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   9473: <a name="new-package"></a>22.2. Packaging a GNOME application</h2></div></div></div>
                   9474: <p>Almost all GNOME applications are written in C and use a common
                   9475: set of tools as their build system.  Things get different with the new
                   9476: bindings to other languages (such as Python), but the following will
                   9477: give you a general idea on the minimum required tools:</p>
                   9478: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   9479: <li class="listitem">
                   9480: <p>Almost all GNOME applications use the GNU Autotools as their
                   9481:     build system.  As a general rule you will need to tell this to your
                   9482:     package:</p>
                   9483: <pre class="programlisting">
                   9484: GNU_CONFIGURE=yes
                   9485: USE_LIBTOOL=yes
                   9486: USE_TOOLS+=gmake
                   9487: </pre>
                   9488: </li>
                   9489: <li class="listitem">
                   9490: <p>If the package uses pkg-config to detect dependencies, add this
                   9491:     tool to the list of required utilities:</p>
                   9492: <pre class="programlisting">
                   9493: USE_TOOLS+=pkg-config
                   9494: </pre>
                   9495: <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
                   9496:     the end of the build process to ensure that you did not miss to
                   9497:     specify any dependency in your package and that the version
                   9498:     requirements are all correct.</p>
                   9499: </li>
                   9500: <li class="listitem"><p>If the package uses intltool, be sure to add
                   9501:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
                   9502:     to handle dependencies and to force the package to use the latest
                   9503:     available version.</p></li>
                   9504: <li class="listitem">
                   9505: <p>If the package uses gtk-doc (a documentation generation
                   9506:     utility), do <span class="emphasis"><em>not</em></span> add a dependency on it.  The
                   9507:     tool is rather big and the distfile should come with pregenerated
                   9508:     documentation anyway; if it does not, it is a bug that you ought to
                   9509:     report.  For such packages you should disable gtk-doc (unless it is
                   9510:     the default):</p>
                   9511: <pre class="programlisting">
                   9512: CONFIGURE_ARGS+=--disable-gtk-doc
                   9513: </pre>
                   9514: <p>The default location of installed HTML files
                   9515:     (<code class="filename">share/gtk-doc/&lt;package-name&gt;</code>) is correct
                   9516:     and should not be changed unless the package insists on installing
                   9517:     them somewhere else.  Otherwise programs as
                   9518:     <span class="command"><strong>devhelp</strong></span> will not be able to open them.  You can
                   9519:     do that with an entry similar to:</p>
                   9520: <pre class="programlisting">
                   9521: CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...
                   9522: </pre>
                   9523: </li>
                   9524: </ul></div>
                   9525: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
                   9526: files under the installation prefix to maintain databases.  In this
                   9527: context, shared means that those exact same directories and files are
                   9528: used among several different packages, leading to conflicts in the
                   9529: <code class="filename">PLIST</code>.  pkgsrc currently includes functionality to
                   9530: handle the most common cases, so you have to forget about using
                   9531: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
                   9532: omitting shared files from them.  If you find yourself doing those,
                   9533: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
                   9534: <p>The following table lists the common situations that result in
                   9535: using shared directories or files.  For each of them, the appropriate
                   9536: solution is given.  After applying the solution be sure to
                   9537: <span class="emphasis"><em>regenerate the package's file list</em></span> with
                   9538: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
                   9539: <div class="table">
                   9540: <a name="plist-handling"></a><p class="title"><b>Table 22.1. PLIST handling for GNOME packages</b></p>
                   9541: <div class="table-contents"><table class="table" summary="PLIST handling for GNOME packages" border="1">
                   9542: <colgroup>
                   9543: <col>
                   9544: <col>
                   9545: </colgroup>
                   9546: <thead><tr>
                   9547: <th>If the package...</th>
                   9548: <th>Then...</th>
                   9549: </tr></thead>
                   9550: <tbody>
                   9551: <tr>
                   9552: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
                   9553: <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>
                   9554: </tr>
                   9555: <tr>
                   9556: <td>Installs icons under the
                   9557:         <code class="filename">share/icons/hicolor</code> hierarchy or updates
                   9558:         <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
                   9559: <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>
                   9560: </tr>
                   9561: <tr>
                   9562: <td>Installs files under
                   9563:         <code class="filename">share/mime/packages</code>.</td>
                   9564: <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>
                   9565: </tr>
                   9566: <tr>
                   9567: <td>Installs <code class="filename">.desktop</code> files under
                   9568:         <code class="filename">share/applications</code> and these include MIME
                   9569:         information.</td>
                   9570: <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>
                   9571: </tr>
                   9572: </tbody>
                   9573: </table></div>
1.75      rillig   9574: </div>
1.299     rillig   9575: <br class="table-break">
1.75      rillig   9576: </div>
1.148     asau     9577: <div class="sect1">
1.87      wiz      9578: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   9579: <a name="full-update"></a>22.3. Updating GNOME to a newer version</h2></div></div></div>
                   9580: <p>When seeing GNOME as a whole, there are two kinds of
                   9581: updates:</p>
                   9582: <div class="variablelist"><dl class="variablelist">
                   9583: <dt><span class="term">Major update</span></dt>
                   9584: <dd>
                   9585: <p>Given that there is still a very long way for GNOME 3 (if it
                   9586:       ever appears), we consider a major update one that goes from a
                   9587:       <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
                   9588:       where <code class="literal">Y</code> is even and greater than
                   9589:       <code class="literal">X</code>.  These are hard to achieve because they
                   9590:       introduce lots of changes in the components' code and almost all
                   9591:       GNOME distfiles are updated to newer versions.  Some of them can
                   9592:       even break API and ABI compatibility with the previous major
                   9593:       version series.  As a result, the update needs to be done all at
                   9594:       once to minimize breakage.</p>
                   9595: <p>A major update typically consists of around 80 package
                   9596:       updates and the addition of some new ones.</p>
                   9597: </dd>
                   9598: <dt><span class="term">Minor update</span></dt>
                   9599: <dd>
                   9600: <p>We consider a minor update one that goes from a
                   9601:       <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
                   9602:       one where <code class="literal">Y</code> is greater than
                   9603:       <code class="literal">X</code>.  These are easy to achieve because they do
                   9604:       not update all GNOME components, can be done in an incremental way
                   9605:       and do not break API nor ABI compatibility.</p>
                   9606: <p>A minor update typically consists of around 50 package
                   9607:       updates, although the numbers here may vary a lot.</p>
                   9608: </dd>
                   9609: </dl></div>
                   9610: <p>In order to update the GNOME components in pkgsrc to a new stable
                   9611: release (either major or minor), the following steps should be
                   9612: followed:</p>
                   9613: <div class="orderedlist"><ol class="orderedlist" type="1">
1.128     wiz      9614: <li class="listitem">
1.299     rillig   9615: <p>Get a list of all the tarballs that form the new release by
                   9616:     using the following commands.  These will leave the full list of the
                   9617:     components' distfiles into the <code class="filename">list.txt</code>
                   9618:     file:</p>
                   9619: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
                   9620:     ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
                   9621:     awk '{ print $9 }' &gt;list.txt</code></strong>
                   9622: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
                   9623:     ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
                   9624:     awk '{ print $9 }' &gt;&gt;list.txt</code></strong></pre>
1.75      rillig   9625: </li>
1.299     rillig   9626: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
                   9627:     bump their version to the release you are updating them to.  The
                   9628:     three meta packages should be always consistent with versioning.
                   9629:     Obviously remove any <code class="varname">PKGREVISION</code>s that might be
                   9630:     in them.</p></li>
1.128     wiz      9631: <li class="listitem">
1.299     rillig   9632: <p>For each meta package, update all its
                   9633:     <code class="varname">DEPENDS</code> lines to match the latest versions as
                   9634:     shown by the above commands.  Do <span class="emphasis"><em>not</em></span> list any
                   9635:     newer version (even if found in the FTP) because the meta packages
                   9636:     are supposed to list the exact versions that form a specific GNOME
                   9637:     release.  Exceptions are permitted here if a newer version solves a
                   9638:     serious issue in the overall desktop experience; these typically
                   9639:     come in the form of a revision bump in pkgsrc, not in newer versions
                   9640:     from the developers.</p>
                   9641: <p>Packages not listed in the <code class="filename">list.txt</code> file
                   9642:     should be updated to the latest version available (if found in
                   9643:     pkgsrc).  This is the case, for example, of the dependencies on the
                   9644:     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   9645: </li>
1.128     wiz      9646: <li class="listitem">
1.299     rillig   9647: <p>Generate a patch from the modified meta packages and extract the
                   9648:     list of "new" lines.  This will provide you an outline on what
                   9649:     packages need to be updated in pkgsrc and in what order:</p>
                   9650: <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   9651: </li>
1.299     rillig   9652: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
                   9653:     installed packages and start over from scratch at this point.</p></li>
                   9654: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
                   9655:     of <code class="filename">todo.txt</code> and update the packages listed in
                   9656:     it in order.  For major desktop updates none of these should be
                   9657:     committed until the entire set is completed because there are chances
                   9658:     of breaking not-yet-updated packages.</p></li>
                   9659: <li class="listitem"><p>Once the packages are up to date and working, commit them to
                   9660:     the tree one by one with appropriate log messages.  At the end,
                   9661:     commit the three meta package updates and all the corresponding
                   9662:     changes to the <code class="filename">doc/CHANGES-&lt;YEAR&gt;</code> and
                   9663:     <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>
                   9664: </ol></div>
                   9665: </div>
                   9666: <div class="sect1">
                   9667: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   9668: <a name="patching"></a>22.4. Patching guidelines</h2></div></div></div>
                   9669: <p>GNOME is a very big component in pkgsrc which approaches 100
                   9670: packages.  Please, it is very important that you always, always,
                   9671: <span class="strong"><strong>always</strong></span> feed back any portability
                   9672: 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
                   9673: their attention on portability issues and to ensure that future versions
                   9674: can be built out-of-the box on NetBSD.  The less custom patches in
                   9675: pkgsrc, the easier further updates are.  Those developers in charge of
                   9676: issuing major GNOME updates will be grateful if you do that.</p>
                   9677: <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
                   9678: Bugzilla</a>.  Not all components use these to track bugs, but most
                   9679: of them do.  Do not be short on your reports: always provide detailed
                   9680: explanations of the current failure, how it can be improved to achieve
                   9681: maximum portability and, if at all possible, provide a patch against CVS
                   9682: head.  The more verbose you are, the higher chances of your patch being
                   9683: accepted.</p>
                   9684: <p>Also, please avoid using preprocessor magic to fix portability
                   9685: issues.  While the FreeBSD GNOME people are doing a great job in porting
                   9686: GNOME to their operating system, the official GNOME sources are now
                   9687: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
                   9688: and similar macros.  This hurts portability.  Please see our patching
                   9689: 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
                   9690: details.</p>
                   9691: </div>
1.75      rillig   9692: </div>
1.148     asau     9693: <div class="chapter">
1.75      rillig   9694: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   9695: <a name="submit"></a>Chapter 23. Submitting and Committing</h2></div></div></div>
1.75      rillig   9696: <div class="toc">
                   9697: <p><b>Table of Contents</b></p>
1.210     leot     9698: <dl class="toc">
1.267     rillig   9699: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
                   9700: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   9701: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
                   9702: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
                   9703: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
                   9704: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
                   9705: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
                   9706: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
1.75      rillig   9707: </dl>
                   9708: </div>
1.148     asau     9709: <div class="sect1">
1.75      rillig   9710: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9711: <a name="submitting-binary-packages"></a>23.1. Submitting binary packages</h2></div></div></div>
1.75      rillig   9712: <p>Our policy is that we accept binaries only from pkgsrc
                   9713:        developers to guarantee that the packages don't contain any
                   9714:        trojan horses etc. This is not to annoy anyone but rather to
                   9715:        protect our users! You're still free to put up your home-made
                   9716:        binary packages and tell the world where to get them. NetBSD
                   9717:        developers doing bulk builds and wanting to upload them please
1.267     rillig   9718:        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     9719: builds)</i></a>.</p>
1.75      rillig   9720: </div>
1.148     asau     9721: <div class="sect1">
1.75      rillig   9722: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9723: <a name="submitting-your-package"></a>23.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.75      rillig   9724: <p>First, check that your package is complete, compiles and
1.299     rillig   9725:        runs well; see <a class="xref" href="#creating" title="Chapter 14. Creating a new pkgsrc package from scratch">Chapter 14, <i>Creating a new pkgsrc package from scratch</i></a> and the rest of this
1.311     leot     9726:        document. Next, generate an uuencoded gzipped <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/tar.1"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a>
1.82      rillig   9727:        archive that contains all files that make up the package.
1.87      wiz      9728:        Finally, send this package to the pkgsrc bug tracking system,
1.311     leot     9729:        either with the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/send-pr.1"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> command, or if you don't have
1.87      wiz      9730:        that, go to the web page
1.289     leot     9731:        <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      9732:        which contains some instructions and a link to a form where you
                   9733:        can submit packages.  The
1.250     leot     9734:        <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      9735:        also available as a substitute for either of the above two tools.
                   9736:        </p>
1.87      wiz      9737: <p>In the form of the problem report, the category should be
1.128     wiz      9738:        <span class="quote">&#8220;<span class="quote">pkg</span>&#8221;</span>, the synopsis should include the package name
1.87      wiz      9739:        and version number, and the description field should contain a
                   9740:        short description of your package (contents of the COMMENT
                   9741:        variable or DESCR file are OK). The uuencoded package data should
1.128     wiz      9742:        go into the <span class="quote">&#8220;<span class="quote">fix</span>&#8221;</span> field.</p>
1.75      rillig   9743: <p>If you want to submit several packages, please send a
                   9744:        separate PR for each one, it's easier for us to track things
                   9745:        that way.</p>
                   9746: <p>Alternatively, you can also import new packages into
1.128     wiz      9747:        pkgsrc-wip (<span class="quote">&#8220;<span class="quote">pkgsrc work-in-progress</span>&#8221;</span>); see the
1.289     leot     9748:        homepage at <a class="ulink" href="https://pkgsrc.org/wip/" target="_top">https://pkgsrc.org/wip/</a>
1.75      rillig   9749:        for details.</p>
                   9750: </div>
1.148     asau     9751: <div class="sect1">
1.75      rillig   9752: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9753: <a name="general-notes-for-changes"></a>23.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.75      rillig   9754: <p>Please note all package additions, updates, moves, and
1.93      rillig   9755:        removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
1.75      rillig   9756:        important to keep this file up to date and conforming to the
                   9757:        existing format, because it will be used by scripts to
1.289     leot     9758:        automatically update pages on <a class="ulink" href="https://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.75      rillig   9759:        sites. Additionally, check the
1.76      rillig   9760:        <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
1.75      rillig   9761:        for the package you updated or removed, in case it was mentioned
                   9762:        there.</p>
                   9763: <p>When the <code class="varname">PKGREVISION</code> of a package is
                   9764:        bumped, the change should appear in
1.93      rillig   9765:        <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
1.75      rillig   9766:        related or otherwise relevant. Mass bumps that result from a
                   9767:        dependency being updated should not be mentioned. In all other
                   9768:        cases it's the developer's decision.</p>
                   9769: <p>There is a make target that helps in creating proper
1.110     hubertf  9770:   <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries:  <span class="command"><strong>make
1.75      rillig   9771:   changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
                   9772:   and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
1.93      rillig   9773:   usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
1.75      rillig   9774:   file is up-to-date (to avoid having to resolve conflicts later-on)
1.110     hubertf  9775:   and then to <span class="command"><strong>cd</strong></span> to the package directory.  For
                   9776:   package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.75      rillig   9777:   For new packages, or package moves or removals, set the
                   9778:   <code class="varname">CTYPE</code> variable on the command line to "Added",
                   9779:   "Moved", or "Removed".  You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.110     hubertf  9780:   in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.125     wiz      9781:   not the same as your NetBSD login name. The target also automatically
                   9782:   removes possibly existing entries for the package in the
                   9783:   <code class="filename">TODO</code> file. Don't forget to commit
1.174     asau     9784:   the changes, e.g. by using <span class="command"><strong>make commit-changes-entry</strong></span>!
1.126     jakllsch 9785:   If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
1.125     wiz      9786:   a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
                   9787:   makes the cvs commands use the main repository.
                   9788:   </p>
1.75      rillig   9789: </div>
1.148     asau     9790: <div class="sect1">
1.75      rillig   9791: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9792: <a name="commit-messages"></a>23.4. Commit Messages</h2></div></div></div>
1.243     wiz      9793: <p>For several years, there have been mirrors of pkgsrc in
                   9794:   fossil, git, and hg. Standard practise when using these tools is to
                   9795:   make the first line of a commit message function as a summary that
                   9796:   can be read without the rest, such as is commonly done with "git log
                   9797:   --oneline". For this reason, we have the following guidelines for
                   9798:   pkgsrc commit messages:</p>
                   9799: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   9800: <li class="listitem"><p>Start the commit message with a line that explains the
1.244     wiz      9801:     big picture in 65 characters or less. When a commit is for one
1.243     wiz      9802:     package, include the name of the package. For updates, include the
                   9803:     version to which it is updated.</p></li>
                   9804: <li class="listitem"><p>Leave the next line empty.</p></li>
                   9805: <li class="listitem"><p>Then come the details for the commit (changes in that
                   9806:     package, reason for a change) and any relevant PRs. Wrap this
                   9807:     section.</p></li>
                   9808: </ul></div>
                   9809: <p>Here is an example:
                   9810:   </p>
                   9811: <pre class="programlisting">
                   9812:   libxslt: update to 1.0.30
                   9813: 
                   9814:   Changes since 1.0.29:
                   9815:   ...
                   9816:   </pre>
                   9817: <p>
                   9818:   </p>
                   9819: <p>Here is another example:
                   9820:   </p>
                   9821: <pre class="programlisting">
                   9822:   mk/bsd.pkg.mk: enable SSP by default on NetBSD
                   9823: 
                   9824:   (rationale)
                   9825:   </pre>
                   9826: <p>
                   9827:   </p>
                   9828: <p>Commit messages are final: no <span class="quote">&#8220;<span class="quote">cvs admin</span>&#8221;</span> is
                   9829:   allowed on the pkgsrc repository to change commit messages.</p>
                   9830: </div>
                   9831: <div class="sect1">
                   9832: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9833: <a name="committing-importing"></a>23.5. Committing: Adding a package to CVS</h2></div></div></div>
1.87      wiz      9834: <p>This section is only of interest for pkgsrc developers with write
1.140     wiz      9835:   access to the pkgsrc repository.</p>
                   9836: <p>When the package is finished, <span class="quote">&#8220;<span class="quote">cvs add</span>&#8221;</span> the files.
                   9837: Start by adding the directory and then files in the directory. Don't
                   9838: forget to add the new package to the category's
                   9839: <code class="filename">Makefile</code>. Make sure you don't forget any files;
                   9840: you can check by running <span class="quote">&#8220;<span class="quote">cvs status</span>&#8221;</span>. An example:</p>
                   9841: <pre class="programlisting">
                   9842: <code class="prompt">$</code> cd .../pkgsrc/category
                   9843: <code class="prompt">$</code> cvs add pkgname
                   9844: <code class="prompt">$</code> cd pkgname
                   9845: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
                   9846: <code class="prompt">$</code> cvs add patches/p*
                   9847: <code class="prompt">$</code> cvs status | less
1.141     wiz      9848: <code class="prompt">$</code> cvs commit
1.140     wiz      9849: <code class="prompt">$</code> cd ..
                   9850: <code class="prompt">$</code> vi Makefile # add SUBDIRS+=pkgname line
1.141     wiz      9851: <code class="prompt">$</code> cvs commit Makefile
1.174     asau     9852: <code class="prompt">$</code> cd pkgname
1.182     jnemeth  9853: <code class="prompt">$</code> make CTYPE=Added commit-changes-entry
1.140     wiz      9854: </pre>
1.87      wiz      9855: <p>The commit message of the initial import should include part of the
1.76      rillig   9856:   <code class="filename">DESCR</code> file, so people reading the mailing lists know
1.87      wiz      9857:   what the package is/does.</p>
1.140     wiz      9858: <p>Also mention the new package in
                   9859: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
                   9860: <p>Previously, <span class="quote">&#8220;<span class="quote">cvs import</span>&#8221;</span> was suggested, but it was
                   9861: much easier to get wrong than <span class="quote">&#8220;<span class="quote">cvs add</span>&#8221;</span>.</p>
1.75      rillig   9862: </div>
1.148     asau     9863: <div class="sect1">
1.75      rillig   9864: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9865: <a name="updating-package"></a>23.6. Updating a package to a newer version</h2></div></div></div>
1.87      wiz      9866: <p>Please always put a concise, appropriate and relevant summary of the
1.75      rillig   9867:   changes between old and new versions into the commit log when updating
1.87      wiz      9868:   a package. There are various reasons for this:</p>
1.148     asau     9869: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      9870: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.87      wiz      9871:   or its information may be overwritten by newer information.</p></li>
1.128     wiz      9872: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.87      wiz      9873:   repository is very useful for people who use either cvs or anoncvs.</p></li>
1.128     wiz      9874: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.75      rillig   9875:   repository is very useful for people who read the pkgsrc-changes mailing
                   9876:   list, so that they can make tactical decisions about when to upgrade
1.87      wiz      9877:   the package.</p></li>
1.75      rillig   9878: </ul></div>
1.87      wiz      9879: <p>Please also recognize that, just because a new version of a package
1.75      rillig   9880:   has been released, it should not automatically be upgraded in the CVS
                   9881:   repository.  We prefer to be conservative in the packages that are
                   9882:   included in pkgsrc - development or beta packages are not really the
                   9883:   best thing for most places in which pkgsrc is used. Please use your
                   9884:   judgement about what should go into pkgsrc, and bear in mind that
1.87      wiz      9885:   stability is to be preferred above new and possibly untested features.</p>
1.75      rillig   9886: </div>
1.148     asau     9887: <div class="sect1">
1.75      rillig   9888: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9889: <a name="renaming-package"></a>23.7. Renaming a package in pkgsrc</h2></div></div></div>
1.122     reed     9890: <p>Renaming packages is not recommended.</p>
1.290     gutterid 9891: <p>When renaming packages, be sure to fix any references to the old name
1.122     reed     9892:   in other Makefiles, options, buildlink files, etc.</p>
1.282     leot     9893: <p>
1.290     gutterid 9894:   Also, when renaming a package, please add
1.282     leot     9895:   the package name and version pattern(s) of the previous package
                   9896:   to <code class="varname">SUPERSEDES</code>.
1.122     reed     9897:   This may be repeated for multiple renames.
                   9898:   The new package would be an exact replacement.
1.282     leot     9899:   Example:
1.122     reed     9900: </p>
1.282     leot     9901: <pre class="programlisting">
                   9902: SUPERSEDES+=    p5-IO-Compress-Zlib&lt;2.017
                   9903: SUPERSEDES+=    optcomp-[0-9]*
                   9904: </pre>
1.128     wiz      9905: <p>Note that <span class="quote">&#8220;<span class="quote">successor</span>&#8221;</span> in the
1.122     reed     9906:   CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
                   9907:   mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
                   9908:   not be an exact replacement but is a suggestion for the replaced
                   9909:   functionality.</p>
                   9910: </div>
1.148     asau     9911: <div class="sect1">
1.122     reed     9912: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9913: <a name="moving-package"></a>23.8. Moving a package in pkgsrc</h2></div></div></div>
1.122     reed     9914: <p>It is preferred that packages are not renamed or moved, but if needed
                   9915:   please follow these steps.
                   9916: </p>
1.128     wiz      9917: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9918: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
                   9919: <li class="listitem">
1.75      rillig   9920: <p>Remove all CVS dirs.</p>
1.87      wiz      9921: <p>Alternatively to the first two steps you can also do:</p>
1.75      rillig   9922: <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      9923: <p>and use that for further work.</p>
1.75      rillig   9924: </li>
1.128     wiz      9925: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
                   9926: <code class="varname">DEPENDS</code> paths that just did <span class="quote">&#8220;<span class="quote">../package</span>&#8221;</span>
                   9927: instead of <span class="quote">&#8220;<span class="quote">../../category/package</span>&#8221;</span>.</p></li>
                   9928: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.122     reed     9929: <code class="varname">PREV_PKGPATH</code> to the previous category/package
                   9930: pathname.  The <code class="varname">PREV_PKGPATH</code> can be used by tools
                   9931: for doing an update using pkgsrc building; for example, it can
1.311     leot     9932: search the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/pkg_summary.5"><span class="citerefentry"><span class="refentrytitle">pkg_summary</span>(5)</span></a> database for <code class="varname">PREV_PKGPATH</code>
1.122     reed     9933: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
                   9934: new <code class="varname">PKGPATH</code> for that moved package.  Note that
                   9935: it may have multiple matches, so the tool should also check on the
                   9936: <code class="varname">PKGBASE</code> too.  The <code class="varname">PREV_PKGPATH</code>
                   9937: probably has no value unless <code class="varname">SUPERSEDES</code> is not
                   9938: set, i.e.  <code class="varname">PKGBASE</code> stays the same.  </p></li>
1.128     wiz      9939: <li class="listitem"><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.75      rillig   9940: place.</p></li>
1.128     wiz      9941: <li class="listitem">
1.75      rillig   9942: <p>Check if any package depends on it:
                   9943: </p>
                   9944: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   9945: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
                   9946: </li>
1.128     wiz      9947: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
                   9948: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
                   9949: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
                   9950: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
                   9951: <li class="listitem">
1.75      rillig   9952: <p>Commit the changed and removed files:</p>
                   9953: <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      9954: <p>(and any packages from step 5, of course).</p>
1.75      rillig   9955: </li>
                   9956: </ol></div>
                   9957: </div>
                   9958: </div>
1.148     asau     9959: <div class="chapter">
1.75      rillig   9960: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   9961: <a name="devfaq"></a>Chapter 24. Frequently Asked Questions</h2></div></div></div>
1.75      rillig   9962: <p>This section contains the answers to questions that may
                   9963:        arise when you are writing a package. If you don't find your
                   9964:        question answered here, first have a look in the other chapters,
                   9965:        and if you still don't have the answer, ask on the
                   9966:        <code class="literal">pkgsrc-users</code> mailing list.</p>
1.148     asau     9967: <div class="qandaset">
1.289     leot     9968: <a name="devfaq.qandaset"></a><dl>
1.267     rillig   9969: <dt>24.1. <a href="#devfaq.makeflags">What is the difference between
1.75      rillig   9970:        MAKEFLAGS, .MAKEFLAGS and
                   9971:        MAKE_FLAGS?</a>
                   9972: </dt>
1.267     rillig   9973: <dt>24.2. <a href="#devfaq.make">What is the difference between
1.75      rillig   9974:        MAKE, GMAKE and
                   9975:        MAKE_PROGRAM?</a>
                   9976: </dt>
1.267     rillig   9977: <dt>24.3. <a href="#devfaq.cc">What is the difference between
1.75      rillig   9978:        CC, PKG_CC and
                   9979:        PKGSRC_COMPILER?</a>
                   9980: </dt>
1.267     rillig   9981: <dt>24.4. <a href="#devfaq.bl3flags">What is the difference between
1.75      rillig   9982:        BUILDLINK_LDFLAGS,
                   9983:        BUILDLINK_LDADD and
                   9984:        BUILDLINK_LIBS?</a>
                   9985: </dt>
1.267     rillig   9986: <dt>24.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.75      rillig   9987:        VARNAME=BUILDLINK_PREFIX.foo
                   9988:        say it's empty?</a>
                   9989: </dt>
1.267     rillig   9990: <dt>24.6. <a href="#devfaq.master_sites">What does
1.78      rillig   9991:        ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
                   9992:        don't understand the := inside
                   9993:        it.</a>
                   9994: </dt>
1.267     rillig   9995: <dt>24.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.78      rillig   9996:        developers?</a>
                   9997: </dt>
1.267     rillig   9998: <dt>24.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.80      rillig   9999:        documentation?</a>
                   10000: </dt>
1.289     leot     10001: <dt>24.9. <a href="#devfaq.too-much-time">I have a little time to kill. 
                   10002: What shall I do?</a>
1.92      rillig   10003: </dt>
1.75      rillig   10004: </dl>
1.148     asau     10005: <table border="0" style="width: 100%;">
                   10006: <colgroup>
1.75      rillig   10007: <col align="left" width="1%">
1.128     wiz      10008: <col>
1.148     asau     10009: </colgroup>
1.75      rillig   10010: <tbody>
1.148     asau     10011: <tr class="question">
1.75      rillig   10012: <td align="left" valign="top">
1.289     leot     10013: <a name="devfaq.makeflags"></a><a name="devfaq.makeflags.q"></a><p><b>24.1.</b></p>
1.75      rillig   10014: </td>
                   10015: <td align="left" valign="top"><p>What is the difference between
                   10016:        <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
                   10017:        <code class="varname">MAKE_FLAGS</code>?</p></td>
                   10018: </tr>
                   10019: <tr class="answer">
1.91      rillig   10020: <td align="left" valign="top"></td>
1.75      rillig   10021: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
1.311     leot     10022:        to the pkgsrc-internal invocations of <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>, while
1.75      rillig   10023:        <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
                   10024:        the <code class="varname">MAKE_PROGRAM</code> when building the
                   10025:        package. [FIXME: What is .MAKEFLAGS for?]</p></td>
                   10026: </tr>
1.148     asau     10027: <tr class="question">
1.75      rillig   10028: <td align="left" valign="top">
1.289     leot     10029: <a name="devfaq.make"></a><a name="devfaq.make.q"></a><p><b>24.2.</b></p>
1.75      rillig   10030: </td>
                   10031: <td align="left" valign="top"><p>What is the difference between
                   10032:        <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
                   10033:        <code class="varname">MAKE_PROGRAM</code>?</p></td>
                   10034: </tr>
                   10035: <tr class="answer">
1.91      rillig   10036: <td align="left" valign="top"></td>
1.75      rillig   10037: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
1.311     leot     10038:        <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> program that is used in the pkgsrc
1.75      rillig   10039:        infrastructure. <code class="varname">GMAKE</code> is the path to GNU
                   10040:        Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
                   10041:        use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
                   10042:        Make program that is used for building the
                   10043:        package.</p></td>
                   10044: </tr>
1.148     asau     10045: <tr class="question">
1.75      rillig   10046: <td align="left" valign="top">
1.289     leot     10047: <a name="devfaq.cc"></a><a name="devfaq.cc.q"></a><p><b>24.3.</b></p>
1.75      rillig   10048: </td>
                   10049: <td align="left" valign="top"><p>What is the difference between
                   10050:        <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
                   10051:        <code class="varname">PKGSRC_COMPILER</code>?</p></td>
                   10052: </tr>
                   10053: <tr class="answer">
1.91      rillig   10054: <td align="left" valign="top"></td>
1.75      rillig   10055: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
                   10056:        compiler, which can be configured by the pkgsrc user.
                   10057:        <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
                   10058:        <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
                   10059:        path to a compiler, but the type of compiler that should be
1.76      rillig   10060:        used. See <code class="filename">mk/compiler.mk</code> for more
1.75      rillig   10061:        information about the latter variable.</p></td>
                   10062: </tr>
1.148     asau     10063: <tr class="question">
1.75      rillig   10064: <td align="left" valign="top">
1.289     leot     10065: <a name="devfaq.bl3flags"></a><a name="devfaq.bl3flags.q"></a><p><b>24.4.</b></p>
1.75      rillig   10066: </td>
                   10067: <td align="left" valign="top"><p>What is the difference between
                   10068:        <code class="varname">BUILDLINK_LDFLAGS</code>,
                   10069:        <code class="varname">BUILDLINK_LDADD</code> and
                   10070:        <code class="varname">BUILDLINK_LIBS</code>?</p></td>
                   10071: </tr>
                   10072: <tr class="answer">
1.91      rillig   10073: <td align="left" valign="top"></td>
1.75      rillig   10074: <td align="left" valign="top"><p>[FIXME]</p></td>
                   10075: </tr>
1.148     asau     10076: <tr class="question">
1.75      rillig   10077: <td align="left" valign="top">
1.289     leot     10078: <a name="devfaq.bl3prefix"></a><a name="devfaq.bl3prefix.q"></a><p><b>24.5.</b></p>
1.75      rillig   10079: </td>
1.110     hubertf  10080: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.75      rillig   10081:        VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
                   10082:        say it's empty?</p></td>
                   10083: </tr>
                   10084: <tr class="answer">
1.91      rillig   10085: <td align="left" valign="top"></td>
1.75      rillig   10086: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.128     wiz      10087:        available in the <span class="quote">&#8220;<span class="quote">wrapper</span>&#8221;</span> phase and later. To
                   10088:        <span class="quote">&#8220;<span class="quote">simulate</span>&#8221;</span> the wrapper phase, append
1.110     hubertf  10089:        <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.75      rillig   10090:        command.</p></td>
                   10091: </tr>
1.148     asau     10092: <tr class="question">
1.78      rillig   10093: <td align="left" valign="top">
1.289     leot     10094: <a name="devfaq.master_sites"></a><a name="devfaq.master_sites.q"></a><p><b>24.6.</b></p>
1.78      rillig   10095: </td>
                   10096: <td align="left" valign="top"><p>What does
1.220     wiz      10097:        <code class="code">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
                   10098:        don't understand the <code class="code">:=</code> inside
1.78      rillig   10099:        it.</p></td>
                   10100: </tr>
                   10101: <tr class="answer">
1.91      rillig   10102: <td align="left" valign="top"></td>
1.220     wiz      10103: <td align="left" valign="top"><p>The <code class="code">:=</code> is not really an
                   10104:        assignment operator, although it looks like it.
1.78      rillig   10105:        Instead, it is a degenerate form of
1.220     wiz      10106:        <code class="code">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.311     leot     10107:        which is documented in the <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/make.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man page and which is
1.220     wiz      10108:        commonly used in the form <code class="code">${SRCS:.c=.o}</code>. In the
1.78      rillig   10109:        case of <code class="varname">MASTER_SITE_*</code>,
                   10110:        <em class="replaceable"><code>old_string</code></em> is the empty string and
                   10111:        <em class="replaceable"><code>new_string</code></em> is
1.220     wiz      10112:        <code class="code">package/</code>. That's where the
                   10113:        <code class="code">:</code> and the <code class="code">=</code> fall
1.78      rillig   10114:        together.</p></td>
                   10115: </tr>
1.148     asau     10116: <tr class="question">
1.78      rillig   10117: <td align="left" valign="top">
1.289     leot     10118: <a name="devfaq.mailinglists"></a><a name="devfaq.mailinglists.q"></a><p><b>24.7.</b></p>
1.78      rillig   10119: </td>
                   10120: <td align="left" valign="top"><p>Which mailing lists are there for package
                   10121:        developers?</p></td>
                   10122: </tr>
                   10123: <tr class="answer">
1.91      rillig   10124: <td align="left" valign="top"></td>
1.148     asau     10125: <td align="left" valign="top"><div class="variablelist"><dl class="variablelist">
1.289     leot     10126: <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   10127: <dd><p>This is a list for technical discussions related
                   10128:        to pkgsrc development, e.g. soliciting feedback for changes to
                   10129:        pkgsrc infrastructure, proposed new features, questions related
                   10130:        to porting pkgsrc to a new platform, advice for maintaining a
                   10131:        package, patches that affect many packages, help requests moved
                   10132:        from pkgsrc-users when an infrastructure bug is found,
                   10133:        etc.</p></dd>
1.289     leot     10134: <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   10135: <dd><p>All bug reports in category "pkg" sent with
1.311     leot     10136:        <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/send-pr.1"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> appear here. Please do not report your bugs here
1.78      rillig   10137:        directly; use one of the other mailing
                   10138:        lists.</p></dd>
                   10139: </dl></div></td>
                   10140: </tr>
1.148     asau     10141: <tr class="question">
1.80      rillig   10142: <td align="left" valign="top">
1.289     leot     10143: <a name="devfaq.documentation"></a><a name="devfaq.documentation.q"></a><p><b>24.8.</b></p>
1.80      rillig   10144: </td>
                   10145: <td align="left" valign="top"><p>Where is the pkgsrc
                   10146:        documentation?</p></td>
                   10147: </tr>
                   10148: <tr class="answer">
1.91      rillig   10149: <td align="left" valign="top"></td>
1.80      rillig   10150: <td align="left" valign="top">
                   10151: <p>There are many places where you can find
                   10152:        documentation about pkgsrc:</p>
1.148     asau     10153: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      10154: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.80      rillig   10155:        of chapters that explain large parts of pkgsrc, but some
                   10156:        chapters tend to be outdated. Which ones they are is hard to
                   10157:        say.</p></li>
1.289     leot     10158: <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   10159:        about certain features, announcements of new parts of the pkgsrc
                   10160:        infrastructure and sometimes even announcements that a certain
                   10161:        feature has been marked as obsolete. The benefit here is that
                   10162:        each message has a date appended to it.</p></li>
1.128     wiz      10163: <li class="listitem"><p>Many of the files in the
1.80      rillig   10164:        <code class="filename">mk/</code> directory start with a comment that
                   10165:        describes the purpose of the file and how it can be used by the
1.92      rillig   10166:        pkgsrc user and package authors. An easy way to find this
1.110     hubertf  10167:        documentation is to run <span class="command"><strong>bmake
1.92      rillig   10168:        help</strong></span>.</p></li>
1.128     wiz      10169: <li class="listitem"><p>The CVS log messages are a rich source of
1.80      rillig   10170:        information, but they tend to be highly abbreviated, especially
                   10171:        for actions that occur often. Some contain a detailed
                   10172:        description of what has changed, but they are geared towards the
                   10173:        other pkgsrc developers, not towards an average pkgsrc user.
                   10174:        They also only document <span class="emphasis"><em>changes</em></span>, so if you
                   10175:        don't know what has been before, these messages may not be worth
                   10176:        too much to you.</p></li>
1.128     wiz      10177: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">&#8220;<span class="quote">implicitly
                   10178:        documented</span>&#8221;</span>, that is the documentation exists only in the
1.80      rillig   10179:        mind of the developer who wrote the code. To get this
1.110     hubertf  10180:        information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.80      rillig   10181:        to see who has written it and ask on the
                   10182:        <code class="literal">tech-pkg</code> mailing list, so that others can
                   10183:        find your questions later (see above). To be sure that the
                   10184:        developer in charge reads the mail, you may CC him or
                   10185:        her.</p></li>
                   10186: </ul></div>
1.299     rillig   10187: </td>
                   10188: </tr>
                   10189: <tr class="question">
                   10190: <td align="left" valign="top">
                   10191: <a name="devfaq.too-much-time"></a><a name="devfaq.too-much-time.q"></a><p><b>24.9.</b></p>
                   10192: </td>
                   10193: <td align="left" valign="top"><p>I have a little time to kill. 
                   10194: What shall I do?</p></td>
                   10195: </tr>
                   10196: <tr class="answer">
                   10197: <td align="left" valign="top"></td>
                   10198: <td align="left" valign="top">
                   10199: <p>This is not really an FAQ yet, but here's the answer
                   10200: anyway.</p>
1.148     asau     10201: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.299     rillig   10202: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
                   10203:     <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
                   10204:     will tell you about newer versions of installed packages that are
                   10205:     available, but not yet updated in pkgsrc.</p></li>
                   10206: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
                   10207:     &mdash; it contains a list of suggested new packages and a list of
                   10208:     cleanups and enhancements for pkgsrc that would be nice to
                   10209:     have.</p></li>
                   10210: <li class="listitem"><p>Review packages for which review was requested on
                   10211:     the <a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a>
                   10212:     mailing list.</p></li>
1.85      jmmv     10213: </ul></div>
1.299     rillig   10214: </td>
1.85      jmmv     10215: </tr>
                   10216: </tbody>
1.299     rillig   10217: </table>
1.85      jmmv     10218: </div>
                   10219: </div>
1.75      rillig   10220: </div>
1.148     asau     10221: <div class="part">
1.75      rillig   10222: <div class="titlepage"><div><div><h1 class="title">
                   10223: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.148     asau     10224: <div class="partintro">
1.75      rillig   10225: <div></div>
                   10226: <p>This part of the guide deals with everything
                   10227:        from the infrastructure that is behind the interfaces described
                   10228:        in the developer's guide. A casual package maintainer should not
                   10229:        need anything from this part.</p>
                   10230: <div class="toc">
                   10231: <p><b>Table of Contents</b></p>
1.210     leot     10232: <dl class="toc">
1.299     rillig   10233: <dt><span class="chapter"><a href="#infr.design">25. Design of the pkgsrc infrastructure</a></span></dt>
1.75      rillig   10234: <dd><dl>
1.299     rillig   10235: <dt><span class="sect1"><a href="#infr.vardef">25.1. The meaning of variable definitions</a></span></dt>
                   10236: <dt><span class="sect1"><a href="#infr.vardef.problems">25.2. Avoiding problems before they arise</a></span></dt>
                   10237: <dt><span class="sect1"><a href="#infr.var">25.3. Variable evaluation</a></span></dt>
1.75      rillig   10238: <dd><dl>
1.299     rillig   10239: <dt><span class="sect2"><a href="#infr.var.load">25.3.1. At load time</a></span></dt>
                   10240: <dt><span class="sect2"><a href="#infr.var.run">25.3.2. At runtime</a></span></dt>
1.75      rillig   10241: </dl></dd>
1.299     rillig   10242: <dt><span class="sect1"><a href="#infr.varspec">25.4. How can variables be specified?</a></span></dt>
                   10243: <dt><span class="sect1"><a href="#infr.design.intf">25.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig   10244: <dd><dl>
1.299     rillig   10245: <dt><span class="sect2"><a href="#infr.design.intf.proc">25.5.1. Procedures with parameters</a></span></dt>
                   10246: <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   10247: </dl></dd>
1.299     rillig   10248: <dt><span class="sect1"><a href="#infr.order">25.6. The order in which files are loaded</a></span></dt>
1.81      rillig   10249: <dd><dl>
1.299     rillig   10250: <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>
                   10251: <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   10252: </dl></dd>
                   10253: </dl></dd>
1.299     rillig   10254: <dt><span class="chapter"><a href="#regression">26. Regression tests</a></span></dt>
1.75      rillig   10255: <dd><dl>
1.299     rillig   10256: <dt><span class="sect1"><a href="#regression.run">26.1. Running the regression tests</a></span></dt>
                   10257: <dt><span class="sect1"><a href="#regression.new">26.2. Adding a new regression test</a></span></dt>
1.75      rillig   10258: <dd><dl>
1.299     rillig   10259: <dt><span class="sect2"><a href="#regression.fun.override">26.2.1. Overridable functions</a></span></dt>
                   10260: <dt><span class="sect2"><a href="#regression.fun.helper">26.2.2. Helper functions</a></span></dt>
1.75      rillig   10261: </dl></dd>
                   10262: </dl></dd>
1.299     rillig   10263: <dt><span class="chapter"><a href="#porting">27. Porting pkgsrc</a></span></dt>
                   10264: <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   10265: </dl>
                   10266: </div>
                   10267: </div>
1.148     asau     10268: <div class="chapter">
1.75      rillig   10269: <div class="titlepage"><div><div><h2 class="title">
1.299     rillig   10270: <a name="infr.design"></a>Chapter 25. Design of the pkgsrc infrastructure</h2></div></div></div>
1.75      rillig   10271: <div class="toc">
                   10272: <p><b>Table of Contents</b></p>
1.210     leot     10273: <dl class="toc">
1.299     rillig   10274: <dt><span class="sect1"><a href="#infr.vardef">25.1. The meaning of variable definitions</a></span></dt>
                   10275: <dt><span class="sect1"><a href="#infr.vardef.problems">25.2. Avoiding problems before they arise</a></span></dt>
                   10276: <dt><span class="sect1"><a href="#infr.var">25.3. Variable evaluation</a></span></dt>
1.81      rillig   10277: <dd><dl>
1.299     rillig   10278: <dt><span class="sect2"><a href="#infr.var.load">25.3.1. At load time</a></span></dt>
                   10279: <dt><span class="sect2"><a href="#infr.var.run">25.3.2. At runtime</a></span></dt>
1.81      rillig   10280: </dl></dd>
1.299     rillig   10281: <dt><span class="sect1"><a href="#infr.varspec">25.4. How can variables be specified?</a></span></dt>
                   10282: <dt><span class="sect1"><a href="#infr.design.intf">25.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig   10283: <dd><dl>
1.299     rillig   10284: <dt><span class="sect2"><a href="#infr.design.intf.proc">25.5.1. Procedures with parameters</a></span></dt>
                   10285: <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   10286: </dl></dd>
1.299     rillig   10287: <dt><span class="sect1"><a href="#infr.order">25.6. The order in which files are loaded</a></span></dt>
1.75      rillig   10288: <dd><dl>
1.299     rillig   10289: <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>
                   10290: <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   10291: </dl></dd>
                   10292: </dl>
                   10293: </div>
                   10294: <p>The pkgsrc infrastructure consists of many small Makefile
                   10295:        fragments. Each such fragment needs a properly specified
                   10296:        interface. This chapter explains how such an interface looks
                   10297:        like.</p>
1.148     asau     10298: <div class="sect1">
1.75      rillig   10299: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   10300: <a name="infr.vardef"></a>25.1. The meaning of variable definitions</h2></div></div></div>
1.81      rillig   10301: <p>Whenever a variable is defined in the pkgsrc
                   10302:        infrastructure, the location and the way of definition provide
                   10303:        much information about the intended use of that variable.
                   10304:        Additionally, more documentation may be found in a header
                   10305:        comment or in this pkgsrc guide.</p>
                   10306: <p>A special file is
                   10307:        <code class="filename">mk/defaults/mk.conf</code>, which lists all
                   10308:        variables that are intended to be user-defined. They are either
                   10309:        defined using the <code class="literal">?=</code> operator or they are
                   10310:        left undefined because defining them to anything would
1.128     wiz      10311:        effectively mean <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. All these variables may be
1.81      rillig   10312:        overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
                   10313:        file.</p>
                   10314: <p>Outside this file, the following conventions apply:
                   10315:        Variables that are defined using the <code class="literal">?=</code>
                   10316:        operator may be overridden by a package.</p>
                   10317: <p>Variables that are defined using the <code class="literal">=</code>
                   10318:        operator may be used read-only at run-time.</p>
                   10319: <p>Variables whose name starts with an underscore must not be
                   10320:        accessed outside the pkgsrc infrastructure at all. They may
                   10321:        change without further notice.</p>
1.148     asau     10322: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.81      rillig   10323: <h3 class="title">Note</h3>
                   10324: <p>These conventions are currently not applied
                   10325:        consistently to the complete pkgsrc
                   10326:        infrastructure.</p>
                   10327: </div>
                   10328: </div>
1.148     asau     10329: <div class="sect1">
1.81      rillig   10330: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   10331: <a name="infr.vardef.problems"></a>25.2. Avoiding problems before they arise</h2></div></div></div>
1.81      rillig   10332: <p>All variables that contain lists of things should default
                   10333:        to being empty. Two examples that do not follow this rule are
                   10334:        <code class="varname">USE_LANGUAGES</code> and
                   10335:        <code class="varname">DISTFILES</code>. These variables cannot simply be
                   10336:        modified using the <code class="literal">+=</code> operator in package
                   10337:        <code class="filename">Makefile</code>s (or other files included by
                   10338:        them), since there is no guarantee whether the variable is
                   10339:        already set or not, and what its value is. In the case of
1.128     wiz      10340:        <code class="varname">DISTFILES</code>, the packages <span class="quote">&#8220;<span class="quote">know</span>&#8221;</span>
1.81      rillig   10341:        the default value and just define it as in the following
                   10342:        example.</p>
                   10343: <pre class="programlisting">
1.100     rillig   10344: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
1.81      rillig   10345: </pre>
                   10346: <p>Because of the selection of this default value, the same
                   10347:        value appears in many package Makefiles. Similarly for
                   10348:        <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.128     wiz      10349:        value (<span class="quote">&#8220;<span class="quote"><code class="literal">c</code></span>&#8221;</span>) is so short that it
1.81      rillig   10350:        doesn't stand out. Nevertheless it is mentioned in many
                   10351:        files.</p>
                   10352: </div>
1.148     asau     10353: <div class="sect1">
1.81      rillig   10354: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   10355: <a name="infr.var"></a>25.3. Variable evaluation</h2></div></div></div>
1.148     asau     10356: <div class="sect2">
1.75      rillig   10357: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   10358: <a name="infr.var.load"></a>25.3.1. At load time</h3></div></div></div>
1.75      rillig   10359: <p>Variable evaluation takes place either at load time or at
                   10360:        runtime, depending on the context in which they occur. The
                   10361:        contexts where variables are evaluated at load time are:</p>
1.148     asau     10362: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      10363: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.75      rillig   10364:        and <code class="literal">!=</code> operators,</p></li>
1.128     wiz      10365: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.75      rillig   10366:        <code class="literal">.for</code>,</p></li>
1.128     wiz      10367: <li class="listitem"><p>Dependency lines.</p></li>
1.75      rillig   10368: </ul></div>
                   10369: <p>A special exception are references to the iteration
                   10370:        variables of <code class="literal">.for</code> loops, which are expanded
                   10371:        inline, no matter in which context they appear.</p>
                   10372: <p>As the values of variables may change during load time,
                   10373:        care must be taken not to evaluate them by accident. Typical
                   10374:        examples for variables that should not be evaluated at load time
                   10375:        are <code class="varname">DEPENDS</code> and
                   10376:        <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
                   10377:        clear, here is an example:</p>
                   10378: <pre class="programlisting">
1.100     rillig   10379: CONFIGURE_ARGS=         # none
                   10380: CFLAGS=                 -O
                   10381: CONFIGURE_ARGS+=        CFLAGS=${CFLAGS:Q}
1.1       grant    10382: 
1.100     rillig   10383: CONFIGURE_ARGS:=        ${CONFIGURE_ARGS}
1.1       grant    10384: 
1.100     rillig   10385: CFLAGS+=                -Wall
1.222     sevan    10386: </pre>
1.75      rillig   10387: <p>This code shows how the use of the <code class="literal">:=</code>
                   10388:        operator can quickly lead to unexpected results. The first
                   10389:        paragraph is fairly common code. The second paragraph evaluates
                   10390:        the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
                   10391:        <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
                   10392:        <code class="literal">-Wall</code> is appended to the
                   10393:        <code class="varname">CFLAGS</code>, but this addition will not appear in
                   10394:        <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
                   10395:        paragraphs from above typically occur in completely unrelated
                   10396:        files.</p>
                   10397: </div>
1.148     asau     10398: <div class="sect2">
1.75      rillig   10399: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   10400: <a name="infr.var.run"></a>25.3.2. At runtime</h3></div></div></div>
1.75      rillig   10401: <p>After all the files have been loaded, the values of the
                   10402:        variables cannot be changed anymore. Variables that are used in
                   10403:        the shell commands are expanded at this point.</p>
                   10404: </div>
                   10405: </div>
1.148     asau     10406: <div class="sect1">
1.75      rillig   10407: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   10408: <a name="infr.varspec"></a>25.4. How can variables be specified?</h2></div></div></div>
1.78      rillig   10409: <p>There are many ways in which the definition and use of a
1.218     rillig   10410:        variable can be restricted in order to detect bugs and violations
                   10411:        of the (mostly unwritten) policies. A package can be checked with
                   10412:        <code class="literal">pkglint -Wall</code> to see whether it meets these
                   10413:        rules.</p>
1.78      rillig   10414: </div>
1.148     asau     10415: <div class="sect1">
1.78      rillig   10416: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   10417: <a name="infr.design.intf"></a>25.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.76      rillig   10418: <p>Most of the <code class="filename">.mk</code> files fall into one
1.75      rillig   10419:        of the following classes. Cases where a file falls into more
                   10420:        than one class should be avoided as it often leads to subtle
                   10421:        bugs.</p>
1.148     asau     10422: <div class="sect2">
1.75      rillig   10423: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   10424: <a name="infr.design.intf.proc"></a>25.5.1. Procedures with parameters</h3></div></div></div>
1.75      rillig   10425: <p>In a traditional imperative programming language some of
1.76      rillig   10426:        the <code class="filename">.mk</code> files could be described as
1.126     jakllsch 10427:        procedures. They take some input parameters and&mdash;after
                   10428:        inclusion&mdash;provide a result in output parameters. Since all
1.76      rillig   10429:        variables in <code class="filename">Makefile</code>s have global scope
1.75      rillig   10430:        care must be taken not to use parameter names that have already
                   10431:        another meaning. For example, <code class="varname">PKGNAME</code> is a
                   10432:        bad choice for a parameter name.</p>
                   10433: <p>Procedures are completely evaluated at preprocessing time.
                   10434:        That is, when calling a procedure all input parameters must be
                   10435:        completely resolvable. For example,
                   10436:        <code class="varname">CONFIGURE_ARGS</code> should never be an input
                   10437:        parameter since it is very likely that further text will be
                   10438:        added after calling the procedure, which would effectively apply
                   10439:        the procedure to only a part of the variable. Also, references
1.218     rillig   10440:        to other variables will be modified after calling the
1.75      rillig   10441:        procedure.</p>
                   10442: <p>A procedure can declare its output parameters either as
                   10443:        suitable for use in preprocessing directives or as only
                   10444:        available at runtime. The latter alternative is for variables
                   10445:        that contain references to other runtime variables.</p>
                   10446: <p>Procedures shall be written such that it is possible to
                   10447:        call the procedure more than once. That is, the file must not
                   10448:        contain multiple-inclusion guards.</p>
                   10449: <p>Examples for procedures are
1.76      rillig   10450:        <code class="filename">mk/bsd.options.mk</code> and
                   10451:        <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
1.75      rillig   10452:        that the parameters are evaluated at load time, they should be
                   10453:        assigned using the <code class="literal">:=</code> operator, which should
                   10454:        be used only for this purpose.</p>
                   10455: </div>
1.148     asau     10456: <div class="sect2">
1.75      rillig   10457: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   10458: <a name="infr.design.intf.action"></a>25.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.75      rillig   10459: <p>Action files take some input parameters and may define
                   10460:        runtime variables. They shall not define loadtime variables.
                   10461:        There are action files that are included implicitly by the
                   10462:        pkgsrc infrastructure, while other must be included
                   10463:        explicitly.</p>
                   10464: <p>An example for action files is
1.76      rillig   10465:        <code class="filename">mk/subst.mk</code>.</p>
1.75      rillig   10466: </div>
                   10467: </div>
1.148     asau     10468: <div class="sect1">
1.81      rillig   10469: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   10470: <a name="infr.order"></a>25.6. The order in which files are loaded</h2></div></div></div>
1.81      rillig   10471: <p>Package <code class="filename">Makefile</code>s usually consist of
                   10472:        a set of variable definitions, and include the file
                   10473:        <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
                   10474:        Before that, they may also include various other
                   10475:        <code class="filename">*.mk</code> files if they need to query the
                   10476:        availability of certain features like the type of compiler or
                   10477:        the X11 implementation. Due to the heavy use of preprocessor
                   10478:        directives like <code class="literal">.if</code> and
                   10479:        <code class="literal">.for</code>, the order in which the files are loaded
                   10480:        matters.</p>
                   10481: <p>This section describes at which point the various files
                   10482:        are loaded and gives reasons for that order.</p>
1.148     asau     10483: <div class="sect2">
1.81      rillig   10484: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   10485: <a name="infr.order.prefs"></a>25.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.93      rillig   10486: </h3></div></div></div>
                   10487: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
1.81      rillig   10488:        is to define some essential variables like
                   10489:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
                   10490:        <code class="varname">MACHINE_ARCH</code>.</p>
                   10491: <p>Then, the user settings are loaded from the file specified
1.110     hubertf  10492:        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   10493:        After that, those variables
1.81      rillig   10494:        that have not been overridden by the user are loaded from
                   10495:        <code class="filename">mk/defaults/mk.conf</code>.</p>
                   10496: <p>After the user settings, the system settings and platform
                   10497:        settings are loaded, which may override the user
                   10498:        settings.</p>
                   10499: <p>Then, the tool definitions are loaded. The tool wrappers
                   10500:        are not yet in effect. This only happens when building a
                   10501:        package, so the proper variables must be used instead of the
                   10502:        direct tool names.</p>
                   10503: <p>As the last steps, some essential variables from the
                   10504:        wrapper and the package system flavor are loaded, as well as the
                   10505:        variables that have been cached in earlier phases of a package
                   10506:        build.</p>
                   10507: </div>
1.148     asau     10508: <div class="sect2">
1.81      rillig   10509: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   10510: <a name="infr.order.pkg"></a>25.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.93      rillig   10511: </h3></div></div></div>
1.81      rillig   10512: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
                   10513: <p>Then, the various <code class="filename">*-vars.mk</code> files are
                   10514:        loaded, which fill default values for those variables that have
1.93      rillig   10515:        not been defined by the package. These variables may later
1.81      rillig   10516:        be used even in unrelated files.</p>
                   10517: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
                   10518:        provides the target <code class="literal">error-check</code> that is added
                   10519:        as a special dependency to all other targets that use
                   10520:        <code class="varname">DELAYED_ERROR_MSG</code> or
                   10521:        <code class="varname">DELAYED_WARNING_MSG</code>.</p>
                   10522: <p>Then, the package-specific hacks from
                   10523:        <code class="filename">hacks.mk</code> are included.</p>
                   10524: <p>Then, various other files follow. Most of them don't have
                   10525:        any dependencies on what they need to have included before or
                   10526:        after them, though some do.</p>
                   10527: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
                   10528:        <code class="varname">PKG_SKIP_REASON</code> is then executed, which
                   10529:        restricts the use of these variables to all the files that have
                   10530:        been included before. Appearances in later files will be
                   10531:        silently ignored.</p>
                   10532: <p>Then, the files for the main targets are included, in the
                   10533:        order of later execution, though the actual order should not
                   10534:        matter.</p>
                   10535: <p>At last, some more files are included that don't set any
                   10536:        interesting variables but rather just define make targets to be
                   10537:        executed.</p>
                   10538: </div>
                   10539: </div>
1.75      rillig   10540: </div>
1.148     asau     10541: <div class="chapter">
1.75      rillig   10542: <div class="titlepage"><div><div><h2 class="title">
1.299     rillig   10543: <a name="regression"></a>Chapter 26. Regression tests</h2></div></div></div>
1.75      rillig   10544: <div class="toc">
                   10545: <p><b>Table of Contents</b></p>
1.210     leot     10546: <dl class="toc">
1.299     rillig   10547: <dt><span class="sect1"><a href="#regression.run">26.1. Running the regression tests</a></span></dt>
                   10548: <dt><span class="sect1"><a href="#regression.new">26.2. Adding a new regression test</a></span></dt>
1.75      rillig   10549: <dd><dl>
1.299     rillig   10550: <dt><span class="sect2"><a href="#regression.fun.override">26.2.1. Overridable functions</a></span></dt>
                   10551: <dt><span class="sect2"><a href="#regression.fun.helper">26.2.2. Helper functions</a></span></dt>
1.75      rillig   10552: </dl></dd>
                   10553: </dl>
                   10554: </div>
                   10555: <p>The pkgsrc infrastructure consists of a large codebase,
                   10556:        and there are many corners where every little bit of a file is
                   10557:        well thought out, making pkgsrc likely to fail as soon as
                   10558:        anything is changed near those parts. To prevent most changes
                   10559:        from breaking anything, a suite of regression tests should go
                   10560:        along with every important part of the pkgsrc infrastructure.
                   10561:        This chapter describes how regression tests work in pkgsrc and
                   10562:        how you can add new tests.</p>
1.148     asau     10563: <div class="sect1">
1.75      rillig   10564: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   10565: <a name="regression.run"></a>26.1. Running the regression tests</h2></div></div></div>
1.250     leot     10566: <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  10567:        provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.75      rillig   10568:        can simply run that command, which will run all tests in the
1.283     rillig   10569:        <code class="filename">regress/</code> directory.</p>
1.75      rillig   10570: </div>
1.148     asau     10571: <div class="sect1">
1.75      rillig   10572: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   10573: <a name="regression.new"></a>26.2. Adding a new regression test</h2></div></div></div>
1.283     rillig   10574: <p>Every directory in the <code class="filename">regress/</code>
                   10575:        directory that contains a file called <code class="filename">spec</code>
1.75      rillig   10576:        is considered a regression test. This file is a shell program
1.110     hubertf  10577:        that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.75      rillig   10578:        The following functions can be overridden to suit your
                   10579:        needs.</p>
1.148     asau     10580: <div class="sect2">
1.75      rillig   10581: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   10582: <a name="regression.fun.override"></a>26.2.1. Overridable functions</h3></div></div></div>
1.218     rillig   10583: <p>These functions do not take any parameters. Although they
                   10584:        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     10585:        first failing command. See <a class="ulink" href="https://stackoverflow.com/q/4072984" target="_top">this Stack Overflow
1.218     rillig   10586:        question</a> for details.</p>
1.148     asau     10587: <div class="variablelist"><dl class="variablelist">
1.218     rillig   10588: <dt><span class="term"><code class="varname">do_setup</code></span></dt>
1.75      rillig   10589: <dd><p>This function prepares the environment for the
                   10590:        test. By default it does nothing.</p></dd>
1.218     rillig   10591: <dt><span class="term"><code class="varname">do_test</code></span></dt>
                   10592: <dd>
                   10593: <p>This function runs the actual test. By default,
1.75      rillig   10594:        it calls <code class="varname">TEST_MAKE</code> with the arguments
                   10595:        <code class="varname">MAKEARGS_TEST</code> and writes its output including
                   10596:        error messages into the file
1.218     rillig   10597:        <code class="varname">TEST_OUTFILE</code>.</p>
                   10598: <p>When defining this function, make sure that all output that
                   10599:        needs to be checked is written to the correct output file.
                   10600:        Example:</p>
                   10601: <pre class="programlisting">
                   10602: do_test() {
1.223     rillig   10603:         echo "Example output"
1.218     rillig   10604: } 1&gt;$TEST_OUTFILE 2&gt;&amp;1
                   10605: </pre>
                   10606: </dd>
                   10607: <dt><span class="term"><code class="varname">check_result</code></span></dt>
                   10608: <dd>
                   10609: <p>This function is run after the test and is
1.75      rillig   10610:        typically used to compare the actual output from the one that is
                   10611:        expected. It can make use of the various helper functions from
1.218     rillig   10612:        the next section. Example:</p>
                   10613: <pre class="programlisting">
                   10614: check_result() {
1.223     rillig   10615:         exit_status 0
                   10616:         output_require "Example"
                   10617:         output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
                   10618:         output_prohibit "no such file or directory"
1.283     rillig   10619:         regress_fail "expected $expected but got $actual for input $input"
1.218     rillig   10620: }
                   10621: </pre>
                   10622: </dd>
                   10623: <dt><span class="term"><code class="varname">do_cleanup</code></span></dt>
1.75      rillig   10624: <dd><p>This function cleans everything up after the
                   10625:        test has been run. By default it does nothing.</p></dd>
                   10626: </dl></div>
                   10627: </div>
1.148     asau     10628: <div class="sect2">
1.75      rillig   10629: <div class="titlepage"><div><div><h3 class="title">
1.299     rillig   10630: <a name="regression.fun.helper"></a>26.2.2. Helper functions</h3></div></div></div>
1.148     asau     10631: <div class="variablelist"><dl class="variablelist">
1.283     rillig   10632: <dt><span class="term"><code class="varname">regress_fail <em class="replaceable"><code>message...</code></em></code></span></dt>
                   10633: <dd><p>This function makes the test fail with the given error message.</p></dd>
1.218     rillig   10634: <dt><span class="term"><code class="varname">exit_status expected</code></span></dt>
1.75      rillig   10635: <dd><p>This function compares the exitcode of the
1.218     rillig   10636:        <span class="command"><strong>do_test</strong></span> function with its first parameter.
1.75      rillig   10637:        If they differ, the test will fail.</p></dd>
1.218     rillig   10638: <dt><span class="term"><code class="varname">output_require regex...</code></span></dt>
                   10639: <dd>
                   10640: <p>This function checks for each of its parameters
                   10641:        if the output from <span class="command"><strong>do_test</strong></span> matches the
1.75      rillig   10642:        extended regular expression. If it does not, the test will
1.218     rillig   10643:        fail. Example:</p>
                   10644: <pre class="programlisting">
1.219     rillig   10645: output_require "looks fine"
                   10646: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
1.218     rillig   10647: </pre>
                   10648: </dd>
1.292     leot     10649: <dt><span class="term"><code class="varname">output_prohibit regex...</code></span></dt>
1.75      rillig   10650: <dd><p>This function checks for each of its parameters
1.110     hubertf  10651:        if the output from <span class="command"><strong>do_test()</strong></span> does
1.75      rillig   10652:        <span class="emphasis"><em>not</em></span> match the extended regular expression.
                   10653:        If any of the regular expressions matches, the test will
                   10654:        fail.</p></dd>
                   10655: </dl></div>
                   10656: </div>
                   10657: </div>
                   10658: </div>
1.148     asau     10659: <div class="chapter">
1.75      rillig   10660: <div class="titlepage"><div><div><h2 class="title">
1.299     rillig   10661: <a name="porting"></a>Chapter 27. Porting pkgsrc</h2></div></div></div>
1.75      rillig   10662: <div class="toc">
                   10663: <p><b>Table of Contents</b></p>
1.299     rillig   10664: <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   10665: </div>
                   10666: <p>The pkgsrc system has already been ported to many
                   10667:        operating systems, hardware architectures and compilers. This
                   10668:        chapter explains the necessary steps to make pkgsrc even more
                   10669:        portable.</p>
1.148     asau     10670: <div class="sect1">
1.75      rillig   10671: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.299     rillig   10672: <a name="porting.opsys"></a>27.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.75      rillig   10673: <p>To port pkgsrc to a new operating system (called
                   10674:        <code class="literal">MyOS</code> in this example), you need to touch the
                   10675:        following files:</p>
1.148     asau     10676: <div class="variablelist"><dl class="variablelist">
1.93      rillig   10677: <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   10678: <dd><p>This file contains some basic definitions, for
                   10679:        example the name of the C
                   10680:        compiler.</p></dd>
1.76      rillig   10681: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
1.75      rillig   10682: <dd><p>Insert code that defines the variables
                   10683:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
                   10684:        <code class="varname">LOWER_OS_VERSION</code>,
                   10685:        <code class="varname">LOWER_VENDOR</code>,
                   10686:        <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
                   10687:        <code class="varname">APPEND_ELF</code>, and the other variables that
                   10688:        appear in this file.</p></dd>
1.93      rillig   10689: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75      rillig   10690: <dd><p>This file contains the platform-specific
                   10691:        definitions that are used by pkgsrc. Start by copying one of the
                   10692:        other files and edit it to your
                   10693:        needs.</p></dd>
1.93      rillig   10694: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75      rillig   10695: <dd><p>This file defines the paths to all the tools
                   10696:        that are needed by one or the other package in pkgsrc, as well
                   10697:        as by pkgsrc itself. Find out where these tools are on your
                   10698:        platform and add them.</p></dd>
                   10699: </dl></div>
                   10700: <p>Now, you should be able to build some basic packages, like
1.250     leot     10701:        <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   10702: </div>
                   10703: </div>
                   10704: </div>
1.148     asau     10705: <div class="appendix">
                   10706: <div class="titlepage"><div><div><h1 class="title">
                   10707: <a name="examples"></a>Appendix A. A simple example package: bison</h1></div></div></div>
1.75      rillig   10708: <div class="toc">
                   10709: <p><b>Table of Contents</b></p>
1.210     leot     10710: <dl class="toc">
1.75      rillig   10711: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
                   10712: <dd><dl>
                   10713: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
                   10714: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
                   10715: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.287     rillig   10716: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with pkglint</a></span></dt>
1.75      rillig   10717: </dl></dd>
                   10718: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
                   10719: </dl>
                   10720: </div>
                   10721: <p>We checked to find a piece of software that wasn't in the packages
                   10722:     collection, and picked GNU bison. Quite why someone would want to have
1.110     hubertf  10723:     <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.75      rillig   10724:     present in the tree is beyond us, but it's useful for the purposes of
                   10725:     this exercise.</p>
1.148     asau     10726: <div class="sect1">
1.75      rillig   10727: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10728: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.148     asau     10729: <div class="sect2">
1.75      rillig   10730: <div class="titlepage"><div><div><h3 class="title">
                   10731: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
                   10732: <pre class="programlisting">
1.100     rillig   10733: # $NetBSD$
                   10734: #
1.1       grant    10735: 
1.100     rillig   10736: DISTNAME=       bison-1.25
                   10737: CATEGORIES=     devel
1.286     rillig   10738: MASTER_SITES=   ${MASTER_SITE_GNU:=bison/}
1.1       grant    10739: 
1.136     dholland 10740: MAINTAINER=     pkgsrc-users@NetBSD.org
1.289     leot     10741: HOMEPAGE=       https://www.gnu.org/software/bison/bison.html
1.100     rillig   10742: COMMENT=        GNU yacc clone
1.1       grant    10743: 
1.100     rillig   10744: GNU_CONFIGURE=  yes
1.152     wiz      10745: INFO_FILES=     yes
1.1       grant    10746: 
1.100     rillig   10747: .include "../../mk/bsd.pkg.mk"
1.1       grant    10748: </pre>
1.75      rillig   10749: </div>
1.148     asau     10750: <div class="sect2">
1.75      rillig   10751: <div class="titlepage"><div><div><h3 class="title">
                   10752: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
                   10753: <pre class="programlisting">
1.100     rillig   10754: GNU version of yacc.  Can make re-entrant parsers, and numerous other
1.311     leot     10755: improvements.  Why you would want this when Berkeley <a class="citerefentry" href="https://man.NetBSD.org/NetBSD-9.1/i386/yacc.1"><span class="citerefentry"><span class="refentrytitle">yacc</span>(1)</span></a> is part
1.100     rillig   10756: of the NetBSD source tree is beyond me.
1.1       grant    10757: </pre>
1.75      rillig   10758: </div>
1.148     asau     10759: <div class="sect2">
1.75      rillig   10760: <div class="titlepage"><div><div><h3 class="title">
                   10761: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
                   10762: <pre class="programlisting">
1.100     rillig   10763: @comment $NetBSD$
                   10764: bin/bison
                   10765: man/man1/bison.1.gz
                   10766: share/bison.simple
                   10767: share/bison.hairy
1.1       grant    10768: </pre>
1.75      rillig   10769: </div>
1.148     asau     10770: <div class="sect2">
1.75      rillig   10771: <div class="titlepage"><div><div><h3 class="title">
1.287     rillig   10772: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with pkglint</h3></div></div></div>
1.75      rillig   10773: <p>The NetBSD package system comes with
1.250     leot     10774:         <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   10775:        which helps to check the contents of these
                   10776:        files. After installation it is quite easy to use, just change to the
1.286     rillig   10777:        directory of the package you wish to examine and run
1.110     hubertf  10778:        <span class="command"><strong>pkglint</strong></span>:</p>
1.75      rillig   10779: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
1.286     rillig   10780: ERROR: Makefile: Each package must define its LICENSE.
                   10781: WARN: Makefile:9: HOMEPAGE should migrate from http to https.
                   10782: NOTE: PLIST:3: The .gz extension is unnecessary for manual pages.
                   10783: WARN: PLIST:5: "share/bison.hairy" should be sorted before "share/bison.simple".
                   10784: 1 error, 2 warnings and 1 note found.
                   10785: (Run "pkglint -e" to show explanations.)
                   10786: (Run "pkglint -fs" to show what can be fixed automatically.)
1.287     rillig   10787: (Run "pkglint -F" to automatically fix some issues.)</pre>
1.75      rillig   10788: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.285     rillig   10789:        more checks will be performed. Use e.g. <span class="command"><strong>pkglint
1.75      rillig   10790:        -Wall</strong></span> for a very thorough check.</p>
                   10791: </div>
                   10792: </div>
1.148     asau     10793: <div class="sect1">
1.75      rillig   10794: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10795: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
                   10796: <p>Create the directory where the package lives,
                   10797:       plus any auxiliary directories:</p>
                   10798: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
                   10799: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
                   10800: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
                   10801: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
1.76      rillig   10802: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.299     rillig   10803:       <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   10804:       then continue with fetching the distfile:</p>
                   10805: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
1.1       grant    10806: &gt;&gt; bison-1.25.tar.gz doesn't seem to exist on this system.
                   10807: &gt;&gt; Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
                   10808: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   10809: ftp: Error retrieving file: 500 Internal error
                   10810: 
                   10811: &gt;&gt; Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
                   10812: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   10813: ftp: Error retrieving file: 500 Internal error
                   10814: 
                   10815: &gt;&gt; Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
                   10816: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
1.75      rillig   10817: Successfully retrieved file.</pre>
                   10818: <p>Generate the checksum of the distfile into
1.76      rillig   10819:       <code class="filename">distinfo</code>:</p>
1.88      wiz      10820: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
1.75      rillig   10821: <p>Now compile:</p>
                   10822: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1       grant    10823: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10824: ===&gt;  Extracting for bison-1.25
                   10825: ===&gt;  Patching for bison-1.25
                   10826: ===&gt;   Ignoring empty patch directory
                   10827: ===&gt;  Configuring for bison-1.25
                   10828: creating cache ./config.cache
                   10829: checking for gcc... cc
                   10830: checking whether we are using GNU C... yes
                   10831: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
                   10832: checking how to run the C preprocessor... cc -E
                   10833: checking for minix/config.h... no
                   10834: checking for POSIXized ISC... no
                   10835: checking whether cross-compiling... no
                   10836: checking for ANSI C header files... yes
                   10837: checking for string.h... yes
                   10838: checking for stdlib.h... yes
                   10839: checking for memory.h... yes
                   10840: checking for working const... yes
                   10841: checking for working alloca.h... no
                   10842: checking for alloca... yes
                   10843: checking for strerror... yes
                   10844: updating cache ./config.cache
                   10845: creating ./config.status
                   10846: creating Makefile
                   10847: ===&gt;  Building for bison-1.25
                   10848: 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
                   10849: 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
                   10850: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g closure.c
                   10851: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g conflicts.c
                   10852: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g derives.c
1.68      rillig   10853: 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    10854: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g getargs.c
                   10855: 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
                   10856: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g lalr.c
                   10857: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g lex.c
                   10858: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g main.c
                   10859: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g nullable.c
                   10860: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g output.c
                   10861: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g print.c
                   10862: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g reader.c
                   10863: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g reduce.c
                   10864: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g symtab.c
                   10865: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g warshall.c
                   10866: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g version.c
                   10867: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g getopt.c
                   10868: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g getopt1.c
                   10869: 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
                   10870: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
                   10871: rm -f bison.s1
1.75      rillig   10872: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" &lt; ./bison.simple &gt; bison.s1</pre>
                   10873: <p>Everything seems OK, so install the files:</p>
                   10874: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1       grant    10875: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10876: ===&gt;  Installing for bison-1.25
                   10877: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share  /usr/pkg/info /usr/pkg/man/man1
                   10878: rm -f /usr/pkg/bin/bison
                   10879: cd /usr/pkg/share; rm -f bison.simple bison.hairy
                   10880: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
                   10881: install -c  -o bin -g bin -m 555 bison /usr/pkg/bin/bison
                   10882: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
                   10883: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
                   10884: cd .; for f in bison.info*;  do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
                   10885: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
1.75      rillig   10886: ===&gt;  Registering installation for bison-1.25</pre>
                   10887: <p>You can now use bison, and also - if you decide so - remove it with
1.110     hubertf  10888:       <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.75      rillig   10889:       binary package, do this now:</p>
                   10890: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1       grant    10891: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10892: ===&gt;  Building package for bison-1.25
                   10893: Creating package bison-1.25.tgz
                   10894: Registering depends:.
1.75      rillig   10895: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
                   10896: <p>Now that you don't need the source and object files
                   10897:       any more, clean up:</p>
                   10898: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
                   10899: ===&gt;  Cleaning for bison-1.25</pre>
                   10900: </div>
                   10901: </div>
1.148     asau     10902: <div class="appendix">
                   10903: <div class="titlepage"><div><div><h1 class="title">
                   10904: <a name="logs"></a>Appendix B. Build logs</h1></div></div></div>
1.75      rillig   10905: <div class="toc">
                   10906: <p><b>Table of Contents</b></p>
1.210     leot     10907: <dl class="toc">
1.75      rillig   10908: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
                   10909: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
                   10910: </dl>
                   10911: </div>
1.148     asau     10912: <div class="sect1">
1.75      rillig   10913: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10914: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
                   10915: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1       grant    10916: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10917: =&gt; figlet221.tar.gz doesn't seem to exist on this system.
                   10918: =&gt; Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
                   10919: =&gt; [172219 bytes]
                   10920: Connected to ftp.plig.net.
                   10921: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
                   10922: 331 Guest login ok, send your complete e-mail address as password.
                   10923: 230-You are user #5 of 500 simultaneous users allowed.
                   10924: 230-
1.68      rillig   10925: 230-  ___ _             _ _
                   10926: 230- |  _| |_ ___   ___| |_|___   ___ ___ ___
1.1       grant    10927: 230- |  _|  _| . |_| . | | | . |_| . |  _| . |
                   10928: 230- |_| |_| |  _|_|  _|_|_|_  |_|___|_| |_  |
                   10929: 230-         |_|   |_|     |___|         |___|
                   10930: 230-
                   10931: 230-** Welcome to ftp.plig.org **
                   10932: 230-
                   10933: 230-Please note that all transfers from this FTP site are logged. If you
                   10934: 230-do not like this, please disconnect now.
                   10935: 230-
1.120     snj      10936: 230-This archive is available via
1.1       grant    10937: 230-
                   10938: 230-HTTP:  http://ftp.plig.org/
                   10939: 230-FTP:   ftp://ftp.plig.org/     (max 500 connections)
                   10940: 230-RSYNC: rsync://ftp.plig.org/   (max  30 connections)
                   10941: 230-
                   10942: 230-Please email comments, bug reports and requests for packages to be
1.68      rillig   10943: 230-mirrored to ftp-admin@plig.org.
1.1       grant    10944: 230-
                   10945: 230-
                   10946: 230 Logged in anonymously.
                   10947: Remote system type is UNIX.
                   10948: Using binary mode to transfer files.
                   10949: 200 Type okay.
                   10950: 250 "/pub" is new cwd.
                   10951: 250-"/pub/figlet" is new cwd.
                   10952: 250-
                   10953: 250-Welcome to the figlet archive at ftp.figlet.org
1.68      rillig   10954: 250-
1.75      rillig   10955: 250-   ftp://ftp.figlet.org/pub/figlet/
1.1       grant    10956: 250-
                   10957: 250-The official FIGlet web page is:
1.75      rillig   10958: 250-   http://www.figlet.org/
1.1       grant    10959: 250-
                   10960: 250-If you have questions, please mailto:info@figlet.org. If you want to
                   10961: 250-contribute a font or something else, you can email us.
1.68      rillig   10962: 250
1.1       grant    10963: 250 "/pub/figlet/program" is new cwd.
                   10964: 250 "/pub/figlet/program/unix" is new cwd.
                   10965: local: figlet221.tar.gz remote: figlet221.tar.gz
                   10966: 502 Unimplemented command.
                   10967: 227 Entering Passive Mode (195,40,6,41,246,104)
                   10968: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
                   10969: 38% |**************                       | 65800      64.16 KB/s    00:01 ETA
                   10970: 226 Transfer completed.
                   10971: 172219 bytes received in 00:02 (75.99 KB/s)
                   10972: 221 Goodbye.
                   10973: =&gt; Checksum OK for figlet221.tar.gz.
                   10974: ===&gt; Extracting for figlet-2.2.1nb2
                   10975: ===&gt; Required installed package ccache-[0-9]*: ccache-2.3nb1 found
                   10976: ===&gt; Patching for figlet-2.2.1nb2
                   10977: ===&gt; Applying pkgsrc patches for figlet-2.2.1nb2
                   10978: ===&gt; Overriding tools for figlet-2.2.1nb2
                   10979: ===&gt; Creating toolchain wrappers for figlet-2.2.1nb2
                   10980: ===&gt; Configuring for figlet-2.2.1nb2
                   10981: ===&gt; Building for figlet-2.2.1nb2
                   10982: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\"  -DDEFAULTFONTFILE=\"standard.flf\"  figlet.c zipio.c crc.c inflate.c -o figlet
                   10983: chmod a+x figlet
                   10984: gcc -O2 -o chkfont chkfont.c
                   10985: =&gt; Unwrapping files-to-be-installed.
1.14      xtraeme  10986: <code class="prompt">#</code>
1.75      rillig   10987: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1       grant    10988: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10989: ===&gt; Installing for figlet-2.2.1nb2
                   10990: install -d -o root -g wheel -m 755 /usr/pkg/bin
                   10991: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
                   10992: mkdir -p /usr/pkg/share/figlet
                   10993: cp figlet /usr/pkg/bin
                   10994: cp chkfont /usr/pkg/bin
                   10995: chmod 555 figlist showfigfonts
                   10996: cp figlist /usr/pkg/bin
                   10997: cp showfigfonts /usr/pkg/bin
                   10998: cp fonts/*.flf /usr/pkg/share/figlet
                   10999: cp fonts/*.flc /usr/pkg/share/figlet
                   11000: cp figlet.6 /usr/pkg/man/man6
                   11001: ===&gt; Registering installation for figlet-2.2.1nb2
1.75      rillig   11002: <code class="prompt">#</code></pre>
                   11003: </div>
1.148     asau     11004: <div class="sect1">
1.75      rillig   11005: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   11006: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
                   11007: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1       grant    11008: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   11009: ===&gt; Packaging figlet-2.2.1nb2
                   11010: ===&gt; Building binary package for figlet-2.2.1nb2
                   11011: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
                   11012: Using SrcDir value of /usr/pkg
1.68      rillig   11013: Registering depends:.
1.75      rillig   11014: <code class="prompt">#</code></pre>
                   11015: </div>
                   11016: </div>
1.148     asau     11017: <div class="appendix">
                   11018: <div class="titlepage"><div><div><h1 class="title">
                   11019: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h1></div></div></div>
1.76      rillig   11020: <div class="toc">
                   11021: <p><b>Table of Contents</b></p>
1.210     leot     11022: <dl class="toc">
1.128     wiz      11023: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
                   11024: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
                   11025: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
                   11026: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
                   11027: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
1.261     leot     11028: <code class="filename">stable</code>,
1.128     wiz      11029: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76      rillig   11030: source packages</a></span></dt>
                   11031: </dl>
                   11032: </div>
                   11033: <p>As in other big projects, the directory layout of pkgsrc
                   11034:        is quite complex for newbies. This chapter explains where you
                   11035:        find things on the FTP server. The base directory on
1.110     hubertf  11036:        <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   11037:        On other servers it may be different, but inside this directory,
                   11038:        everything should look the same, no matter on which server you
                   11039:        are. This directory contains some subdirectories, which are
                   11040:        explained below.</p>
1.148     asau     11041: <div class="sect1">
1.76      rillig   11042: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126     jakllsch 11043: <a name="ftp-distfiles"></a>C.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
1.76      rillig   11044: <p>The directory <code class="filename">distfiles</code> contains lots
                   11045:        of archive files from all pkgsrc packages, which are mirrored
                   11046:        here. The subdirectories are called after their package names
                   11047:        and are used when the distributed files have names that don't
                   11048:        explicitly contain a version number or are otherwise too generic
                   11049:        (for example <code class="filename">release.tar.gz</code>).</p>
                   11050: </div>
1.148     asau     11051: <div class="sect1">
1.76      rillig   11052: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126     jakllsch 11053: <a name="ftp-misc"></a>C.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
1.76      rillig   11054: <p>This directory contains things that individual pkgsrc
                   11055:        developers find worth publishing.</p>
                   11056: </div>
1.148     asau     11057: <div class="sect1">
1.76      rillig   11058: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126     jakllsch 11059: <a name="ftp-packages"></a>C.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
1.102     rillig   11060: <p>This directory contains binary packages for the various
                   11061:        platforms that are supported by pkgsrc.
                   11062:        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     11063: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      11064: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
1.109     rillig   11065:        operating system for which the packages have been built. The
1.110     hubertf  11066:        name is taken from the output of the <span class="command"><strong>uname</strong></span>
1.109     rillig   11067:        command, so it may differ from the one you are used to
                   11068:        hear.</p></li>
1.128     wiz      11069: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
1.108     rillig   11070:        architecture of the platform for which the packages have been
1.110     hubertf  11071:        built. It also includes the <code class="varname">ABI</code> (Application
                   11072:        Binary Interface) for platforms that have several of
                   11073:        them.</p></li>
1.128     wiz      11074: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
1.108     rillig   11075:        the operating system. For version numbers that change often (for
                   11076:        example NetBSD-current), the often-changing part should be
                   11077:        replaced with an <code class="literal">x</code>, for example
                   11078:        <code class="literal">4.99.x</code>.</p></li>
1.128     wiz      11079: <li class="listitem"><p><code class="varname">TAG</code> is either
1.126     jakllsch 11080:        <code class="literal">20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
1.108     rillig   11081:        for a stable branch, or <code class="literal">head</code> for packages
                   11082:        built from the HEAD branch. The latter should only be used when
                   11083:        the packages are updated on a regular basis. Otherwise the date
                   11084:        from checking out pkgsrc should be appended, for example
                   11085:        <code class="literal">head_20071015</code>.</p></li>
1.102     rillig   11086: </ul></div>
                   11087: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
                   11088:        can quickly click through the directories on the
                   11089:        server and find the best binary packages for their machines. Since they
                   11090:        usually know the operating system and the hardware architecture, OPSYS
                   11091:        and ARCH are placed first. After these choices, they can select the
                   11092:        best combination of OSVERSION and TAG together, since it is usually the
                   11093:        case that packages stay compatible between different version of the
                   11094:        operating system.</p>
                   11095: <p>In each of these directories, there is a
                   11096:        whole binary packages collection for a specific platform. It has a directory called
1.76      rillig   11097:        <code class="filename">All</code> which contains all binary packages.
                   11098:        Besides that, there are various category directories that
                   11099:        contain symbolic links to the real binary packages.</p>
                   11100: </div>
1.148     asau     11101: <div class="sect1">
1.76      rillig   11102: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126     jakllsch 11103: <a name="ftp-reports"></a>C.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.108     rillig   11104: <p>Here are the reports from bulk builds, for those who want
                   11105:        to fix packages that didn't build on some of the platforms. The
1.128     wiz      11106:        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   11107: </div>
1.148     asau     11108: <div class="sect1">
1.108     rillig   11109: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126     jakllsch 11110: <a name="ftp-source"></a>C.5. <code class="filename">current</code>,
1.261     leot     11111: <code class="filename">stable</code>,
1.126     jakllsch 11112: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76      rillig   11113: source packages</h2></div></div></div>
1.128     wiz      11114: <p>These directories contain the <span class="quote">&#8220;<span class="quote">real</span>&#8221;</span> pkgsrc,
1.76      rillig   11115:        that is the files that define how to create binary packages from
                   11116:        source archives.</p>
1.262     leot     11117: <p>Each of the <code class="filename">current</code>,
                   11118:        <code class="filename">stable</code> and
                   11119:        <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
                   11120:        directories share the same structure.  They each contain a
                   11121:        <code class="filename">pkgsrc</code> directory and
                   11122:        <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> file.</p>
1.76      rillig   11123: <p>The directory <code class="filename">pkgsrc</code> contains a
1.89      rillig   11124:        snapshot of the CVS repository, which is updated regularly. The
1.262     leot     11125:        file <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> contains the same
                   11126:        as the directory, ready to be downloaded as a whole.</p>
                   11127: <p>The <code class="filename">current</code> directory contains files
                   11128:        related to the HEAD branch of the CVS repository.
                   11129:        In this directory there is an additional file called
                   11130:        <code class="filename">pkgsrc-readmes.tar.{bz,gz,xz}</code> that contains
                   11131:        all pkgsrc <code class="filename">README</code>s with information about
                   11132:        categories and packages.
                   11133:        </p>
                   11134: <p>The <code class="filename">stable</code> directory is a symlink to
                   11135:        the latest 
                   11136:        <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
                   11137:        </p>
                   11138: <p>The
                   11139:        <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
                   11140:        directories contain files related to the 
                   11141:        <code class="filename">-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
                   11142:        stable branch of the CVS repository. In these directories there is
                   11143:        an additional file called
                   11144:        <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   11145:        which contains the state of pkgsrc when it was branched.</p>
                   11146: </div>
1.75      rillig   11147: </div>
1.148     asau     11148: <div class="appendix">
                   11149: <div class="titlepage"><div><div><h1 class="title">
1.267     rillig   11150: <a name="help-topics"></a>Appendix D. Help topics</h1></div></div></div>
                   11151: <p>
                   11152:        The following list contains all help topics that are available
                   11153:        when running <span class="command"><strong>bmake help topic=:index</strong></span>.
                   11154: </p>
1.269     leot     11155: <table border="0" summary="Simple list" class="simplelist">
                   11156: <tr>
                   11157: <td>#!</td>
                   11158: <td>-lintl</td>
                   11159: </tr>
                   11160: <tr>
                   11161: <td>64bit</td>
                   11162: <td>ABI</td>
                   11163: </tr>
                   11164: <tr>
                   11165: <td>ACCEPTABLE_LICENSES</td>
                   11166: <td>ACROREAD_FONTPATH</td>
                   11167: </tr>
                   11168: <tr>
                   11169: <td>ADDITIONAL</td>
                   11170: <td>AFAIK</td>
                   11171: </tr>
                   11172: <tr>
                   11173: <td>AIX</td>
                   11174: <td>ALLOW_VULNERABLE_PACKAGES</td>
                   11175: </tr>
                   11176: <tr>
                   11177: <td>ALL_ENV</td>
1.311     leot     11178: <td>ALSA_PC</td>
                   11179: </tr>
                   11180: <tr>
1.310     jnemeth  11181: <td>ALTERNATIVES_SRC</td>
1.311     leot     11182: <td>AMANDA_TMP</td>
1.292     leot     11183: </tr>
                   11184: <tr>
1.310     jnemeth  11185: <td>AMANDA_USER</td>
1.311     leot     11186: <td>AMANDA_VAR</td>
1.274     rillig   11187: </tr>
                   11188: <tr>
1.310     jnemeth  11189: <td>APACHE_GROUP</td>
1.311     leot     11190: <td>APACHE_MODULE_NAME</td>
1.269     leot     11191: </tr>
                   11192: <tr>
1.310     jnemeth  11193: <td>APACHE_MODULE_SRC</td>
1.311     leot     11194: <td>APACHE_MODULE_SRCDIR</td>
1.269     leot     11195: </tr>
                   11196: <tr>
1.310     jnemeth  11197: <td>APACHE_PKG_PREFIX</td>
1.311     leot     11198: <td>APACHE_SUEXEC_CONFIGURE_ARGS</td>
1.269     leot     11199: </tr>
                   11200: <tr>
1.310     jnemeth  11201: <td>APACHE_SUEXEC_DOCROOT</td>
1.311     leot     11202: <td>APACHE_USER</td>
1.269     leot     11203: </tr>
                   11204: <tr>
1.310     jnemeth  11205: <td>APPEND_ABI</td>
1.311     leot     11206: <td>APPEND_ELF</td>
1.269     leot     11207: </tr>
                   11208: <tr>
1.310     jnemeth  11209: <td>ARLA_CACHE</td>
1.311     leot     11210: <td>AUDIT_PACKAGES_FLAGS</td>
1.269     leot     11211: </tr>
                   11212: <tr>
1.310     jnemeth  11213: <td>AUTOCONF_REQD</td>
1.311     leot     11214: <td>AUTOMAKE_OVERRIDE</td>
1.269     leot     11215: </tr>
                   11216: <tr>
1.310     jnemeth  11217: <td>AUTOMAKE_REQD</td>
1.311     leot     11218: <td>AUTO_MKDIRS</td>
1.269     leot     11219: </tr>
                   11220: <tr>
1.310     jnemeth  11221: <td>BDB185_DEFAULT</td>
1.311     leot     11222: <td>BDBBASE</td>
1.269     leot     11223: </tr>
                   11224: <tr>
1.310     jnemeth  11225: <td>BDB_ACCEPTED</td>
1.311     leot     11226: <td>BDB_DEFAULT</td>
1.269     leot     11227: </tr>
                   11228: <tr>
1.310     jnemeth  11229: <td>BDB_LIBS</td>
1.311     leot     11230: <td>BDB_TYPE</td>
1.269     leot     11231: </tr>
                   11232: <tr>
1.312   ! gdt      11233: <td>BINCIMAP_GROUP</td>
        !          11234: <td>BINCIMAP_USER</td>
        !          11235: </tr>
        !          11236: <tr>
1.310     jnemeth  11237: <td>BIND_DIR</td>
1.311     leot     11238: <td>BIND_GROUP</td>
1.269     leot     11239: </tr>
                   11240: <tr>
1.310     jnemeth  11241: <td>BIND_USER</td>
1.311     leot     11242: <td>BINOWN</td>
1.269     leot     11243: </tr>
                   11244: <tr>
1.310     jnemeth  11245: <td>BINPKG_SITES</td>
1.311     leot     11246: <td>BIN_INSTALL_FLAGS</td>
1.303     bacon    11247: </tr>
                   11248: <tr>
1.310     jnemeth  11249: <td>BISON_PKGDATADIR</td>
1.311     leot     11250: <td>BLAS_ACCEPTED</td>
1.269     leot     11251: </tr>
                   11252: <tr>
1.310     jnemeth  11253: <td>BLAS_LIBS</td>
1.311     leot     11254: <td>BLAS_TYPE</td>
1.292     leot     11255: </tr>
                   11256: <tr>
1.310     jnemeth  11257: <td>BOOTSTRAP_DEPENDS</td>
1.311     leot     11258: <td>BOOTSTRAP_SETUPTOOLS</td>
1.269     leot     11259: </tr>
                   11260: <tr>
1.310     jnemeth  11261: <td>BROKEN</td>
1.311     leot     11262: <td>BROKEN_EXCEPT_ON_PLATFORM</td>
1.269     leot     11263: </tr>
                   11264: <tr>
1.310     jnemeth  11265: <td>BROKEN_ON_PLATFORM</td>
1.311     leot     11266: <td>BSDSRCDIR</td>
1.269     leot     11267: </tr>
                   11268: <tr>
1.310     jnemeth  11269: <td>BSDXSRCDIR</td>
1.311     leot     11270: <td>BSD_MAKE_ENV</td>
1.269     leot     11271: </tr>
                   11272: <tr>
1.310     jnemeth  11273: <td>BUILDLINK_AUTO_DIRS</td>
1.311     leot     11274: <td>BUILDLINK_AUTO_VARS</td>
1.269     leot     11275: </tr>
                   11276: <tr>
1.310     jnemeth  11277: <td>BUILDLINK_CFLAGS</td>
1.311     leot     11278: <td>BUILDLINK_CONTENTS_FILTER</td>
1.269     leot     11279: </tr>
                   11280: <tr>
                   11281: <td>BUILDLINK_CPPFLAGS</td>
1.311     leot     11282: <td>BUILDLINK_DEPMETHOD</td>
1.269     leot     11283: </tr>
                   11284: <tr>
                   11285: <td>BUILDLINK_FILES</td>
1.303     bacon    11286: <td>BUILDLINK_FILES_CMD</td>
1.269     leot     11287: </tr>
                   11288: <tr>
                   11289: <td>BUILDLINK_FNAME_TRANSFORM</td>
1.303     bacon    11290: <td>BUILDLINK_LDFLAGS</td>
1.269     leot     11291: </tr>
                   11292: <tr>
                   11293: <td>BUILDLINK_LIBS</td>
1.303     bacon    11294: <td>BUILDLINK_OPSYS_SUPPORT_PTHREAD</td>
1.269     leot     11295: </tr>
                   11296: <tr>
                   11297: <td>BUILDLINK_PKGNAME</td>
1.303     bacon    11298: <td>BUILDLINK_PREFIX</td>
1.269     leot     11299: </tr>
                   11300: <tr>
                   11301: <td>BUILDLINK_RPATHDIRS</td>
1.303     bacon    11302: <td>BUILDLINK_TREE</td>
1.269     leot     11303: </tr>
                   11304: <tr>
                   11305: <td>BUILD_DEFS</td>
1.303     bacon    11306: <td>BUILD_DEFS_EFFECTS</td>
1.269     leot     11307: </tr>
                   11308: <tr>
                   11309: <td>BUILD_DEPENDS</td>
1.303     bacon    11310: <td>BUILD_DIRS</td>
1.269     leot     11311: </tr>
                   11312: <tr>
                   11313: <td>BUILD_ENV_SHELL</td>
1.303     bacon    11314: <td>BUILD_MAKE_CMD</td>
1.269     leot     11315: </tr>
                   11316: <tr>
                   11317: <td>BUILD_MAKE_FLAGS</td>
1.303     bacon    11318: <td>BUILD_TARGET</td>
1.269     leot     11319: </tr>
                   11320: <tr>
                   11321: <td>BUILTIN_FIND_FILES</td>
1.303     bacon    11322: <td>BUILTIN_FIND_FILES_VAR</td>
1.269     leot     11323: </tr>
                   11324: <tr>
                   11325: <td>BUILTIN_FIND_GREP</td>
1.303     bacon    11326: <td>BUILTIN_FIND_HEADERS</td>
1.269     leot     11327: </tr>
                   11328: <tr>
                   11329: <td>BUILTIN_FIND_HEADERS_VAR</td>
1.309     gutterid 11330: <td>BUILTIN_FIND_PKGCONFIG</td>
                   11331: </tr>
                   11332: <tr>
                   11333: <td>BUILTIN_FIND_PKGCONFIG_VAR</td>
1.303     bacon    11334: <td>BUILTIN_PKG</td>
1.269     leot     11335: </tr>
                   11336: <tr>
                   11337: <td>BUILTIN_TEST_CURSES_DEFINES</td>
1.303     bacon    11338: <td>BUILTIN_TEST_CURSES_FUNCS</td>
1.269     leot     11339: </tr>
                   11340: <tr>
                   11341: <td>BUILTIN_VERSION_SCRIPT</td>
1.303     bacon    11342: <td>BUILTIN_X11_TYPE</td>
1.269     leot     11343: </tr>
                   11344: <tr>
                   11345: <td>BUILTIN_X11_VERSION</td>
1.303     bacon    11346: <td>CACTI_GROUP</td>
1.269     leot     11347: </tr>
                   11348: <tr>
                   11349: <td>CACTI_USER</td>
1.303     bacon    11350: <td>CANNA_GROUP</td>
1.269     leot     11351: </tr>
                   11352: <tr>
                   11353: <td>CANNA_USER</td>
1.303     bacon    11354: <td>CAT</td>
1.269     leot     11355: </tr>
                   11356: <tr>
                   11357: <td>CCACHE_BASE</td>
1.303     bacon    11358: <td>CCACHE_DIR</td>
1.269     leot     11359: </tr>
                   11360: <tr>
                   11361: <td>CCACHE_LOGFILE</td>
1.303     bacon    11362: <td>CC_VERSION</td>
1.269     leot     11363: </tr>
                   11364: <tr>
                   11365: <td>CC_VERSION_STRING</td>
1.303     bacon    11366: <td>CDRECORD_CONF</td>
1.269     leot     11367: </tr>
                   11368: <tr>
                   11369: <td>CDROM_PKG_URL_DIR</td>
1.303     bacon    11370: <td>CDROM_PKG_URL_HOST</td>
1.269     leot     11371: </tr>
                   11372: <tr>
1.311     leot     11373: <td>CHECKOUT_DATE</td>
1.303     bacon    11374: <td>CHECK_COMPILER</td>
1.311     leot     11375: </tr>
                   11376: <tr>
1.310     jnemeth  11377: <td>CHECK_FAKEHOME</td>
1.311     leot     11378: <td>CHECK_FILES</td>
1.292     leot     11379: </tr>
                   11380: <tr>
1.310     jnemeth  11381: <td>CHECK_FILES_SKIP</td>
1.311     leot     11382: <td>CHECK_FILES_STRICT</td>
1.274     rillig   11383: </tr>
                   11384: <tr>
1.310     jnemeth  11385: <td>CHECK_HEADERS</td>
1.311     leot     11386: <td>CHECK_HEADERS_SKIP</td>
1.269     leot     11387: </tr>
                   11388: <tr>
1.310     jnemeth  11389: <td>CHECK_INTERPRETER</td>
1.311     leot     11390: <td>CHECK_INTERPRETER_SKIP</td>
1.269     leot     11391: </tr>
                   11392: <tr>
1.310     jnemeth  11393: <td>CHECK_PERMS</td>
1.311     leot     11394: <td>CHECK_PERMS_AUTOFIX</td>
1.269     leot     11395: </tr>
                   11396: <tr>
1.310     jnemeth  11397: <td>CHECK_PERMS_SKIP</td>
1.311     leot     11398: <td>CHECK_PORTABILITY</td>
1.269     leot     11399: </tr>
                   11400: <tr>
1.310     jnemeth  11401: <td>CHECK_PORTABILITY_EXPERIMENTAL</td>
1.311     leot     11402: <td>CHECK_PORTABILITY_SKIP</td>
1.269     leot     11403: </tr>
                   11404: <tr>
1.310     jnemeth  11405: <td>CHECK_RELRO</td>
1.311     leot     11406: <td>CHECK_RELRO_SKIP</td>
1.269     leot     11407: </tr>
                   11408: <tr>
1.310     jnemeth  11409: <td>CHECK_RELRO_SUPPORTED</td>
1.311     leot     11410: <td>CHECK_SHLIBS</td>
1.269     leot     11411: </tr>
                   11412: <tr>
1.310     jnemeth  11413: <td>CHECK_SHLIBS_BLACKLIST</td>
1.311     leot     11414: <td>CHECK_SHLIBS_SKIP</td>
1.269     leot     11415: </tr>
                   11416: <tr>
1.310     jnemeth  11417: <td>CHECK_SHLIBS_SUPPORTED</td>
1.311     leot     11418: <td>CHECK_SSP</td>
1.269     leot     11419: </tr>
                   11420: <tr>
1.310     jnemeth  11421: <td>CHECK_SSP_SKIP</td>
1.311     leot     11422: <td>CHECK_SSP_SUPPORTED</td>
1.269     leot     11423: </tr>
                   11424: <tr>
1.310     jnemeth  11425: <td>CHECK_STRIPPED</td>
1.311     leot     11426: <td>CHECK_STRIPPED_SKIP</td>
1.269     leot     11427: </tr>
                   11428: <tr>
1.310     jnemeth  11429: <td>CHECK_WRKREF</td>
1.311     leot     11430: <td>CHECK_WRKREF_EXTRA_DIRS</td>
1.269     leot     11431: </tr>
                   11432: <tr>
1.310     jnemeth  11433: <td>CHECK_WRKREF_SKIP</td>
1.311     leot     11434: <td>CLAMAV_DBDIR</td>
1.269     leot     11435: </tr>
                   11436: <tr>
1.310     jnemeth  11437: <td>CLAMAV_GROUP</td>
1.311     leot     11438: <td>CLAMAV_USER</td>
1.269     leot     11439: </tr>
                   11440: <tr>
1.310     jnemeth  11441: <td>CLANGBASE</td>
1.311     leot     11442: <td>CLEANDEPENDS</td>
1.269     leot     11443: </tr>
                   11444: <tr>
1.310     jnemeth  11445: <td>CMAKE_DEPENDENCIES_REWRITE</td>
1.311     leot     11446: <td>CMAKE_INSTALL_NAME_DIR</td>
1.269     leot     11447: </tr>
                   11448: <tr>
1.310     jnemeth  11449: <td>CMAKE_INSTALL_PREFIX</td>
1.311     leot     11450: <td>CMAKE_MODULE_PATH_OVERRIDE</td>
1.269     leot     11451: </tr>
                   11452: <tr>
1.310     jnemeth  11453: <td>CMAKE_PKGSRC_BUILD_FLAGS</td>
1.311     leot     11454: <td>CMAKE_PREFIX_PATH</td>
1.269     leot     11455: </tr>
                   11456: <tr>
1.305     bacon    11457: <td>CMAKE_USE_GNU_INSTALL_DIRS</td>
1.311     leot     11458: <td>COMMON_LISP_DOCFILES</td>
                   11459: </tr>
                   11460: <tr>
                   11461: <td>COMMON_LISP_EXAMPLES</td>
                   11462: <td>COMMON_LISP_EXTRAFILES</td>
                   11463: </tr>
                   11464: <tr>
                   11465: <td>COMMON_LISP_PACKAGES</td>
                   11466: <td>COMMON_LISP_SYSTEM</td>
1.292     leot     11467: </tr>
                   11468: <tr>
1.305     bacon    11469: <td>COMPILER_RPATH_FLAG</td>
1.269     leot     11470: <td>COMPILER_USE_SYMLINKS</td>
                   11471: </tr>
                   11472: <tr>
1.305     bacon    11473: <td>CONFIGURE_ARGS</td>
1.269     leot     11474: <td>CONFIGURE_DIRS</td>
                   11475: </tr>
                   11476: <tr>
1.305     bacon    11477: <td>CONFIGURE_ENV</td>
1.287     rillig   11478: <td>CONFIGURE_ENV_SHELL</td>
1.269     leot     11479: </tr>
                   11480: <tr>
1.305     bacon    11481: <td>CONFIGURE_HAS_INFODIR</td>
1.269     leot     11482: <td>CONFIGURE_HAS_MANDIR</td>
                   11483: </tr>
                   11484: <tr>
1.305     bacon    11485: <td>CONFIGURE_SCRIPT</td>
1.269     leot     11486: <td>CONFIG_SHELL</td>
                   11487: </tr>
                   11488: <tr>
1.305     bacon    11489: <td>CONFIG_SHELL_FLAGS</td>
1.269     leot     11490: <td>CONF_FILES</td>
                   11491: </tr>
                   11492: <tr>
1.305     bacon    11493: <td>CONF_FILES_MODE</td>
1.269     leot     11494: <td>CONF_FILES_PERMS</td>
                   11495: </tr>
                   11496: <tr>
1.305     bacon    11497: <td>CONSERVER_DEFAULTHOST</td>
1.269     leot     11498: <td>CONSERVER_DEFAULTPORT</td>
                   11499: </tr>
                   11500: <tr>
1.305     bacon    11501: <td>CP</td>
1.269     leot     11502: <td>CPP</td>
                   11503: </tr>
                   11504: <tr>
1.305     bacon    11505: <td>CPP_PRECOMP_FLAGS</td>
1.269     leot     11506: <td>CREATE_WRKDIR_SYMLINK</td>
                   11507: </tr>
                   11508: <tr>
1.305     bacon    11509: <td>CROSSBASE</td>
1.269     leot     11510: <td>CTFCONVERT</td>
                   11511: </tr>
                   11512: <tr>
1.305     bacon    11513: <td>CTF_FILES_SKIP</td>
1.269     leot     11514: <td>CTF_SUPPORTED</td>
                   11515: </tr>
                   11516: <tr>
1.305     bacon    11517: <td>CTYPE</td>
1.269     leot     11518: <td>CUPS_GROUP</td>
                   11519: </tr>
                   11520: <tr>
1.305     bacon    11521: <td>CUPS_SYSTEM_GROUPS</td>
1.269     leot     11522: <td>CUPS_USER</td>
                   11523: </tr>
                   11524: <tr>
1.305     bacon    11525: <td>CURSES_DEFAULT</td>
1.269     leot     11526: <td>CURSES_TYPE</td>
1.292     leot     11527: </tr>
                   11528: <tr>
1.311     leot     11529: <td>CVS_EXTRACTDIR</td>
                   11530: <td>CVS_MODULE</td>
                   11531: </tr>
                   11532: <tr>
                   11533: <td>CVS_PROJECT</td>
                   11534: <td>CVS_REPOSITORIES</td>
                   11535: </tr>
                   11536: <tr>
                   11537: <td>CVS_ROOT</td>
                   11538: <td>CVS_ROOT_GNU</td>
                   11539: </tr>
                   11540: <tr>
                   11541: <td>CVS_ROOT_NONGNU</td>
                   11542: <td>CVS_ROOT_SOURCEFORGE</td>
                   11543: </tr>
                   11544: <tr>
                   11545: <td>CVS_TAG</td>
1.273     brook    11546: <td>CXX</td>
1.311     leot     11547: </tr>
                   11548: <tr>
1.310     jnemeth  11549: <td>CYRUS_GROUP</td>
1.311     leot     11550: <td>CYRUS_IDLE</td>
1.269     leot     11551: </tr>
                   11552: <tr>
1.310     jnemeth  11553: <td>CYRUS_USER</td>
1.311     leot     11554: <td>DAEMONTOOLS_GROUP</td>
1.269     leot     11555: </tr>
                   11556: <tr>
1.310     jnemeth  11557: <td>DAEMONTOOLS_LOG_USER</td>
1.311     leot     11558: <td>DARWIN_NO_SYSTEM_LIBS</td>
1.269     leot     11559: </tr>
                   11560: <tr>
1.310     jnemeth  11561: <td>DARWIN_REQUIRES_FILTER</td>
1.311     leot     11562: <td>DBUS_GROUP</td>
1.309     gutterid 11563: </tr>
                   11564: <tr>
1.310     jnemeth  11565: <td>DBUS_USER</td>
1.311     leot     11566: <td>DEFANG_GROUP</td>
1.269     leot     11567: </tr>
                   11568: <tr>
1.310     jnemeth  11569: <td>DEFANG_USER</td>
1.311     leot     11570: <td>DEFAULT_ACCEPTABLE_LICENSES</td>
1.269     leot     11571: </tr>
                   11572: <tr>
1.310     jnemeth  11573: <td>DEFAULT_DISTFILES</td>
1.311     leot     11574: <td>DEFAULT_IRC_SERVER</td>
1.269     leot     11575: </tr>
                   11576: <tr>
1.310     jnemeth  11577: <td>DEFAULT_SERIAL_DEVICE</td>
1.311     leot     11578: <td>DEF_UMASK</td>
1.269     leot     11579: </tr>
                   11580: <tr>
1.310     jnemeth  11581: <td>DEINSTALLDEPENDS</td>
1.311     leot     11582: <td>DEINSTALL_SRC</td>
1.269     leot     11583: </tr>
                   11584: <tr>
1.310     jnemeth  11585: <td>DEINSTALL_TEMPLATES</td>
1.311     leot     11586: <td>DELAYED_ERROR_MSG</td>
1.269     leot     11587: </tr>
                   11588: <tr>
1.310     jnemeth  11589: <td>DELAYED_WARNING_MSG</td>
1.311     leot     11590: <td>DEPENDS</td>
1.269     leot     11591: </tr>
                   11592: <tr>
1.310     jnemeth  11593: <td>DEPENDS_TARGET</td>
1.311     leot     11594: <td>DEPENDS_TYPE</td>
1.269     leot     11595: </tr>
                   11596: <tr>
1.310     jnemeth  11597: <td>DESTDIR</td>
1.311     leot     11598: <td>DESTDIR_VARNAME</td>
1.269     leot     11599: </tr>
                   11600: <tr>
1.310     jnemeth  11601: <td>DIALER_GROUP</td>
1.311     leot     11602: <td>DIGEST_REQD</td>
1.269     leot     11603: </tr>
                   11604: <tr>
1.310     jnemeth  11605: <td>DISTDIR</td>
1.311     leot     11606: <td>DISTFILES</td>
1.269     leot     11607: </tr>
                   11608: <tr>
1.310     jnemeth  11609: <td>DISTINFO_FILE</td>
1.311     leot     11610: <td>DISTNAME</td>
1.269     leot     11611: </tr>
                   11612: <tr>
1.310     jnemeth  11613: <td>DIST_PATH</td>
1.311     leot     11614: <td>DIST_SUBDIR</td>
1.269     leot     11615: </tr>
                   11616: <tr>
1.310     jnemeth  11617: <td>DJBDNS_AXFR_USER</td>
1.311     leot     11618: <td>DJBDNS_CACHE_USER</td>
1.269     leot     11619: </tr>
                   11620: <tr>
1.310     jnemeth  11621: <td>DJBDNS_DJBDNS_GROUP</td>
1.311     leot     11622: <td>DJBDNS_LOG_USER</td>
1.269     leot     11623: </tr>
                   11624: <tr>
1.310     jnemeth  11625: <td>DJBDNS_RBL_USER</td>
1.311     leot     11626: <td>DJBDNS_TINY_USER</td>
1.269     leot     11627: </tr>
                   11628: <tr>
1.310     jnemeth  11629: <td>DLOPEN_REQUIRE_PTHREADS</td>
1.311     leot     11630: <td>DL_AUTO_VARS</td>
1.269     leot     11631: </tr>
                   11632: <tr>
1.310     jnemeth  11633: <td>DL_CFLAGS</td>
1.311     leot     11634: <td>DL_LDFLAGS</td>
1.269     leot     11635: </tr>
                   11636: <tr>
1.310     jnemeth  11637: <td>DL_LIBS</td>
1.311     leot     11638: <td>DNS</td>
1.269     leot     11639: </tr>
                   11640: <tr>
1.310     jnemeth  11641: <td>DOCOWN</td>
1.311     leot     11642: <td>DOWNLOADED_DISTFILE</td>
1.269     leot     11643: </tr>
                   11644: <tr>
1.310     jnemeth  11645: <td>DT_LAYOUT</td>
1.311     leot     11646: <td>DYNAMIC_SITES_CMD</td>
1.269     leot     11647: </tr>
                   11648: <tr>
1.310     jnemeth  11649: <td>DYNAMIC_SITES_SCRIPT</td>
1.311     leot     11650: <td>ECHO</td>
1.269     leot     11651: </tr>
                   11652: <tr>
1.310     jnemeth  11653: <td>ECHO_N</td>
1.311     leot     11654: <td>ELK_GUI</td>
1.269     leot     11655: </tr>
                   11656: <tr>
1.310     jnemeth  11657: <td>EMACS_TYPE</td>
1.311     leot     11658: <td>EMULDIR</td>
1.269     leot     11659: </tr>
                   11660: <tr>
1.310     jnemeth  11661: <td>EMULSUBDIR</td>
1.311     leot     11662: <td>EMULSUBDIRSLASH</td>
1.269     leot     11663: </tr>
                   11664: <tr>
1.310     jnemeth  11665: <td>EMUL_ARCH</td>
1.311     leot     11666: <td>EMUL_DISTRO</td>
1.269     leot     11667: </tr>
                   11668: <tr>
1.310     jnemeth  11669: <td>EMUL_EXEC_FMT</td>
1.311     leot     11670: <td>EMUL_IS_NATIVE</td>
1.269     leot     11671: </tr>
                   11672: <tr>
1.310     jnemeth  11673: <td>EMUL_MODULES</td>
1.311     leot     11674: <td>EMUL_OPSYS</td>
1.269     leot     11675: </tr>
                   11676: <tr>
1.310     jnemeth  11677: <td>EMUL_PKG_FMT</td>
1.311     leot     11678: <td>EMUL_PLATFORM</td>
1.269     leot     11679: </tr>
                   11680: <tr>
1.310     jnemeth  11681: <td>EMUL_PLATFORMS</td>
1.311     leot     11682: <td>EMUL_PREFER</td>
1.269     leot     11683: </tr>
                   11684: <tr>
1.310     jnemeth  11685: <td>EMUL_REQD</td>
1.311     leot     11686: <td>EMUL_TYPE</td>
1.269     leot     11687: </tr>
                   11688: <tr>
1.310     jnemeth  11689: <td>ERROR_MSG</td>
1.311     leot     11690: <td>EXIM_GROUP</td>
1.269     leot     11691: </tr>
                   11692: <tr>
1.310     jnemeth  11693: <td>EXIM_USER</td>
1.311     leot     11694: <td>EXPORT_SYMBOLS_LDFLAGS</td>
1.269     leot     11695: </tr>
                   11696: <tr>
1.310     jnemeth  11697: <td>EXTRACTOR</td>
1.311     leot     11698: <td>EXTRACT_CMD</td>
1.269     leot     11699: </tr>
                   11700: <tr>
1.310     jnemeth  11701: <td>EXTRACT_CMD_DEFAULT</td>
1.311     leot     11702: <td>EXTRACT_DIR</td>
1.269     leot     11703: </tr>
                   11704: <tr>
1.310     jnemeth  11705: <td>EXTRACT_ELEMENTS</td>
1.311     leot     11706: <td>EXTRACT_ENV</td>
1.269     leot     11707: </tr>
                   11708: <tr>
1.310     jnemeth  11709: <td>EXTRACT_ONLY</td>
1.311     leot     11710: <td>EXTRACT_OPTS</td>
1.269     leot     11711: </tr>
                   11712: <tr>
1.310     jnemeth  11713: <td>EXTRACT_SUFX</td>
1.311     leot     11714: <td>EXTRACT_USING</td>
1.269     leot     11715: </tr>
                   11716: <tr>
1.310     jnemeth  11717: <td>FAIL</td>
1.311     leot     11718: <td>FAILOVER_FETCH</td>
1.292     leot     11719: </tr>
                   11720: <tr>
1.310     jnemeth  11721: <td>FAIL_MSG</td>
1.311     leot     11722: <td>FAKE_NCURSES</td>
1.269     leot     11723: </tr>
                   11724: <tr>
1.310     jnemeth  11725: <td>FAM</td>
1.311     leot     11726: <td>FAM_ACCEPTED</td>
1.269     leot     11727: </tr>
                   11728: <tr>
1.310     jnemeth  11729: <td>FAM_DEFAULT</td>
1.311     leot     11730: <td>FAM_SERVER</td>
1.269     leot     11731: </tr>
                   11732: <tr>
1.310     jnemeth  11733: <td>FCPATH</td>
1.311     leot     11734: <td>FEATURE_CPPFLAGS</td>
1.269     leot     11735: </tr>
                   11736: <tr>
1.310     jnemeth  11737: <td>FEATURE_LDFLAGS</td>
1.311     leot     11738: <td>FEATURE_LIBS</td>
1.269     leot     11739: </tr>
                   11740: <tr>
1.310     jnemeth  11741: <td>FETCH_AFTER_ARGS</td>
1.311     leot     11742: <td>FETCH_BEFORE_ARGS</td>
1.269     leot     11743: </tr>
                   11744: <tr>
1.310     jnemeth  11745: <td>FETCH_CMD</td>
1.311     leot     11746: <td>FETCH_OUTPUT_ARGS</td>
1.269     leot     11747: </tr>
                   11748: <tr>
1.310     jnemeth  11749: <td>FETCH_PROXY</td>
1.311     leot     11750: <td>FETCH_RESUME_ARGS</td>
1.269     leot     11751: </tr>
                   11752: <tr>
1.310     jnemeth  11753: <td>FETCH_TIMEOUT</td>
1.311     leot     11754: <td>FETCH_USE_IPV4_ONLY</td>
1.303     bacon    11755: </tr>
                   11756: <tr>
1.310     jnemeth  11757: <td>FETCH_USING</td>
1.311     leot     11758: <td>FILES_SUBST</td>
1.269     leot     11759: </tr>
                   11760: <tr>
1.310     jnemeth  11761: <td>FILES_SUBST_SED</td>
1.311     leot     11762: <td>FIX_SYSTEM_HEADERS</td>
1.269     leot     11763: </tr>
                   11764: <tr>
1.310     jnemeth  11765: <td>FLUXBOX_USE_GNOME</td>
1.311     leot     11766: <td>FLUXBOX_USE_KDE</td>
1.269     leot     11767: </tr>
                   11768: <tr>
1.310     jnemeth  11769: <td>FLUXBOX_USE_XFT</td>
1.311     leot     11770: <td>FLUXBOX_USE_XINERAMA</td>
1.269     leot     11771: </tr>
                   11772: <tr>
1.311     leot     11773: <td>FONTDIR</td>
1.295     rillig   11774: <td>FONTS_DIRS</td>
1.274     rillig   11775: </tr>
                   11776: <tr>
1.305     bacon    11777: <td>FONTS_VERBOSE</td>
1.295     rillig   11778: <td>FOO_HACKS_MK</td>
1.292     leot     11779: </tr>
                   11780: <tr>
1.311     leot     11781: <td>FOSSIL_EXTRACTDIR</td>
                   11782: <td>FOSSIL_REPO</td>
                   11783: </tr>
                   11784: <tr>
                   11785: <td>FOSSIL_REPOSITORIES</td>
                   11786: <td>FOSSIL_VERSION</td>
                   11787: </tr>
                   11788: <tr>
1.305     bacon    11789: <td>FOX_USE_XUNICODE</td>
1.295     rillig   11790: <td>FREEWNN_GROUP</td>
1.269     leot     11791: </tr>
                   11792: <tr>
1.305     bacon    11793: <td>FREEWNN_USER</td>
1.295     rillig   11794: <td>FTP_PKG_URL_DIR</td>
1.269     leot     11795: </tr>
                   11796: <tr>
1.305     bacon    11797: <td>FTP_PKG_URL_HOST</td>
1.295     rillig   11798: <td>GAMEDATAMODE</td>
1.269     leot     11799: </tr>
                   11800: <tr>
1.305     bacon    11801: <td>GAMEDATA_PERMS</td>
1.295     rillig   11802: <td>GAMEDIRMODE</td>
1.269     leot     11803: </tr>
                   11804: <tr>
1.305     bacon    11805: <td>GAMEDIR_PERMS</td>
1.295     rillig   11806: <td>GAMEGRP</td>
1.269     leot     11807: </tr>
                   11808: <tr>
1.305     bacon    11809: <td>GAMEMODE</td>
1.295     rillig   11810: <td>GAMEOWN</td>
1.269     leot     11811: </tr>
                   11812: <tr>
1.305     bacon    11813: <td>GAMES_GROUP</td>
1.295     rillig   11814: <td>GAMES_USER</td>
1.269     leot     11815: </tr>
                   11816: <tr>
1.305     bacon    11817: <td>GCC</td>
1.295     rillig   11818: <td>GCCBASE</td>
1.269     leot     11819: </tr>
                   11820: <tr>
1.305     bacon    11821: <td>GCC_REQD</td>
1.295     rillig   11822: <td>GCC_VERSION_SUFFIX</td>
1.269     leot     11823: </tr>
                   11824: <tr>
1.305     bacon    11825: <td>GEM_BUILD</td>
1.295     rillig   11826: <td>GEM_CLEANBUILD</td>
1.269     leot     11827: </tr>
                   11828: <tr>
1.305     bacon    11829: <td>GEM_CLEANBUILD_EXTENSIONS</td>
1.295     rillig   11830: <td>GEM_DOCDIR</td>
1.269     leot     11831: </tr>
                   11832: <tr>
1.305     bacon    11833: <td>GEM_EXTSDIR</td>
1.295     rillig   11834: <td>GEM_HOME</td>
1.292     leot     11835: </tr>
                   11836: <tr>
1.305     bacon    11837: <td>GEM_KEEPBUILD</td>
1.295     rillig   11838: <td>GEM_LIBDIR</td>
1.269     leot     11839: </tr>
                   11840: <tr>
1.305     bacon    11841: <td>GEM_NAME</td>
1.295     rillig   11842: <td>GEM_PATH</td>
1.269     leot     11843: </tr>
                   11844: <tr>
1.312   ! gdt      11845: <td>GEM_PLUGINSDIR</td>
1.305     bacon    11846: <td>GEM_SPECFILE</td>
1.269     leot     11847: </tr>
                   11848: <tr>
1.312   ! gdt      11849: <td>GENERATE_PLIST</td>
1.305     bacon    11850: <td>GHOSTSCRIPT_REQD</td>
1.269     leot     11851: </tr>
                   11852: <tr>
1.312   ! gdt      11853: <td>GITHUB_PROJECT</td>
1.305     bacon    11854: <td>GITHUB_RELEASE</td>
1.292     leot     11855: </tr>
                   11856: <tr>
1.312   ! gdt      11857: <td>GITHUB_TAG</td>
1.305     bacon    11858: <td>GITHUB_TYPE</td>
1.311     leot     11859: </tr>
                   11860: <tr>
1.312   ! gdt      11861: <td>GITLAB_PROJECT</td>
1.311     leot     11862: <td>GITLAB_TAG</td>
                   11863: </tr>
                   11864: <tr>
1.312   ! gdt      11865: <td>GITLAB_TYPE</td>
1.311     leot     11866: <td>GIT_BRANCH</td>
                   11867: </tr>
                   11868: <tr>
1.312   ! gdt      11869: <td>GIT_ENV</td>
1.311     leot     11870: <td>GIT_EXTRACTDIR</td>
                   11871: </tr>
                   11872: <tr>
1.312   ! gdt      11873: <td>GIT_REPO</td>
1.311     leot     11874: <td>GIT_REPOSITORIES</td>
                   11875: </tr>
                   11876: <tr>
1.312   ! gdt      11877: <td>GIT_REVISION</td>
1.311     leot     11878: <td>GIT_TAG</td>
1.269     leot     11879: </tr>
                   11880: <tr>
1.312   ! gdt      11881: <td>GNU</td>
1.305     bacon    11882: <td>GNU_CONFIGURE</td>
1.269     leot     11883: </tr>
                   11884: <tr>
1.312   ! gdt      11885: <td>GNU_CONFIGURE_INFODIR</td>
1.305     bacon    11886: <td>GNU_CONFIGURE_MANDIR</td>
1.269     leot     11887: </tr>
                   11888: <tr>
1.312   ! gdt      11889: <td>GNU_CONFIGURE_QUIET</td>
1.305     bacon    11890: <td>GNU_CONFIGURE_STRICT</td>
1.269     leot     11891: </tr>
                   11892: <tr>
1.312   ! gdt      11893: <td>GODEP_REDIRECTS</td>
1.305     bacon    11894: <td>GO_BUILD_PATTERN</td>
1.269     leot     11895: </tr>
                   11896: <tr>
1.312   ! gdt      11897: <td>GO_DEPS</td>
1.305     bacon    11898: <td>GO_DIST_BASE</td>
1.276     leot     11899: </tr>
                   11900: <tr>
1.312   ! gdt      11901: <td>GO_MODULE_FILES</td>
1.305     bacon    11902: <td>GO_SRCPATH</td>
1.269     leot     11903: </tr>
                   11904: <tr>
1.312   ! gdt      11905: <td>GO_VERSION_DEFAULT</td>
1.305     bacon    11906: <td>GROUP_SPECIFIC_PKGS</td>
1.269     leot     11907: </tr>
                   11908: <tr>
1.312   ! gdt      11909: <td>GRUB_NETWORK_CARDS</td>
1.305     bacon    11910: <td>GRUB_PRESET_COMMAND</td>
1.269     leot     11911: </tr>
                   11912: <tr>
1.312   ! gdt      11913: <td>GRUB_SCAN_ARGS</td>
1.305     bacon    11914: <td>GZIP</td>
1.311     leot     11915: </tr>
                   11916: <tr>
1.312   ! gdt      11917: <td>HASKELL_COMPILER</td>
1.310     jnemeth  11918: <td>HASKELL_ENABLE_HADDOCK_DOCUMENTATION</td>
1.269     leot     11919: </tr>
                   11920: <tr>
1.312   ! gdt      11921: <td>HASKELL_ENABLE_LIBRARY_PROFILING</td>
1.310     jnemeth  11922: <td>HASKELL_ENABLE_SHARED_LIBRARY</td>
1.269     leot     11923: </tr>
                   11924: <tr>
1.312   ! gdt      11925: <td>HASKELL_OPTIMIZATION_LEVEL</td>
1.310     jnemeth  11926: <td>HAS_CONFIGURE</td>
1.292     leot     11927: </tr>
                   11928: <tr>
1.312   ! gdt      11929: <td>HEADER_TEMPLATES</td>
1.311     leot     11930: <td>HG_REPO</td>
                   11931: </tr>
                   11932: <tr>
1.312   ! gdt      11933: <td>HG_REPOSITORIES</td>
1.311     leot     11934: <td>HG_TAG</td>
1.269     leot     11935: </tr>
                   11936: <tr>
1.312   ! gdt      11937: <td>HOMEPAGE</td>
1.305     bacon    11938: <td>HOST_PKGTOOLS_ARGS</td>
1.269     leot     11939: </tr>
                   11940: <tr>
1.312   ! gdt      11941: <td>HOST_SPECIFIC_PKGS</td>
1.305     bacon    11942: <td>HOWL_GROUP</td>
1.269     leot     11943: </tr>
                   11944: <tr>
1.312   ! gdt      11945: <td>HOWL_USER</td>
1.305     bacon    11946: <td>ICCBASE</td>
                   11947: </tr>
                   11948: <tr>
1.312   ! gdt      11949: <td>ICECAST_CHROOTDIR</td>
1.295     rillig   11950: <td>ICON_THEMES</td>
1.269     leot     11951: </tr>
                   11952: <tr>
1.312   ! gdt      11953: <td>IDOBASE</td>
1.295     rillig   11954: <td>IGNORE_CCACHE</td>
1.269     leot     11955: </tr>
                   11956: <tr>
1.312   ! gdt      11957: <td>IGNORE_INFO_DIRS</td>
1.295     rillig   11958: <td>IGNORE_INTERACTIVE_FETCH</td>
1.269     leot     11959: </tr>
                   11960: <tr>
1.312   ! gdt      11961: <td>IMAKE</td>
1.295     rillig   11962: <td>IMAKEOPTS</td>
1.269     leot     11963: </tr>
                   11964: <tr>
1.312   ! gdt      11965: <td>IMAKE_MAKE</td>
1.295     rillig   11966: <td>IMAKE_MANINSTALL</td>
1.269     leot     11967: </tr>
                   11968: <tr>
1.312   ! gdt      11969: <td>IMAP_UW_CCLIENT_MBOX_FMT</td>
1.295     rillig   11970: <td>IMDICTDIR</td>
1.269     leot     11971: </tr>
                   11972: <tr>
1.312   ! gdt      11973: <td>INCOMPAT_CURSES</td>
1.295     rillig   11974: <td>INFO_DIR</td>
1.269     leot     11975: </tr>
                   11976: <tr>
1.312   ! gdt      11977: <td>INFO_FILES</td>
1.295     rillig   11978: <td>INFO_FILES_VERBOSE</td>
1.269     leot     11979: </tr>
                   11980: <tr>
1.312   ! gdt      11981: <td>INFO_MSG</td>
1.295     rillig   11982: <td>INIT_SYSTEM</td>
1.269     leot     11983: </tr>
                   11984: <tr>
1.312   ! gdt      11985: <td>INN_DATA_DIR</td>
1.295     rillig   11986: <td>INN_GROUP</td>
1.287     rillig   11987: </tr>
                   11988: <tr>
1.312   ! gdt      11989: <td>INN_USER</td>
1.295     rillig   11990: <td>INSTALLATION_DIRS</td>
1.269     leot     11991: </tr>
                   11992: <tr>
1.312   ! gdt      11993: <td>INSTALLATION_DIRS_FROM_PLIST</td>
1.295     rillig   11994: <td>INSTALL_ENV</td>
1.269     leot     11995: </tr>
                   11996: <tr>
1.312   ! gdt      11997: <td>INSTALL_SH_OVERRIDE</td>
1.295     rillig   11998: <td>INSTALL_SRC</td>
1.269     leot     11999: </tr>
                   12000: <tr>
1.312   ! gdt      12001: <td>INSTALL_TEMPLATES</td>
1.295     rillig   12002: <td>INSTALL_UNSTRIPPED</td>
1.269     leot     12003: </tr>
                   12004: <tr>
1.312   ! gdt      12005: <td>IRCD_HYBRID_IRC_GROUP</td>
1.295     rillig   12006: <td>IRCD_HYBRID_IRC_USER</td>
1.269     leot     12007: </tr>
                   12008: <tr>
1.312   ! gdt      12009: <td>IRCD_HYBRID_MAXCONN</td>
1.295     rillig   12010: <td>IRCD_HYBRID_NICLEN</td>
1.269     leot     12011: </tr>
                   12012: <tr>
1.312   ! gdt      12013: <td>IRCD_HYBRID_SYSLOG_EVENTS</td>
1.295     rillig   12014: <td>IRCD_HYBRID_SYSLOG_FACILITY</td>
1.269     leot     12015: </tr>
                   12016: <tr>
1.312   ! gdt      12017: <td>IRCD_HYBRID_TOPICLEN</td>
1.295     rillig   12018: <td>IRIX</td>
1.269     leot     12019: </tr>
                   12020: <tr>
1.312   ! gdt      12021: <td>IRRD_USE_PGP</td>
1.295     rillig   12022: <td>JABBERD_GROUP</td>
1.269     leot     12023: </tr>
                   12024: <tr>
1.312   ! gdt      12025: <td>JABBERD_LOGDIR</td>
1.295     rillig   12026: <td>JABBERD_PIDDIR</td>
1.269     leot     12027: </tr>
                   12028: <tr>
1.312   ! gdt      12029: <td>JABBERD_SPOOLDIR</td>
1.295     rillig   12030: <td>JABBERD_USER</td>
1.292     leot     12031: </tr>
                   12032: <tr>
1.312   ! gdt      12033: <td>JAKARTA_HOME</td>
1.311     leot     12034: <td>JAVA_APP_PATH</td>
                   12035: </tr>
                   12036: <tr>
1.312   ! gdt      12037: <td>JAVA_APP_TARGETS</td>
1.295     rillig   12038: <td>JAVA_BINPREFIX</td>
1.269     leot     12039: </tr>
                   12040: <tr>
1.312   ! gdt      12041: <td>JAVA_CLASSPATH</td>
1.295     rillig   12042: <td>JAVA_HOME</td>
1.269     leot     12043: </tr>
                   12044: <tr>
1.312   ! gdt      12045: <td>JAVA_LD_LIBRARY_PATH</td>
1.295     rillig   12046: <td>JAVA_NAME</td>
1.269     leot     12047: </tr>
                   12048: <tr>
1.312   ! gdt      12049: <td>JAVA_UNLIMIT</td>
1.295     rillig   12050: <td>JAVA_WRAPPERS</td>
1.269     leot     12051: </tr>
                   12052: <tr>
1.312   ! gdt      12053: <td>JPEG_ACCEPTED</td>
1.295     rillig   12054: <td>JPEG_DEFAULT</td>
1.269     leot     12055: </tr>
                   12056: <tr>
1.312   ! gdt      12057: <td>KERBEROS</td>
1.295     rillig   12058: <td>KERMIT_SUID_UUCP</td>
1.269     leot     12059: </tr>
                   12060: <tr>
1.312   ! gdt      12061: <td>KJS_USE_PCRE</td>
1.295     rillig   12062: <td>KNEWS_DOMAIN_FILE</td>
1.269     leot     12063: </tr>
                   12064: <tr>
1.312   ! gdt      12065: <td>KNEWS_DOMAIN_NAME</td>
1.295     rillig   12066: <td>KRB5_ACCEPTED</td>
1.292     leot     12067: </tr>
                   12068: <tr>
1.312   ! gdt      12069: <td>KRB5_DEFAULT</td>
1.295     rillig   12070: <td>LANGUAGES</td>
1.271     brook    12071: </tr>
                   12072: <tr>
1.312   ! gdt      12073: <td>LAPACK_LIBS</td>
1.295     rillig   12074: <td>LATEX2HTML_ICONPATH</td>
1.269     leot     12075: </tr>
                   12076: <tr>
1.312   ! gdt      12077: <td>LDCONFIG_ADD_CMD</td>
1.295     rillig   12078: <td>LDCONFIG_REMOVE_CMD</td>
1.269     leot     12079: </tr>
                   12080: <tr>
1.312   ! gdt      12081: <td>LEAFNODE_DATA_DIR</td>
1.295     rillig   12082: <td>LEAFNODE_GROUP</td>
1.269     leot     12083: </tr>
                   12084: <tr>
1.312   ! gdt      12085: <td>LEAFNODE_USER</td>
1.295     rillig   12086: <td>LIBDVDCSS_HOMEPAGE</td>
1.269     leot     12087: </tr>
                   12088: <tr>
1.312   ! gdt      12089: <td>LIBDVDCSS_MASTER_SITES</td>
1.295     rillig   12090: <td>LIBRSVG_TYPE</td>
1.270     leot     12091: </tr>
                   12092: <tr>
1.312   ! gdt      12093: <td>LIBTOOL</td>
1.295     rillig   12094: <td>LIBTOOLIZE_PLIST</td>
1.269     leot     12095: </tr>
                   12096: <tr>
1.312   ! gdt      12097: <td>LIBTOOL_M4_OVERRIDE</td>
1.295     rillig   12098: <td>LIBUSB_TYPE</td>
1.292     leot     12099: </tr>
                   12100: <tr>
1.312   ! gdt      12101: <td>LICENSE</td>
1.295     rillig   12102: <td>LINKER_RPATH_FLAG</td>
1.269     leot     12103: </tr>
                   12104: <tr>
1.312   ! gdt      12105: <td>LINK_RPATH_FLAG</td>
1.311     leot     12106: <td>LINUX_BASE_NODEPS</td>
                   12107: </tr>
                   12108: <tr>
1.312   ! gdt      12109: <td>LINUX_BASE_PREFERRED</td>
1.311     leot     12110: <td>LINUX_BASE_REQUIRED</td>
                   12111: </tr>
                   12112: <tr>
1.312   ! gdt      12113: <td>LINUX_LOCALES</td>
1.310     jnemeth  12114: <td>LOCALBASE</td>
1.269     leot     12115: </tr>
                   12116: <tr>
1.312   ! gdt      12117: <td>LOCALBASE_LOCKTYPE</td>
1.310     jnemeth  12118: <td>LOCALPATCHES</td>
1.269     leot     12119: </tr>
                   12120: <tr>
1.312   ! gdt      12121: <td>LOVE_DATA</td>
1.310     jnemeth  12122: <td>LOVE_GAME</td>
1.269     leot     12123: </tr>
                   12124: <tr>
1.312   ! gdt      12125: <td>LOVE_VERSION</td>
1.310     jnemeth  12126: <td>LP64PLATFORMS</td>
1.269     leot     12127: </tr>
                   12128: <tr>
1.312   ! gdt      12129: <td>MACHINE_PLATFORM</td>
1.310     jnemeth  12130: <td>MAILAGENT_DOMAIN</td>
1.269     leot     12131: </tr>
                   12132: <tr>
1.312   ! gdt      12133: <td>MAILAGENT_EMAIL</td>
1.310     jnemeth  12134: <td>MAILAGENT_FQDN</td>
1.269     leot     12135: </tr>
                   12136: <tr>
1.312   ! gdt      12137: <td>MAILAGENT_ORGANIZATION</td>
1.295     rillig   12138: <td>MAJORDOMO_HOMEDIR</td>
1.269     leot     12139: </tr>
                   12140: <tr>
1.312   ! gdt      12141: <td>MAJOR_OS_VERSION</td>
1.295     rillig   12142: <td>MAKEINFO_ARGS</td>
1.269     leot     12143: </tr>
                   12144: <tr>
1.312   ! gdt      12145: <td>MAKE_DIRS</td>
1.295     rillig   12146: <td>MAKE_DIRS_PERMS</td>
1.269     leot     12147: </tr>
                   12148: <tr>
1.312   ! gdt      12149: <td>MAKE_ENV</td>
1.295     rillig   12150: <td>MAKE_FILE</td>
1.269     leot     12151: </tr>
                   12152: <tr>
1.312   ! gdt      12153: <td>MAKE_FLAGS</td>
1.295     rillig   12154: <td>MAKE_JOBS</td>
1.269     leot     12155: </tr>
                   12156: <tr>
1.312   ! gdt      12157: <td>MAKE_JOBS_SAFE</td>
1.295     rillig   12158: <td>MAKE_PROGRAM</td>
1.269     leot     12159: </tr>
                   12160: <tr>
1.312   ! gdt      12161: <td>MANCOMPRESSED_IF_MANZ</td>
1.302     leot     12162: <td>MANINSTALL</td>
1.303     bacon    12163: </tr>
                   12164: <tr>
1.312   ! gdt      12165: <td>MANZ</td>
1.303     bacon    12166: <td>MASTER_SITES</td>
1.269     leot     12167: </tr>
                   12168: <tr>
1.312   ! gdt      12169: <td>MASTER_SITE_BACKUP</td>
1.303     bacon    12170: <td>MASTER_SITE_LOCAL</td>
1.269     leot     12171: </tr>
                   12172: <tr>
1.312   ! gdt      12173: <td>MASTER_SITE_MOZILLA</td>
1.303     bacon    12174: <td>MASTER_SITE_OVERRIDE</td>
1.269     leot     12175: </tr>
                   12176: <tr>
1.312   ! gdt      12177: <td>MASTER_SITE_PERL_CPAN</td>
1.303     bacon    12178: <td>MASTER_SORT</td>
1.269     leot     12179: </tr>
                   12180: <tr>
1.312   ! gdt      12181: <td>MASTER_SORT_RANDOM</td>
1.303     bacon    12182: <td>MASTER_SORT_REGEX</td>
1.269     leot     12183: </tr>
                   12184: <tr>
1.312   ! gdt      12185: <td>MECAB_CHARSET</td>
1.303     bacon    12186: <td>MEDIATOMB_GROUP</td>
1.269     leot     12187: </tr>
                   12188: <tr>
1.312   ! gdt      12189: <td>MEDIATOMB_USER</td>
1.303     bacon    12190: <td>MIPSPROBASE</td>
1.269     leot     12191: </tr>
                   12192: <tr>
1.312   ! gdt      12193: <td>MIREDO_GROUP</td>
1.303     bacon    12194: <td>MIREDO_USER</td>
1.269     leot     12195: </tr>
                   12196: <tr>
1.312   ! gdt      12197: <td>MISSING_FEATURES</td>
1.303     bacon    12198: <td>MKDIR</td>
1.269     leot     12199: </tr>
                   12200: <tr>
1.312   ! gdt      12201: <td>MLDONKEY_GROUP</td>
1.303     bacon    12202: <td>MLDONKEY_HOME</td>
1.269     leot     12203: </tr>
                   12204: <tr>
1.312   ! gdt      12205: <td>MLDONKEY_USER</td>
1.303     bacon    12206: <td>MONOTONE_GROUP</td>
1.269     leot     12207: </tr>
                   12208: <tr>
1.312   ! gdt      12209: <td>MONOTONE_USER</td>
1.303     bacon    12210: <td>MOTIFBASE</td>
1.269     leot     12211: </tr>
                   12212: <tr>
1.312   ! gdt      12213: <td>MOTIF_TYPE</td>
1.303     bacon    12214: <td>MOTIF_TYPE_DEFAULT</td>
1.269     leot     12215: </tr>
                   12216: <tr>
1.312   ! gdt      12217: <td>MPI_TYPE</td>
1.303     bacon    12218: <td>MSGFMT_STRIP_MSGCTXT</td>
1.269     leot     12219: </tr>
                   12220: <tr>
1.312   ! gdt      12221: <td>MSGFMT_STRIP_MSGID_PLURAL</td>
1.303     bacon    12222: <td>MTOOLS_ENABLE_FLOPPYD</td>
1.311     leot     12223: </tr>
                   12224: <tr>
1.312   ! gdt      12225: <td>MUST</td>
1.310     jnemeth  12226: <td>MV</td>
1.269     leot     12227: </tr>
                   12228: <tr>
1.312   ! gdt      12229: <td>MYSQL_CHARSET</td>
1.310     jnemeth  12230: <td>MYSQL_DATADIR</td>
1.269     leot     12231: </tr>
                   12232: <tr>
1.312   ! gdt      12233: <td>MYSQL_EXTRA_CHARSET</td>
1.310     jnemeth  12234: <td>MYSQL_GROUP</td>
1.269     leot     12235: </tr>
                   12236: <tr>
1.312   ! gdt      12237: <td>MYSQL_PKGSRCDIR</td>
1.310     jnemeth  12238: <td>MYSQL_USER</td>
1.269     leot     12239: </tr>
                   12240: <tr>
1.312   ! gdt      12241: <td>MYSQL_VERSION</td>
1.310     jnemeth  12242: <td>MYSQL_VERSIONS_ACCEPTED</td>
1.309     gutterid 12243: </tr>
                   12244: <tr>
1.312   ! gdt      12245: <td>MYSQL_VERSION_DEFAULT</td>
1.310     jnemeth  12246: <td>NAGIOSCMD_GROUP</td>
1.269     leot     12247: </tr>
                   12248: <tr>
1.312   ! gdt      12249: <td>NAGIOSDIR</td>
1.310     jnemeth  12250: <td>NAGIOS_GROUP</td>
1.269     leot     12251: </tr>
                   12252: <tr>
1.312   ! gdt      12253: <td>NAGIOS_USER</td>
1.310     jnemeth  12254: <td>NATIVE_APPEND_ABI</td>
1.269     leot     12255: </tr>
                   12256: <tr>
1.312   ! gdt      12257: <td>NATIVE_APPEND_ELF</td>
1.310     jnemeth  12258: <td>NATIVE_EXEC_FMT</td>
1.269     leot     12259: </tr>
                   12260: <tr>
1.312   ! gdt      12261: <td>NATIVE_MACHINE_PLATFORM</td>
1.310     jnemeth  12262: <td>NATIVE_OBJECT_FMT</td>
1.269     leot     12263: </tr>
                   12264: <tr>
1.312   ! gdt      12265: <td>NBPAX_PROGRAM_PREFIX</td>
1.310     jnemeth  12266: <td>NETBSD_LOGIN_NAME</td>
1.269     leot     12267: </tr>
                   12268: <tr>
1.312   ! gdt      12269: <td>NMH_EDITOR</td>
1.310     jnemeth  12270: <td>NMH_MTA</td>
1.293     rillig   12271: </tr>
                   12272: <tr>
1.312   ! gdt      12273: <td>NMH_PAGER</td>
1.310     jnemeth  12274: <td>NOLOGIN</td>
1.269     leot     12275: </tr>
                   12276: <tr>
1.312   ! gdt      12277: <td>NOTE</td>
1.310     jnemeth  12278: <td>NOT_FOR_PLATFORM</td>
1.269     leot     12279: </tr>
                   12280: <tr>
1.312   ! gdt      12281: <td>NOT_PAX_ASLR_SAFE</td>
1.310     jnemeth  12282: <td>NOT_PAX_MPROTECT_SAFE</td>
1.269     leot     12283: </tr>
                   12284: <tr>
1.312   ! gdt      12285: <td>NO_BUILD</td>
1.310     jnemeth  12286: <td>NO_CHECKSUM</td>
1.269     leot     12287: </tr>
                   12288: <tr>
1.312   ! gdt      12289: <td>NO_CONFIGURE</td>
1.310     jnemeth  12290: <td>NO_SKIP</td>
1.269     leot     12291: </tr>
                   12292: <tr>
1.312   ! gdt      12293: <td>NS_PREFERRED</td>
1.310     jnemeth  12294: <td>NULLMAILER_GROUP</td>
1.269     leot     12295: </tr>
                   12296: <tr>
1.312   ! gdt      12297: <td>NULLMAILER_USER</td>
1.310     jnemeth  12298: <td>OASIS</td>
1.269     leot     12299: </tr>
                   12300: <tr>
1.312   ! gdt      12301: <td>OASIS_BUILD_ARGS</td>
1.310     jnemeth  12302: <td>OBJHOSTNAME</td>
1.269     leot     12303: </tr>
                   12304: <tr>
1.312   ! gdt      12305: <td>OBJMACHINE</td>
1.310     jnemeth  12306: <td>OCAML_FINDLIB_DIRS</td>
1.269     leot     12307: </tr>
                   12308: <tr>
1.312   ! gdt      12309: <td>OCAML_FINDLIB_REGISTER</td>
1.310     jnemeth  12310: <td>OCAML_FINDLIB_REGISTER_VERBOSE</td>
1.269     leot     12311: </tr>
                   12312: <tr>
1.312   ! gdt      12313: <td>OCAML_SITELIBDIR</td>
1.310     jnemeth  12314: <td>OCAML_TOPKG_DOCDIR</td>
1.269     leot     12315: </tr>
                   12316: <tr>
1.312   ! gdt      12317: <td>OCAML_USE_DUNE</td>
1.310     jnemeth  12318: <td>OCAML_USE_FINDLIB</td>
1.269     leot     12319: </tr>
                   12320: <tr>
1.312   ! gdt      12321: <td>OCAML_USE_JBUILDER</td>
1.310     jnemeth  12322: <td>OCAML_USE_OASIS</td>
1.269     leot     12323: </tr>
                   12324: <tr>
1.312   ! gdt      12325: <td>OCAML_USE_OASIS_DYNRUN</td>
1.310     jnemeth  12326: <td>OCAML_USE_OPAM</td>
1.269     leot     12327: </tr>
                   12328: <tr>
1.312   ! gdt      12329: <td>OCAML_USE_OPT_COMPILER</td>
1.310     jnemeth  12330: <td>OCAML_USE_TOPKG</td>
1.269     leot     12331: </tr>
                   12332: <tr>
1.312   ! gdt      12333: <td>OMF</td>
1.310     jnemeth  12334: <td>ONLY_FOR_COMPILER</td>
1.269     leot     12335: </tr>
                   12336: <tr>
1.312   ! gdt      12337: <td>ONLY_FOR_PLATFORM</td>
1.310     jnemeth  12338: <td>OPENSSH_CHROOT</td>
1.269     leot     12339: </tr>
                   12340: <tr>
1.312   ! gdt      12341: <td>OPENSSH_GROUP</td>
1.310     jnemeth  12342: <td>OPENSSH_USER</td>
1.269     leot     12343: </tr>
                   12344: <tr>
1.312   ! gdt      12345: <td>OPSYS</td>
1.310     jnemeth  12346: <td>OPSYS_EMULDIR</td>
1.269     leot     12347: </tr>
                   12348: <tr>
1.312   ! gdt      12349: <td>OS</td>
1.310     jnemeth  12350: <td>OSS_TYPE</td>
1.312   ! gdt      12351: </tr>
        !          12352: <tr>
1.311     leot     12353: <td>OSX</td>
1.312   ! gdt      12354: <td>OSX_TOLERATE_SDK_SKEW</td>
1.269     leot     12355: </tr>
                   12356: <tr>
1.311     leot     12357: <td>OS_HAVE_ALSA</td>
1.312   ! gdt      12358: <td>OS_HAVE_RCD</td>
1.292     leot     12359: </tr>
                   12360: <tr>
1.309     gutterid 12361: <td>OS_VARIANT</td>
1.312   ! gdt      12362: <td>OS_VERSION</td>
1.311     leot     12363: </tr>
                   12364: <tr>
                   12365: <td>OTF_FONTS_DIR</td>
1.312   ! gdt      12366: <td>OVERRIDE_DIRDEPTH</td>
1.269     leot     12367: </tr>
                   12368: <tr>
1.311     leot     12369: <td>OVERRIDE_GEMSPEC</td>
1.312   ! gdt      12370: <td>OVERRIDE_GNU_CONFIG_SCRIPTS</td>
1.269     leot     12371: </tr>
                   12372: <tr>
1.311     leot     12373: <td>OVERRIDE_ROCKSPEC</td>
1.312   ! gdt      12374: <td>OWN_DIRS</td>
1.269     leot     12375: </tr>
                   12376: <tr>
1.309     gutterid 12377: <td>OWN_DIRS_PERMS</td>
1.312   ! gdt      12378: <td>P4GROUP</td>
1.269     leot     12379: </tr>
                   12380: <tr>
1.309     gutterid 12381: <td>P4PORT</td>
1.312   ! gdt      12382: <td>P4ROOT</td>
1.269     leot     12383: </tr>
                   12384: <tr>
1.309     gutterid 12385: <td>P4USER</td>
1.312   ! gdt      12386: <td>PACKAGES</td>
1.269     leot     12387: </tr>
                   12388: <tr>
1.309     gutterid 12389: <td>PALMOS_DEFAULT_SDK</td>
1.312   ! gdt      12390: <td>PAMBASE</td>
1.269     leot     12391: </tr>
                   12392: <tr>
1.309     gutterid 12393: <td>PAM_DEFAULT</td>
1.312   ! gdt      12394: <td>PAPERSIZE</td>
1.269     leot     12395: </tr>
                   12396: <tr>
1.309     gutterid 12397: <td>PASSIVE_FETCH</td>
1.312   ! gdt      12398: <td>PATCHDIR</td>
1.269     leot     12399: </tr>
                   12400: <tr>
1.309     gutterid 12401: <td>PATCHFILES</td>
1.312   ! gdt      12402: <td>PATCH_ARGS</td>
1.269     leot     12403: </tr>
                   12404: <tr>
1.309     gutterid 12405: <td>PATCH_DEBUG</td>
1.312   ! gdt      12406: <td>PATCH_DIST_ARGS</td>
1.269     leot     12407: </tr>
                   12408: <tr>
1.309     gutterid 12409: <td>PATCH_DIST_CAT</td>
1.312   ! gdt      12410: <td>PATCH_DIST_STRIP</td>
1.284     rillig   12411: </tr>
                   12412: <tr>
1.309     gutterid 12413: <td>PATCH_FUZZ_FACTOR</td>
1.312   ! gdt      12414: <td>PATCH_STRIP</td>
1.269     leot     12415: </tr>
                   12416: <tr>
1.309     gutterid 12417: <td>PATH</td>
1.312   ! gdt      12418: <td>PCCBASE</td>
1.269     leot     12419: </tr>
                   12420: <tr>
1.311     leot     12421: <td>PEAR</td>
1.312   ! gdt      12422: <td>PEAR_CHANNEL</td>
1.311     leot     12423: </tr>
                   12424: <tr>
                   12425: <td>PEAR_CHANNEL_ALIAS</td>
1.312   ! gdt      12426: <td>PEAR_CHANNEL_VERSION</td>
1.311     leot     12427: </tr>
                   12428: <tr>
1.309     gutterid 12429: <td>PEAR_CMD</td>
1.312   ! gdt      12430: <td>PEAR_LIB</td>
1.292     leot     12431: </tr>
                   12432: <tr>
1.309     gutterid 12433: <td>PEAR_PACKAGE_XML</td>
1.312   ! gdt      12434: <td>PERL5</td>
1.274     rillig   12435: </tr>
                   12436: <tr>
1.309     gutterid 12437: <td>PERL5_CONFIGURE</td>
1.312   ! gdt      12438: <td>PERL5_CONFIGURE_DIRS</td>
1.274     rillig   12439: </tr>
                   12440: <tr>
1.309     gutterid 12441: <td>PERL5_LDFLAGS</td>
1.312   ! gdt      12442: <td>PERL5_LICENSE</td>
1.269     leot     12443: </tr>
                   12444: <tr>
1.309     gutterid 12445: <td>PERL5_MODULE_TYPE</td>
1.312   ! gdt      12446: <td>PERL5_PACKLIST</td>
1.269     leot     12447: </tr>
                   12448: <tr>
1.309     gutterid 12449: <td>PERL5_PACKLIST_DIR</td>
1.312   ! gdt      12450: <td>PERL5_PERLBASE</td>
1.269     leot     12451: </tr>
                   12452: <tr>
1.309     gutterid 12453: <td>PERL5_SITEBASE</td>
1.312   ! gdt      12454: <td>PERL5_USE_PACKLIST</td>
1.269     leot     12455: </tr>
                   12456: <tr>
1.309     gutterid 12457: <td>PERL5_VENDORBASE</td>
1.312   ! gdt      12458: <td>PFCTL</td>
1.269     leot     12459: </tr>
                   12460: <tr>
1.309     gutterid 12461: <td>PFVAR_H</td>
1.312   ! gdt      12462: <td>PF_VERSION</td>
1.269     leot     12463: </tr>
                   12464: <tr>
1.309     gutterid 12465: <td>PGGROUP</td>
1.312   ! gdt      12466: <td>PGHOME</td>
1.269     leot     12467: </tr>
                   12468: <tr>
1.309     gutterid 12469: <td>PGPKGSRCDIR</td>
1.312   ! gdt      12470: <td>PGSQL_TYPE</td>
1.269     leot     12471: </tr>
                   12472: <tr>
1.309     gutterid 12473: <td>PGSQL_VERSION</td>
1.312   ! gdt      12474: <td>PGSQL_VERSIONS_ACCEPTED</td>
1.269     leot     12475: </tr>
                   12476: <tr>
1.305     bacon    12477: <td>PGSQL_VERSION_DEFAULT</td>
1.312   ! gdt      12478: <td>PGUSER</td>
1.269     leot     12479: </tr>
                   12480: <tr>
1.305     bacon    12481: <td>PG_LIB_EXT</td>
1.312   ! gdt      12482: <td>PHP</td>
1.269     leot     12483: </tr>
                   12484: <tr>
1.305     bacon    12485: <td>PHPCOMMON_MK</td>
1.312   ! gdt      12486: <td>PHPPKGSRCDIR</td>
1.269     leot     12487: </tr>
                   12488: <tr>
1.305     bacon    12489: <td>PHP_BASE_VERS</td>
1.312   ! gdt      12490: <td>PHP_CHECK_INSTALLED</td>
1.269     leot     12491: </tr>
                   12492: <tr>
1.305     bacon    12493: <td>PHP_EXTENSION_DIR</td>
1.312   ! gdt      12494: <td>PHP_INITIAL_TEENY</td>
1.269     leot     12495: </tr>
                   12496: <tr>
1.305     bacon    12497: <td>PHP_PKG_PREFIX</td>
1.312   ! gdt      12498: <td>PHP_VERSION</td>
1.269     leot     12499: </tr>
                   12500: <tr>
1.305     bacon    12501: <td>PHP_VERSIONS_ACCEPTED</td>
1.312   ! gdt      12502: <td>PHP_VERSIONS_INCOMPATIBLE</td>
1.269     leot     12503: </tr>
                   12504: <tr>
1.305     bacon    12505: <td>PHP_VERSION_DEFAULT</td>
1.312   ! gdt      12506: <td>PHP_VERSION_REQD</td>
1.269     leot     12507: </tr>
                   12508: <tr>
1.305     bacon    12509: <td>PILRC_USE_GTK</td>
1.312   ! gdt      12510: <td>PKGCONFIG_BASE</td>
1.269     leot     12511: </tr>
                   12512: <tr>
1.305     bacon    12513: <td>PKGCONFIG_FILE</td>
1.312   ! gdt      12514: <td>PKGCONFIG_OVERRIDE</td>
1.269     leot     12515: </tr>
                   12516: <tr>
1.305     bacon    12517: <td>PKGCONFIG_OVERRIDE_STAGE</td>
1.312   ! gdt      12518: <td>PKGDIR</td>
1.269     leot     12519: </tr>
                   12520: <tr>
1.305     bacon    12521: <td>PKGGNUDIR</td>
1.312   ! gdt      12522: <td>PKGINFODIR</td>
1.269     leot     12523: </tr>
                   12524: <tr>
1.305     bacon    12525: <td>PKGLOCALEDIR</td>
1.312   ! gdt      12526: <td>PKGMANDIR</td>
1.269     leot     12527: </tr>
                   12528: <tr>
1.305     bacon    12529: <td>PKGNAME</td>
1.312   ! gdt      12530: <td>PKGNAME_REQD</td>
1.269     leot     12531: </tr>
                   12532: <tr>
1.305     bacon    12533: <td>PKGPATH</td>
1.312   ! gdt      12534: <td>PKGREVISION</td>
1.269     leot     12535: </tr>
                   12536: <tr>
1.305     bacon    12537: <td>PKGSRC_BLAS_TYPES</td>
1.312   ! gdt      12538: <td>PKGSRC_CHANGES</td>
1.292     leot     12539: </tr>
                   12540: <tr>
1.305     bacon    12541: <td>PKGSRC_COMPILER</td>
1.312   ! gdt      12542: <td>PKGSRC_KEEP_BIN_PKGS</td>
1.269     leot     12543: </tr>
                   12544: <tr>
1.305     bacon    12545: <td>PKGSRC_LOCKTYPE</td>
1.312   ! gdt      12546: <td>PKGSRC_MAKE_ENV</td>
1.274     rillig   12547: </tr>
                   12548: <tr>
1.305     bacon    12549: <td>PKGSRC_MESSAGE_RECIPIENTS</td>
1.312   ! gdt      12550: <td>PKGSRC_MKPIE</td>
1.269     leot     12551: </tr>
                   12552: <tr>
1.305     bacon    12553: <td>PKGSRC_MKREPRO</td>
1.312   ! gdt      12554: <td>PKGSRC_RUN_TEST</td>
1.269     leot     12555: </tr>
                   12556: <tr>
1.305     bacon    12557: <td>PKGSRC_SETENV</td>
1.312   ! gdt      12558: <td>PKGSRC_SLEEPSECS</td>
1.269     leot     12559: </tr>
                   12560: <tr>
1.305     bacon    12561: <td>PKGSRC_TODO</td>
1.312   ! gdt      12562: <td>PKGSRC_USE_CTF</td>
1.269     leot     12563: </tr>
                   12564: <tr>
1.305     bacon    12565: <td>PKGSRC_USE_FORTIFY</td>
1.312   ! gdt      12566: <td>PKGSRC_USE_RELRO</td>
1.269     leot     12567: </tr>
                   12568: <tr>
1.305     bacon    12569: <td>PKGSRC_USE_SSP</td>
1.312   ! gdt      12570: <td>PKGSRC_USE_STACK_CHECK</td>
1.269     leot     12571: </tr>
                   12572: <tr>
1.305     bacon    12573: <td>PKGTASKS_DATAFILE</td>
1.312   ! gdt      12574: <td>PKGTOOLS_ARGS</td>
1.269     leot     12575: </tr>
                   12576: <tr>
1.305     bacon    12577: <td>PKGTOOLS_ENV</td>
1.312   ! gdt      12578: <td>PKG_ALTERNATIVES</td>
1.269     leot     12579: </tr>
                   12580: <tr>
1.305     bacon    12581: <td>PKG_APACHE</td>
1.312   ! gdt      12582: <td>PKG_APACHE_ACCEPTED</td>
1.269     leot     12583: </tr>
                   12584: <tr>
1.305     bacon    12585: <td>PKG_APACHE_DEFAULT</td>
1.312   ! gdt      12586: <td>PKG_BEST_EXISTS</td>
1.269     leot     12587: </tr>
                   12588: <tr>
1.305     bacon    12589: <td>PKG_BUILD_OPTIONS</td>
1.312   ! gdt      12590: <td>PKG_COMPRESSION</td>
1.269     leot     12591: </tr>
                   12592: <tr>
1.305     bacon    12593: <td>PKG_CONFIG</td>
1.312   ! gdt      12594: <td>PKG_CONFIG_PERMS</td>
1.269     leot     12595: </tr>
                   12596: <tr>
1.305     bacon    12597: <td>PKG_CREATE_USERGROUP</td>
1.312   ! gdt      12598: <td>PKG_DB_TMPDIR</td>
1.269     leot     12599: </tr>
                   12600: <tr>
1.305     bacon    12601: <td>PKG_DEBUG_LEVEL</td>
1.312   ! gdt      12602: <td>PKG_DEFAULT_OPTIONS</td>
1.269     leot     12603: </tr>
                   12604: <tr>
1.305     bacon    12605: <td>PKG_DESTDIR_SUPPORT</td>
1.312   ! gdt      12606: <td>PKG_DEVELOPER</td>
1.269     leot     12607: </tr>
                   12608: <tr>
1.305     bacon    12609: <td>PKG_DISABLED_OPTIONS</td>
1.312   ! gdt      12610: <td>PKG_FATAL_ERRORS</td>
1.269     leot     12611: </tr>
                   12612: <tr>
1.305     bacon    12613: <td>PKG_FC</td>
1.312   ! gdt      12614: <td>PKG_FILELIST_CMD</td>
1.269     leot     12615: </tr>
                   12616: <tr>
1.305     bacon    12617: <td>PKG_GECOS</td>
1.312   ! gdt      12618: <td>PKG_GID</td>
1.269     leot     12619: </tr>
                   12620: <tr>
1.305     bacon    12621: <td>PKG_GROUPS</td>
1.312   ! gdt      12622: <td>PKG_GROUPS_VARS</td>
1.269     leot     12623: </tr>
                   12624: <tr>
1.305     bacon    12625: <td>PKG_HOME</td>
1.312   ! gdt      12626: <td>PKG_INIT_SCRIPTS</td>
1.269     leot     12627: </tr>
                   12628: <tr>
1.305     bacon    12629: <td>PKG_JAVA_HOME</td>
1.312   ! gdt      12630: <td>PKG_JVM</td>
1.269     leot     12631: </tr>
                   12632: <tr>
1.305     bacon    12633: <td>PKG_JVMS_ACCEPTED</td>
1.312   ! gdt      12634: <td>PKG_JVM_DEFAULT</td>
1.269     leot     12635: </tr>
                   12636: <tr>
1.305     bacon    12637: <td>PKG_LEGACY_OPTIONS</td>
1.312   ! gdt      12638: <td>PKG_LIBTOOL</td>
1.269     leot     12639: </tr>
                   12640: <tr>
1.305     bacon    12641: <td>PKG_OPTIONS</td>
1.312   ! gdt      12642: <td>PKG_OPTIONS_DEPRECATED_WARNINGS</td>
1.269     leot     12643: </tr>
                   12644: <tr>
1.305     bacon    12645: <td>PKG_OPTIONS_LEGACY_OPTS</td>
1.312   ! gdt      12646: <td>PKG_OPTIONS_LEGACY_VARS</td>
1.269     leot     12647: </tr>
                   12648: <tr>
1.305     bacon    12649: <td>PKG_OPTIONS_NONEMPTY_SETS</td>
1.312   ! gdt      12650: <td>PKG_OPTIONS_OPTIONAL_GROUPS</td>
1.269     leot     12651: </tr>
                   12652: <tr>
1.305     bacon    12653: <td>PKG_OPTIONS_REQUIRED_GROUPS</td>
1.312   ! gdt      12654: <td>PKG_OPTIONS_VAR</td>
1.269     leot     12655: </tr>
                   12656: <tr>
1.305     bacon    12657: <td>PKG_PHP</td>
1.312   ! gdt      12658: <td>PKG_PHP_MAJOR_VERS</td>
1.269     leot     12659: </tr>
                   12660: <tr>
1.305     bacon    12661: <td>PKG_PHP_VERSION</td>
1.312   ! gdt      12662: <td>PKG_RCD_SCRIPTS</td>
1.269     leot     12663: </tr>
                   12664: <tr>
1.305     bacon    12665: <td>PKG_REFCOUNT_DBDIR</td>
1.312   ! gdt      12666: <td>PKG_REGISTER_SHELLS</td>
1.269     leot     12667: </tr>
                   12668: <tr>
1.305     bacon    12669: <td>PKG_RESUME_TRANSFERS</td>
1.312   ! gdt      12670: <td>PKG_SHELL</td>
1.269     leot     12671: </tr>
                   12672: <tr>
1.305     bacon    12673: <td>PKG_SUGGESTED_OPTIONS</td>
1.312   ! gdt      12674: <td>PKG_SUPPORTED_OPTIONS</td>
1.269     leot     12675: </tr>
                   12676: <tr>
1.305     bacon    12677: <td>PKG_SYSCONFBASE</td>
1.312   ! gdt      12678: <td>PKG_SYSCONFBASEDIR</td>
1.269     leot     12679: </tr>
                   12680: <tr>
1.305     bacon    12681: <td>PKG_SYSCONFDIR</td>
1.312   ! gdt      12682: <td>PKG_SYSCONFDIR_PERMS</td>
1.269     leot     12683: </tr>
                   12684: <tr>
1.305     bacon    12685: <td>PKG_SYSCONFSUBDIR</td>
1.312   ! gdt      12686: <td>PKG_SYSCONFVAR</td>
1.269     leot     12687: </tr>
                   12688: <tr>
1.305     bacon    12689: <td>PKG_TOOLS_BIN</td>
1.312   ! gdt      12690: <td>PKG_UID</td>
1.269     leot     12691: </tr>
                   12692: <tr>
1.305     bacon    12693: <td>PKG_UPDATE_FONTS_DB</td>
1.312   ! gdt      12694: <td>PKG_USERS</td>
1.269     leot     12695: </tr>
                   12696: <tr>
1.305     bacon    12697: <td>PKG_USERS_VARS</td>
1.312   ! gdt      12698: <td>PKG_VERBOSE</td>
1.269     leot     12699: </tr>
                   12700: <tr>
1.305     bacon    12701: <td>PLIST</td>
1.312   ! gdt      12702: <td>PLIST_AWK</td>
1.269     leot     12703: </tr>
                   12704: <tr>
1.305     bacon    12705: <td>PLIST_AWK_ENV</td>
1.312   ! gdt      12706: <td>PLIST_SRC</td>
1.269     leot     12707: </tr>
                   12708: <tr>
1.305     bacon    12709: <td>PLIST_SUBST</td>
1.312   ! gdt      12710: <td>PLIST_TYPE</td>
1.269     leot     12711: </tr>
                   12712: <tr>
1.305     bacon    12713: <td>PLIST_VARS</td>
1.312   ! gdt      12714: <td>POPTOP_USE_MPPE</td>
1.269     leot     12715: </tr>
                   12716: <tr>
1.305     bacon    12717: <td>POSSIBLE_GFORTRAN_VERSION</td>
1.312   ! gdt      12718: <td>POST_FETCH_HOOK</td>
1.269     leot     12719: </tr>
                   12720: <tr>
1.305     bacon    12721: <td>PREFER</td>
1.312   ! gdt      12722: <td>PREFER_NATIVE</td>
1.269     leot     12723: </tr>
                   12724: <tr>
1.305     bacon    12725: <td>PREFER_NATIVE_PTHREADS</td>
1.312   ! gdt      12726: <td>PREFER_PKGSRC</td>
1.269     leot     12727: </tr>
                   12728: <tr>
1.305     bacon    12729: <td>PREFIX</td>
1.312   ! gdt      12730: <td>PREPEND_PATH</td>
1.269     leot     12731: </tr>
                   12732: <tr>
1.305     bacon    12733: <td>PRE_ROOT_CMD</td>
1.312   ! gdt      12734: <td>PRIVILEGED_STAGES</td>
1.269     leot     12735: </tr>
                   12736: <tr>
1.305     bacon    12737: <td>PS</td>
1.312   ! gdt      12738: <td>PTHREAD_AUTO_VARS</td>
1.269     leot     12739: </tr>
                   12740: <tr>
1.305     bacon    12741: <td>PTHREAD_CFLAGS</td>
1.312   ! gdt      12742: <td>PTHREAD_LDFLAGS</td>
1.269     leot     12743: </tr>
                   12744: <tr>
1.305     bacon    12745: <td>PTHREAD_LIBS</td>
1.312   ! gdt      12746: <td>PTHREAD_OPTS</td>
1.269     leot     12747: </tr>
                   12748: <tr>
1.305     bacon    12749: <td>PTHREAD_TYPE</td>
1.312   ! gdt      12750: <td>PVM_SSH</td>
1.269     leot     12751: </tr>
                   12752: <tr>
1.305     bacon    12753: <td>PYPKGPREFIX</td>
1.312   ! gdt      12754: <td>PYTHON_FOR_BUILD_ONLY</td>
1.269     leot     12755: </tr>
                   12756: <tr>
1.305     bacon    12757: <td>PYTHON_SELF_CONFLICT</td>
1.312   ! gdt      12758: <td>PYTHON_VERSIONED_DEPENDENCIES</td>
1.269     leot     12759: </tr>
                   12760: <tr>
1.305     bacon    12761: <td>PYTHON_VERSIONS_ACCEPTED</td>
1.312   ! gdt      12762: <td>PYTHON_VERSIONS_INCOMPATIBLE</td>
1.269     leot     12763: </tr>
                   12764: <tr>
1.305     bacon    12765: <td>PYTHON_VERSION_DEFAULT</td>
1.312   ! gdt      12766: <td>PYTHON_VERSION_REQD</td>
1.269     leot     12767: </tr>
                   12768: <tr>
1.305     bacon    12769: <td>PYVERSSUFFIX</td>
1.312   ! gdt      12770: <td>PY_NO_EGG</td>
1.269     leot     12771: </tr>
                   12772: <tr>
1.305     bacon    12773: <td>QMAILDIR</td>
1.312   ! gdt      12774: <td>QMAIL_ALIAS_USER</td>
1.269     leot     12775: </tr>
                   12776: <tr>
1.305     bacon    12777: <td>QMAIL_DAEMON_USER</td>
1.312   ! gdt      12778: <td>QMAIL_LOG_USER</td>
1.269     leot     12779: </tr>
                   12780: <tr>
1.305     bacon    12781: <td>QMAIL_NOFILES_GROUP</td>
1.312   ! gdt      12782: <td>QMAIL_PASSWD_USER</td>
1.269     leot     12783: </tr>
                   12784: <tr>
1.305     bacon    12785: <td>QMAIL_QMAIL_GROUP</td>
1.312   ! gdt      12786: <td>QMAIL_QUEUE_DIR</td>
1.269     leot     12787: </tr>
                   12788: <tr>
1.305     bacon    12789: <td>QMAIL_QUEUE_EXTRA</td>
1.312   ! gdt      12790: <td>QMAIL_QUEUE_USER</td>
1.269     leot     12791: </tr>
                   12792: <tr>
1.305     bacon    12793: <td>QMAIL_REMOTE_USER</td>
1.312   ! gdt      12794: <td>QMAIL_ROOT_USER</td>
1.269     leot     12795: </tr>
                   12796: <tr>
1.305     bacon    12797: <td>QMAIL_SEND_USER</td>
1.312   ! gdt      12798: <td>QPOPPER_FAC</td>
1.269     leot     12799: </tr>
                   12800: <tr>
1.305     bacon    12801: <td>QPOPPER_SPOOL_DIR</td>
1.312   ! gdt      12802: <td>QPOPPER_USER</td>
1.269     leot     12803: </tr>
                   12804: <tr>
1.305     bacon    12805: <td>RAKE_NAME</td>
1.312   ! gdt      12806: <td>RASMOL_DEPTH</td>
1.269     leot     12807: </tr>
                   12808: <tr>
1.311     leot     12809: <td>RCD_DIR</td>
1.312   ! gdt      12810: <td>RCD_ORDER</td>
1.311     leot     12811: </tr>
                   12812: <tr>
1.305     bacon    12813: <td>RCD_SCRIPTS</td>
1.312   ! gdt      12814: <td>RCD_SCRIPTS_DIR</td>
1.292     leot     12815: </tr>
                   12816: <tr>
1.305     bacon    12817: <td>RCD_SCRIPTS_EXAMPLEDIR</td>
1.312   ! gdt      12818: <td>RCD_SCRIPTS_MODE</td>
1.269     leot     12819: </tr>
                   12820: <tr>
1.305     bacon    12821: <td>RCD_SCRIPTS_SHELL</td>
1.312   ! gdt      12822: <td>RCD_SCRIPT_SRC</td>
1.269     leot     12823: </tr>
                   12824: <tr>
1.311     leot     12825: <td>RCD_SUBR</td>
1.312   ! gdt      12826: <td>RDOC</td>
1.311     leot     12827: </tr>
                   12828: <tr>
                   12829: <td>READLINE_DEFAULT</td>
1.312   ! gdt      12830: <td>READLINE_TYPE</td>
1.269     leot     12831: </tr>
                   12832: <tr>
1.311     leot     12833: <td>REAL_ROOT_GROUP</td>
1.312   ! gdt      12834: <td>REAL_ROOT_USER</td>
1.269     leot     12835: </tr>
                   12836: <tr>
1.311     leot     12837: <td>RECURSIVE_MAKE</td>
1.312   ! gdt      12838: <td>RELAY_CTRL_DIR</td>
1.269     leot     12839: </tr>
                   12840: <tr>
1.311     leot     12841: <td>RELRO_SUPPORTED</td>
1.312   ! gdt      12842: <td>REPLACE_AWK</td>
1.269     leot     12843: </tr>
                   12844: <tr>
1.311     leot     12845: <td>REPLACE_BASH</td>
1.312   ! gdt      12846: <td>REPLACE_CSH</td>
1.269     leot     12847: </tr>
                   12848: <tr>
1.311     leot     12849: <td>REPLACE_KSH</td>
1.312   ! gdt      12850: <td>REPLACE_PERL</td>
1.269     leot     12851: </tr>
                   12852: <tr>
1.311     leot     12853: <td>REPLACE_PERL6</td>
1.312   ! gdt      12854: <td>REPLACE_PHP</td>
1.269     leot     12855: </tr>
                   12856: <tr>
1.311     leot     12857: <td>REPLACE_PYTHON</td>
1.312   ! gdt      12858: <td>REPLACE_RUBY</td>
1.269     leot     12859: </tr>
                   12860: <tr>
1.311     leot     12861: <td>REPLACE_RUBY_DIRS</td>
1.312   ! gdt      12862: <td>REPLACE_RUBY_PAT</td>
1.281     leot     12863: </tr>
                   12864: <tr>
1.311     leot     12865: <td>REPLACE_SH</td>
1.312   ! gdt      12866: <td>REPLACE_TEXLUA</td>
1.269     leot     12867: </tr>
                   12868: <tr>
1.311     leot     12869: <td>REQD_DIRS</td>
1.312   ! gdt      12870: <td>REQD_DIRS_PERMS</td>
1.269     leot     12871: </tr>
                   12872: <tr>
1.311     leot     12873: <td>REQD_FILES</td>
1.312   ! gdt      12874: <td>REQD_FILES_MODE</td>
1.269     leot     12875: </tr>
                   12876: <tr>
1.311     leot     12877: <td>REQD_FILES_PERMS</td>
1.312   ! gdt      12878: <td>RESOLV_AUTO_VARS</td>
1.269     leot     12879: </tr>
                   12880: <tr>
1.311     leot     12881: <td>RESOLV_LDFLAGS</td>
1.312   ! gdt      12882: <td>RESOLV_LIBS</td>
1.269     leot     12883: </tr>
                   12884: <tr>
1.311     leot     12885: <td>RM</td>
1.312   ! gdt      12886: <td>ROCKSPEC_NAME</td>
1.311     leot     12887: </tr>
                   12888: <tr>
                   12889: <td>ROCKSPEC_SPECFILE</td>
1.312   ! gdt      12890: <td>ROOT_CMD</td>
1.269     leot     12891: </tr>
                   12892: <tr>
1.311     leot     12893: <td>ROOT_GROUP</td>
1.312   ! gdt      12894: <td>ROOT_USER</td>
1.274     rillig   12895: </tr>
                   12896: <tr>
1.311     leot     12897: <td>RPCGEN</td>
1.312   ! gdt      12898: <td>RPM</td>
1.269     leot     12899: </tr>
                   12900: <tr>
1.311     leot     12901: <td>RPM2PKG_PLIST</td>
1.312   ! gdt      12902: <td>RPM2PKG_PREFIX</td>
1.269     leot     12903: </tr>
                   12904: <tr>
1.311     leot     12905: <td>RPM2PKG_STAGE</td>
1.312   ! gdt      12906: <td>RPM2PKG_STRIP</td>
1.269     leot     12907: </tr>
                   12908: <tr>
1.311     leot     12909: <td>RPM2PKG_SUBPREFIX</td>
1.312   ! gdt      12910: <td>RPMFILES</td>
1.269     leot     12911: </tr>
                   12912: <tr>
1.311     leot     12913: <td>RPMIGNOREPATH</td>
1.312   ! gdt      12914: <td>RPM_DB_PREFIX</td>
1.269     leot     12915: </tr>
                   12916: <tr>
1.311     leot     12917: <td>RSSH_CVS_PATH</td>
1.312   ! gdt      12918: <td>RSSH_RDIST_PATH</td>
1.269     leot     12919: </tr>
                   12920: <tr>
1.311     leot     12921: <td>RSSH_RSYNC_PATH</td>
1.312   ! gdt      12922: <td>RSSH_SCP_PATH</td>
1.269     leot     12923: </tr>
                   12924: <tr>
1.311     leot     12925: <td>RSSH_SFTP_SERVER_PATH</td>
1.312   ! gdt      12926: <td>RUBY</td>
1.269     leot     12927: </tr>
                   12928: <tr>
1.311     leot     12929: <td>RUBYGEM</td>
1.312   ! gdt      12930: <td>RUBYGEM_NAME</td>
1.269     leot     12931: </tr>
                   12932: <tr>
1.311     leot     12933: <td>RUBYGEM_OPTIONS</td>
1.312   ! gdt      12934: <td>RUBYGEM_VERBOSE</td>
1.269     leot     12935: </tr>
                   12936: <tr>
1.306     kim      12937: <td>RUBY_ABI_VERSION</td>
1.311     leot     12938: <td>RUBY_ARCH</td>
1.269     leot     12939: </tr>
                   12940: <tr>
1.306     kim      12941: <td>RUBY_ARCHINC</td>
1.311     leot     12942: <td>RUBY_ARCHLIB</td>
1.269     leot     12943: </tr>
                   12944: <tr>
1.306     kim      12945: <td>RUBY_BASE</td>
1.311     leot     12946: <td>RUBY_BASERIDIR</td>
1.269     leot     12947: </tr>
                   12948: <tr>
1.306     kim      12949: <td>RUBY_BUILD_DOCUMENT</td>
1.311     leot     12950: <td>RUBY_DLEXT</td>
1.269     leot     12951: </tr>
                   12952: <tr>
1.306     kim      12953: <td>RUBY_DOC</td>
1.311     leot     12954: <td>RUBY_DYNAMIC_DIRS</td>
1.269     leot     12955: </tr>
                   12956: <tr>
1.306     kim      12957: <td>RUBY_EG</td>
1.311     leot     12958: <td>RUBY_ENCODING_ARG</td>
1.269     leot     12959: </tr>
                   12960: <tr>
1.306     kim      12961: <td>RUBY_EXTCONF</td>
1.311     leot     12962: <td>RUBY_EXTCONF_CHECK</td>
1.269     leot     12963: </tr>
                   12964: <tr>
1.306     kim      12965: <td>RUBY_EXTCONF_DEBUG</td>
1.311     leot     12966: <td>RUBY_EXTCONF_MAKEFILE</td>
1.269     leot     12967: </tr>
                   12968: <tr>
1.306     kim      12969: <td>RUBY_GEM_BASE</td>
1.311     leot     12970: <td>RUBY_INC</td>
1.269     leot     12971: </tr>
                   12972: <tr>
1.306     kim      12973: <td>RUBY_LIB</td>
1.311     leot     12974: <td>RUBY_LIB_BASE</td>
1.269     leot     12975: </tr>
                   12976: <tr>
1.306     kim      12977: <td>RUBY_NAME</td>
1.311     leot     12978: <td>RUBY_NOVERSION</td>
1.269     leot     12979: </tr>
                   12980: <tr>
1.306     kim      12981: <td>RUBY_PKGPREFIX</td>
1.311     leot     12982: <td>RUBY_RAILS</td>
1.269     leot     12983: </tr>
                   12984: <tr>
1.295     rillig   12985: <td>RUBY_RAILS52_VERSION</td>
1.311     leot     12986: <td>RUBY_RAILS60_VERSION</td>
1.269     leot     12987: </tr>
                   12988: <tr>
1.312   ! gdt      12989: <td>RUBY_RAILS61_VERSION</td>
1.295     rillig   12990: <td>RUBY_RAILS_ACCEPTED</td>
1.312   ! gdt      12991: </tr>
        !          12992: <tr>
1.311     leot     12993: <td>RUBY_RAILS_DEFAULT</td>
1.312   ! gdt      12994: <td>RUBY_RAILS_REQD</td>
1.289     leot     12995: </tr>
                   12996: <tr>
1.311     leot     12997: <td>RUBY_RAILS_STRICT_DEP</td>
1.312   ! gdt      12998: <td>RUBY_RIDIR</td>
1.269     leot     12999: </tr>
                   13000: <tr>
1.311     leot     13001: <td>RUBY_SETUP</td>
1.312   ! gdt      13002: <td>RUBY_SHLIB</td>
1.269     leot     13003: </tr>
                   13004: <tr>
1.311     leot     13005: <td>RUBY_SHLIBALIAS</td>
1.312   ! gdt      13006: <td>RUBY_SHLIBVER</td>
1.269     leot     13007: </tr>
                   13008: <tr>
1.311     leot     13009: <td>RUBY_SIMPLE_INSTALL</td>
1.312   ! gdt      13010: <td>RUBY_SITEARCHLIB</td>
1.269     leot     13011: </tr>
                   13012: <tr>
1.311     leot     13013: <td>RUBY_SITELIB</td>
1.312   ! gdt      13014: <td>RUBY_SITELIB_BASE</td>
1.269     leot     13015: </tr>
                   13016: <tr>
1.311     leot     13017: <td>RUBY_SITERIDIR</td>
1.312   ! gdt      13018: <td>RUBY_SLEXT</td>
1.269     leot     13019: </tr>
                   13020: <tr>
1.311     leot     13021: <td>RUBY_SRCDIR</td>
1.312   ! gdt      13022: <td>RUBY_STATICLIB</td>
1.269     leot     13023: </tr>
                   13024: <tr>
1.311     leot     13025: <td>RUBY_SUFFIX</td>
1.312   ! gdt      13026: <td>RUBY_SYSRIDIR</td>
1.269     leot     13027: </tr>
                   13028: <tr>
1.311     leot     13029: <td>RUBY_USE_PTHREAD</td>
1.312   ! gdt      13030: <td>RUBY_VENDORARCHLIB</td>
1.269     leot     13031: </tr>
                   13032: <tr>
1.311     leot     13033: <td>RUBY_VENDORLIB</td>
1.312   ! gdt      13034: <td>RUBY_VENDORLIB_BASE</td>
1.269     leot     13035: </tr>
                   13036: <tr>
1.311     leot     13037: <td>RUBY_VER</td>
1.312   ! gdt      13038: <td>RUBY_VERSION</td>
1.269     leot     13039: </tr>
                   13040: <tr>
1.311     leot     13041: <td>RUBY_VERSIONS_ACCEPTED</td>
1.312   ! gdt      13042: <td>RUBY_VERSIONS_INCOMPATIBLE</td>
1.269     leot     13043: </tr>
                   13044: <tr>
1.311     leot     13045: <td>RUBY_VERSION_DEFAULT</td>
1.312   ! gdt      13046: <td>RUBY_VERSION_REQD</td>
1.269     leot     13047: </tr>
                   13048: <tr>
1.311     leot     13049: <td>RUBY_VER_DIR</td>
1.312   ! gdt      13050: <td>RUN</td>
1.269     leot     13051: </tr>
                   13052: <tr>
1.311     leot     13053: <td>RUN_LDCONFIG</td>
1.312   ! gdt      13054: <td>SAWFISH_THEMES</td>
1.269     leot     13055: </tr>
                   13056: <tr>
1.311     leot     13057: <td>SCO</td>
1.312   ! gdt      13058: <td>SCREWS_GROUP</td>
1.269     leot     13059: </tr>
                   13060: <tr>
1.311     leot     13061: <td>SCREWS_USER</td>
1.312   ! gdt      13062: <td>SCRIPTS_ENV</td>
1.269     leot     13063: </tr>
                   13064: <tr>
1.311     leot     13065: <td>SCROLLKEEPER_DATADIR</td>
1.312   ! gdt      13066: <td>SCROLLKEEPER_REBUILDDB</td>
1.269     leot     13067: </tr>
                   13068: <tr>
1.311     leot     13069: <td>SCROLLKEEPER_UPDATEDB</td>
1.312   ! gdt      13070: <td>SDIST_PAWD</td>
1.269     leot     13071: </tr>
                   13072: <tr>
1.311     leot     13073: <td>SERIAL_DEVICES</td>
1.312   ! gdt      13074: <td>SETGIDGAME</td>
1.269     leot     13075: </tr>
                   13076: <tr>
1.311     leot     13077: <td>SETGID_GAMES_PERMS</td>
1.312   ! gdt      13078: <td>SETUID_ROOT_PERMS</td>
1.269     leot     13079: </tr>
                   13080: <tr>
1.311     leot     13081: <td>SH</td>
1.312   ! gdt      13082: <td>SHLIB</td>
1.269     leot     13083: </tr>
                   13084: <tr>
1.311     leot     13085: <td>SHORTNAME</td>
1.312   ! gdt      13086: <td>SIGN_PACKAGES</td>
1.292     leot     13087: </tr>
                   13088: <tr>
1.308     leot     13089: <td>SILC_CLIENT_WITH_PERL</td>
1.312   ! gdt      13090: <td>SITE_SPECIFIC_PKGS</td>
1.269     leot     13091: </tr>
                   13092: <tr>
1.308     leot     13093: <td>SKIP_DEPENDS</td>
1.312   ! gdt      13094: <td>SMF_INSTANCES</td>
1.269     leot     13095: </tr>
                   13096: <tr>
1.308     leot     13097: <td>SMF_MANIFEST</td>
1.312   ! gdt      13098: <td>SMF_METHODS</td>
1.274     rillig   13099: </tr>
                   13100: <tr>
1.308     leot     13101: <td>SMF_METHOD_SHELL</td>
1.312   ! gdt      13102: <td>SMF_METHOD_SRC</td>
1.269     leot     13103: </tr>
                   13104: <tr>
1.308     leot     13105: <td>SMF_NAME</td>
1.312   ! gdt      13106: <td>SMF_PREFIX</td>
1.269     leot     13107: </tr>
                   13108: <tr>
1.308     leot     13109: <td>SMF_SRCDIR</td>
1.312   ! gdt      13110: <td>SNIPROXY_GROUP</td>
1.269     leot     13111: </tr>
                   13112: <tr>
1.308     leot     13113: <td>SNIPROXY_USER</td>
1.312   ! gdt      13114: <td>SOURCE_BUFFSIZE</td>
1.269     leot     13115: </tr>
                   13116: <tr>
1.308     leot     13117: <td>SPECIAL_PERMS</td>
1.312   ! gdt      13118: <td>SPECIFIC_PKGS</td>
1.269     leot     13119: </tr>
                   13120: <tr>
1.308     leot     13121: <td>SSH_SUID</td>
1.312   ! gdt      13122: <td>SSP_SUPPORTED</td>
1.269     leot     13123: </tr>
                   13124: <tr>
1.308     leot     13125: <td>SSYNC_PAWD</td>
1.312   ! gdt      13126: <td>STEP_MSG</td>
1.269     leot     13127: </tr>
                   13128: <tr>
1.308     leot     13129: <td>STRIP</td>
1.312   ! gdt      13130: <td>STRIP_DBG</td>
1.269     leot     13131: </tr>
                   13132: <tr>
1.308     leot     13133: <td>STRIP_DEBUG</td>
1.312   ! gdt      13134: <td>STRIP_DEBUG_SUPPORTED</td>
1.269     leot     13135: </tr>
                   13136: <tr>
1.308     leot     13137: <td>STRIP_FILES_SKIP</td>
1.312   ! gdt      13138: <td>SU</td>
1.269     leot     13139: </tr>
                   13140: <tr>
1.308     leot     13141: <td>SUBDIR</td>
1.312   ! gdt      13142: <td>SUBST</td>
1.269     leot     13143: </tr>
                   13144: <tr>
1.308     leot     13145: <td>SUBST_CLASSES</td>
1.312   ! gdt      13146: <td>SUBST_FILES</td>
1.289     leot     13147: </tr>
                   13148: <tr>
1.308     leot     13149: <td>SUBST_FILTER_CMD</td>
1.312   ! gdt      13150: <td>SUBST_MESSAGE</td>
1.269     leot     13151: </tr>
                   13152: <tr>
1.308     leot     13153: <td>SUBST_NOOP_OK</td>
1.312   ! gdt      13154: <td>SUBST_SED</td>
1.269     leot     13155: </tr>
                   13156: <tr>
1.308     leot     13157: <td>SUBST_SHOW_DIFF</td>
1.312   ! gdt      13158: <td>SUBST_SKIP_TEXT_CHECK</td>
1.269     leot     13159: </tr>
                   13160: <tr>
1.308     leot     13161: <td>SUBST_STAGE</td>
1.312   ! gdt      13162: <td>SUBST_VARS</td>
1.269     leot     13163: </tr>
                   13164: <tr>
1.308     leot     13165: <td>SUNWSPROBASE</td>
1.312   ! gdt      13166: <td>SUSE_PREFER</td>
1.269     leot     13167: </tr>
                   13168: <tr>
1.308     leot     13169: <td>SU_CMD</td>
1.312   ! gdt      13170: <td>SVN_EXTRACTDIR</td>
1.292     leot     13171: </tr>
                   13172: <tr>
1.311     leot     13173: <td>SVN_REPO</td>
1.312   ! gdt      13174: <td>SVN_REPOSITORIES</td>
1.311     leot     13175: </tr>
                   13176: <tr>
                   13177: <td>SVN_REVISION</td>
1.312   ! gdt      13178: <td>TBL</td>
1.311     leot     13179: </tr>
                   13180: <tr>
1.308     leot     13181: <td>TERMCAP_TYPE</td>
1.312   ! gdt      13182: <td>TERMINFO_DEFAULT</td>
1.303     bacon    13183: </tr>
                   13184: <tr>
1.308     leot     13185: <td>TERMINFO_TYPE</td>
1.312   ! gdt      13186: <td>TEST</td>
1.274     rillig   13187: </tr>
                   13188: <tr>
1.308     leot     13189: <td>TEST_DEPENDS</td>
1.312   ! gdt      13190: <td>TEST_DIRS</td>
1.269     leot     13191: </tr>
                   13192: <tr>
1.308     leot     13193: <td>TEST_ENV</td>
1.312   ! gdt      13194: <td>TEST_ENV_SHELL</td>
1.269     leot     13195: </tr>
                   13196: <tr>
1.308     leot     13197: <td>TEST_MAKE_CMD</td>
1.312   ! gdt      13198: <td>TEST_MAKE_FLAGS</td>
1.269     leot     13199: </tr>
                   13200: <tr>
1.308     leot     13201: <td>TEST_TARGET</td>
1.312   ! gdt      13202: <td>TEXLIVE_IGNORE_PATTERNS</td>
1.269     leot     13203: </tr>
                   13204: <tr>
1.308     leot     13205: <td>TEXLIVE_REV</td>
1.312   ! gdt      13206: <td>TEXLIVE_UNVERSIONED</td>
1.269     leot     13207: </tr>
                   13208: <tr>
1.308     leot     13209: <td>TEXMFSITE</td>
1.312   ! gdt      13210: <td>TEX_FORMATS</td>
1.269     leot     13211: </tr>
                   13212: <tr>
1.308     leot     13213: <td>TEX_HYPHEN_DAT</td>
1.312   ! gdt      13214: <td>TEX_HYPHEN_DEF</td>
1.269     leot     13215: </tr>
                   13216: <tr>
1.308     leot     13217: <td>TEX_TEXMF_DIRS</td>
1.312   ! gdt      13218: <td>THTTPD_LOG_FACILITY</td>
1.269     leot     13219: </tr>
                   13220: <tr>
1.309     gutterid 13221: <td>TINYDYN_USER</td>
1.312   ! gdt      13222: <td>TO</td>
1.269     leot     13223: </tr>
                   13224: <tr>
1.303     bacon    13225: <td>TOOLS_ALIASES</td>
1.312   ! gdt      13226: <td>TOOLS_ALWAYS_WRAP</td>
1.269     leot     13227: </tr>
                   13228: <tr>
1.303     bacon    13229: <td>TOOLS_ARGS</td>
1.312   ! gdt      13230: <td>TOOLS_BROKEN</td>
1.269     leot     13231: </tr>
                   13232: <tr>
1.303     bacon    13233: <td>TOOLS_CMD</td>
1.312   ! gdt      13234: <td>TOOLS_CMDLINE_SED</td>
1.269     leot     13235: </tr>
                   13236: <tr>
1.295     rillig   13237: <td>TOOLS_CREATE</td>
1.312   ! gdt      13238: <td>TOOLS_DIR</td>
1.269     leot     13239: </tr>
                   13240: <tr>
1.295     rillig   13241: <td>TOOLS_FAIL</td>
1.312   ! gdt      13242: <td>TOOLS_GNU_MISSING</td>
1.269     leot     13243: </tr>
                   13244: <tr>
1.295     rillig   13245: <td>TOOLS_LDCONFIG</td>
1.312   ! gdt      13246: <td>TOOLS_NOOP</td>
1.269     leot     13247: </tr>
                   13248: <tr>
1.295     rillig   13249: <td>TOOLS_PATH</td>
1.312   ! gdt      13250: <td>TOOLS_SCRIPT</td>
1.269     leot     13251: </tr>
                   13252: <tr>
1.295     rillig   13253: <td>TOOL_DEPENDS</td>
1.312   ! gdt      13254: <td>TTF_FONTDIR</td>
1.269     leot     13255: </tr>
                   13256: <tr>
1.295     rillig   13257: <td>TTF_FONTS_DIR</td>
1.312   ! gdt      13258: <td>TYPE</td>
1.311     leot     13259: </tr>
                   13260: <tr>
                   13261: <td>UAC_REQD_EXECS</td>
1.312   ! gdt      13262: <td>UCSPI_SSL_GROUP</td>
1.269     leot     13263: </tr>
                   13264: <tr>
1.311     leot     13265: <td>UCSPI_SSL_USER</td>
1.312   ! gdt      13266: <td>UNLIMIT_RESOURCES</td>
1.269     leot     13267: </tr>
                   13268: <tr>
1.311     leot     13269: <td>UNPRIVILEGED</td>
1.312   ! gdt      13270: <td>UNPRIVILEGED_GROUP</td>
1.269     leot     13271: </tr>
                   13272: <tr>
1.311     leot     13273: <td>UNPRIVILEGED_GROUPS</td>
1.312   ! gdt      13274: <td>UNPRIVILEGED_USER</td>
1.269     leot     13275: </tr>
                   13276: <tr>
1.311     leot     13277: <td>UNWRAP_FILES</td>
1.312   ! gdt      13278: <td>UNWRAP_PATTERNS</td>
1.269     leot     13279: </tr>
                   13280: <tr>
1.311     leot     13281: <td>UPDATE_GEMSPEC</td>
1.312   ! gdt      13282: <td>UPDATE_TARGET</td>
1.269     leot     13283: </tr>
                   13284: <tr>
1.311     leot     13285: <td>URI</td>
1.312   ! gdt      13286: <td>USERGROUP_PHASE</td>
1.269     leot     13287: </tr>
                   13288: <tr>
1.311     leot     13289: <td>USERPPP_GROUP</td>
1.312   ! gdt      13290: <td>USER_SPECIFIC_PKGS</td>
1.269     leot     13291: </tr>
                   13292: <tr>
1.311     leot     13293: <td>USE_ABI_DEPENDS</td>
1.312   ! gdt      13294: <td>USE_APR</td>
1.269     leot     13295: </tr>
                   13296: <tr>
1.311     leot     13297: <td>USE_BSD_MAKEFILE</td>
1.312   ! gdt      13298: <td>USE_BUILTIN</td>
1.269     leot     13299: </tr>
                   13300: <tr>
1.311     leot     13301: <td>USE_CROSS_COMPILE</td>
1.312   ! gdt      13302: <td>USE_CURSES</td>
1.269     leot     13303: </tr>
                   13304: <tr>
1.311     leot     13305: <td>USE_CWRAPPERS</td>
1.312   ! gdt      13306: <td>USE_DB185</td>
1.269     leot     13307: </tr>
                   13308: <tr>
1.311     leot     13309: <td>USE_FEATURES</td>
1.312   ! gdt      13310: <td>USE_GAMESGROUP</td>
1.269     leot     13311: </tr>
                   13312: <tr>
1.311     leot     13313: <td>USE_GCC_RUNTIME</td>
1.312   ! gdt      13314: <td>USE_IMAKE</td>
1.269     leot     13315: </tr>
                   13316: <tr>
1.311     leot     13317: <td>USE_JAVA</td>
1.312   ! gdt      13318: <td>USE_JAVA2</td>
1.269     leot     13319: </tr>
                   13320: <tr>
1.311     leot     13321: <td>USE_LANGUAGES</td>
1.312   ! gdt      13322: <td>USE_LIBTOOL</td>
1.269     leot     13323: </tr>
                   13324: <tr>
1.311     leot     13325: <td>USE_NATIVE_GCC</td>
1.312   ! gdt      13326: <td>USE_NETBSD_REPO</td>
1.269     leot     13327: </tr>
                   13328: <tr>
1.311     leot     13329: <td>USE_PKGSRC_GCC</td>
1.312   ! gdt      13330: <td>USE_PKGSRC_GCC_RUNTIME</td>
1.269     leot     13331: </tr>
                   13332: <tr>
1.311     leot     13333: <td>USE_PKGTASKS</td>
1.312   ! gdt      13334: <td>USE_PKG_ADMIN_DIGEST</td>
1.269     leot     13335: </tr>
                   13336: <tr>
1.311     leot     13337: <td>USE_RUBY_EXTCONF</td>
1.312   ! gdt      13338: <td>USE_RUBY_INSTALL</td>
1.269     leot     13339: </tr>
                   13340: <tr>
1.311     leot     13341: <td>USE_RUBY_SETUP</td>
1.312   ! gdt      13342: <td>USE_RUBY_SETUP_PKG</td>
1.269     leot     13343: </tr>
                   13344: <tr>
1.311     leot     13345: <td>USE_TOOLS</td>
1.312   ! gdt      13346: <td>UUCP_GROUP</td>
1.269     leot     13347: </tr>
                   13348: <tr>
1.311     leot     13349: <td>UUCP_USER</td>
1.312   ! gdt      13350: <td>VARBASE</td>
1.269     leot     13351: </tr>
                   13352: <tr>
1.311     leot     13353: <td>VARNAME</td>
1.312   ! gdt      13354: <td>VIM_EXTRA_OPTS</td>
1.269     leot     13355: </tr>
                   13356: <tr>
1.311     leot     13357: <td>WARNING_MSG</td>
1.312   ! gdt      13358: <td>WCALC_CGIDIR</td>
1.269     leot     13359: </tr>
                   13360: <tr>
1.311     leot     13361: <td>WCALC_CGIPATH</td>
1.312   ! gdt      13362: <td>WCALC_HTMLDIR</td>
1.269     leot     13363: </tr>
                   13364: <tr>
1.311     leot     13365: <td>WCALC_HTMLPATH</td>
1.312   ! gdt      13366: <td>WDM_MANAGERS</td>
1.269     leot     13367: </tr>
                   13368: <tr>
1.311     leot     13369: <td>WRAPPER_CC</td>
1.312   ! gdt      13370: <td>WRAPPER_REORDER_CMDS</td>
1.269     leot     13371: </tr>
                   13372: <tr>
1.311     leot     13373: <td>WRKDIR</td>
1.312   ! gdt      13374: <td>WRKDIR_BASENAME</td>
1.303     bacon    13375: </tr>
                   13376: <tr>
1.311     leot     13377: <td>WRKDIR_LOCKTYPE</td>
1.312   ! gdt      13378: <td>WRKLOG</td>
1.269     leot     13379: </tr>
                   13380: <tr>
1.311     leot     13381: <td>WRKOBJDIR</td>
1.312   ! gdt      13382: <td>WRKSRC</td>
1.269     leot     13383: </tr>
                   13384: <tr>
1.311     leot     13385: <td>X10_PORT</td>
1.312   ! gdt      13386: <td>X11</td>
1.269     leot     13387: </tr>
                   13388: <tr>
1.311     leot     13389: <td>X11BASE</td>
1.312   ! gdt      13390: <td>X11_PKGSRCDIR</td>
1.269     leot     13391: </tr>
                   13392: <tr>
1.311     leot     13393: <td>X11_TYPE</td>
1.312   ! gdt      13394: <td>X509_CERTIFICATE</td>
1.269     leot     13395: </tr>
                   13396: <tr>
1.311     leot     13397: <td>X509_KEY</td>
1.312   ! gdt      13398: <td>XAW_TYPE</td>
1.269     leot     13399: </tr>
                   13400: <tr>
1.311     leot     13401: <td>XLOCK_DEFAULT_MODE</td>
1.312   ! gdt      13402: <td>XMKMF</td>
1.269     leot     13403: </tr>
                   13404: <tr>
1.311     leot     13405: <td>XMKMF_FLAGS</td>
1.312   ! gdt      13406: <td>XXX</td>
1.269     leot     13407: </tr>
                   13408: <tr>
1.311     leot     13409: <td>XXXX</td>
1.312   ! gdt      13410: <td>YES</td>
1.274     rillig   13411: </tr>
                   13412: <tr>
1.295     rillig   13413: <td>ZSH_STATIC</td>
1.312   ! gdt      13414: <td>__stdc__</td>
1.269     leot     13415: </tr>
                   13416: <tr>
1.295     rillig   13417: <td>_vargroups</td>
1.312   ! gdt      13418: <td>accept</td>
1.289     leot     13419: </tr>
                   13420: <tr>
1.295     rillig   13421: <td>acquire-localbase-lock</td>
1.312   ! gdt      13422: <td>acquire-lock</td>
1.269     leot     13423: </tr>
                   13424: <tr>
1.295     rillig   13425: <td>add</td>
1.312   ! gdt      13426: <td>administrator</td>
1.269     leot     13427: </tr>
                   13428: <tr>
1.295     rillig   13429: <td>alloca</td>
1.312   ! gdt      13430: <td>alternatives</td>
1.289     leot     13431: </tr>
                   13432: <tr>
1.295     rillig   13433: <td>aslr</td>
1.312   ! gdt      13434: <td>asprintf</td>
1.269     leot     13435: </tr>
                   13436: <tr>
1.295     rillig   13437: <td>atlas</td>
1.312   ! gdt      13438: <td>autoconf</td>
1.269     leot     13439: </tr>
                   13440: <tr>
1.295     rillig   13441: <td>automake</td>
1.312   ! gdt      13442: <td>autoreconf</td>
1.269     leot     13443: </tr>
                   13444: <tr>
1.295     rillig   13445: <td>awk</td>
1.312   ! gdt      13446: <td>bash</td>
1.271     brook    13447: </tr>
                   13448: <tr>
1.295     rillig   13449: <td>big-endian</td>
1.312   ! gdt      13450: <td>bin-install</td>
1.269     leot     13451: </tr>
                   13452: <tr>
1.295     rillig   13453: <td>bind</td>
1.312   ! gdt      13454: <td>binpkg-list</td>
1.292     leot     13455: </tr>
                   13456: <tr>
1.295     rillig   13457: <td>blas</td>
1.312   ! gdt      13458: <td>bootstrap-depends</td>
1.274     rillig   13459: </tr>
                   13460: <tr>
1.295     rillig   13461: <td>broken</td>
1.312   ! gdt      13462: <td>broken_on_platform</td>
1.269     leot     13463: </tr>
                   13464: <tr>
1.295     rillig   13465: <td>bsd</td>
1.312   ! gdt      13466: <td>bsd.prog.mk</td>
1.289     leot     13467: </tr>
                   13468: <tr>
1.295     rillig   13469: <td>build</td>
1.312   ! gdt      13470: <td>build-env</td>
1.269     leot     13471: </tr>
                   13472: <tr>
1.295     rillig   13473: <td>buildlink-directories</td>
1.312   ! gdt      13474: <td>buildlink-oss-soundcard-h</td>
1.269     leot     13475: </tr>
                   13476: <tr>
1.295     rillig   13477: <td>c</td>
1.312   ! gdt      13478: <td>c++</td>
1.269     leot     13479: </tr>
                   13480: <tr>
1.295     rillig   13481: <td>ccache</td>
1.312   ! gdt      13482: <td>cce</td>
1.269     leot     13483: </tr>
                   13484: <tr>
1.295     rillig   13485: <td>cdefs</td>
1.312   ! gdt      13486: <td>ceil</td>
1.289     leot     13487: </tr>
                   13488: <tr>
1.295     rillig   13489: <td>changes</td>
1.312   ! gdt      13490: <td>changes-entry</td>
1.269     leot     13491: </tr>
                   13492: <tr>
1.295     rillig   13493: <td>changes-entry-noupdate</td>
1.312   ! gdt      13494: <td>check</td>
1.269     leot     13495: </tr>
                   13496: <tr>
1.295     rillig   13497: <td>check-clean</td>
1.312   ! gdt      13498: <td>check-files</td>
1.269     leot     13499: </tr>
                   13500: <tr>
1.295     rillig   13501: <td>check-files-clean</td>
1.312   ! gdt      13502: <td>check-vulnerable</td>
1.269     leot     13503: </tr>
                   13504: <tr>
1.295     rillig   13505: <td>checksum</td>
1.312   ! gdt      13506: <td>checksum-phase</td>
1.269     leot     13507: </tr>
                   13508: <tr>
1.295     rillig   13509: <td>clean</td>
1.312   ! gdt      13510: <td>clean-depends</td>
1.269     leot     13511: </tr>
                   13512: <tr>
1.295     rillig   13513: <td>cleandir</td>
1.312   ! gdt      13514: <td>commit</td>
1.269     leot     13515: </tr>
                   13516: <tr>
1.295     rillig   13517: <td>commit-changes-entry</td>
1.312   ! gdt      13518: <td>compact</td>
1.269     leot     13519: </tr>
                   13520: <tr>
1.295     rillig   13521: <td>compiler</td>
1.312   ! gdt      13522: <td>conf</td>
1.269     leot     13523: </tr>
                   13524: <tr>
1.295     rillig   13525: <td>config.guess</td>
1.312   ! gdt      13526: <td>config.sub</td>
1.269     leot     13527: </tr>
                   13528: <tr>
1.295     rillig   13529: <td>configuration</td>
1.312   ! gdt      13530: <td>configure</td>
1.269     leot     13531: </tr>
                   13532: <tr>
1.295     rillig   13533: <td>configure-env</td>
1.312   ! gdt      13534: <td>configure-help</td>
1.269     leot     13535: </tr>
                   13536: <tr>
1.295     rillig   13537: <td>configure_args</td>
1.312   ! gdt      13538: <td>connect</td>
1.269     leot     13539: </tr>
                   13540: <tr>
1.295     rillig   13541: <td>cos</td>
1.312   ! gdt      13542: <td>cputime</td>
1.289     leot     13543: </tr>
                   13544: <tr>
1.295     rillig   13545: <td>create-usergroup</td>
1.312   ! gdt      13546: <td>csh</td>
1.269     leot     13547: </tr>
                   13548: <tr>
1.295     rillig   13549: <td>ctf</td>
1.312   ! gdt      13550: <td>cvs</td>
1.269     leot     13551: </tr>
                   13552: <tr>
1.295     rillig   13553: <td>debug</td>
1.312   ! gdt      13554: <td>declaration</td>
1.311     leot     13555: </tr>
                   13556: <tr>
                   13557: <td>declare</td>
1.312   ! gdt      13558: <td>defined</td>
1.269     leot     13559: </tr>
                   13560: <tr>
1.311     leot     13561: <td>depend</td>
1.312   ! gdt      13562: <td>dependencies</td>
1.269     leot     13563: </tr>
                   13564: <tr>
1.311     leot     13565: <td>depends</td>
1.312   ! gdt      13566: <td>depends-checksum</td>
1.269     leot     13567: </tr>
                   13568: <tr>
1.311     leot     13569: <td>depends-fetch</td>
1.312   ! gdt      13570: <td>deps</td>
1.269     leot     13571: </tr>
                   13572: <tr>
1.311     leot     13573: <td>describe</td>
1.312   ! gdt      13574: <td>destdir</td>
1.269     leot     13575: </tr>
                   13576: <tr>
1.311     leot     13577: <td>disable</td>
1.312   ! gdt      13578: <td>distclean</td>
1.269     leot     13579: </tr>
                   13580: <tr>
1.311     leot     13581: <td>distinfo</td>
1.312   ! gdt      13582: <td>dl</td>
1.277     rillig   13583: </tr>
                   13584: <tr>
1.311     leot     13585: <td>dlopen</td>
1.312   ! gdt      13586: <td>do-build</td>
1.269     leot     13587: </tr>
                   13588: <tr>
1.311     leot     13589: <td>do-buildlink</td>
1.312   ! gdt      13590: <td>do-clean</td>
1.269     leot     13591: </tr>
                   13592: <tr>
1.311     leot     13593: <td>do-configure</td>
1.312   ! gdt      13594: <td>do-configure-post-hook</td>
1.269     leot     13595: </tr>
                   13596: <tr>
1.311     leot     13597: <td>do-extract</td>
1.312   ! gdt      13598: <td>do-fetch</td>
1.285     rillig   13599: </tr>
                   13600: <tr>
1.311     leot     13601: <td>do-install</td>
1.312   ! gdt      13602: <td>emul</td>
1.289     leot     13603: </tr>
                   13604: <tr>
1.295     rillig   13605: <td>emul-distinfo</td>
1.312   ! gdt      13606: <td>emul-fetch</td>
1.269     leot     13607: </tr>
                   13608: <tr>
1.295     rillig   13609: <td>emulation</td>
1.312   ! gdt      13610: <td>emulator</td>
1.274     rillig   13611: </tr>
                   13612: <tr>
1.295     rillig   13613: <td>enable</td>
1.312   ! gdt      13614: <td>endian</td>
1.269     leot     13615: </tr>
                   13616: <tr>
1.311     leot     13617: <td>endif</td>
1.312   ! gdt      13618: <td>enomem</td>
1.311     leot     13619: </tr>
                   13620: <tr>
                   13621: <td>err</td>
1.312   ! gdt      13622: <td>errx</td>
1.269     leot     13623: </tr>
                   13624: <tr>
1.311     leot     13625: <td>etc</td>
1.312   ! gdt      13626: <td>exp</td>
1.269     leot     13627: </tr>
                   13628: <tr>
1.311     leot     13629: <td>extract-rpm</td>
1.312   ! gdt      13630: <td>fabs</td>
1.289     leot     13631: </tr>
                   13632: <tr>
1.311     leot     13633: <td>feature</td>
1.312   ! gdt      13634: <td>features</td>
1.269     leot     13635: </tr>
                   13636: <tr>
1.311     leot     13637: <td>fetch</td>
1.312   ! gdt      13638: <td>fetch-list</td>
1.269     leot     13639: </tr>
                   13640: <tr>
1.311     leot     13641: <td>follows</td>
1.312   ! gdt      13642: <td>forbids</td>
1.269     leot     13643: </tr>
                   13644: <tr>
1.311     leot     13645: <td>form</td>
1.312   ! gdt      13646: <td>format</td>
1.269     leot     13647: </tr>
                   13648: <tr>
1.311     leot     13649: <td>fortify</td>
1.312   ! gdt      13650: <td>fortify_source</td>
1.269     leot     13651: </tr>
                   13652: <tr>
1.311     leot     13653: <td>fossil</td>
1.312   ! gdt      13654: <td>friend</td>
1.269     leot     13655: </tr>
                   13656: <tr>
1.295     rillig   13657: <td>fts</td>
1.312   ! gdt      13658: <td>fts_close</td>
1.269     leot     13659: </tr>
                   13660: <tr>
1.295     rillig   13661: <td>fts_open</td>
1.312   ! gdt      13662: <td>fts_read</td>
1.269     leot     13663: </tr>
                   13664: <tr>
1.295     rillig   13665: <td>fts_set</td>
1.312   ! gdt      13666: <td>gcc</td>
1.289     leot     13667: </tr>
                   13668: <tr>
1.295     rillig   13669: <td>gethostbyaddr</td>
1.312   ! gdt      13670: <td>gethostbyname</td>
1.269     leot     13671: </tr>
                   13672: <tr>
1.295     rillig   13673: <td>gethostbyname2</td>
1.312   ! gdt      13674: <td>getopt_long</td>
1.269     leot     13675: </tr>
                   13676: <tr>
1.295     rillig   13677: <td>getprogname</td>
1.312   ! gdt      13678: <td>getservbyname</td>
1.289     leot     13679: </tr>
                   13680: <tr>
1.295     rillig   13681: <td>getservbyport</td>
1.312   ! gdt      13682: <td>getservent</td>
1.289     leot     13683: </tr>
                   13684: <tr>
1.295     rillig   13685: <td>gettext</td>
1.312   ! gdt      13686: <td>git</td>
1.269     leot     13687: </tr>
                   13688: <tr>
1.295     rillig   13689: <td>github</td>
1.312   ! gdt      13690: <td>gitlab</td>
1.311     leot     13691: </tr>
                   13692: <tr>
1.295     rillig   13693: <td>glob</td>
1.312   ! gdt      13694: <td>gnu</td>
1.274     rillig   13695: </tr>
                   13696: <tr>
1.295     rillig   13697: <td>gnu_configure_strict</td>
1.312   ! gdt      13698: <td>go</td>
1.269     leot     13699: </tr>
                   13700: <tr>
1.295     rillig   13701: <td>go-deps</td>
1.312   ! gdt      13702: <td>golang</td>
1.269     leot     13703: </tr>
                   13704: <tr>
1.295     rillig   13705: <td>guess-license</td>
1.312   ! gdt      13706: <td>hashbang</td>
1.269     leot     13707: </tr>
                   13708: <tr>
1.295     rillig   13709: <td>heimdal</td>
1.312   ! gdt      13710: <td>help</td>
1.269     leot     13711: </tr>
                   13712: <tr>
1.311     leot     13713: <td>hg</td>
1.312   ! gdt      13714: <td>imake</td>
1.311     leot     13715: </tr>
                   13716: <tr>
                   13717: <td>increment</td>
1.312   ! gdt      13718: <td>inet_aton</td>
1.269     leot     13719: </tr>
                   13720: <tr>
1.311     leot     13721: <td>interp</td>
1.312   ! gdt      13722: <td>interpreter</td>
1.269     leot     13723: </tr>
                   13724: <tr>
1.311     leot     13725: <td>intl</td>
1.312   ! gdt      13726: <td>ip4</td>
1.269     leot     13727: </tr>
                   13728: <tr>
1.311     leot     13729: <td>ip6</td>
1.312   ! gdt      13730: <td>ipv4</td>
1.269     leot     13731: </tr>
                   13732: <tr>
1.311     leot     13733: <td>ipv6</td>
1.312   ! gdt      13734: <td>iso</td>
1.303     bacon    13735: </tr>
                   13736: <tr>
1.311     leot     13737: <td>kerberos</td>
1.312   ! gdt      13738: <td>krb</td>
1.303     bacon    13739: </tr>
                   13740: <tr>
1.311     leot     13741: <td>krb5</td>
1.312   ! gdt      13742: <td>ksh</td>
1.269     leot     13743: </tr>
                   13744: <tr>
1.311     leot     13745: <td>lapack</td>
1.312   ! gdt      13746: <td>latex</td>
1.292     leot     13747: </tr>
                   13748: <tr>
1.311     leot     13749: <td>libintl_bindtextdomain</td>
1.312   ! gdt      13750: <td>libintl_gettext</td>
1.269     leot     13751: </tr>
                   13752: <tr>
1.311     leot     13753: <td>libintl_textdomain</td>
1.312   ! gdt      13754: <td>libnbcompat</td>
1.289     leot     13755: </tr>
                   13756: <tr>
1.311     leot     13757: <td>libs</td>
1.312   ! gdt      13758: <td>libtool</td>
1.274     rillig   13759: </tr>
                   13760: <tr>
1.311     leot     13761: <td>licence</td>
1.312   ! gdt      13762: <td>license</td>
1.271     brook    13763: </tr>
                   13764: <tr>
1.311     leot     13765: <td>lintl</td>
1.312   ! gdt      13766: <td>little-endian</td>
1.269     leot     13767: </tr>
                   13768: <tr>
1.311     leot     13769: <td>lock</td>
1.312   ! gdt      13770: <td>locking</td>
1.269     leot     13771: </tr>
                   13772: <tr>
1.311     leot     13773: <td>lvalue</td>
1.312   ! gdt      13774: <td>make</td>
1.269     leot     13775: </tr>
                   13776: <tr>
1.311     leot     13777: <td>makesum</td>
1.312   ! gdt      13778: <td>memory</td>
1.269     leot     13779: </tr>
                   13780: <tr>
1.311     leot     13781: <td>mercurial</td>
1.312   ! gdt      13782: <td>meta</td>
1.269     leot     13783: </tr>
                   13784: <tr>
1.295     rillig   13785: <td>meta-package</td>
1.312   ! gdt      13786: <td>meta_package</td>
1.269     leot     13787: </tr>
                   13788: <tr>
1.295     rillig   13789: <td>mit-krb5</td>
1.312   ! gdt      13790: <td>mk.conf</td>
1.292     leot     13791: </tr>
                   13792: <tr>
1.295     rillig   13793: <td>mkl</td>
1.312   ! gdt      13794: <td>mount</td>
1.274     rillig   13795: </tr>
                   13796: <tr>
1.295     rillig   13797: <td>mprotect</td>
1.312   ! gdt      13798: <td>mremap</td>
1.269     leot     13799: </tr>
                   13800: <tr>
1.295     rillig   13801: <td>nb</td>
1.312   ! gdt      13802: <td>nbcompat</td>
1.269     leot     13803: </tr>
                   13804: <tr>
1.295     rillig   13805: <td>obstack</td>
1.312   ! gdt      13806: <td>obstack_ptr_grow</td>
1.269     leot     13807: </tr>
                   13808: <tr>
1.295     rillig   13809: <td>occurs</td>
1.312   ! gdt      13810: <td>only</td>
1.269     leot     13811: </tr>
                   13812: <tr>
1.295     rillig   13813: <td>openblas</td>
1.312   ! gdt      13814: <td>options</td>
1.269     leot     13815: </tr>
                   13816: <tr>
1.295     rillig   13817: <td>options.mk</td>
1.312   ! gdt      13818: <td>order</td>
1.271     brook    13819: </tr>
                   13820: <tr>
1.295     rillig   13821: <td>override</td>
1.312   ! gdt      13822: <td>override-intltool</td>
1.269     leot     13823: </tr>
                   13824: <tr>
1.295     rillig   13825: <td>override-message-intltool</td>
1.312   ! gdt      13826: <td>package</td>
1.269     leot     13827: </tr>
                   13828: <tr>
1.295     rillig   13829: <td>parallel</td>
1.312   ! gdt      13830: <td>path</td>
1.269     leot     13831: </tr>
                   13832: <tr>
1.295     rillig   13833: <td>pax</td>
1.312   ! gdt      13834: <td>paxctl</td>
1.269     leot     13835: </tr>
                   13836: <tr>
1.295     rillig   13837: <td>pbulk-index</td>
1.312   ! gdt      13838: <td>pc</td>
1.269     leot     13839: </tr>
                   13840: <tr>
1.295     rillig   13841: <td>perl</td>
1.312   ! gdt      13842: <td>perl5</td>
1.269     leot     13843: </tr>
                   13844: <tr>
1.295     rillig   13845: <td>perms</td>
1.312   ! gdt      13846: <td>php</td>
1.269     leot     13847: </tr>
                   13848: <tr>
1.295     rillig   13849: <td>pkg-build-options</td>
1.312   ! gdt      13850: <td>pkg-config</td>
1.269     leot     13851: </tr>
                   13852: <tr>
1.295     rillig   13853: <td>pkg_build_options</td>
1.312   ! gdt      13854: <td>platform</td>
1.269     leot     13855: </tr>
                   13856: <tr>
1.295     rillig   13857: <td>plist</td>
1.312   ! gdt      13858: <td>post-extract</td>
1.269     leot     13859: </tr>
                   13860: <tr>
1.295     rillig   13861: <td>post-fetch</td>
1.312   ! gdt      13862: <td>post-wrapper</td>
1.269     leot     13863: </tr>
                   13864: <tr>
1.295     rillig   13865: <td>pre-build-checks-hook</td>
1.312   ! gdt      13866: <td>pre-configure</td>
1.289     leot     13867: </tr>
                   13868: <tr>
1.295     rillig   13869: <td>pre-configure-checks-hook</td>
1.312   ! gdt      13870: <td>pre-extract</td>
1.269     leot     13871: </tr>
                   13872: <tr>
1.295     rillig   13873: <td>pre-fetch</td>
1.312   ! gdt      13874: <td>print-go-deps</td>
1.269     leot     13875: </tr>
                   13876: <tr>
1.295     rillig   13877: <td>print-plist</td>
1.312   ! gdt      13878: <td>print-summary-data</td>
1.269     leot     13879: </tr>
                   13880: <tr>
1.295     rillig   13881: <td>privileged-install-hook</td>
1.312   ! gdt      13882: <td>pypi</td>
1.269     leot     13883: </tr>
                   13884: <tr>
1.295     rillig   13885: <td>python</td>
1.312   ! gdt      13886: <td>readme-all</td>
1.269     leot     13887: </tr>
                   13888: <tr>
1.295     rillig   13889: <td>recv</td>
1.312   ! gdt      13890: <td>recvfrom</td>
1.289     leot     13891: </tr>
                   13892: <tr>
1.295     rillig   13893: <td>regcomp</td>
1.312   ! gdt      13894: <td>release-localbase-lock</td>
1.289     leot     13895: </tr>
                   13896: <tr>
1.295     rillig   13897: <td>release-lock</td>
1.312   ! gdt      13898: <td>relro</td>
1.269     leot     13899: </tr>
                   13900: <tr>
1.295     rillig   13901: <td>rename</td>
1.312   ! gdt      13902: <td>reorder</td>
1.269     leot     13903: </tr>
                   13904: <tr>
1.295     rillig   13905: <td>replace</td>
1.312   ! gdt      13906: <td>replace_interpreter</td>
1.269     leot     13907: </tr>
                   13908: <tr>
1.295     rillig   13909: <td>reproducible</td>
1.312   ! gdt      13910: <td>resolv</td>
1.269     leot     13911: </tr>
                   13912: <tr>
1.295     rillig   13913: <td>root</td>
1.312   ! gdt      13914: <td>ruby</td>
1.289     leot     13915: </tr>
                   13916: <tr>
1.295     rillig   13917: <td>send</td>
1.312   ! gdt      13918: <td>sendfile</td>
1.269     leot     13919: </tr>
                   13920: <tr>
1.295     rillig   13921: <td>sendto</td>
1.312   ! gdt      13922: <td>setenv</td>
1.269     leot     13923: </tr>
                   13924: <tr>
1.295     rillig   13925: <td>setgid</td>
1.312   ! gdt      13926: <td>setprogname</td>
1.269     leot     13927: </tr>
                   13928: <tr>
1.295     rillig   13929: <td>setuid</td>
1.312   ! gdt      13930: <td>sh</td>
1.269     leot     13931: </tr>
                   13932: <tr>
1.296     rillig   13933: <td>shebang</td>
1.312   ! gdt      13934: <td>show</td>
1.296     rillig   13935: </tr>
                   13936: <tr>
1.273     brook    13937: <td>show-all</td>
1.312   ! gdt      13938: <td>show-build-defs</td>
1.269     leot     13939: </tr>
                   13940: <tr>
1.273     brook    13941: <td>show-depends</td>
1.312   ! gdt      13942: <td>show-deps</td>
1.269     leot     13943: </tr>
                   13944: <tr>
1.273     brook    13945: <td>show-distfiles</td>
1.312   ! gdt      13946: <td>show-downlevel</td>
1.269     leot     13947: </tr>
                   13948: <tr>
1.273     brook    13949: <td>show-subdir-var</td>
1.312   ! gdt      13950: <td>show-tools</td>
1.269     leot     13951: </tr>
                   13952: <tr>
1.273     brook    13953: <td>show-var</td>
1.312   ! gdt      13954: <td>show-vars</td>
1.269     leot     13955: </tr>
                   13956: <tr>
1.273     brook    13957: <td>snprintf</td>
1.312   ! gdt      13958: <td>socket</td>
1.289     leot     13959: </tr>
                   13960: <tr>
1.285     rillig   13961: <td>ssp</td>
1.312   ! gdt      13962: <td>st_mode</td>
1.269     leot     13963: </tr>
                   13964: <tr>
1.285     rillig   13965: <td>stage-install</td>
1.312   ! gdt      13966: <td>strcasestr</td>
1.269     leot     13967: </tr>
                   13968: <tr>
1.277     rillig   13969: <td>strict</td>
1.312   ! gdt      13970: <td>strip</td>
1.277     rillig   13971: </tr>
                   13972: <tr>
1.289     leot     13973: <td>strndup</td>
1.312   ! gdt      13974: <td>strnlen</td>
1.269     leot     13975: </tr>
                   13976: <tr>
1.289     leot     13977: <td>strsep</td>
1.312   ! gdt      13978: <td>subst</td>
1.289     leot     13979: </tr>
                   13980: <tr>
                   13981: <td>substitutions</td>
1.312   ! gdt      13982: <td>subversion</td>
1.292     leot     13983: </tr>
                   13984: <tr>
1.290     gutterid 13985: <td>sun</td>
1.312   ! gdt      13986: <td>sunpro</td>
1.311     leot     13987: </tr>
                   13988: <tr>
                   13989: <td>sunwspro</td>
1.312   ! gdt      13990: <td>svn</td>
1.269     leot     13991: </tr>
                   13992: <tr>
1.276     leot     13993: <td>symlink</td>
1.312   ! gdt      13994: <td>test</td>
1.269     leot     13995: </tr>
                   13996: <tr>
1.289     leot     13997: <td>test-env</td>
1.312   ! gdt      13998: <td>tex</td>
1.269     leot     13999: </tr>
                   14000: <tr>
1.289     leot     14001: <td>texlive</td>
1.312   ! gdt      14002: <td>tmp</td>
1.269     leot     14003: </tr>
                   14004: <tr>
1.289     leot     14005: <td>tool</td>
1.312   ! gdt      14006: <td>tools</td>
1.269     leot     14007: </tr>
                   14008: <tr>
1.289     leot     14009: <td>tools-libtool-m4-override</td>
1.312   ! gdt      14010: <td>type</td>
1.269     leot     14011: </tr>
                   14012: <tr>
1.289     leot     14013: <td>ulimit</td>
1.312   ! gdt      14014: <td>undefined</td>
1.269     leot     14015: </tr>
                   14016: <tr>
1.289     leot     14017: <td>undo-replace</td>
1.312   ! gdt      14018: <td>unlimit</td>
1.269     leot     14019: </tr>
                   14020: <tr>
1.289     leot     14021: <td>unprivileged</td>
1.312   ! gdt      14022: <td>unprivileged-install-hook</td>
1.269     leot     14023: </tr>
                   14024: <tr>
1.289     leot     14025: <td>unstripped</td>
1.312   ! gdt      14026: <td>update</td>
1.269     leot     14027: </tr>
                   14028: <tr>
1.289     leot     14029: <td>upload</td>
1.312   ! gdt      14030: <td>upload-distfiles</td>
1.269     leot     14031: </tr>
                   14032: <tr>
1.270     leot     14033: <td>use_tools</td>
1.312   ! gdt      14034: <td>user</td>
1.269     leot     14035: </tr>
                   14036: <tr>
1.270     leot     14037: <td>utimes</td>
1.312   ! gdt      14038: <td>vasprintf</td>
1.269     leot     14039: </tr>
                   14040: <tr>
1.270     leot     14041: <td>verbose</td>
1.312   ! gdt      14042: <td>vsnprintf</td>
1.269     leot     14043: </tr>
                   14044: <tr>
1.270     leot     14045: <td>warn</td>
1.312   ! gdt      14046: <td>warning</td>
1.269     leot     14047: </tr>
                   14048: <tr>
1.270     leot     14049: <td>warnings</td>
1.312   ! gdt      14050: <td>warnx</td>
1.269     leot     14051: </tr>
                   14052: <tr>
1.289     leot     14053: <td>wattr_off</td>
1.312   ! gdt      14054: <td>wattr_on</td>
1.269     leot     14055: </tr>
                   14056: <tr>
1.289     leot     14057: <td>work</td>
1.312   ! gdt      14058: <td>wrapper</td>
1.269     leot     14059: </tr>
                   14060: <tr>
1.289     leot     14061: <td>wrkdir</td>
1.312   ! gdt      14062: <td> </td>
1.269     leot     14063: </tr>
                   14064: </table>
1.267     rillig   14065: </div>
                   14066: <div class="appendix">
                   14067: <div class="titlepage"><div><div><h1 class="title">
                   14068: <a name="editing"></a>Appendix E. Editing guidelines for the pkgsrc guide</h1></div></div></div>
1.75      rillig   14069: <div class="toc">
                   14070: <p><b>Table of Contents</b></p>
1.210     leot     14071: <dl class="toc">
1.267     rillig   14072: <dt><span class="sect1"><a href="#targets">E.1. Make targets</a></span></dt>
                   14073: <dt><span class="sect1"><a href="#procedure">E.2. Procedure</a></span></dt>
1.75      rillig   14074: </dl>
                   14075: </div>
1.79      rillig   14076: <p>This section contains information on editing the pkgsrc
                   14077:        guide itself.</p>
1.148     asau     14078: <div class="sect1">
1.75      rillig   14079: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   14080: <a name="targets"></a>E.1. Make targets</h2></div></div></div>
1.79      rillig   14081: <p>The pkgsrc guide's source code is stored in
                   14082:        <code class="filename">pkgsrc/doc/guide/files</code>, and several files
                   14083:        are created from it:</p>
1.148     asau     14084: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      14085: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
                   14086: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
1.289     leot     14087: <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>
                   14088: <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   14089:        The PDF version of the pkgsrc guide.</p></li>
1.289     leot     14090: <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   14091:        PostScript version of the pkgsrc guide.</p></li>
1.75      rillig   14092: </ul></div>
                   14093: </div>
1.148     asau     14094: <div class="sect1">
1.75      rillig   14095: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   14096: <a name="procedure"></a>E.2. Procedure</h2></div></div></div>
1.79      rillig   14097: <p>The procedure to edit the pkgsrc guide is:</p>
1.128     wiz      14098: <div class="procedure"><ol class="procedure" type="1">
1.304     bacon    14099: <li class="step"><p>Make sure you have checked out the htdocs repository
                   14100:        into a sibling directory of your pkgsrc directory.  You will need
                   14101:        the ability to commit from both pkgsrc and htdocs.</p></li>
1.148     asau     14102: <li class="step"><p>Make sure you have the packages needed to
1.83      wiz      14103:        regenerate the pkgsrc guide (and other XML-based NetBSD
1.151     obache   14104:        documentation) installed. These are automatically installed when
1.250     leot     14105:        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     14106: <li class="step"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.79      rillig   14107:        right directory. All further steps will take place
                   14108:        here.</p></li>
1.148     asau     14109: <li class="step"><p>Edit the XML file(s) in
1.79      rillig   14110:        <code class="filename">files/</code>.</p></li>
1.148     asau     14111: <li class="step"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.79      rillig   14112:        guide for valid XML and to build the final output files. If you
                   14113:        get any errors at this stage, you can just edit the files, as
                   14114:        there are only symbolic links in the working directory, pointing
                   14115:        to the files in <code class="filename">files/</code>.</p></li>
1.148     asau     14116: <li class="step"><p><span class="command"><strong>(cd files &amp;&amp; cvs
1.79      rillig   14117:        commit)</strong></span></p></li>
1.148     asau     14118: <li class="step"><p>Run <span class="command"><strong>bmake clean &amp;&amp; bmake</strong></span> to
1.79      rillig   14119:        regenerate the output files with the proper RCS
                   14120:        Ids.</p></li>
1.148     asau     14121: <li class="step">
1.110     hubertf  14122: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.91      rillig   14123:        commit the files in both <code class="filename">pkgsrc/doc</code> and
                   14124:        <code class="filename">htdocs</code>.</p>
1.148     asau     14125: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.91      rillig   14126: <h3 class="title">Note</h3>
                   14127: <p>If you have added, removed or renamed some chapters,
1.110     hubertf  14128:        you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
                   14129:        <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.91      rillig   14130:        directory.</p>
                   14131: </div>
                   14132: </li>
1.79      rillig   14133: </ol></div>
1.75      rillig   14134: </div>
                   14135: </div>
                   14136: </div></body>
1.1       grant    14137: </html>

CVSweb <webmaster@jp.NetBSD.org>