Annotation of htdocs/docs/pkgsrc/pkgsrc.html, revision 1.203

1.1       dsieger     1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
                      2: <html>
                      3: <head>
                      4: <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
                      5: <title>The pkgsrc guide</title>
1.25      spz         6: <link rel="stylesheet" type="text/css" href="/global.css">
1.1       dsieger     7: <meta name="generator" content="DocBook XSL Stylesheets VX.X.X">
                      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.">
                      9: </head>
1.41      asau       10: <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book">
1.1       dsieger    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.10      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.1       dsieger    22: </div>
                     23: <div class="author">
                     24: <h3 class="author">
                     25: <span class="firstname">Hubert</span> <span class="surname">Feyrer</span>
                     26: </h3>
1.10      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.1       dsieger    28: </div>
                     29: <h3 class="corpauthor">
                     30:         The pkgsrc Developers
                     31:       </h3>
                     32: </div></div>
1.196     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.41      asau       35: <div><div class="abstract">
1.1       dsieger    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.100     leot       48: <dl class="toc">
1.1       dsieger    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>
                     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>
                     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>
                     58: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
                     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.154     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.1       dsieger    65: <dd><dl>
1.154     rillig     66: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.1       dsieger    67: <dd><dl>
1.154     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.1       dsieger    70: </dl></dd>
1.154     rillig     71: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.1       dsieger    72: <dd><dl>
1.154     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.1       dsieger    75: </dl></dd>
                     76: </dl></dd>
1.154     rillig     77: <dt><span class="chapter"><a href="#platforms">4. Using pkgsrc on systems other than NetBSD</a></span></dt>
1.1       dsieger    78: <dd><dl>
1.154     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.1       dsieger    81: </dl></dd>
1.154     rillig     82: <dt><span class="chapter"><a href="#using">5. Using pkgsrc</a></span></dt>
1.1       dsieger    83: <dd><dl>
1.154     rillig     84: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.1       dsieger    85: <dd><dl>
1.154     rillig     86: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
                     87: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
1.202     nia        88: <dt><span class="sect2"><a href="#using.pkgin_update">5.1.3. Updating packages</a></span></dt>
                     89: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.4. Deinstalling packages</a></span></dt>
                     90: <dt><span class="sect2"><a href="#using.pkg_info">5.1.5. Getting information about installed packages</a></span></dt>
                     91: <dt><span class="sect2"><a href="#vulnerabilities">5.1.6. Checking for security vulnerabilities in installed packages</a></span></dt>
                     92: <dt><span class="sect2"><a href="#pkg_versions">5.1.7. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
                     93: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.8. Other administrative functions</a></span></dt>
1.1       dsieger    94: </dl></dd>
1.154     rillig     95: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1.1       dsieger    96: <dd><dl>
1.154     rillig     97: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
                     98: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
                     99: <dt><span class="sect2"><a href="#how-to-build-and-install">5.2.3. How to build and install</a></span></dt>
1.1       dsieger   100: </dl></dd>
                    101: </dl></dd>
1.154     rillig    102: <dt><span class="chapter"><a href="#configuring">6. Configuring pkgsrc</a></span></dt>
1.1       dsieger   103: <dd><dl>
1.154     rillig    104: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
                    105: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
                    106: <dt><span class="sect1"><a href="#variables-affecting-installation">6.3. Variables affecting the installation process</a></span></dt>
                    107: <dt><span class="sect1"><a href="#conf.compiler">6.4. Selecting and configuring the compiler</a></span></dt>
1.1       dsieger   108: <dd><dl>
1.154     rillig    109: <dt><span class="sect2"><a href="#selecting-the-compiler">6.4.1. Selecting the compiler</a></span></dt>
                    110: <dt><span class="sect2"><a href="#conf.cflags">6.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                    111: <dt><span class="sect2"><a href="#conf.ldflags">6.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.1       dsieger   112: </dl></dd>
1.154     rillig    113: <dt><span class="sect1"><a href="#developer-advanced-settings">6.5. Developer/advanced settings</a></span></dt>
                    114: <dt><span class="sect1"><a href="#selecting-build-options">6.6. Selecting Build Options</a></span></dt>
1.1       dsieger   115: </dl></dd>
1.154     rillig    116: <dt><span class="chapter"><a href="#binary">7. Creating binary packages</a></span></dt>
1.1       dsieger   117: <dd><dl>
1.154     rillig    118: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
                    119: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">7.2. Settings for creation of binary packages</a></span></dt>
1.6       rillig    120: </dl></dd>
1.154     rillig    121: <dt><span class="chapter"><a href="#bulk">8. Creating binary packages for everything in pkgsrc (bulk
1.6       rillig    122: builds)</a></span></dt>
1.1       dsieger   123: <dd><dl>
1.154     rillig    124: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
1.180     rillig    125: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a bulk build</a></span></dt>
1.154     rillig    126: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
                    127: <dt><span class="sect1"><a href="#bulk.req">8.3. Requirements of a full bulk build</a></span></dt>
1.178     rillig    128: <dt><span class="sect1"><a href="#bulk.var">8.4. Bulk build variants</a></span></dt>
                    129: <dd><dl>
1.179     rillig    130: <dt><span class="sect2"><a href="#bulk.var.confopt">8.4.1. Detect unknown configure options</a></span></dt>
                    131: <dt><span class="sect2"><a href="#bulk.var.comperr">8.4.2. Detect classes of bugs by forcing compiler warnings</a></span></dt>
1.181     rillig    132: <dt><span class="sect2"><a href="#bulk.var.builderr">8.4.3. Force compiler options only in the build phase</a></span></dt>
                    133: <dt><span class="sect2"><a href="#bulk.var.dirs">8.4.4. Use custom directories</a></span></dt>
                    134: <dt><span class="sect2"><a href="#bulk.var.warn">8.4.5. Turn warnings into errors</a></span></dt>
                    135: <dt><span class="sect2"><a href="#bulk.var.pkglint">8.4.6. Reject packages for which pkglint reports errors</a></span></dt>
                    136: <dt><span class="sect2"><a href="#bulk.var.strings">8.4.7. Reject packages that contain forbidden strings</a></span></dt>
                    137: <dt><span class="sect2"><a href="#bulk.var.test">8.4.8. Reject packages whose self-test fails</a></span></dt>
                    138: <dt><span class="sect2"><a href="#bulk.var.shvar">8.4.9. Reject packages that use undefined shell variables</a></span></dt>
                    139: <dt><span class="sect2"><a href="#bulk.var.quiet">8.4.10. Turn off verbose logging</a></span></dt>
1.178     rillig    140: </dl></dd>
                    141: <dt><span class="sect1"><a href="#creating-cdroms">8.5. Creating a multiple CD-ROM packages collection</a></span></dt>
                    142: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.5.1. Example of cdpack</a></span></dt></dl></dd>
1.154     rillig    143: </dl></dd>
                    144: <dt><span class="chapter"><a href="#files">9. Directory layout of the installed files</a></span></dt>
                    145: <dd><dl>
                    146: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
                    147: <dt><span class="sect1"><a href="#files.varbase">9.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
                    148: </dl></dd>
                    149: <dt><span class="chapter"><a href="#faq">10. Frequently Asked Questions</a></span></dt>
                    150: <dd><dl>
                    151: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                    152: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
                    153: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
                    154: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
                    155: <dt><span class="sect1"><a href="#x.org-from-pkgsrc">10.5. How can I install/use modular X.org from pkgsrc?</a></span></dt>
                    156: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
                    157: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
                    158: <dt><span class="sect1"><a href="#passive-ftp">10.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</a></span></dt>
                    159: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
                    160: <dt><span class="sect1"><a href="#tmac.andoc-missing">10.10. What does <span class="quote">&#8220;<span class="quote">Don't know how to make
1.23      wiz       161: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</a></span></dt>
1.154     rillig    162: <dt><span class="sect1"><a href="#bsd.own.mk-missing">10.11. What does <span class="quote">&#8220;<span class="quote">Could not find bsd.own.mk</span>&#8221;</span> mean?</a></span></dt>
                    163: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' with pkgsrc</a></span></dt>
                    164: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
                    165: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
                    166: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
                    167: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build.  What shall I do?</a></span></dt>
                    168: <dt><span class="sect1"><a href="#faq.rcs-conflicts">10.17. What does <span class="quote">&#8220;<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>&#8221;</span> mean?</a></span></dt>
1.1       dsieger   169: </dl></dd>
                    170: </dl></dd>
                    171: <dt><span class="part"><a href="#developers-guide">II. The pkgsrc developer's guide</a></span></dt>
                    172: <dd><dl>
1.154     rillig    173: <dt><span class="chapter"><a href="#help-devel">11. Getting help</a></span></dt>
1.184     rillig    174: <dt><span class="chapter"><a href="#components">12. Package components - files, directories and contents</a></span></dt>
1.1       dsieger   175: <dd><dl>
1.184     rillig    176: <dt><span class="sect1"><a href="#components.Makefile">12.1. <code class="filename">Makefile</code></a></span></dt>
                    177: <dt><span class="sect1"><a href="#components.distinfo">12.2. <code class="filename">distinfo</code></a></span></dt>
                    178: <dt><span class="sect1"><a href="#components.patches">12.3. <code class="filename">patches/*</code></a></span></dt>
1.1       dsieger   179: <dd><dl>
1.184     rillig    180: <dt><span class="sect2"><a href="#components.patch.structure">12.3.1. Structure of a single patch file</a></span></dt>
                    181: <dt><span class="sect2"><a href="#components.patches.caveats">12.3.2. Creating patch files</a></span></dt>
                    182: <dt><span class="sect2"><a href="#components.patches.sources">12.3.3. Sources where the patch files come from</a></span></dt>
                    183: <dt><span class="sect2"><a href="#components.patches.guidelines">12.3.4. Patching guidelines</a></span></dt>
                    184: <dt><span class="sect2"><a href="#components.patches.feedback">12.3.5. Feedback to the author</a></span></dt>
1.1       dsieger   185: </dl></dd>
1.184     rillig    186: <dt><span class="sect1"><a href="#other-mandatory-files">12.4. Other mandatory files</a></span></dt>
                    187: <dt><span class="sect1"><a href="#components.optional">12.5. Optional files</a></span></dt>
                    188: <dd><dl>
                    189: <dt><span class="sect2"><a href="#components.optional.bin">12.5.1. Files affecting the binary package</a></span></dt>
                    190: <dt><span class="sect2"><a href="#components.optional.build">12.5.2. Files affecting the build process</a></span></dt>
                    191: <dt><span class="sect2"><a href="#components.optional.none">12.5.3. Files affecting nothing at all</a></span></dt>
                    192: </dl></dd>
                    193: <dt><span class="sect1"><a href="#work-dir">12.6. <code class="filename">work*</code></a></span></dt>
                    194: <dt><span class="sect1"><a href="#files-dir">12.7. <code class="filename">files/*</code></a></span></dt>
1.6       rillig    195: </dl></dd>
1.184     rillig    196: <dt><span class="chapter"><a href="#build">13. The build process</a></span></dt>
1.6       rillig    197: <dd><dl>
1.184     rillig    198: <dt><span class="sect1"><a href="#build.intro">13.1. Introduction</a></span></dt>
                    199: <dt><span class="sect1"><a href="#build.prefix">13.2. Program location</a></span></dt>
                    200: <dt><span class="sect1"><a href="#build.builddirs">13.3. Directories used during the build process</a></span></dt>
                    201: <dt><span class="sect1"><a href="#build.running">13.4. Running a phase</a></span></dt>
                    202: <dt><span class="sect1"><a href="#build.fetch">13.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
1.6       rillig    203: <dd><dl>
1.184     rillig    204: <dt><span class="sect2"><a href="#build.fetch.what">13.5.1. What to fetch and where to get it from</a></span></dt>
                    205: <dt><span class="sect2"><a href="#build.fetch.how">13.5.2. How are the files fetched?</a></span></dt>
1.6       rillig    206: </dl></dd>
1.184     rillig    207: <dt><span class="sect1"><a href="#build.checksum">13.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                    208: <dt><span class="sect1"><a href="#build.extract">13.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                    209: <dt><span class="sect1"><a href="#build.patch">13.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                    210: <dt><span class="sect1"><a href="#build.tools">13.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                    211: <dt><span class="sect1"><a href="#build.wrapper">13.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                    212: <dt><span class="sect1"><a href="#build.configure">13.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                    213: <dt><span class="sect1"><a href="#build.build">13.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                    214: <dt><span class="sect1"><a href="#build.test">13.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                    215: <dt><span class="sect1"><a href="#build.install">13.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                    216: <dt><span class="sect1"><a href="#build.package">13.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
                    217: <dt><span class="sect1"><a href="#build.clean">13.16. Cleaning up</a></span></dt>
                    218: <dt><span class="sect1"><a href="#build.helpful-targets">13.17. Other helpful targets</a></span></dt>
                    219: </dl></dd>
                    220: <dt><span class="chapter"><a href="#creating">14. Creating a new pkgsrc package from scratch</a></span></dt>
                    221: <dd><dl>
                    222: <dt><span class="sect1"><a href="#creating.common">14.1. Common types of packages</a></span></dt>
1.6       rillig    223: <dd><dl>
1.184     rillig    224: <dt><span class="sect2"><a href="#creating.perl-module">14.1.1. Perl modules</a></span></dt>
                    225: <dt><span class="sect2"><a href="#creating.python-module">14.1.2. Python modules and programs</a></span></dt>
                    226: <dt><span class="sect2"><a href="#creating.R-package">14.1.3. R packages</a></span></dt>
                    227: <dt><span class="sect2"><a href="#creating.TeX-package">14.1.4. TeXlive packages</a></span></dt>
1.6       rillig    228: </dl></dd>
1.184     rillig    229: <dt><span class="sect1"><a href="#creating.examples">14.2. Examples</a></span></dt>
                    230: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">14.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
1.6       rillig    231: </dl></dd>
1.184     rillig    232: <dt><span class="chapter"><a href="#makefile">15. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.6       rillig    233: <dd><dl>
1.184     rillig    234: <dt><span class="sect1"><a href="#makefile.style">15.1. Caveats</a></span></dt>
                    235: <dt><span class="sect1"><a href="#makefile.variables">15.2. <code class="filename">Makefile</code> variables</a></span></dt>
                    236: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">15.2.1. Naming conventions</a></span></dt></dl></dd>
                    237: <dt><span class="sect1"><a href="#makefile.code">15.3. Code snippets</a></span></dt>
1.6       rillig    238: <dd><dl>
1.184     rillig    239: <dt><span class="sect2"><a href="#adding-to-list">15.3.1. Adding things to a list</a></span></dt>
                    240: <dt><span class="sect2"><a href="#echo-literal">15.3.2. Echoing a string exactly as-is</a></span></dt>
                    241: <dt><span class="sect2"><a href="#cflags-gnu-configure">15.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</a></span></dt>
                    242: <dt><span class="sect2"><a href="#empty-variables">15.3.4. Handling possibly empty variables</a></span></dt>
1.6       rillig    243: </dl></dd>
                    244: </dl></dd>
1.184     rillig    245: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
1.6       rillig    246: <dd><dl>
1.184     rillig    247: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
                    248: <dt><span class="sect1"><a href="#converting-to-options">16.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
                    249: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
                    250: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
1.6       rillig    251: </dl></dd>
1.184     rillig    252: <dt><span class="chapter"><a href="#tools">17. Tools needed for building or running</a></span></dt>
1.6       rillig    253: <dd><dl>
1.184     rillig    254: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
                    255: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
                    256: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
                    257: </dl></dd>
                    258: <dt><span class="chapter"><a href="#buildlink">18. Buildlink methodology</a></span></dt>
                    259: <dd><dl>
                    260: <dt><span class="sect1"><a href="#converting-to-buildlink3">18.1. Converting packages to use buildlink3</a></span></dt>
                    261: <dt><span class="sect1"><a href="#creating-buildlink3.mk">18.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6       rillig    262: <dd><dl>
1.184     rillig    263: <dt><span class="sect2"><a href="#anatomy-of-bl3">18.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
                    264: <dt><span class="sect2"><a href="#updating-buildlink-depends">18.2.2. Updating
1.26      wiz       265:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                    266:       and
                    267:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                    268:       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6       rillig    269: </dl></dd>
1.184     rillig    270: <dt><span class="sect1"><a href="#writing-builtin.mk">18.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
                    271: <dd><dl>
                    272: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">18.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
                    273: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">18.3.2. Global preferences for native or pkgsrc software</a></span></dt>
                    274: </dl></dd>
                    275: </dl></dd>
                    276: <dt><span class="chapter"><a href="#plist">19. PLIST issues</a></span></dt>
1.6       rillig    277: <dd><dl>
1.184     rillig    278: <dt><span class="sect1"><a href="#rcs-id">19.1. RCS ID</a></span></dt>
                    279: <dt><span class="sect1"><a href="#automatic-plist-generation">19.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                    280: <dt><span class="sect1"><a href="#print-PLIST">19.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
                    281: <dt><span class="sect1"><a href="#plist.misc">19.4. Variable substitution in PLIST</a></span></dt>
                    282: <dt><span class="sect1"><a href="#manpage-compression">19.5. Man page compression</a></span></dt>
                    283: <dt><span class="sect1"><a href="#using-PLIST_SRC">19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
                    284: <dt><span class="sect1"><a href="#platform-specific-plist">19.7. Platform-specific and differing PLISTs</a></span></dt>
                    285: <dt><span class="sect1"><a href="#build-plist">19.8. Build-specific PLISTs</a></span></dt>
                    286: <dt><span class="sect1"><a href="#faq.common-dirs">19.9. Sharing directories between packages</a></span></dt>
1.6       rillig    287: </dl></dd>
1.184     rillig    288: <dt><span class="chapter"><a href="#pkginstall">20. The pkginstall framework</a></span></dt>
                    289: <dd><dl>
                    290: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">20.1. Files and directories outside the installation prefix</a></span></dt>
                    291: <dd><dl>
                    292: <dt><span class="sect2"><a href="#dirs-outside-prefix">20.1.1. Directory manipulation</a></span></dt>
                    293: <dt><span class="sect2"><a href="#files-outside-prefix">20.1.2. File manipulation</a></span></dt>
1.6       rillig    294: </dl></dd>
1.184     rillig    295: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
1.6       rillig    296: <dd><dl>
1.184     rillig    297: <dt><span class="sect2"><a href="#conf-files-sysconfdir">20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
                    298: <dt><span class="sect2"><a href="#conf-files-configure">20.2.2. Telling the software where configuration files are</a></span></dt>
                    299: <dt><span class="sect2"><a href="#conf-files-patching">20.2.3. Patching installations</a></span></dt>
                    300: <dt><span class="sect2"><a href="#conf-files-disable">20.2.4. Disabling handling of configuration files</a></span></dt>
                    301: </dl></dd>
                    302: <dt><span class="sect1"><a href="#rcd-scripts">20.3. System startup scripts</a></span></dt>
                    303: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">20.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
                    304: <dt><span class="sect1"><a href="#users-and-groups">20.4. System users and groups</a></span></dt>
                    305: <dt><span class="sect1"><a href="#shells">20.5. System shells</a></span></dt>
                    306: <dd><dl><dt><span class="sect2"><a href="#shells-disable">20.5.1. Disabling shell registration</a></span></dt></dl></dd>
                    307: <dt><span class="sect1"><a href="#fonts">20.6. Fonts</a></span></dt>
                    308: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">20.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
1.154     rillig    309: </dl></dd>
                    310: <dt><span class="chapter"><a href="#fixes">21. Making your package work</a></span></dt>
                    311: <dd><dl>
                    312: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
                    313: <dd><dl>
                    314: <dt><span class="sect2"><a href="#pulling-vars-from-etc-mk.conf">21.1.1. How to pull in user-settable variables from <code class="filename">mk.conf</code></a></span></dt>
                    315: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
                    316: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
                    317: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
                    318: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
                    319: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
                    320: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
                    321: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
                    322: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
                    323: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
                    324: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                    325: </dl></dd>
                    326: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                    327: <dd><dl>
                    328: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                    329: <dt><span class="sect2"><a href="#modified-distfiles-same-name">21.2.2. How to handle modified distfiles with the 'old' name</a></span></dt>
                    330: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
                    331: </dl></dd>
                    332: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                    333: <dd><dl>
                    334: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
                    335: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                    336: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
                    337: </dl></dd>
                    338: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
                    339: <dd><dl>
                    340: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
                    341: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
1.203   ! nia       342: <dt><span class="sect2"><a href="#perl-scripts">21.4.3. Packages containing Perl scripts</a></span></dt>
1.154     rillig    343: <dt><span class="sect2"><a href="#shell-scripts">21.4.4. Packages containing shell scripts</a></span></dt>
                    344: <dt><span class="sect2"><a href="#other-programming-languages">21.4.5. Other programming languages</a></span></dt>
                    345: </dl></dd>
                    346: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                    347: <dd><dl>
                    348: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
                    349: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.172     rillig    350: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
                    351: <dt><span class="sect2"><a href="#undefined-reference">21.5.4. Undefined reference to <span class="quote">&#8220;<span class="quote">...</span>&#8221;</span></a></span></dt>
                    352: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.154     rillig    353: </dl></dd>
                    354: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                    355: <dd><dl>
                    356: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
                    357: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
                    358: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
                    359: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
                    360: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
1.203   ! nia       361: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing Perl modules</a></span></dt>
1.154     rillig    362: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
                    363: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
1.203   ! nia       364: <dt><span class="sect2"><a href="#x11-fonts">21.6.9. Packages installing X11 fonts</a></span></dt>
        !           365: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.10. Packages installing SGML or XML data</a></span></dt>
        !           366: <dt><span class="sect2"><a href="#mime-database">21.6.11. Packages installing extensions to the MIME database</a></span></dt>
        !           367: <dt><span class="sect2"><a href="#intltool">21.6.12. Packages using intltool</a></span></dt>
        !           368: <dt><span class="sect2"><a href="#startup-scripts">21.6.13. Packages installing startup scripts</a></span></dt>
        !           369: <dt><span class="sect2"><a href="#tex-packages">21.6.14. Packages installing TeX modules</a></span></dt>
        !           370: <dt><span class="sect2"><a href="#emulation-packages">21.6.15. Packages supporting running binaries in
1.1       dsieger   371:     emulation</a></span></dt>
1.203   ! nia       372: <dt><span class="sect2"><a href="#hicolor-theme">21.6.16. Packages installing hicolor icons</a></span></dt>
        !           373: <dt><span class="sect2"><a href="#desktop-files">21.6.17. Packages installing desktop files</a></span></dt>
1.1       dsieger   374: </dl></dd>
1.154     rillig    375: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.1       dsieger   376: </dl></dd>
1.184     rillig    377: <dt><span class="chapter"><a href="#gnome">22. GNOME packaging and porting</a></span></dt>
                    378: <dd><dl>
                    379: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
                    380: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
                    381: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
                    382: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
                    383: </dl></dd>
1.154     rillig    384: <dt><span class="chapter"><a href="#submit">23. Submitting and Committing</a></span></dt>
1.1       dsieger   385: <dd><dl>
1.154     rillig    386: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
                    387: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                    388: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
                    389: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
                    390: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
                    391: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
                    392: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
                    393: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
                    394: </dl></dd>
                    395: <dt><span class="chapter"><a href="#devfaq">24. Frequently Asked Questions</a></span></dt>
1.1       dsieger   396: </dl></dd>
                    397: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
                    398: <dd><dl>
1.184     rillig    399: <dt><span class="chapter"><a href="#infr.design">25. Design of the pkgsrc infrastructure</a></span></dt>
1.1       dsieger   400: <dd><dl>
1.184     rillig    401: <dt><span class="sect1"><a href="#infr.vardef">25.1. The meaning of variable definitions</a></span></dt>
                    402: <dt><span class="sect1"><a href="#infr.vardef.problems">25.2. Avoiding problems before they arise</a></span></dt>
                    403: <dt><span class="sect1"><a href="#infr.var">25.3. Variable evaluation</a></span></dt>
1.1       dsieger   404: <dd><dl>
1.184     rillig    405: <dt><span class="sect2"><a href="#infr.var.load">25.3.1. At load time</a></span></dt>
                    406: <dt><span class="sect2"><a href="#infr.var.run">25.3.2. At runtime</a></span></dt>
1.1       dsieger   407: </dl></dd>
1.184     rillig    408: <dt><span class="sect1"><a href="#infr.varspec">25.4. How can variables be specified?</a></span></dt>
                    409: <dt><span class="sect1"><a href="#infr.design.intf">25.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1       dsieger   410: <dd><dl>
1.184     rillig    411: <dt><span class="sect2"><a href="#infr.design.intf.proc">25.5.1. Procedures with parameters</a></span></dt>
                    412: <dt><span class="sect2"><a href="#infr.design.intf.action">25.5.2. Actions taken on behalf of parameters</a></span></dt>
1.1       dsieger   413: </dl></dd>
1.184     rillig    414: <dt><span class="sect1"><a href="#infr.order">25.6. The order in which files are loaded</a></span></dt>
1.1       dsieger   415: <dd><dl>
1.184     rillig    416: <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>
                    417: <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.1       dsieger   418: </dl></dd>
                    419: </dl></dd>
1.184     rillig    420: <dt><span class="chapter"><a href="#regression">26. Regression tests</a></span></dt>
1.1       dsieger   421: <dd><dl>
1.184     rillig    422: <dt><span class="sect1"><a href="#regression.run">26.1. Running the regression tests</a></span></dt>
                    423: <dt><span class="sect1"><a href="#regression.new">26.2. Adding a new regression test</a></span></dt>
1.1       dsieger   424: <dd><dl>
1.184     rillig    425: <dt><span class="sect2"><a href="#regression.fun.override">26.2.1. Overridable functions</a></span></dt>
                    426: <dt><span class="sect2"><a href="#regression.fun.helper">26.2.2. Helper functions</a></span></dt>
1.1       dsieger   427: </dl></dd>
                    428: </dl></dd>
1.184     rillig    429: <dt><span class="chapter"><a href="#porting">27. Porting pkgsrc</a></span></dt>
                    430: <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.1       dsieger   431: </dl></dd>
                    432: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
                    433: <dd><dl>
                    434: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
                    435: <dd><dl>
                    436: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
                    437: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
                    438: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.172     rillig    439: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with pkglint</a></span></dt>
1.1       dsieger   440: </dl></dd>
                    441: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
                    442: </dl></dd>
                    443: <dt><span class="appendix"><a href="#logs">B. Build logs</a></span></dt>
                    444: <dd><dl>
                    445: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
                    446: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
                    447: </dl></dd>
                    448: <dt><span class="appendix"><a href="#ftp-layout">C. Directory layout of the pkgsrc FTP server</a></span></dt>
                    449: <dd><dl>
1.23      wiz       450: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
                    451: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
                    452: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
                    453: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
                    454: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
1.148     leot      455: <code class="filename">stable</code>,
1.23      wiz       456: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1       dsieger   457: source packages</a></span></dt>
                    458: </dl></dd>
1.154     rillig    459: <dt><span class="appendix"><a href="#help-topics">D. Help topics</a></span></dt>
                    460: <dt><span class="appendix"><a href="#editing">E. Editing guidelines for the pkgsrc guide</a></span></dt>
1.1       dsieger   461: <dd><dl>
1.154     rillig    462: <dt><span class="sect1"><a href="#targets">E.1. Make targets</a></span></dt>
                    463: <dt><span class="sect1"><a href="#procedure">E.2. Procedure</a></span></dt>
1.1       dsieger   464: </dl></dd>
                    465: </dl>
                    466: </div>
                    467: <div class="list-of-tables">
                    468: <p><b>List of Tables</b></p>
                    469: <dl>
                    470: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
                    471: </dt>
1.184     rillig    472: <dt>12.1. <a href="#patch-examples">Patching examples</a>
1.1       dsieger   473: </dt>
1.184     rillig    474: <dt>22.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.1       dsieger   475: </dt>
                    476: </dl>
                    477: </div>
1.41      asau      478: <div class="chapter">
                    479: <div class="titlepage"><div><div><h1 class="title">
                    480: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h1></div></div></div>
1.1       dsieger   481: <div class="toc">
                    482: <p><b>Table of Contents</b></p>
1.100     leot      483: <dl class="toc">
1.1       dsieger   484: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
                    485: <dd><dl>
                    486: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
                    487: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
                    488: </dl></dd>
                    489: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
                    490: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
                    491: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
                    492: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
                    493: </dl>
                    494: </div>
1.41      asau      495: <div class="sect1">
1.1       dsieger   496: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    497: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
                    498: <p>There is a lot of software freely available for Unix-based
                    499: systems, which is usually available in form of the source code. Before
                    500: such software can be used, it needs to be configured to the local
                    501: system, compiled and installed, and this is exactly what The NetBSD
                    502: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
                    503: to handle binary packages, so that not every user has to build the
                    504: packages for himself, which is a time-costly task.</p>
                    505: <p>pkgsrc currently contains several thousand packages,
                    506:       including:</p>
1.41      asau      507: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.137     leot      508: <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.1       dsieger   509:          web server</p></li>
1.137     leot      510: <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.1       dsieger   511:          web browser</p></li>
1.137     leot      512: <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.1       dsieger   513:          Desktop Environment</p></li>
1.137     leot      514: <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.1       dsieger   515:          Desktop Environment</p></li>
                    516: </ul></div>
1.108     rillig    517: <p>&#8230; just to name a few.</p>
1.1       dsieger   518: <p>pkgsrc has built-in support for handling varying dependencies,
                    519:       such as pthreads and X11, and extended features such as IPv6 support on
                    520:       a range of platforms.</p>
1.41      asau      521: <div class="sect2">
1.1       dsieger   522: <div class="titlepage"><div><div><h3 class="title">
                    523: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
                    524: <p>
                    525: pkgsrc provides the following key features:
                    526: </p>
1.41      asau      527: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz       528: <li class="listitem"><p>Easy building of software from source as well as the creation
1.1       dsieger   529:   and installation of binary packages. The source and latest
                    530:   patches are retrieved from a master or mirror download site, checksum
                    531:   verified, then built on your system. Support for binary-only
                    532:   distributions is available for both native platforms and NetBSD
                    533:   emulated platforms.</p></li>
1.23      wiz       534: <li class="listitem"><p>All packages are installed in a consistent directory tree,
1.1       dsieger   535:   including binaries, libraries, man pages and other
                    536:   documentation.</p></li>
1.104     sevan     537: <li class="listitem"><p>Tracking of package dependencies automatically, including when
                    538:   performing updates, to ensure required packages are installed. The
                    539:   configuration files of various packages are handled automatically during
                    540:   updates, so local changes are preserved.</p></li>
1.23      wiz       541: <li class="listitem"><p>Like NetBSD, pkgsrc is designed with portability in mind and
1.1       dsieger   542:   consists of highly portable code. This allows the greatest speed of
1.25      spz       543:   development when porting to a new platform. This portability also
1.1       dsieger   544:   ensures that pkgsrc is <span class="emphasis"><em>consistent across all
                    545:   platforms</em></span>.</p></li>
1.23      wiz       546: <li class="listitem"><p>The installation prefix, acceptable software licenses,
1.1       dsieger   547:   international encryption requirements and build-time options for a
                    548:   large number of packages are all set in a simple, central
                    549:   configuration file.</p></li>
1.23      wiz       550: <li class="listitem"><p>The entire source (not including the distribution files) is
1.1       dsieger   551:   freely available under a BSD license, so you may extend and adapt
                    552:   pkgsrc to your needs. Support for local packages and patches is
                    553:   available right out of the box, so you can configure it specifically
                    554:   for your environment.</p></li>
                    555: </ul></div>
                    556: <p>The following principles are basic to pkgsrc:</p>
1.41      asau      557: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz       558: <li class="listitem"><p><span class="quote">&#8220;<span class="quote">It should only work if it's right.</span>&#8221;</span>
1.14      jmcneill  559: &mdash; That means, if a package contains bugs, it's better to find
1.1       dsieger   560: them and to complain about them rather than to just install the package
                    561: and hope that it works. There are numerous checks in pkgsrc that try to
1.175     gutterid  562: 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.1       dsieger   563: of shell scripts), and post-installation checks (installed files,
                    564: references to shared libraries, script interpreters).</p></li>
1.23      wiz       565: <li class="listitem"><p><span class="quote">&#8220;<span class="quote">If it works, it should work everywhere</span>&#8221;</span>
1.14      jmcneill  566: &mdash; Like NetBSD has been ported to many hardware architectures,
1.1       dsieger   567: pkgsrc has been ported to many operating systems. Care is taken that
                    568: packages behave the same on all platforms.</p></li>
                    569: </ul></div>
                    570: </div>
1.41      asau      571: <div class="sect2">
1.1       dsieger   572: <div class="titlepage"><div><div><h3 class="title">
                    573: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
                    574: <p>pkgsrc consists of both a source distribution and a binary
                    575: distribution for these operating systems. After retrieving the required
                    576: source or binaries, you can be up and running with pkgsrc in just
                    577: minutes!</p>
                    578: <p>pkgsrc was derived from FreeBSD's ports system, and
                    579:       initially developed for NetBSD only. Since then, pkgsrc has
                    580:       grown a lot, and now supports the following platforms:</p>
                    581: <div class="table">
                    582: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.106     tnn       583: <div class="table-contents"><table class="table" summary="Platforms supported by pkgsrc" border="1">
1.1       dsieger   584: <colgroup>
                    585: <col>
                    586: <col>
1.92      sevan     587: <col>
1.1       dsieger   588: </colgroup>
                    589: <thead><tr>
                    590: <th>Platform</th>
                    591: <th>Date Support Added</th>
1.92      sevan     592: <th>Notes</th>
1.1       dsieger   593: </tr></thead>
                    594: <tbody>
                    595: <tr>
1.174     leot      596: <td><a class="ulink" href="https://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.1       dsieger   597: <td align="center">Aug 1997</td>
1.92      sevan     598: <td class="auto-generated"> </td>
1.1       dsieger   599: </tr>
                    600: <tr>
1.10      hubertf   601: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.1       dsieger   602: <td align="center">Mar 1999</td>
1.151     sevan     603: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Solaris" target="_top">README.Solaris</a></td>
1.1       dsieger   604: </tr>
                    605: <tr>
1.174     leot      606: <td><a class="ulink" href="https://www.kernel.org/" target="_top">Linux</a></td>
1.1       dsieger   607: <td align="center">Jun 1999</td>
1.151     sevan     608: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Linux" target="_top">README.Linux</a></td>
1.1       dsieger   609: </tr>
                    610: <tr>
                    611: <td>
1.118     sevan     612:           <a class="ulink" href="https://developer.apple.com/macos/" target="_top">Darwin / Mac OS X / OS X / macOS</a>
1.1       dsieger   613:         </td>
                    614: <td align="center">Oct 2001</td>
1.191     bacon     615: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.macOS" target="_top">README.macOS</a></td>
1.1       dsieger   616: </tr>
                    617: <tr>
1.174     leot      618: <td><a class="ulink" href="https://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.1       dsieger   619: <td align="center">Nov 2002</td>
1.151     sevan     620: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.FreeBSD" target="_top">README.FreeBSD</a></td>
1.1       dsieger   621: </tr>
                    622: <tr>
1.174     leot      623: <td><a class="ulink" href="https://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.1       dsieger   624: <td align="center">Nov 2002</td>
1.151     sevan     625: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.OpenBSD" target="_top">README.OpenBSD</a></td>
1.1       dsieger   626: </tr>
                    627: <tr>
1.174     leot      628: <td><a class="ulink" href="https://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.1       dsieger   629: <td align="center">Dec 2002</td>
1.92      sevan     630: <td>
1.151     sevan     631:        <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.IRIX" target="_top">README.IRIX</a>
                    632:        <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.IRIX5.3" target="_top">README.IRIX5.3</a>
1.92      sevan     633:        </td>
1.1       dsieger   634: </tr>
                    635: <tr>
                    636: <td>BSD/OS</td>
                    637: <td align="center">Dec 2003</td>
1.92      sevan     638: <td class="auto-generated"> </td>
1.1       dsieger   639: </tr>
                    640: <tr>
1.174     leot      641: <td><a class="ulink" href="https://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.1       dsieger   642: <td align="center">Dec 2003</td>
1.151     sevan     643: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.AIX" target="_top">README.AIX</a></td>
1.1       dsieger   644: </tr>
                    645: <tr>
                    646: <td>
1.174     leot      647:           <a class="ulink" href="https://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.1       dsieger   648:           (Microsoft Windows Services for Unix)
                    649:         </td>
                    650: <td align="center">Mar 2004</td>
1.151     sevan     651: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Interix" target="_top">README.Interix</a></td>
1.1       dsieger   652: </tr>
                    653: <tr>
1.174     leot      654: <td><a class="ulink" href="https://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.1       dsieger   655: <td align="center">Oct 2004</td>
1.92      sevan     656: <td class="auto-generated"> </td>
1.1       dsieger   657: </tr>
                    658: <tr>
1.10      hubertf   659: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.1       dsieger   660: <td align="center">Nov 2004</td>
1.151     sevan     661: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.OSF1" target="_top">README.OSF1</a></td>
1.1       dsieger   662: </tr>
                    663: <tr>
1.174     leot      664: <td><a class="ulink" href="https://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.1       dsieger   665: <td align="center">Apr 2007</td>
1.151     sevan     666: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.HPUX" target="_top">README.HPUX</a></td>
1.1       dsieger   667: </tr>
1.23      wiz       668: <tr>
1.174     leot      669: <td><a class="ulink" href="https://www.haiku-os.org/" target="_top">Haiku</a></td>
1.23      wiz       670: <td align="center">Sep 2010</td>
1.151     sevan     671: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Haiku" target="_top">README.Haiku</a></td>
1.23      wiz       672: </tr>
1.45      obache    673: <tr>
1.174     leot      674: <td><a class="ulink" href="https://www.mirbsd.org/" target="_top">MirBSD</a></td>
1.57      bsiegert  675: <td align="center">Jan 2011</td>
1.92      sevan     676: <td class="auto-generated"> </td>
1.45      obache    677: </tr>
                    678: <tr>
1.174     leot      679: <td><a class="ulink" href="https://www.minix3.org/" target="_top">Minix3</a></td>
1.45      obache    680: <td align="center">Nov 2011</td>
1.151     sevan     681: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Minix3" target="_top">README.Minix3</a></td>
1.45      obache    682: </tr>
                    683: <tr>
1.174     leot      684: <td><a class="ulink" href="https://cygwin.com/" target="_top">Cygwin</a></td>
1.45      obache    685: <td align="center">Mar 2013</td>
1.151     sevan     686: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Cygwin" target="_top">README.Cygwin</a></td>
1.45      obache    687: </tr>
1.58      ryoon     688: <tr>
1.174     leot      689: <td><a class="ulink" href="https://www.debian.org/ports/kfreebsd-gnu/" target="_top">GNU/kFreeBSD</a></td>
1.58      ryoon     690: <td align="center">Jul 2013</td>
1.151     sevan     691: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.GNUkFreeBSD" target="_top">README.GNUkFreeBSD</a></td>
1.58      ryoon     692: </tr>
1.104     sevan     693: <tr>
1.174     leot      694: <td><a class="ulink" href="https://www.bitrig.org/" target="_top">Bitrig</a></td>
1.104     sevan     695: <td align="center">Jun 2014</td>
1.151     sevan     696: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Bitrig" target="_top">README.Bitrig</a></td>
1.104     sevan     697: </tr>
1.1       dsieger   698: </tbody>
                    699: </table></div>
                    700: </div>
                    701: <br class="table-break">
                    702: </div>
                    703: </div>
1.41      asau      704: <div class="sect1">
1.1       dsieger   705: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    706: <a name="overview"></a>1.2. Overview</h2></div></div></div>
                    707: <p>This document is divided into three parts. The first,
1.10      hubertf   708:        <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.1       dsieger   709:        describes how one can use one of the packages in the Package
                    710:        Collection, either by installing a precompiled binary package,
                    711:        or by building one's own copy using the NetBSD package system.
1.10      hubertf   712:        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.1       dsieger   713:        package so it can be easily built by other NetBSD users without
                    714:        knowing about the package's building details. The third part,
1.10      hubertf   715:        <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.1       dsieger   716:        is intended for those who want to understand how pkgsrc is
                    717:        implemented.</p>
                    718: <p>This document is available in various formats:
1.10      hubertf   719:        <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.1       dsieger   720: </div>
1.41      asau      721: <div class="sect1">
1.1       dsieger   722: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    723: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
1.23      wiz       724: <p>There has been a lot of talk about <span class="quote">&#8220;<span class="quote">ports</span>&#8221;</span>,
                    725:       <span class="quote">&#8220;<span class="quote">packages</span>&#8221;</span>, etc. so far. Here is a description of all the
1.1       dsieger   726:       terminology used within this document.</p>
1.41      asau      727: <div class="variablelist"><dl class="variablelist">
1.1       dsieger   728: <dt><span class="term">Package</span></dt>
                    729: <dd><p>A set of files and building instructions
                    730:            that describe what's necessary
                    731:            to build a certain piece of software using
                    732:             pkgsrc. Packages are traditionally stored under
1.123     wiz       733:            <code class="filename">/usr/pkgsrc</code>,
                    734:            but may be stored in any location,
                    735:            referred to as <code class="varname">PKGSRCDIR</code>.</p></dd>
1.1       dsieger   736: <dt><span class="term">The NetBSD package system</span></dt>
1.23      wiz       737: <dd><p>This is the former name of <span class="quote">&#8220;<span class="quote">pkgsrc</span>&#8221;</span>.  It
1.1       dsieger   738:          is part of the NetBSD operating system and can be bootstrapped
                    739:          to run on non-NetBSD operating systems as well.  It handles
                    740:          building (compiling), installing, and removing of
                    741:          packages.</p></dd>
                    742: <dt><span class="term">Distfile</span></dt>
                    743: <dd><p>This term describes the file or files that are
                    744:            provided by the author of the piece of software to
                    745:            distribute his work. All the changes necessary to build on
                    746:            NetBSD are reflected in the corresponding package. Usually
                    747:            the distfile is in the form of a compressed tar-archive,
                    748:            but other types are possible, too. Distfiles are usually
                    749:            stored below
                    750:            <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
                    751: <dt><span class="term">Port</span></dt>
                    752: <dd><p>This is the term used by FreeBSD and OpenBSD people
                    753:            for what we call a package.
1.23      wiz       754:            In NetBSD terminology, <span class="quote">&#8220;<span class="quote">port</span>&#8221;</span> refers to a different
1.1       dsieger   755:            architecture.</p></dd>
                    756: <dt><span class="term">Precompiled/binary package</span></dt>
                    757: <dd>
                    758: <p>A set of binaries built with pkgsrc from a distfile
                    759:            and stuffed together in a single <code class="filename">.tgz</code>
                    760:            file so it can be installed on machines of the same
                    761:            machine architecture without the need to
                    762:            recompile. Packages are usually generated in
                    763:            <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.25      spz       764:            an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.23      wiz       765: <p>Sometimes, this is referred to by the term <span class="quote">&#8220;<span class="quote">package</span>&#8221;</span> too,
1.1       dsieger   766:            especially in the context of precompiled packages.</p>
                    767: </dd>
                    768: <dt><span class="term">Program</span></dt>
                    769: <dd><p>The piece of software to be installed which will be
                    770:          constructed from all the files in the distfile by the
                    771:          actions defined in the corresponding package.</p></dd>
                    772: </dl></div>
1.41      asau      773: <div class="sect2">
1.1       dsieger   774: <div class="titlepage"><div><div><h3 class="title">
                    775: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.41      asau      776: <div class="variablelist"><dl class="variablelist">
1.1       dsieger   777: <dt><span class="term">pkgsrc users</span></dt>
                    778: <dd>
                    779: <p>The
                    780:        pkgsrc users are people who use the packages provided by pkgsrc.
                    781:        Typically they are system administrators. The people using the
1.23      wiz       782:        software that is inside the packages (maybe called <span class="quote">&#8220;<span class="quote">end
                    783:        users</span>&#8221;</span>) are not covered by the pkgsrc guide.</p>
1.1       dsieger   784: <p>There are two kinds of pkgsrc users: Some only want to
                    785:        install pre-built binary packages. Others build the pkgsrc
                    786:        packages from source, either for installing them directly or for
1.10      hubertf   787:        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.1       dsieger   788:        documentation.</p>
                    789: </dd>
                    790: <dt><span class="term">package maintainers</span></dt>
                    791: <dd><p>A
1.10      hubertf   792:        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.1       dsieger   793: <dt><span class="term">infrastructure developers</span></dt>
                    794: <dd><p>These people are involved in all those files
                    795:        that live in the <code class="filename">mk/</code> directory and below.
1.10      hubertf   796:        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.1       dsieger   797:        too.</p></dd>
                    798: </dl></div>
                    799: </div>
                    800: </div>
1.41      asau      801: <div class="sect1">
1.1       dsieger   802: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    803: <a name="typography"></a>1.4. Typography</h2></div></div></div>
                    804: <p>When giving examples for commands, shell prompts are used to
                    805:       show if the command should/can be issued as root, or if
1.23      wiz       806:       <span class="quote">&#8220;<span class="quote">normal</span>&#8221;</span> user privileges are sufficient. We use a
1.115     sevan     807:       <code class="prompt">#</code> for root's shell prompt, a <code class="prompt">%</code> for users'
                    808:       shell prompt, assuming they use the C-shell or tcsh and a <code class="prompt">$</code> for
                    809:       bourne shell and derivatives.</p>
1.1       dsieger   810: </div>
                    811: </div>
1.41      asau      812: <div class="part">
1.1       dsieger   813: <div class="titlepage"><div><div><h1 class="title">
                    814: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
                    815: <div class="toc">
                    816: <p><b>Table of Contents</b></p>
1.100     leot      817: <dl class="toc">
1.154     rillig    818: <dt><span class="chapter"><a href="#help-user">2. Getting help</a></span></dt>
                    819: <dt><span class="chapter"><a href="#getting">3. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
1.1       dsieger   820: <dd><dl>
1.154     rillig    821: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.1       dsieger   822: <dd><dl>
1.154     rillig    823: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
                    824: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.1       dsieger   825: </dl></dd>
1.154     rillig    826: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.1       dsieger   827: <dd><dl>
1.154     rillig    828: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
                    829: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.1       dsieger   830: </dl></dd>
                    831: </dl></dd>
1.154     rillig    832: <dt><span class="chapter"><a href="#platforms">4. Using pkgsrc on systems other than NetBSD</a></span></dt>
1.1       dsieger   833: <dd><dl>
1.154     rillig    834: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
                    835: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.1       dsieger   836: </dl></dd>
1.154     rillig    837: <dt><span class="chapter"><a href="#using">5. Using pkgsrc</a></span></dt>
1.1       dsieger   838: <dd><dl>
1.154     rillig    839: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.1       dsieger   840: <dd><dl>
1.154     rillig    841: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
                    842: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
1.202     nia       843: <dt><span class="sect2"><a href="#using.pkgin_update">5.1.3. Updating packages</a></span></dt>
                    844: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.4. Deinstalling packages</a></span></dt>
                    845: <dt><span class="sect2"><a href="#using.pkg_info">5.1.5. Getting information about installed packages</a></span></dt>
                    846: <dt><span class="sect2"><a href="#vulnerabilities">5.1.6. Checking for security vulnerabilities in installed packages</a></span></dt>
                    847: <dt><span class="sect2"><a href="#pkg_versions">5.1.7. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
                    848: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.8. Other administrative functions</a></span></dt>
1.1       dsieger   849: </dl></dd>
1.154     rillig    850: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1.1       dsieger   851: <dd><dl>
1.154     rillig    852: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
                    853: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
                    854: <dt><span class="sect2"><a href="#how-to-build-and-install">5.2.3. How to build and install</a></span></dt>
1.1       dsieger   855: </dl></dd>
                    856: </dl></dd>
1.154     rillig    857: <dt><span class="chapter"><a href="#configuring">6. Configuring pkgsrc</a></span></dt>
1.1       dsieger   858: <dd><dl>
1.154     rillig    859: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
                    860: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
                    861: <dt><span class="sect1"><a href="#variables-affecting-installation">6.3. Variables affecting the installation process</a></span></dt>
                    862: <dt><span class="sect1"><a href="#conf.compiler">6.4. Selecting and configuring the compiler</a></span></dt>
1.1       dsieger   863: <dd><dl>
1.154     rillig    864: <dt><span class="sect2"><a href="#selecting-the-compiler">6.4.1. Selecting the compiler</a></span></dt>
                    865: <dt><span class="sect2"><a href="#conf.cflags">6.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                    866: <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.1       dsieger   867: </dl></dd>
1.154     rillig    868: <dt><span class="sect1"><a href="#developer-advanced-settings">6.5. Developer/advanced settings</a></span></dt>
                    869: <dt><span class="sect1"><a href="#selecting-build-options">6.6. Selecting Build Options</a></span></dt>
1.1       dsieger   870: </dl></dd>
1.154     rillig    871: <dt><span class="chapter"><a href="#binary">7. Creating binary packages</a></span></dt>
1.1       dsieger   872: <dd><dl>
1.154     rillig    873: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
                    874: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">7.2. Settings for creation of binary packages</a></span></dt>
1.6       rillig    875: </dl></dd>
1.154     rillig    876: <dt><span class="chapter"><a href="#bulk">8. Creating binary packages for everything in pkgsrc (bulk
1.6       rillig    877: builds)</a></span></dt>
1.1       dsieger   878: <dd><dl>
1.154     rillig    879: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
1.180     rillig    880: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a bulk build</a></span></dt>
1.154     rillig    881: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
                    882: <dt><span class="sect1"><a href="#bulk.req">8.3. Requirements of a full bulk build</a></span></dt>
1.178     rillig    883: <dt><span class="sect1"><a href="#bulk.var">8.4. Bulk build variants</a></span></dt>
                    884: <dd><dl>
1.179     rillig    885: <dt><span class="sect2"><a href="#bulk.var.confopt">8.4.1. Detect unknown configure options</a></span></dt>
                    886: <dt><span class="sect2"><a href="#bulk.var.comperr">8.4.2. Detect classes of bugs by forcing compiler warnings</a></span></dt>
1.181     rillig    887: <dt><span class="sect2"><a href="#bulk.var.builderr">8.4.3. Force compiler options only in the build phase</a></span></dt>
                    888: <dt><span class="sect2"><a href="#bulk.var.dirs">8.4.4. Use custom directories</a></span></dt>
                    889: <dt><span class="sect2"><a href="#bulk.var.warn">8.4.5. Turn warnings into errors</a></span></dt>
                    890: <dt><span class="sect2"><a href="#bulk.var.pkglint">8.4.6. Reject packages for which pkglint reports errors</a></span></dt>
                    891: <dt><span class="sect2"><a href="#bulk.var.strings">8.4.7. Reject packages that contain forbidden strings</a></span></dt>
                    892: <dt><span class="sect2"><a href="#bulk.var.test">8.4.8. Reject packages whose self-test fails</a></span></dt>
                    893: <dt><span class="sect2"><a href="#bulk.var.shvar">8.4.9. Reject packages that use undefined shell variables</a></span></dt>
                    894: <dt><span class="sect2"><a href="#bulk.var.quiet">8.4.10. Turn off verbose logging</a></span></dt>
1.178     rillig    895: </dl></dd>
                    896: <dt><span class="sect1"><a href="#creating-cdroms">8.5. Creating a multiple CD-ROM packages collection</a></span></dt>
                    897: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.5.1. Example of cdpack</a></span></dt></dl></dd>
1.154     rillig    898: </dl></dd>
                    899: <dt><span class="chapter"><a href="#files">9. Directory layout of the installed files</a></span></dt>
                    900: <dd><dl>
                    901: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
                    902: <dt><span class="sect1"><a href="#files.varbase">9.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
                    903: </dl></dd>
                    904: <dt><span class="chapter"><a href="#faq">10. Frequently Asked Questions</a></span></dt>
                    905: <dd><dl>
                    906: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                    907: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
                    908: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
                    909: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
                    910: <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>
                    911: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
                    912: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
                    913: <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>
                    914: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
                    915: <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.23      wiz       916: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</a></span></dt>
1.154     rillig    917: <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>
                    918: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' with pkgsrc</a></span></dt>
                    919: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
                    920: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
                    921: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
                    922: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build.  What shall I do?</a></span></dt>
                    923: <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.1       dsieger   924: </dl></dd>
                    925: </dl>
                    926: </div>
1.41      asau      927: <div class="chapter">
1.1       dsieger   928: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig    929: <a name="help-user"></a>Chapter 2. Getting help</h2></div></div></div>
                    930: <p>
                    931:        To get help when using pkgsrc, the definitive source is this
                    932:        document, the pkgsrc guide. If you don't find anything here,
                    933:        there are alternatives:
                    934: </p>
                    935: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                    936: <li class="listitem">
                    937: <p>
                    938:        The built-in pkgsrc help, which is available after bootstrapping
                    939:        pkgsrc. Run <span class="command"><strong>bmake help topic=&#8230;</strong></span> to get
                    940:        help for any topic, such as a variable name like
                    941:        <code class="varname">BUILD_DEFS</code>, a make target like
                    942:        <span class="command"><strong>do-build</strong></span>, a missing C or C++ function like
                    943:        <span class="command"><strong>strcasecmp</strong></span> or any other topic.</p>
                    944: <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>
                    945: </li>
                    946: <li class="listitem"><p>
1.163     rillig    947:        To see the value of a single variable, run <span class="command"><strong>bmake
                    948:        show-var VARNAME=<em class="replaceable"><code>X</code></em></strong></span>.
                    949: </p></li>
                    950: <li class="listitem"><p>
                    951:        To see the values of the most common variables, run
                    952:        <span class="command"><strong>bmake show-all</strong></span>. These variables are grouped by
                    953:        topic. To see the variables for a single topic, run
                    954:        <span class="command"><strong>bmake
                    955:        show-all-<em class="replaceable"><code>topic</code></em></strong></span>, for example
                    956:        <span class="command"><strong>bmake show-all-fetch</strong></span>.
                    957: </p></li>
                    958: <li class="listitem"><p>
1.154     rillig    959:        The pkgsrc-users mailing list, to which
                    960:        <a class="ulink" href="https://www.NetBSD.org/mailinglists/#pkgsrc-users" target="_top">you
                    961:        can subscribe</a> and then <a class="ulink" href="mailto:pkgsrc-users@NetBSD.org" target="_top">ask your
                    962:        questions</a>.</p></li>
                    963: <li class="listitem"><p>The #pkgsrc IRC channel, which is accessible
                    964:        <a class="ulink" href="https://webchat.freenode.net/" target="_top">via a web browser</a>
                    965:        or by using a specialized chat program such as
                    966:        <a class="ulink" href="http://xchat.org/" target="_top">XChat</a>.
                    967:        Pick any user name and join the channel #pkgsrc.</p></li>
                    968: </ul></div>
                    969: </div>
                    970: <div class="chapter">
                    971: <div class="titlepage"><div><div><h2 class="title">
                    972: <a name="getting"></a>Chapter 3. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
1.1       dsieger   973: <div class="toc">
                    974: <p><b>Table of Contents</b></p>
1.100     leot      975: <dl class="toc">
1.154     rillig    976: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.1       dsieger   977: <dd><dl>
1.154     rillig    978: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
                    979: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.1       dsieger   980: </dl></dd>
1.154     rillig    981: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.1       dsieger   982: <dd><dl>
1.154     rillig    983: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
                    984: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.1       dsieger   985: </dl></dd>
                    986: </dl>
                    987: </div>
                    988: <p>Before you download and extract the files, you need to decide
                    989: where you want to extract them. When using pkgsrc as root user, pkgsrc
                    990: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
                    991: free to install the sources and binary packages wherever you want in
                    992: your filesystem, provided that the pathname does not contain white-space
                    993: or other characters that are interpreted specially by the shell and some
                    994: other programs. A safe bet is to use only letters, digits, underscores
                    995: and dashes.</p>
1.41      asau      996: <div class="sect1">
1.1       dsieger   997: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig    998: <a name="getting-first"></a>3.1. Getting pkgsrc for the first time</h2></div></div></div>
1.1       dsieger   999: <p>Before you download any pkgsrc files, you should decide
                   1000:        whether you want the <span class="emphasis"><em>current</em></span> branch or the
                   1001:        <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
                   1002:        quarterly basis from the current branch and only gets modified
                   1003:        for security updates. The names of the stable branches are built
                   1004:        from the year and the quarter, for example
1.198     leot     1005:        <code class="literal">2021Q1</code>.</p>
1.1       dsieger  1006: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
1.23      wiz      1007:        want to download pkgsrc. You can get it as a tar file or via CVS.
                   1008:        Both ways are described here.</p>
1.51      asau     1009: <p>Note that tar archive contains CVS working copy.
                   1010:        Thus you can switch to using CVS at any later time.</p>
1.41      asau     1011: <div class="sect2">
1.1       dsieger  1012: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   1013: <a name="getting-via-tar"></a>3.1.1. As tar archive</h3></div></div></div>
1.1       dsieger  1014: <p>The primary download location for all pkgsrc files is
1.151     sevan    1015:        <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/" target="_top">https://cdn.NetBSD.org/pub/pkgsrc/</a> or
1.51      asau     1016:        <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>
                   1017:        (it points to the same location).
                   1018:        There are a number of subdirectories for different purposes,
                   1019:        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>
                   1020: <p>The tar archive for the current branch is in the directory
1.151     sevan    1021:        <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.118     sevan    1022:        It is autogenerated weekly.</p>
1.51      asau     1023: <p>To save download time we provide bzip2- and
                   1024:        xz-compressed archives which are published at
1.151     sevan    1025:        <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.51      asau     1026:        and
1.151     sevan    1027:        <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.51      asau     1028:        respectively.
                   1029:        </p>
                   1030: <p>You can fetch the same files using FTP.</p>
1.198     leot     1031: <p>The tar file for the stable branch 2021Q1 is in the
                   1032:        directory <code class="filename">pkgsrc-2021Q1</code> and is also called <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/pkgsrc-2021Q1/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.</p>
1.136     leot     1033: <p>To download the latest pkgsrc stable tarball, run:</p>
1.12      weinem   1034: <pre class="screen">
1.198     leot     1035: <code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2021Q1/pkgsrc.tar.gz</code></strong></pre>
1.78      snj      1036: <p>If you prefer, you can also fetch it using "wget", "curl",
1.51      asau     1037:        or your web browser.</p>
1.12      weinem   1038: <p>Then, extract it with:</p>
1.78      snj      1039: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf pkgsrc.tar.gz -C /usr</code></strong></pre>
1.12      weinem   1040: <p>This will create the directory <code class="filename">pkgsrc/</code>
                   1041:        in <code class="filename">/usr/</code> and all the package source will be 
                   1042:        stored under <code class="filename">/usr/pkgsrc/</code>.</p>
                   1043: <p>To download pkgsrc-current, run:</p>
                   1044: <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.1       dsieger  1045: </div>
1.41      asau     1046: <div class="sect2">
1.1       dsieger  1047: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   1048: <a name="getting-via-cvs"></a>3.1.2. Via anonymous CVS</h3></div></div></div>
1.23      wiz      1049: <p>To fetch a specific pkgsrc stable branch, run:</p>
1.198     leot     1050: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr &amp;&amp; cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -r pkgsrc-2021Q1 -P pkgsrc</code></strong>
1.23      wiz      1051: </pre>
                   1052: <p>This will create the directory <code class="filename">pkgsrc/</code> 
                   1053:        in your <code class="filename">/usr/</code> directory and all the package source 
                   1054:        will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
                   1055: <p>To fetch the pkgsrc current branch, run:</p>
1.39      wiz      1056: <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       dsieger  1057: </pre>
1.174     leot     1058: <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.23      wiz      1059: <p>If you get error messages from <code class="literal">rsh</code>, you need to set CVS_RSH variable. E.g.:</p>
1.39      wiz      1060: <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.23      wiz      1061: </pre>
                   1062: <p>Refer to documentation on your command shell how to set CVS_RSH=ssh permanently.
                   1063:        For Bourne shells, you can set it in your <code class="filename">.profile</code>
                   1064:        or better globally in <code class="filename">/etc/profile</code>:</p>
                   1065: <pre class="programlisting">
                   1066: # set CVS remote shell command
                   1067: CVS_RSH=ssh
                   1068: export CVS_RSH
                   1069: </pre>
                   1070: <p>By default, CVS doesn't do things like most people would expect it to do.
                   1071:        But there is a way to convince CVS, by creating a file called <code class="filename">.cvsrc</code>
                   1072:        in your home directory and saving the following lines to it.
                   1073:        This file will save you lots of headache and some bug reports, so we strongly recommend it.
                   1074:        You can find an explanation of this file in the CVS documentation.</p>
1.2       rillig   1075: <pre class="programlisting">
                   1076: # recommended CVS configuration file from the pkgsrc guide
1.155     sevan    1077: cvs -q
1.2       rillig   1078: checkout -P
1.4       rillig   1079: update -dP
                   1080: diff -upN
1.2       rillig   1081: rdiff -u
1.23      wiz      1082: release -d
1.2       rillig   1083: </pre>
1.1       dsieger  1084: </div>
                   1085: </div>
1.41      asau     1086: <div class="sect1">
1.1       dsieger  1087: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   1088: <a name="uptodate"></a>3.2. Keeping pkgsrc up-to-date</h2></div></div></div>
1.1       dsieger  1089: <p>The preferred way to keep pkgsrc up-to-date is via CVS
                   1090:        (which also works if you have first installed it via a tar
                   1091:        file). It saves bandwidth and hard disk activity, compared to
                   1092:        downloading the tar file again.</p>
1.41      asau     1093: <div class="sect2">
1.1       dsieger  1094: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   1095: <a name="uptodate-tar"></a>3.2.1. Via tar files</h3></div></div></div>
1.41      asau     1096: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  1097: <h3 class="title">Warning</h3>
                   1098: <p>When updating from a tar file, you first need to
                   1099:        completely remove the old pkgsrc directory. Otherwise those
                   1100:        files that have been removed from pkgsrc in the mean time will
                   1101:        not be removed on your local disk, resulting in inconsistencies.
                   1102:        When removing the old files, any changes that you have done to
                   1103:        the pkgsrc files will be lost after updating. Therefore updating
                   1104:        via CVS is strongly recommended.</p>
                   1105: </div>
                   1106: <p>Note that by default the distfiles and the binary packages
                   1107:        are saved in the pkgsrc tree, so don't forget to rescue them
1.78      snj      1108:        before updating. You can also configure pkgsrc to store distfiles
                   1109:         and packages in directories outside the pkgsrc tree by setting the
1.1       dsieger  1110:        <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.154     rillig   1111:        variables. See <a class="xref" href="#configuring" title="Chapter 6. Configuring pkgsrc">Chapter 6, <i>Configuring pkgsrc</i></a> for the details.</p>
1.1       dsieger  1112: <p>To update pkgsrc from a tar file, download the tar file as
                   1113:        explained above. Then, make sure that you have not made any
                   1114:        changes to the files in the pkgsrc directory. Remove the pkgsrc
                   1115:        directory and extract the new tar file. Done.</p>
                   1116: </div>
1.41      asau     1117: <div class="sect2">
1.1       dsieger  1118: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   1119: <a name="uptodate-cvs"></a>3.2.2. Via CVS</h3></div></div></div>
1.25      spz      1120: <p>To update pkgsrc via CVS, change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
                   1121: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc &amp;&amp; cvs update -dP</code></strong>
                   1122: </pre>
                   1123: <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>
                   1124: <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>
                   1125: </pre>
1.41      asau     1126: <div class="sect3">
1.1       dsieger  1127: <div class="titlepage"><div><div><h4 class="title">
1.154     rillig   1128: <a name="uptodate-cvs-switch"></a>3.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1.1       dsieger  1129: <p>When updating pkgsrc, the CVS program keeps track of the
                   1130:        branch you selected. But if you, for whatever reason, want to
                   1131:        switch from the stable branch to the current one, you can do it
1.23      wiz      1132:        by adding the option <span class="quote">&#8220;<span class="quote">-A</span>&#8221;</span> after the
                   1133:        <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> keyword. To switch from the current branch
1.1       dsieger  1134:        back to the stable branch, add the
1.198     leot     1135:        <span class="quote">&#8220;<span class="quote">-rpkgsrc-2021Q1</span>&#8221;</span> option.</p>
1.1       dsieger  1136: </div>
1.41      asau     1137: <div class="sect3">
1.1       dsieger  1138: <div class="titlepage"><div><div><h4 class="title">
1.154     rillig   1139: <a name="uptodate-cvs-changes"></a>3.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1.1       dsieger  1140: <p>When you update pkgsrc, the CVS program will only touch
                   1141:        those files that are registered in the CVS repository. That
                   1142:        means that any packages that you created on your own will stay
                   1143:        unmodified. If you change files that are managed by CVS, later
                   1144:        updates will try to merge your changes with those that have been
                   1145:        done by others. See the CVS manual, chapter
1.23      wiz      1146:        <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> for details.</p>
1.1       dsieger  1147: </div>
                   1148: </div>
                   1149: </div>
                   1150: </div>
1.41      asau     1151: <div class="chapter">
1.1       dsieger  1152: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   1153: <a name="platforms"></a>Chapter 4. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1.1       dsieger  1154: <div class="toc">
                   1155: <p><b>Table of Contents</b></p>
1.100     leot     1156: <dl class="toc">
1.154     rillig   1157: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
                   1158: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.1       dsieger  1159: </dl>
                   1160: </div>
1.41      asau     1161: <div class="sect1">
1.1       dsieger  1162: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   1163: <a name="binarydist"></a>4.1. Binary distribution</h2></div></div></div>
                   1164: <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.1       dsieger  1165: </div>
1.41      asau     1166: <div class="sect1">
1.1       dsieger  1167: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   1168: <a name="bootstrapping-pkgsrc"></a>4.2. Bootstrapping pkgsrc</h2></div></div></div>
1.43      asau     1169: <p>pkgsrc can be bootstrapped for use in two different modes:
                   1170:     privileged and unprivileged one. In unprivileged mode in contrast
1.44      asau     1171:     to privileged one all programs are installed under one particular user
1.43      asau     1172:     and cannot utilise privileged operations (packages don't create
                   1173:     special users and all special file permissions like setuid are ignored).
                   1174:     </p>
1.1       dsieger  1175: <p>Installing the bootstrap kit from source should be as simple as:</p>
                   1176: <pre class="screen">
1.60      asau     1177: <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.1       dsieger  1178: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
                   1179: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
                   1180:     </pre>
1.43      asau     1181: <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>
                   1182: <p>By default, in privileged mode pkgsrc uses
                   1183:     <code class="filename">/usr/pkg</code> for <span class="emphasis"><em>prefix</em></span>
                   1184:     where programs will be installed in,
1.118     sevan    1185:     and <code class="filename">/usr/pkg/pkgdb</code> for the package database
1.43      asau     1186:     directory where pkgsrc will do its internal bookkeeping,
                   1187:     <code class="filename">/var</code> is used as <span class="emphasis"><em>varbase</em></span>,
                   1188:     where packages install their persistent data.
                   1189:     In unprivileged mode pkgsrc uses
                   1190:     <code class="filename">~/pkg</code> for <span class="emphasis"><em>prefix</em></span>,
1.118     sevan    1191:     <code class="filename">~/pkg/pkgdb</code> for the package database,
1.43      asau     1192:     and <code class="filename">~/pkg/var</code> for <span class="emphasis"><em>varbase</em></span>.
                   1193:     </p>
                   1194: <p>You can change default layout using command-line arguments.
                   1195:     Run <span class="quote">&#8220;<span class="quote">./bootstrap --help</span>&#8221;</span> to get details.
                   1196:     </p>
1.41      asau     1197: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  1198: <h3 class="title">Note</h3>
1.10      hubertf  1199: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
                   1200:       Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
                   1201:       For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.23      wiz      1202:       instead of <span class="quote">&#8220;<span class="quote">make</span>&#8221;</span>.</p>
1.1       dsieger  1203: </div>
1.43      asau     1204: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1205: <h3 class="title">Note</h3>
                   1206: <p>It is possible to bootstrap multiple instances of pkgsrc
                   1207:       using non-intersecting directories. Use <span class="command"><strong>bmake</strong></span>
                   1208:       corresponding to the installation you're working with to build
                   1209:       and install packages.
                   1210:       </p>
                   1211: </div>
1.1       dsieger  1212: </div>
                   1213: </div>
1.41      asau     1214: <div class="chapter">
1.1       dsieger  1215: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   1216: <a name="using"></a>Chapter 5. Using pkgsrc</h2></div></div></div>
1.1       dsieger  1217: <div class="toc">
                   1218: <p><b>Table of Contents</b></p>
1.100     leot     1219: <dl class="toc">
1.154     rillig   1220: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.1       dsieger  1221: <dd><dl>
1.154     rillig   1222: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
                   1223: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
1.202     nia      1224: <dt><span class="sect2"><a href="#using.pkgin_update">5.1.3. Updating packages</a></span></dt>
                   1225: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.4. Deinstalling packages</a></span></dt>
                   1226: <dt><span class="sect2"><a href="#using.pkg_info">5.1.5. Getting information about installed packages</a></span></dt>
                   1227: <dt><span class="sect2"><a href="#vulnerabilities">5.1.6. Checking for security vulnerabilities in installed packages</a></span></dt>
                   1228: <dt><span class="sect2"><a href="#pkg_versions">5.1.7. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
                   1229: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.8. Other administrative functions</a></span></dt>
1.154     rillig   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.1       dsieger  1236: </dl></dd>
                   1237: </dl>
                   1238: </div>
                   1239: <p>Basically, there are two ways of using pkgsrc. The first
                   1240: is to only install the package tools and to use binary packages
1.23      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.1       dsieger  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.41      asau     1245: <div class="sect1">
1.1       dsieger  1246: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   1247: <a name="using-pkg"></a>5.1. Using binary packages</h2></div></div></div>
1.202     nia      1248: <p>On the <a class="ulink" href="https://cdn.NetBSD.org/" target="_top">cdn.NetBSD.org</a>
1.151     sevan    1249:   site and mirrors, there are collections of binary packages,
1.9       rillig   1250:   ready to be installed. These binary packages have been built using the
                   1251:   default settings for the directories, that is:</p>
1.41      asau     1252: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      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.9       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.154     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.41      asau     1260: <div class="sect2">
1.1       dsieger  1261: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   1262: <a name="finding-binary-packages"></a>5.1.1. Finding binary packages</h3></div></div></div>
1.5       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.202     nia      1265:     pkgsrc CDN in the directory <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/packages/" target="_top"><code class="filename">/pub/pkgsrc/packages</code></a>.</p>
1.5       weinem   1266: <p>This directory contains binary packages for multiple
                   1267:     platforms. First, select your operating system. (Ignore the
                   1268:     directories with version numbers attached to it, they just exist for
                   1269:     legacy reasons.) Then, select your hardware architecture, and in the
1.23      wiz      1270:     third step, the OS version and the <span class="quote">&#8220;<span class="quote">version</span>&#8221;</span> of pkgsrc.</p>
1.9       rillig   1271: <p>In this directory, you often find a file called
                   1272:     <code class="filename">bootstrap.tar.gz</code> which contains the package
                   1273:     management tools. If the file is missing, it is likely that your
                   1274:     operating system already provides those tools. Download the file and
                   1275:     extract it in the <code class="filename">/</code> directory. It will create
                   1276:     the directories <code class="filename">/usr/pkg</code> (containing the tools
1.118     sevan    1277:     for managing binary packages and the database of installed packages).</p>
1.1       dsieger  1278: </div>
1.41      asau     1279: <div class="sect2">
1.1       dsieger  1280: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   1281: <a name="installing-binary-packages"></a>5.1.2. Installing binary packages</h3></div></div></div>
1.9       rillig   1282: <p>In the directory from the last section, there is a
1.85      wiz      1283:     subdirectory called <code class="filename">All/</code>, which contains all the
1.9       rillig   1284:     binary packages that are available for the platform, excluding those
1.202     nia      1285:     that may not be distributed via HTTP or FTP.</p>
1.9       rillig   1286: <p>To install packages directly from an FTP or HTTP server, run
                   1287:     the following commands in a Bourne-compatible shell (be sure to
1.10      hubertf  1288:     <span class="command"><strong>su</strong></span> to root first):</p>
1.9       rillig   1289: <pre class="screen">
1.202     nia      1290: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:/usr/pkg/bin:$PATH"</code></strong>
                   1291: <code class="prompt">#</code> <strong class="userinput"><code>PKG_PATH="https://cdn.NetBSD.org/pub/pkgsrc/packages"</code></strong>
1.169     rillig   1292: <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.9       rillig   1293: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
1.202     nia      1294: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add pkgin</code></strong>
1.9       rillig   1295: </pre>
                   1296: <p>Instead of URLs, you can also use local paths, for example if
                   1297:     you are installing from a set of CDROMs, DVDs or an NFS-mounted
                   1298:     repository. If you want to install packages from multiple sources,
                   1299:     you can separate them by a semicolon in
                   1300:     <code class="varname">PKG_PATH</code>.</p>
                   1301: <p>After these preparations, installing a package is very
                   1302:     easy:</p>
                   1303: <pre class="screen">
1.202     nia      1304: <code class="prompt">#</code> <strong class="userinput"><code>pkgin search nginx</code></strong>
                   1305: nginx-1.19.6         Lightweight HTTP server and mail proxy server
                   1306: nginx-1.18.0nb8      Lightweight HTTP server and mail proxy server
                   1307: <code class="prompt">#</code> <strong class="userinput"><code>pkgin install zsh nginx-1.19.6 vim</code></strong>
                   1308: </pre>
                   1309: <p>Note that <span class="command"><strong>pkgin</strong></span> is a user-friendly frontend
                   1310:     to the <span class="command"><strong>pkg_*</strong></span> tools.</p>
                   1311: <p>Any prerequisite packages needed to run the
1.1       dsieger  1312:     package in question will be installed, too, assuming they are
1.202     nia      1313:     present in the repository.</p>
1.1       dsieger  1314: <p>After you've installed packages, be sure to have
                   1315:     <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
                   1316:     <code class="varname">PATH</code> so you can actually start the just
                   1317:     installed program.</p>
                   1318: </div>
1.41      asau     1319: <div class="sect2">
1.1       dsieger  1320: <div class="titlepage"><div><div><h3 class="title">
1.202     nia      1321: <a name="using.pkgin_update"></a>5.1.3. Updating packages</h3></div></div></div>
                   1322: <p>To update binary packages, it is recommended that you use
                   1323:     <span class="command"><strong>pkgin upgrade</strong></span>.  This will compare the remote
                   1324:     package repository to your locally installed packages and safely
                   1325:     replace any older packages.</p>
                   1326: <p>Note that pkgsrc is released as quarterly branches.
                   1327:     If you are updating to a newer quarterly branch of pkgsrc, you may
                   1328:     need to adjust the repository in
                   1329:     <code class="filename">/usr/pkg/etc/pkgin/repositories.conf</code>.</p>
                   1330: </div>
                   1331: <div class="sect2">
                   1332: <div class="titlepage"><div><div><h3 class="title">
                   1333: <a name="using.pkg_delete"></a>5.1.4. Deinstalling packages</h3></div></div></div>
1.1       dsieger  1334: <p>To deinstall a package, it does not matter whether it was
1.202     nia      1335:     installed from source code or from a binary package. Neither the
                   1336:     <span class="command"><strong>pkgin</strong></span> or the <span class="command"><strong>pkg_delete</strong></span>
                   1337:     command need to know.</p>
                   1338: <p>To delete a package, you can just run <span class="command"><strong>pkgin remove
1.1       dsieger  1339:     <em class="replaceable"><code>package-name</code></em></strong></span>. The package
1.202     nia      1340:     name can be given with or without version number.</p>
1.1       dsieger  1341: </div>
1.41      asau     1342: <div class="sect2">
1.1       dsieger  1343: <div class="titlepage"><div><div><h3 class="title">
1.202     nia      1344: <a name="using.pkg_info"></a>5.1.5. Getting information about installed packages</h3></div></div></div>
1.10      hubertf  1345: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.202     nia      1346:     installed packages or binary package files.
                   1347:     As with other management tools, it works with packages installed
                   1348:     from source or binaries.</p>
1.1       dsieger  1349: </div>
1.41      asau     1350: <div class="sect2">
1.1       dsieger  1351: <div class="titlepage"><div><div><h3 class="title">
1.202     nia      1352: <a name="vulnerabilities"></a>5.1.6. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1.1       dsieger  1353: <p>
1.164     leot     1354:       The pkgsrc Security Team and Packages Groups maintain a list of
1.202     nia      1355:       known vulnerabilities to packages which are (or have been)
1.1       dsieger  1356:       included in pkgsrc.  The list is available from the NetBSD
1.202     nia      1357:       CDN at <a class="ulink" href="https://cdn.NetBSD.org/pub/NetBSD/packages/vulns/pkg-vulnerabilities" target="_top">https://cdn.NetBSD.org/pub/NetBSD/packages/vulns/pkg-vulnerabilities</a>.
                   1358:     </p>
                   1359: <p>
                   1360:       Please note that not every "vulnerability" with a CVE assignment is
                   1361:       exploitable in every configuration.
                   1362:       Some bugs are marked as active simply because an fix was not
                   1363:       marked as such.
                   1364:       Operating system specific hardening and mitigation features may also
                   1365:       reduce the impact of bugs.
1.1       dsieger  1366:     </p>
                   1367: <p>
1.22      jakllsch 1368:       Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.1       dsieger  1369:       this list can be downloaded
                   1370:       automatically, and a security audit of all packages installed on a system
                   1371:       can take place.
                   1372:     </p>
                   1373: <p>
1.22      jakllsch 1374:       There are two components to auditing.  The first
                   1375:       step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
                   1376:       is for downloading
1.1       dsieger  1377:       the list of vulnerabilities from the NetBSD FTP site.  The second
1.22      jakllsch 1378:       step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.1       dsieger  1379:       installed packages are vulnerable.  If a package is vulnerable, you
                   1380:       will see output similar to the following:
                   1381:     </p>
                   1382: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1.174     leot     1383:     https://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1.1       dsieger  1384: <p>
1.22      jakllsch 1385:       You may wish to have the
1.202     nia      1386:       <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.22      jakllsch 1387:       file downloaded daily so that
                   1388:       it remains current.  This may be done by adding an appropriate entry
1.197     leot     1389:       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.22      jakllsch 1390:       </p>
                   1391: <pre class="screen">
1.121     sevan    1392: # Download vulnerabilities file
1.118     sevan    1393: 0 3 * * * /usr/pkg/sbin/pkg_admin fetch-pkg-vulnerabilities &gt;/dev/null 2&gt;&amp;1
1.121     sevan    1394: # Audit the installed packages and email results to root
                   1395: 9 3 * * * /usr/pkg/sbin/pkg_admin audit |mail -s "Installed package audit result" \
                   1396:            root &gt;/dev/null 2&gt;&amp;1
1.22      jakllsch 1397:       </pre>
                   1398: <p>
1.118     sevan    1399:       will update the vulnerability list every day at 3AM, followed by an audit
                   1400:       at 3:09AM. The result of the audit are then emailed to root.
1.22      jakllsch 1401: 
1.118     sevan    1402:       On NetBSD this may be accomplished instead by adding the following
                   1403:       line to <code class="filename">/etc/daily.conf</code>:
                   1404:       </p>
                   1405: <pre class="screen">
                   1406: fetch_pkg_vulnerabilities=YES
                   1407:       </pre>
                   1408: <p>
                   1409:       to fetch the vulnerability list from the daily security script. The system
                   1410:       is set to audit the packages by default but can be set explicitly, if
1.123     wiz      1411:       desired (not required), by adding the following line to
1.118     sevan    1412: <code class="filename">/etc/security.conf</code>:
1.22      jakllsch 1413:       </p>
                   1414: <pre class="screen">
1.118     sevan    1415: check_pkg_vulnerabilities=YES
1.22      jakllsch 1416:       </pre>
                   1417: <p>
1.197     leot     1418:       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.1       dsieger  1419:     </p>
                   1420: </div>
1.41      asau     1421: <div class="sect2">
1.1       dsieger  1422: <div class="titlepage"><div><div><h3 class="title">
1.202     nia      1423: <a name="pkg_versions"></a>5.1.7. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
1.1       dsieger  1424: <p>
1.137     leot     1425:       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.23      wiz      1426:       <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">&#8220;<span class="quote">-i</span>&#8221;</span>
1.202     nia      1427:       argument to check if any packages are stale, e.g.
1.1       dsieger  1428:     </p>
                   1429: <pre class="screen">
                   1430: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
                   1431: ...
                   1432: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
                   1433:     </pre>
                   1434: </div>
1.41      asau     1435: <div class="sect2">
1.1       dsieger  1436: <div class="titlepage"><div><div><h3 class="title">
1.202     nia      1437: <a name="using.pkg_admin"></a>5.1.8. Other administrative functions</h3></div></div></div>
1.10      hubertf  1438: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.1       dsieger  1439:     administrative functions on the package system.</p>
                   1440: </div>
                   1441: </div>
1.41      asau     1442: <div class="sect1">
1.1       dsieger  1443: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   1444: <a name="building-packages-from-source"></a>5.2. Building packages from source</h2></div></div></div>
1.1       dsieger  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.10      hubertf  1448:   <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.1       dsieger  1449:   directory to build local <code class="filename">README.html</code> files for
1.137     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.1       dsieger  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.10      hubertf  1454:   <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.1       dsieger  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.10      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.1       dsieger  1459:   instructions how to create your own packages.</p>
1.41      asau     1460: <div class="sect2">
1.1       dsieger  1461: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   1462: <a name="requirements"></a>5.2.1. Requirements</h3></div></div></div>
1.1       dsieger  1463: <p>To build packages from source, you need a working C
                   1464:     compiler. On NetBSD, you need to install the
1.23      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.1       dsieger  1466:     sets. If you want to build X11-related packages, the
1.23      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.1       dsieger  1468:     sets are required, too.</p>
                   1469: </div>
1.41      asau     1470: <div class="sect2">
1.1       dsieger  1471: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   1472: <a name="fetching-distfiles"></a>5.2.2. Fetching distfiles</h3></div></div></div>
1.1       dsieger  1473: <p>The first step for building a package is downloading the
                   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>
                   1481: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
                   1482: <p>
1.10      hubertf  1483:     to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1       dsieger  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>
                   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>
                   1502: <p>You can change these settings either in your shell's environment, or,
                   1503:     if you want to keep the settings, by editing the
1.10      hubertf  1504:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.1       dsieger  1505:     and adding the definitions there.</p>
                   1506: <p>
                   1507:       If a package depends on many other packages (such as
1.137     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.1       dsieger  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>
                   1513: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
                   1514: <p>
                   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>
                   1519: </div>
1.41      asau     1520: <div class="sect2">
1.1       dsieger  1521: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   1522: <a name="how-to-build-and-install"></a>5.2.3. How to build and install</h3></div></div></div>
1.1       dsieger  1523: <p>
                   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.41      asau     1529: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  1530: <h3 class="title">Note</h3>
                   1531: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.10      hubertf  1532:     use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.23      wiz      1533:     <span class="quote">&#8220;<span class="quote">make</span>&#8221;</span> in the examples in this guide.</p>
1.1       dsieger  1534: </div>
                   1535: <p>For example, type</p>
                   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>
                   1540: <p>at the shell prompt to build the various components of the
                   1541:     package.</p>
                   1542: <p>The next stage is to actually install the newly compiled
                   1543:     program onto your system. Do this by entering:
                   1544: 
                   1545:     </p>
                   1546: <pre class="screen">
                   1547: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
                   1548:     </pre>
                   1549: <p>
                   1550: 
                   1551:     while you are still in the directory for whatever package you
                   1552:     are installing.</p>
                   1553: <p>Installing the package on your system may require you to
                   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>
                   1557: <p>That's it, the software should now be installed and setup for use.
                   1558:     You can now enter:
                   1559: 
                   1560:     </p>
                   1561: <pre class="screen">
                   1562: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
                   1563:     </pre>
                   1564: <p>
                   1565: 
                   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>
                   1570: <pre class="screen">
                   1571: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
                   1572:     </pre>
                   1573: <p>Taking the figlet utility as an example, we can install it on our
1.10      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.1       dsieger  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.10      hubertf  1592: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1       dsieger  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.10      hubertf  1597:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.1       dsieger  1598:     set them each time you want to use pkgsrc.</p>
1.23      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.1       dsieger  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.23      wiz      1604: <div class="orderedlist"><ol class="orderedlist" type="1">
                   1605: <li class="listitem">
1.197     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.1       dsieger  1607:        <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
                   1608:        information will be displayed. For example,</p>
                   1609: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
                   1610: <p>will show all the commands that are invoked, up to and
1.23      wiz      1611:        including the <span class="quote">&#8220;<span class="quote">patch</span>&#8221;</span> stage.</p>
1.1       dsieger  1612: </li>
1.23      wiz      1613: <li class="listitem">
1.197     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.1       dsieger  1615:        definition, then the <code class="varname">VARNAME</code> definition
                   1616:        should be used, in conjunction with the show-var
1.197     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.1       dsieger  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>
                   1621: /usr/pkg
                   1622: <code class="prompt">%</code>
                   1623:        </pre>
                   1624: </li>
                   1625: </ol></div>
                   1626: <p>If you want to install a binary package that you've either
                   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.197     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.10      hubertf  1631:     else do a <span class="command"><strong>make package</strong></span>.  The list of remote FTP
1.1       dsieger  1632:     sites searched is kept in the variable
                   1633:     <code class="varname">BINPKG_SITES</code>, which defaults to
1.197     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.1       dsieger  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>
                   1648: </div>
                   1649: </div>
                   1650: </div>
1.41      asau     1651: <div class="chapter">
1.1       dsieger  1652: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   1653: <a name="configuring"></a>Chapter 6. Configuring pkgsrc</h2></div></div></div>
1.1       dsieger  1654: <div class="toc">
                   1655: <p><b>Table of Contents</b></p>
1.100     leot     1656: <dl class="toc">
1.154     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.1       dsieger  1665: </dl></dd>
1.154     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.1       dsieger  1668: </dl>
                   1669: </div>
1.4       rillig   1670: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.1       dsieger  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.197     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.1       dsieger  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.112     rillig   1681: spelling mistakes) takes place.</p>
1.41      asau     1682: <div class="sect1">
1.1       dsieger  1683: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   1684: <a name="general-configuration"></a>6.1. General configuration</h2></div></div></div>
1.112     rillig   1685: <p>The following variables apply to all
1.1       dsieger  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.41      asau     1690: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      1691: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.1       dsieger  1692:            packages will be installed. The default is
                   1693:            <code class="filename">/usr/pkg</code>. Do not mix binary packages
                   1694:            with different <code class="varname">LOCALBASE</code>s!</p></li>
1.23      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.1       dsieger  1697:            installed. The default is
                   1698:            <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.23      wiz      1699: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.1       dsieger  1700:            X11 is installed on the system. The default is
1.84      wiz      1701:            <code class="filename">/usr/X11R7</code>.</p></li>
1.23      wiz      1702: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.1       dsieger  1703:            downloaded copies of the original source distributions used
                   1704:            for building pkgsrc packages. The default is
                   1705:            <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.23      wiz      1706: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.1       dsieger  1707:            database about installed packages is stored.  The default is
1.118     sevan    1708:            <code class="filename">/usr/pkg/pkgdb</code>.</p></li>
1.23      wiz      1709: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.1       dsieger  1710:            If set, override the packages'
                   1711:            <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.23      wiz      1712: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.1       dsieger  1713:            Backup location(s) for distribution files and patch files
                   1714:            if not found locally or in
                   1715:            <code class="filename">${MASTER_SITES}</code> or
                   1716:            <code class="filename">${PATCH_SITES}</code> respectively.
1.118     sevan    1717:            The defaults is
                   1718:            <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.23      wiz      1719: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.1       dsieger  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.23      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.22      jakllsch 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.1       dsieger  1730: </ul></div>
                   1731: </div>
1.41      asau     1732: <div class="sect1">
1.1       dsieger  1733: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   1734: <a name="variables-affecting-build"></a>6.2. Variables affecting the build process</h2></div></div></div>
1.108     rillig   1735: <p>
1.1       dsieger  1736:       </p>
1.41      asau     1737: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      1738: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.1       dsieger  1739:            directory for the binary packages. The default is
                   1740:            <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.23      wiz      1741: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.1       dsieger  1742:            The top level directory where, if defined, the separate
                   1743:            working directories will get created, and symbolically
                   1744:            linked to from <code class="filename">${WRKDIR}</code> (see below).
                   1745:            This is useful for building packages on several
                   1746:            architectures, then <code class="filename">${PKGSRCDIR}</code>
                   1747:            can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
                   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.14      jmcneill 1750:            &mdash; it is an internal definition which refers to the
1.1       dsieger  1751:            root of the pkgsrc tree. It is possible to have many
                   1752:            pkgsrc tree instances.)</p></li>
1.23      wiz      1753: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.1       dsieger  1754:            Directory for local patches that aren't part of pkgsrc.
1.184     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.1       dsieger  1756:            information.</p></li>
1.23      wiz      1757: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.10      hubertf  1758:            the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.1       dsieger  1759:            BSD-style Makefile. If this is not set,
                   1760:            <code class="varname">MAKECONF</code> is set to
                   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>
                   1763: </ul></div>
                   1764: </div>
1.41      asau     1765: <div class="sect1">
1.1       dsieger  1766: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   1767: <a name="variables-affecting-installation"></a>6.3. Variables affecting the installation process</h2></div></div></div>
1.198     leot     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.143     maya     1769:                 By default, binary packages of built packages are
1.150     leot     1770:                 preserved in <code class="filename">${PACKAGES}/All</code>. Setting
1.143     maya     1771:                this variable to "no" prevents this.</p></li></ul></div>
1.107     jnemeth  1772: <p>Packages have to support installation into a
1.4       rillig   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.41      asau     1776: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      1777: <li class="listitem"><p>Basic DESTDIR support means that the package
1.24      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.4       rillig   1783: <p>With basic DESTDIR support, <strong class="userinput"><code>make
                   1784:     clean</code></strong> needs to be run as root.</p>
1.17      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.66      asau     1802: <code class="prompt">$</code> make stage-install
1.17      imil     1803: </pre>
                   1804: <p>
                   1805: 
                   1806:     Create a package without root privileges
                   1807: 
                   1808: </p>
                   1809: <pre class="programlisting">
1.66      asau     1810: <code class="prompt">$</code> make PACKAGES=$HOME/packages package
1.17      imil     1811: </pre>
                   1812: <p>
                   1813: 
                   1814:     For the following command, you must be able to gain root
1.197     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.17      imil     1816: 
                   1817: </p>
                   1818: <pre class="programlisting">
1.66      asau     1819: <code class="prompt">$</code> make PACKAGES=$HOME/packages install
1.17      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.4       rillig   1832: </div>
1.41      asau     1833: <div class="sect1">
1.4       rillig   1834: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   1835: <a name="conf.compiler"></a>6.4. Selecting and configuring the compiler</h2></div></div></div>
1.41      asau     1836: <div class="sect2">
1.1       dsieger  1837: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   1838: <a name="selecting-the-compiler"></a>6.4.1. Selecting the compiler</h3></div></div></div>
1.1       dsieger  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.41      asau     1841: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  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.41      asau     1847: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.66      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.23      wiz      1854: <li class="listitem"><p><code class="varname">distcc</code>:
1.1       dsieger  1855:            distributed C/C++ (chainable)</p></li>
1.66      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.23      wiz      1862: <li class="listitem"><p><code class="varname">gcc</code>:
1.1       dsieger  1863:            GNU C/C++ Compiler</p></li>
1.66      asau     1864: <li class="listitem"><p><code class="varname">hp</code>:
                   1865:            HP-UX C/aC++ compilers</p></li>
1.23      wiz      1866: <li class="listitem"><p><code class="varname">mipspro</code>:
1.1       dsieger  1867:            Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.66      asau     1868: <li class="listitem"><p><code class="varname">mipspro-ucode</code>:
1.1       dsieger  1869:            Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.23      wiz      1870: <li class="listitem"><p><code class="varname">sunpro</code>:
1.1       dsieger  1871:            Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
1.66      asau     1872: <li class="listitem"><p><code class="varname">xlc</code>:
1.118     sevan    1873:            IBM's XL C/C++ compiler suite</p></li>
1.1       dsieger  1874: </ul></div>
                   1875: <p>The default is
1.23      wiz      1876:          <span class="quote">&#8220;<span class="quote"><code class="varname">gcc</code></span>&#8221;</span>.  You can use
1.1       dsieger  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.23      wiz      1880:          e.g. <span class="quote">&#8220;<span class="quote"><code class="varname">ccache gcc</code></span>&#8221;</span>.  This
1.1       dsieger  1881:          variable should always be terminated with a value for
                   1882:          a real compiler.  Note that only one real compiler
1.23      wiz      1883:          should be listed (e.g. <span class="quote">&#8220;<span class="quote"><code class="varname">sunpro gcc</code></span>&#8221;</span>
1.1       dsieger  1884:          is not allowed).</p>
                   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.153     leot     1891: <dt><span class="term"><code class="varname">PYTHON_VERSION_DEFAULT</code>:</span></dt>
1.114     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.176     gutterid 1895: <dd><p>Specifies the Fortran compiler to use.
                   1896:          The default is <code class="varname">gfortran</code>.</p></dd>
1.114     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.1       dsieger  1901: </dl></div>
                   1902: </div>
1.41      asau     1903: <div class="sect2">
1.1       dsieger  1904: <div class="titlepage"><div><div><h3 class="title">
1.154     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.1       dsieger  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">
                   1910: CFLAGS+=        -your -flags
                   1911: </pre>
                   1912: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.23      wiz      1913:        <span class="quote">&#8220;<span class="quote">+</span>&#8221;</span>) may lead to problems with packages that
1.16      jnemeth  1914:        need to add their own flags.  You may want to take a look
1.137     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.23      wiz      1916:        package if you're interested in optimization specifically
                   1917:        for the current CPU. </p>
1.1       dsieger  1918: </div>
1.41      asau     1919: <div class="sect2">
1.1       dsieger  1920: <div class="titlepage"><div><div><h3 class="title">
1.154     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.1       dsieger  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">
                   1933: LDFLAGS+=        -your -linkerflags
                   1934: </pre>
                   1935: </div>
                   1936: </div>
1.41      asau     1937: <div class="sect1">
1.1       dsieger  1938: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   1939: <a name="developer-advanced-settings"></a>6.5. Developer/advanced settings</h2></div></div></div>
1.84      wiz      1940: <p>
1.1       dsieger  1941:       </p>
1.41      asau     1942: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      1943: <li class="listitem">
1.1       dsieger  1944: <p><code class="varname">PKG_DEVELOPER</code>:
                   1945:            Run some sanity checks that package developers want:
                   1946:            </p>
1.41      asau     1947: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.23      wiz      1948: <li class="listitem"><p>make sure patches apply with zero
1.1       dsieger  1949:              fuzz</p></li>
1.23      wiz      1950: <li class="listitem"><p>run check-shlibs to see that all
1.1       dsieger  1951:              binaries will find their shared libs.</p></li>
                   1952: </ul></div>
                   1953: <p>
                   1954:        </p>
                   1955: </li>
1.23      wiz      1956: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.1       dsieger  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.112     rillig   1963:        as well as their actual execution progress with <span class="command"><strong>set
                   1964:        -x</strong></span>.</p></li>
1.1       dsieger  1965: </ul></div>
                   1966: <p>
                   1967:     </p>
                   1968: </div>
1.41      asau     1969: <div class="sect1">
1.1       dsieger  1970: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   1971: <a name="selecting-build-options"></a>6.6. Selecting Build Options</h2></div></div></div>
1.1       dsieger  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>
                   1975: <p>To see which options, if any, a package supports, and which
1.10      hubertf  1976:     options are mutually exclusive, run <span class="command"><strong>make
1.1       dsieger  1977:     show-options</strong></span>, for example:</p>
                   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.
                   1987: 
                   1988:     These options are enabled by default: firefox
                   1989:     These options are currently enabled: mozilla ssl
                   1990: </pre>
                   1991: <p>The following variables can be defined in
1.10      hubertf  1992:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.1       dsieger  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.23      wiz      1999:     these variables are selected, options preceded by <span class="quote">&#8220;<span class="quote">-</span>&#8221;</span>
1.1       dsieger  2000:     are disabled. A few examples:</p>
                   2001: <pre class="screen">
1.10      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.1       dsieger  2003: PKG_DEFAULT_OPTIONS=    -arts -dvdread -esound
                   2004: PKG_OPTIONS.kdebase=    debug -sasl
                   2005: PKG_OPTIONS.apache=     suexec </pre>
1.11      rillig   2006: <p>It is important to note that options that were specifically
1.18      snj      2007:     suggested by the package maintainer must be explicitly removed if
1.11      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.1       dsieger  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.23      wiz      2013: <div class="orderedlist"><ol class="orderedlist" type="1">
                   2014: <li class="listitem"><p>the default options as suggested by the package
1.1       dsieger  2015:       maintainer</p></li>
1.23      wiz      2016: <li class="listitem"><p>the options implied by the settings of legacy
1.1       dsieger  2017:       variables (see below)</p></li>
1.23      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.1       dsieger  2020: </ol></div>
                   2021: <p>For groups of mutually exclusive options, the last option
                   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.10      hubertf  2030:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option.  To ease
1.1       dsieger  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.10      hubertf  2035:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.1       dsieger  2036:     directly.  Support for the legacy variables will be removed
                   2037:     eventually.</p>
                   2038: </div>
                   2039: </div>
1.41      asau     2040: <div class="chapter">
1.1       dsieger  2041: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   2042: <a name="binary"></a>Chapter 7. Creating binary packages</h2></div></div></div>
1.1       dsieger  2043: <div class="toc">
                   2044: <p><b>Table of Contents</b></p>
1.100     leot     2045: <dl class="toc">
1.154     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.1       dsieger  2048: </dl>
                   2049: </div>
1.41      asau     2050: <div class="sect1">
1.1       dsieger  2051: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2052: <a name="building-a-single-binary-package"></a>7.1. Building a single binary package</h2></div></div></div>
1.1       dsieger  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.197     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.1       dsieger  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.10      hubertf  2060:     directory in pkgsrc, and run <span class="command"><strong>make
1.1       dsieger  2061:     package</strong></span>:</p>
                   2062: <pre class="screen">
1.112     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.1       dsieger  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.10      hubertf  2068:     then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.1       dsieger  2069:     it. Binary packages are created by default in
                   2070:     <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.10      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.137     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.154     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.1       dsieger  2074:     such a binary package.</p>
                   2075: </div>
1.41      asau     2076: <div class="sect1">
1.1       dsieger  2077: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2078: <a name="settings-for-creationg-of-binary-packages"></a>7.2. Settings for creation of binary packages</h2></div></div></div>
1.184     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.6       rillig   2080: </div>
                   2081: </div>
1.41      asau     2082: <div class="chapter">
1.6       rillig   2083: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   2084: <a name="bulk"></a>Chapter 8. Creating binary packages for everything in pkgsrc (bulk
1.6       rillig   2085: builds)</h2></div></div></div>
                   2086: <div class="toc">
                   2087: <p><b>Table of Contents</b></p>
1.100     leot     2088: <dl class="toc">
1.154     rillig   2089: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
1.180     rillig   2090: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a bulk build</a></span></dt>
1.154     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.178     rillig   2093: <dt><span class="sect1"><a href="#bulk.var">8.4. Bulk build variants</a></span></dt>
                   2094: <dd><dl>
1.179     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.181     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.178     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.6       rillig   2108: </dl>
                   2109: </div>
1.175     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.71      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.175     gutterid 2115: deploying onto production systems.
1.71      wiz      2116: There is a way of getting a set of binary packages:
1.175     gutterid 2117: the bulk build system, or pbulk ("p" stands for "parallel").
1.112     rillig   2118: This chapter describes how to set it up.</p>
1.41      asau     2119: <div class="sect1">
1.6       rillig   2120: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2121: <a name="bulk.pre"></a>8.1. Preparations</h2></div></div></div>
1.71      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.175     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.112     rillig   2129: Note that all their dependencies will be built, so you don't need to track them manually.
1.71      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.112     rillig   2134: Essentially, you should provide a fresh system, either a chroot environment
1.71      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.6       rillig   2139: certain packages tried to install files outside the
                   2140: <code class="filename">LOCALBASE</code> or wanted to edit some files in
1.71      wiz      2141: <code class="filename">/etc</code>.
                   2142: </p>
1.6       rillig   2143: </div>
1.41      asau     2144: <div class="sect1">
1.6       rillig   2145: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.180     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.41      asau     2148: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      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.15      rillig   2151: </ul></div>
1.41      asau     2152: <div class="sect2">
1.15      rillig   2153: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   2154: <a name="bulk.pbulk.conf"></a>8.2.1. Configuration</h3></div></div></div>
1.112     rillig   2155: <p>To simplify configuration, we provide the helper script <code class="filename">mk/pbulk/pbulk.sh</code>.</p>
1.68      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.112     rillig   2158: Create a user with name "pbulk".</p>
1.68      asau     2159: <p>Fetch and extract pkgsrc. Use a command like one of these:</p>
                   2160: <pre class="screen">
1.151     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.72      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.68      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.118     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.68      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.112     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.68      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.112     rillig   2185: with your list of packages, one per line without empty lines or comments. E.g.:</p>
1.68      asau     2186: <pre class="programlisting">
                   2187: www/firefox
                   2188: mail/thunderbird
                   2189: misc/libreoffice4
                   2190: </pre>
1.69      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.68      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.6       rillig   2211: </div>
                   2212: </div>
1.41      asau     2213: <div class="sect1">
1.6       rillig   2214: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2215: <a name="bulk.req"></a>8.3. Requirements of a full bulk build</h2></div></div></div>
1.71      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.178     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.179     rillig   2238: <a name="bulk.var.confopt"></a>8.4.1. Detect unknown configure options</h3></div></div></div>
1.178     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.179     rillig   2249: <a name="bulk.var.comperr"></a>8.4.2. Detect classes of bugs by forcing compiler warnings</h3></div></div></div>
1.178     rillig   2250: <p>The job of a compiler is not restricted to producing executable
1.179     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.178     rillig   2257: <pre class="programlisting">
                   2258: CFLAGS+=        -Werror=char-subscripts
1.179     rillig   2259: CFLAGS+=        -Werror=implicit-function-declaration
1.178     rillig   2260: </pre>
1.179     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.178     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.179     rillig   2270: <li class="listitem"><p>The exact error message from the compiler.</p></li>
1.178     rillig   2271: </ul></div>
                   2272: <p>If a package produces these error messages, but the package is
1.179     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.178     rillig   2275: <pre class="programlisting">
1.179     rillig   2276: .if ${PKGPATH} == category/package
1.178     rillig   2277: # Version ${VERSION} failed on ${MACHINE_PLATFORM}:
                   2278: # error message
                   2279: # code
1.179     rillig   2280: # Reason why the code does not need to be fixed.
1.178     rillig   2281: BUILDLINK_TRANSFORM+=   rm:-Werror=char-subscripts
1.179     rillig   2282: .endif
1.178     rillig   2283: </pre>
                   2284: <p>If the error messages from the compiler are valid and the code
1.179     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.178     rillig   2292: </div>
                   2293: <div class="sect2">
                   2294: <div class="titlepage"><div><div><h3 class="title">
1.181     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.178     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.181     rillig   2390: <a name="bulk.var.warn"></a>8.4.5. Turn warnings into errors</h3></div></div></div>
1.178     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.179     rillig   2400: <p>If a package suggests to add <code class="varname">USE_TOOLS+=perl</code> to
1.178     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.181     rillig   2408: <a name="bulk.var.pkglint"></a>8.4.6. Reject packages for which pkglint reports errors</h3></div></div></div>
1.178     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.181     rillig   2416: <a name="bulk.var.strings"></a>8.4.7. Reject packages that contain forbidden strings</h3></div></div></div>
1.178     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.181     rillig   2433: <a name="bulk.var.test"></a>8.4.8. Reject packages whose self-test fails</h3></div></div></div>
1.178     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.181     rillig   2446: <a name="bulk.var.shvar"></a>8.4.9. Reject packages that use undefined shell variables</h3></div></div></div>
1.178     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.181     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.178     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.181     rillig   2462: <a name="bulk.var.quiet"></a>8.4.10. Turn off verbose logging</h3></div></div></div>
1.178     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.1       dsieger  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.137     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.1       dsieger  2483:     a simple tool for creating the ISO 9660 images.
1.10      hubertf  2484:     <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.1       dsieger  2485:     way that keeps all the dependencies for a given package on the same
                   2486:     CD as that package.</p>
1.41      asau     2487: <div class="sect2">
1.1       dsieger  2488: <div class="titlepage"><div><div><h3 class="title">
1.178     rillig   2489: <a name="cdpack-example"></a>8.5.1. Example of cdpack</h3></div></div></div>
1.1       dsieger  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>
                   2498: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
                   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.175     gutterid 2504:       directory which contains these files, e.g.:</p>
1.1       dsieger  2505: <pre class="screen">
                   2506: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
                   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>
                   2512: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
                   2513:       </pre>
                   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>
                   2516: <p>Each image will contain <code class="filename">README</code>,
                   2517:       <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
                   2518:       in their root directories.</p>
                   2519: </div>
                   2520: </div>
                   2521: </div>
1.41      asau     2522: <div class="chapter">
1.1       dsieger  2523: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   2524: <a name="files"></a>Chapter 9. Directory layout of the installed files</h2></div></div></div>
1.1       dsieger  2525: <div class="toc">
                   2526: <p><b>Table of Contents</b></p>
1.100     leot     2527: <dl class="toc">
1.154     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.1       dsieger  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>
                   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">
                   2544: LOCALBASE=              /usr/pkg
                   2545: PKG_SYSCONFBASE=        /usr/pkg/etc
                   2546: VARBASE=                /var
1.119     sevan    2547: PKG_DBDIR=              /usr/pkg/pkgdb
1.1       dsieger  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">
                   2552: LOCALBASE=              ${HOME}/pkg
                   2553: PKG_SYSCONFBASE=        ${HOME}/pkg/etc
                   2554: VARBASE=                ${HOME}/pkg/var
1.119     sevan    2555: PKG_DBDIR=              ${HOME}/pkg/pkgdb
1.1       dsieger  2556: </pre>
                   2557: <p>What these four directories are for, and what they look like is
                   2558: explained below.</p>
1.41      asau     2559: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      2560: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.1       dsieger  2561: <code class="filename">/usr</code> directory in the base system. It is the
1.23      wiz      2562: <span class="quote">&#8220;<span class="quote">main</span>&#8221;</span> directory where the files are installed and contains
1.1       dsieger  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.23      wiz      2567: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.1       dsieger  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.23      wiz      2571: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.1       dsieger  2572: <code class="filename">/etc</code> in the base system. It contains configuration
1.10      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.1       dsieger  2574: itself.</p></li>
                   2575: </ul></div>
1.41      asau     2576: <div class="sect1">
1.1       dsieger  2577: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2578: <a name="files.localbase"></a>9.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.1       dsieger  2579: </h2></div></div></div>
                   2580: <p>The following directories exist in a typical pkgsrc installation
                   2581: in <code class="filename">${LOCALBASE}</code>.</p>
1.41      asau     2582: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  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.41      asau     2642: <div class="sect1">
1.1       dsieger  2643: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2644: <a name="files.varbase"></a>9.2. File system layout in <code class="literal">${VARBASE}</code>
1.1       dsieger  2645: </h2></div></div></div>
1.41      asau     2646: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  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.41      asau     2663: <div class="chapter">
1.1       dsieger  2664: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   2665: <a name="faq"></a>Chapter 10. Frequently Asked Questions</h2></div></div></div>
1.1       dsieger  2666: <div class="toc">
                   2667: <p><b>Table of Contents</b></p>
1.100     leot     2668: <dl class="toc">
1.154     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.23      wiz      2679: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</a></span></dt>
1.154     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.1       dsieger  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.41      asau     2692: <div class="sect1">
1.1       dsieger  2693: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2694: <a name="mailing-list-pointers"></a>10.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.1       dsieger  2695: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.41      asau     2696: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      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.1       dsieger  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.174     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.1       dsieger  2707:          A list where the results of pkgsrc bulk builds are sent and
                   2708:          discussed.</p></li>
1.174     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.1       dsieger  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">
                   2718: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
                   2719: </pre>
                   2720: <p>Archives for all these mailing lists are available from
1.174     leot     2721: <a class="ulink" href="https://mail-index.NetBSD.org/" target="_top">https://mail-index.NetBSD.org/</a>.</p>
1.1       dsieger  2722: </div>
1.41      asau     2723: <div class="sect1">
1.1       dsieger  2724: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2725: <a name="faq-pkgtools"></a>10.2. Utilities for package management (pkgtools)</h2></div></div></div>
1.1       dsieger  2726: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
                   2727: a number of useful utilities for both users and developers of pkgsrc.  This
1.121     sevan    2728: section attempts only to make the reader aware of some of the utilities and when
1.1       dsieger  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.137     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.1       dsieger  2733:       Symlinks for use by buildlink.</p></li></ul></div>
                   2734: <p>OS tool augmentation (automatically installed when needed):</p>
1.41      asau     2735: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.137     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.121     sevan    2737:       Calculates various kinds of checksums (including SHA3).</p></li>
1.137     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.1       dsieger  2739:       Compatibility library for pkgsrc tools.</p></li>
1.137     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.1       dsieger  2741:       non-BSD systems due to lack of native mtree.</p></li>
1.137     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.1       dsieger  2743:       Up-to-date replacement for
                   2744:       <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
                   2745:       systems where pkg_install is not present.</p></li>
                   2746: </ul></div>
                   2747: <p>Utilities used by pkgsrc (not automatically installed):</p>
1.41      asau     2748: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.137     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.1       dsieger  2750:       Create a binary package from an
1.10      hubertf  2751:       already-installed package.  Used by <span class="command"><strong>make replace</strong></span> to
1.1       dsieger  2752:       save the old package.</p></li>
1.137     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.1       dsieger  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.137     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.16      jnemeth  2758:       the best compiler flags to optimise code for your current
1.23      wiz      2759:       CPU and compiler. </p></li>
1.1       dsieger  2760: </ul></div>
                   2761: <p>Utilities for keeping track of installed packages, being up to date,
                   2762: etc:</p>
1.41      asau     2763: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.137     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.65      wiz      2765:     update tool similar to apt(1). Download, install, and upgrade
                   2766:     binary packages easily.</p></li>
1.137     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.1       dsieger  2768:       packages whose installed versions do not match the latest pkgsrc
                   2769:       entries.</p></li>
1.137     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.1       dsieger  2771:       dependency graphs of packages, to aid in choosing a strategy for
                   2772:       updating.</p></li>
1.137     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.12      weinem   2776:       pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.137     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.1       dsieger  2778:       does various checks on the complete pkgsrc system.</p></li>
1.137     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.1       dsieger  2780:       packages you have installed.</p></li>
                   2781: </ul></div>
                   2782: <p>Utilities for people maintaining or creating individual packages:</p>
1.41      asau     2783: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.137     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.1       dsieger  2785:       making and maintaining patches for a package (includes pkgdiff,
                   2786:       pkgvi, mkpatches, etc.).</p></li>
1.137     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.1       dsieger  2788:       converting to pkgsrc.</p></li>
                   2789: </ul></div>
                   2790: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
                   2791: utilities)</p>
1.41      asau     2792: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.137     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.1       dsieger  2794:       packages in a chrooted area.</p></li>
1.137     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.1       dsieger  2796:       kernel version for chrooted cross builds.</p></li>
                   2797: </ul></div>
                   2798: </div>
1.41      asau     2799: <div class="sect1">
1.1       dsieger  2800: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2801: <a name="non-root-pkgsrc"></a>10.3. How to use pkgsrc as non-root</h2></div></div></div>
1.108     rillig   2802: <p>To install packages from source as a non-root user, download
1.154     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.108     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.1       dsieger  2810: </div>
1.41      asau     2811: <div class="sect1">
1.1       dsieger  2812: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2813: <a name="resume-transfers"></a>10.4. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.1       dsieger  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.10      hubertf  2817: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  If, during a fetch step, an incomplete
1.1       dsieger  2818: distfile is found, pkgsrc will try to resume it.</p>
                   2819: <p>You can also
1.61      wiz      2820: use a different program than the platform default program by changing the
1.16      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.1       dsieger  2828: <p>For example, if you want to use
1.16      jnemeth  2829: <code class="filename">wget</code> to download, you'll have to use something
1.1       dsieger  2830: like:</p>
                   2831: <pre class="programlisting">
1.112     rillig   2832: FETCH_USING=    wget
1.1       dsieger  2833: </pre>
                   2834: </div>
1.41      asau     2835: <div class="sect1">
1.1       dsieger  2836: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     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.4       rillig   2838: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.1       dsieger  2839: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
                   2840: you will have to add the following line into
1.10      hubertf  2841: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1       dsieger  2842: <pre class="programlisting">
1.4       rillig   2843: X11_TYPE=modular
1.1       dsieger  2844: </pre>
                   2845: </div>
1.41      asau     2846: <div class="sect1">
1.1       dsieger  2847: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2848: <a name="fetch-behind-firewall"></a>10.6. How to fetch files from behind a firewall</h2></div></div></div>
1.1       dsieger  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.23      wiz      2853: <span class="quote">&#8220;<span class="quote">orpheus.amdahl.com</span>&#8221;</span> is one of the firewalls, and it uses
1.1       dsieger  2854: port 80 as the proxy port number.  So the proxy environment variables
                   2855: are:</p>
                   2856: <pre class="programlisting">
                   2857: ftp_proxy=ftp://orpheus.amdahl.com:80/
                   2858: http_proxy=http://orpheus.amdahl.com:80/
                   2859: </pre>
                   2860: </div>
1.41      asau     2861: <div class="sect1">
1.1       dsieger  2862: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2863: <a name="fetch-https"></a>10.7. How to fetch files from HTTPS sites</h2></div></div></div>
1.65      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.154     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.1       dsieger  2879: <p>This depends on which utility is used to retrieve distfiles.  From
                   2880: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
                   2881: the first available command from the following list:</p>
1.41      asau     2882: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      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.1       dsieger  2885: </ul></div>
                   2886: <p>On a default NetBSD installation, this will be
                   2887: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
                   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.10      hubertf  2890: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.1       dsieger  2891: <code class="varname">PASSIVE_FETCH=1</code>.</p>
                   2892: <p>Having that option present will prevent
                   2893: <code class="filename">/usr/bin/ftp</code> from falling back to active
                   2894: transfers.</p>
                   2895: </div>
1.41      asau     2896: <div class="sect1">
1.1       dsieger  2897: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2898: <a name="fetching-all-distfiles"></a>10.9. How to fetch all distfiles at once</h2></div></div></div>
1.1       dsieger  2899: <p>You would like to download all the distfiles in a single batch
1.10      hubertf  2900: from work or university, where you can't run a <span class="command"><strong>make
1.25      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.1       dsieger  2902: but downloading the entire directory may not be appropriate.</p>
1.10      hubertf  2903: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.1       dsieger  2904: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
                   2905: resulting list to your machine at work/school and use it there.  If you
1.197     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.1       dsieger  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>
                   2915: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
                   2916: home.</p>
                   2917: <p>If you have a machine running NetBSD, and you want to get
                   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.10      hubertf  2920: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.1       dsieger  2921: directly by running:</p>
                   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.41      asau     2928: <div class="sect1">
1.1       dsieger  2929: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     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.23      wiz      2931: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</h2></div></div></div>
1.137     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.1       dsieger  2933: package, you get the error from make that it doesn't know how to make
                   2934: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.23      wiz      2935: you don't have installed the <span class="quote">&#8220;<span class="quote">text</span>&#8221;</span> set (nroff, ...) from
1.1       dsieger  2936: the NetBSD base distribution on your machine.  It is recommended to do
                   2937: that to format man pages.</p>
1.137     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.1       dsieger  2939: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.10      hubertf  2940: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1       dsieger  2941: </div>
1.41      asau     2942: <div class="sect1">
1.1       dsieger  2943: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     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.1       dsieger  2945: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
                   2946: when you installed your NetBSD machine.  Please get and install it, by
                   2947: extracting it in <code class="filename">/</code>:</p>
                   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>
                   2950: <p><code class="filename">comp.tgz</code> is part of every NetBSD release.  Get
1.10      hubertf  2951: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.1       dsieger  2952: -r</strong></span>).</p>
                   2953: </div>
1.41      asau     2954: <div class="sect1">
1.1       dsieger  2955: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2956: <a name="using-sudo-with-pkgsrc"></a>10.12. Using 'sudo' with pkgsrc</h2></div></div></div>
1.1       dsieger  2957: <p>When installing packages as non-root user and using the just-in-time
1.197     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.1       dsieger  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.137     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.10      hubertf  2963: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.1       dsieger  2964: <span class="emphasis"><em>after</em></span> the definition of the
                   2965: <code class="varname">LOCALBASE</code> variable:</p>
                   2966: <pre class="programlisting">
                   2967: .if exists(${LOCALBASE}/bin/sudo)
                   2968: SU_CMD=        ${LOCALBASE}/bin/sudo /bin/sh -c
                   2969: .endif
                   2970: </pre>
                   2971: </div>
1.41      asau     2972: <div class="sect1">
1.1       dsieger  2973: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2974: <a name="faq.conf"></a>10.13. How do I change the location of configuration files?</h2></div></div></div>
1.1       dsieger  2975: <p>As the system administrator, you can choose where configuration files
                   2976: are installed.  The default settings make all these files go into
                   2977: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
                   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.10      hubertf  2983: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.1       dsieger  2984: directory; some common examples include <code class="filename">/etc</code> or
                   2985: <code class="filename">/etc/pkg</code>.</p>
                   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.41      asau     2994: <div class="sect1">
1.1       dsieger  2995: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2996: <a name="audit-packages"></a>10.14. Automated security checks</h2></div></div></div>
1.1       dsieger  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.14      jmcneill 3003: do this, refer to the following two tools (installed as part of the
1.137     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.23      wiz      3005: <div class="orderedlist"><ol class="orderedlist" type="1">
                   3006: <li class="listitem">
1.20      snj      3007: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.1       dsieger  3008:     download a list of the security vulnerabilities information.  This list
1.25      spz      3009:     is kept up to date by the pkgsrc security team, and is distributed
                   3010:     from the NetBSD ftp server:</p>
1.177     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.1       dsieger  3012: </li>
1.23      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.1       dsieger  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.121     sevan    3019: <p>Use of these tools is strongly recommended!
1.202     nia      3020: See <a class="xref" href="#vulnerabilities" title="5.1.6. Checking for security vulnerabilities in installed packages">Section 5.1.6, &#8220;Checking for security vulnerabilities in installed packages&#8221;</a> for instructions on how to automate checking and
1.121     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.1       dsieger  3024: </div>
1.41      asau     3025: <div class="sect1">
1.1       dsieger  3026: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     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.1       dsieger  3028: <p>When you add your own preferences to the
                   3029:        <code class="varname">CFLAGS</code> variable in your
1.10      hubertf  3030:        <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.1       dsieger  3031:        environment variables to the <code class="filename">./configure</code>
1.197     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.1       dsieger  3033:        <code class="varname">CFLAGS</code> from the environment variable by
                   3034:        overriding them in the <code class="filename">Makefile</code>s of their
                   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.10      hubertf  3038:        you should run <span class="command"><strong>make patch</strong></span> in the package
1.1       dsieger  3039:        directory and then inspect any <code class="filename">Makefile</code> and
                   3040:        <code class="filename">Makefile.in</code> for whether they define
                   3041:        <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.23      wiz      3042:        these lines. But be aware that some <span class="quote">&#8220;<span class="quote">smart</span>&#8221;</span>
1.1       dsieger  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.172     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.184     rillig   3061: the <a class="link" href="#build.wrapper" title="13.10. The wrapper phase">pkgsrc compiler wrappers</a>.</p>
1.1       dsieger  3062: </div>
1.41      asau     3063: <div class="sect1">
1.1       dsieger  3064: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   3065: <a name="ufaq-fail"></a>10.16. A package does not build.  What shall I do?</h2></div></div></div>
1.23      wiz      3066: <div class="procedure"><ol class="procedure" type="1">
1.41      asau     3067: <li class="step"><p>Make sure that your copy of pkgsrc is consistent. A
1.1       dsieger  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.41      asau     3073: <li class="step"><p>Make sure that you don't have any CVS conflicts.
1.23      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.1       dsieger  3076:        files.</p></li>
1.41      asau     3077: <li class="step"><p>Make sure that you don't have old copies of the packages
1.10      hubertf  3078:        extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.1       dsieger  3079:        verify this.</p></li>
1.108     rillig   3080: <li class="step"><p>If you are a package developer who wants to invest
1.154     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.41      asau     3082: <li class="step"><p>If the problem still exists, write a mail to the
1.1       dsieger  3083:        <code class="literal">pkgsrc-users</code> mailing list.</p></li>
                   3084: </ol></div>
                   3085: </div>
1.41      asau     3086: <div class="sect1">
1.1       dsieger  3087: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     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.1       dsieger  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.10      hubertf  3096: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.1       dsieger  3097: -dP</strong></span> in that directory to download the current version.</p>
                   3098: </div>
                   3099: </div>
                   3100: </div>
1.41      asau     3101: <div class="part">
1.1       dsieger  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.41      asau     3104: <div class="partintro">
1.1       dsieger  3105: <div></div>
                   3106: <p>This part of the book deals with creating and
1.23      wiz      3107:        modifying packages. It starts with a <span class="quote">&#8220;<span class="quote">HOWTO</span>&#8221;</span>-like
1.1       dsieger  3108:        guide on creating a new package. The remaining chapters are more
                   3109:        like a reference manual for pkgsrc.</p>
                   3110: <div class="toc">
                   3111: <p><b>Table of Contents</b></p>
1.100     leot     3112: <dl class="toc">
1.154     rillig   3113: <dt><span class="chapter"><a href="#help-devel">11. Getting help</a></span></dt>
1.184     rillig   3114: <dt><span class="chapter"><a href="#components">12. Package components - files, directories and contents</a></span></dt>
1.1       dsieger  3115: <dd><dl>
1.184     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.1       dsieger  3119: <dd><dl>
1.184     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.1       dsieger  3125: </dl></dd>
1.184     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.6       rillig   3135: </dl></dd>
1.184     rillig   3136: <dt><span class="chapter"><a href="#build">13. The build process</a></span></dt>
1.6       rillig   3137: <dd><dl>
1.184     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.6       rillig   3143: <dd><dl>
1.184     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.6       rillig   3146: </dl></dd>
1.184     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.6       rillig   3163: <dd><dl>
1.184     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.6       rillig   3168: </dl></dd>
1.184     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.6       rillig   3171: </dl></dd>
1.184     rillig   3172: <dt><span class="chapter"><a href="#makefile">15. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.6       rillig   3173: <dd><dl>
1.184     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.6       rillig   3178: <dd><dl>
1.184     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.6       rillig   3183: </dl></dd>
                   3184: </dl></dd>
1.184     rillig   3185: <dt><span class="chapter"><a href="#options">16. Options handling</a></span></dt>
1.6       rillig   3186: <dd><dl>
1.184     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.6       rillig   3191: </dl></dd>
1.184     rillig   3192: <dt><span class="chapter"><a href="#tools">17. Tools needed for building or running</a></span></dt>
1.6       rillig   3193: <dd><dl>
1.184     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.6       rillig   3202: <dd><dl>
1.184     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.26      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.6       rillig   3209: </dl></dd>
1.184     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.6       rillig   3217: <dd><dl>
1.184     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.6       rillig   3227: </dl></dd>
1.184     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.6       rillig   3234: </dl></dd>
1.184     rillig   3235: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
1.6       rillig   3236: <dd><dl>
1.184     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.154     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>
1.203   ! nia      3282: <dt><span class="sect2"><a href="#perl-scripts">21.4.3. Packages containing Perl scripts</a></span></dt>
1.154     rillig   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.172     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.154     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>
1.203   ! nia      3301: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing Perl modules</a></span></dt>
1.154     rillig   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>
1.203   ! nia      3304: <dt><span class="sect2"><a href="#x11-fonts">21.6.9. Packages installing X11 fonts</a></span></dt>
        !          3305: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.10. Packages installing SGML or XML data</a></span></dt>
        !          3306: <dt><span class="sect2"><a href="#mime-database">21.6.11. Packages installing extensions to the MIME database</a></span></dt>
        !          3307: <dt><span class="sect2"><a href="#intltool">21.6.12. Packages using intltool</a></span></dt>
        !          3308: <dt><span class="sect2"><a href="#startup-scripts">21.6.13. Packages installing startup scripts</a></span></dt>
        !          3309: <dt><span class="sect2"><a href="#tex-packages">21.6.14. Packages installing TeX modules</a></span></dt>
        !          3310: <dt><span class="sect2"><a href="#emulation-packages">21.6.15. Packages supporting running binaries in
1.1       dsieger  3311:     emulation</a></span></dt>
1.203   ! nia      3312: <dt><span class="sect2"><a href="#hicolor-theme">21.6.16. Packages installing hicolor icons</a></span></dt>
        !          3313: <dt><span class="sect2"><a href="#desktop-files">21.6.17. Packages installing desktop files</a></span></dt>
1.1       dsieger  3314: </dl></dd>
1.154     rillig   3315: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.1       dsieger  3316: </dl></dd>
1.184     rillig   3317: <dt><span class="chapter"><a href="#gnome">22. GNOME packaging and porting</a></span></dt>
                   3318: <dd><dl>
                   3319: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
                   3320: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
                   3321: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
                   3322: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
                   3323: </dl></dd>
1.154     rillig   3324: <dt><span class="chapter"><a href="#submit">23. Submitting and Committing</a></span></dt>
1.1       dsieger  3325: <dd><dl>
1.154     rillig   3326: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
                   3327: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   3328: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
                   3329: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
                   3330: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
                   3331: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
                   3332: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
                   3333: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
                   3334: </dl></dd>
                   3335: <dt><span class="chapter"><a href="#devfaq">24. Frequently Asked Questions</a></span></dt>
1.1       dsieger  3336: </dl>
                   3337: </div>
                   3338: </div>
1.41      asau     3339: <div class="chapter">
1.1       dsieger  3340: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   3341: <a name="help-devel"></a>Chapter 11. Getting help</h2></div></div></div>
                   3342: <p>
                   3343:        To get help when developing pkgsrc, the definitive source is this
                   3344:        document, the pkgsrc guide. If you don't find anything here,
                   3345:        there are alternatives:
                   3346: </p>
                   3347: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   3348: <li class="listitem">
                   3349: <p>
                   3350:        The built-in pkgsrc help, which is available after bootstrapping
                   3351:        pkgsrc. Run <span class="command"><strong>bmake help topic=&#8230;</strong></span> to get
                   3352:        help for any topic, such as a variable name like
                   3353:        <code class="varname">BUILD_DEFS</code>, a make target like
                   3354:        <span class="command"><strong>do-build</strong></span>, a missing C or C++ function like
                   3355:        <span class="command"><strong>strcasecmp</strong></span> or any other topic.</p>
                   3356: <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>
                   3357: </li>
                   3358: <li class="listitem"><p>
1.163     rillig   3359:        To see the value of a single variable, run <span class="command"><strong>bmake
                   3360:        show-var VARNAME=<em class="replaceable"><code>X</code></em></strong></span>.
                   3361: </p></li>
                   3362: <li class="listitem"><p>
                   3363:        To see the values of the most common variables, run
                   3364:        <span class="command"><strong>bmake show-all</strong></span>. These variables are grouped by
                   3365:        topic. To see the variables for a single topic, run
                   3366:        <span class="command"><strong>bmake
                   3367:        show-all-<em class="replaceable"><code>topic</code></em></strong></span>, for example
                   3368:        <span class="command"><strong>bmake show-all-fetch</strong></span>.
                   3369: </p></li>
                   3370: <li class="listitem"><p>
1.154     rillig   3371:        The tech-pkg mailing list, to which
                   3372:        <a class="ulink" href="https://www.NetBSD.org/mailinglists/#tech-pkg" target="_top">you
                   3373:        can subscribe</a> and then <a class="ulink" href="mailto:tech-pkg@NetBSD.org" target="_top">ask your
                   3374:        questions</a>.</p></li>
                   3375: <li class="listitem"><p>The #pkgsrc IRC channel, which is accessible
                   3376:        <a class="ulink" href="https://webchat.freenode.net/" target="_top">via a web browser</a>
                   3377:        or by using a specialized chat program such as
                   3378:        <a class="ulink" href="http://xchat.org/" target="_top">XChat</a>.
                   3379:        Pick any user name and join the channel #pkgsrc.</p></li>
                   3380: </ul></div>
                   3381: </div>
                   3382: <div class="chapter">
                   3383: <div class="titlepage"><div><div><h2 class="title">
1.184     rillig   3384: <a name="components"></a>Chapter 12. Package components - files, directories and contents</h2></div></div></div>
1.1       dsieger  3385: <div class="toc">
                   3386: <p><b>Table of Contents</b></p>
1.100     leot     3387: <dl class="toc">
1.184     rillig   3388: <dt><span class="sect1"><a href="#components.Makefile">12.1. <code class="filename">Makefile</code></a></span></dt>
                   3389: <dt><span class="sect1"><a href="#components.distinfo">12.2. <code class="filename">distinfo</code></a></span></dt>
                   3390: <dt><span class="sect1"><a href="#components.patches">12.3. <code class="filename">patches/*</code></a></span></dt>
                   3391: <dd><dl>
                   3392: <dt><span class="sect2"><a href="#components.patch.structure">12.3.1. Structure of a single patch file</a></span></dt>
                   3393: <dt><span class="sect2"><a href="#components.patches.caveats">12.3.2. Creating patch files</a></span></dt>
                   3394: <dt><span class="sect2"><a href="#components.patches.sources">12.3.3. Sources where the patch files come from</a></span></dt>
                   3395: <dt><span class="sect2"><a href="#components.patches.guidelines">12.3.4. Patching guidelines</a></span></dt>
                   3396: <dt><span class="sect2"><a href="#components.patches.feedback">12.3.5. Feedback to the author</a></span></dt>
                   3397: </dl></dd>
                   3398: <dt><span class="sect1"><a href="#other-mandatory-files">12.4. Other mandatory files</a></span></dt>
                   3399: <dt><span class="sect1"><a href="#components.optional">12.5. Optional files</a></span></dt>
                   3400: <dd><dl>
                   3401: <dt><span class="sect2"><a href="#components.optional.bin">12.5.1. Files affecting the binary package</a></span></dt>
                   3402: <dt><span class="sect2"><a href="#components.optional.build">12.5.2. Files affecting the build process</a></span></dt>
                   3403: <dt><span class="sect2"><a href="#components.optional.none">12.5.3. Files affecting nothing at all</a></span></dt>
1.1       dsieger  3404: </dl></dd>
1.184     rillig   3405: <dt><span class="sect1"><a href="#work-dir">12.6. <code class="filename">work*</code></a></span></dt>
                   3406: <dt><span class="sect1"><a href="#files-dir">12.7. <code class="filename">files/*</code></a></span></dt>
1.1       dsieger  3407: </dl>
                   3408: </div>
1.184     rillig   3409: <p>Whenever you're preparing a package, there are a number of
                   3410: files involved which are described in the following
                   3411: sections.</p>
                   3412: <div class="sect1">
                   3413: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   3414: <a name="components.Makefile"></a>12.1. <code class="filename">Makefile</code>
                   3415: </h2></div></div></div>
                   3416: <p>Building, installation and creation of a binary package are all
                   3417:   controlled by the package's <code class="filename">Makefile</code>.
                   3418:   The <code class="filename">Makefile</code> describes various things about
                   3419:   a package, for example from where to get it, how to configure,
                   3420:   build, and install it.</p>
                   3421: <p>A package <code class="filename">Makefile</code> contains several
                   3422:   sections that describe the package.</p>
                   3423: <p>In the first section there are the following variables, which
                   3424:   should appear exactly in the order given here.  The order and
                   3425:   grouping of the variables is mostly historical and has no further
                   3426:   meaning.</p>
                   3427: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   3428: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
                   3429:     distribution file to be downloaded from the package's
                   3430:     website.</p></li>
                   3431: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
                   3432:     package, as used by pkgsrc. You need to provide it if
                   3433:     <code class="varname">DISTNAME</code> (which is the default) is not a good
                   3434:     name for the package in pkgsrc or <code class="varname">DISTNAME</code> is not
                   3435:     provided (no distribution file is required).  Usually it is the pkgsrc
                   3436:     directory name together with the version number. It must match the
                   3437:     regular expression
                   3438:     <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
                   3439:     starts with a letter or digit, and contains only letters, digits,
                   3440:     dashes, underscores, dots and plus signs.</p></li>
                   3441: <li class="listitem">
                   3442: <p><code class="varname">CATEGORIES</code> is a list of categories
                   3443:     which the package fits in. You can choose any of the top-level
                   3444:     directories of pkgsrc for it.</p>
                   3445: <p>Currently the following values are available for
                   3446:     <code class="varname">CATEGORIES</code>. If more than
                   3447:     one is used, they need to be separated by spaces:</p>
1.1       dsieger  3448: <pre class="programlisting">
1.184     rillig   3449: archivers     cross         geography     meta-pkgs     security
                   3450: audio         databases     graphics      misc          shells
                   3451: benchmarks    devel         ham           multimedia    sysutils
                   3452: biology       editors       inputmethod   net           textproc
                   3453: cad           emulators     lang          news          time
                   3454: chat          finance       mail          parallel      wm
                   3455: comms         fonts         math          pkgtools      www
                   3456: converters    games         mbone         print         x11
1.1       dsieger  3457: </pre>
                   3458: </li>
1.184     rillig   3459: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
                   3460:     <code class="varname">DYNAMIC_MASTER_SITES</code>,
                   3461:     <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
                   3462:     and <code class="varname">DISTFILES</code> are discussed in detail in
                   3463:     <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>
                   3464: </ul></div>
                   3465: <p>The second section contains information about separately
                   3466:   downloaded patches, if any.
                   3467:   </p>
                   3468: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   3469: <li class="listitem"><p><code class="varname">PATCHFILES</code>:
                   3470:     Name(s) of additional files that contain distribution patches.
                   3471:     There is no default. pkgsrc will look for them at
                   3472:     <code class="varname">PATCH_SITES</code>.
                   3473:     They will automatically be uncompressed before patching if
                   3474:     the names end with <code class="filename">.gz</code> or
                   3475:     <code class="filename">.Z</code>.</p></li>
                   3476: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
                   3477:     Primary location(s) for distribution patch files (see
                   3478:     <code class="varname">PATCHFILES</code> above) if not found locally.</p></li>
                   3479: <li class="listitem"><p><code class="varname">PATCH_DIST_STRIP</code>:
1.197     leot     3480:     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.184     rillig   3481:     help find the correct files to patch. It defaults to
                   3482:     <span class="command"><strong>-p0</strong></span>.</p></li>
                   3483: </ul></div>
                   3484: <p>The third section contains the following variables.
                   3485:   </p>
                   3486: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   3487: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email
                   3488:     address of the person who feels responsible for this package,
                   3489:     and who is most likely to look at problems or questions regarding
1.197     leot     3490:     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.184     rillig   3491:     Other developers may contact the <code class="varname">MAINTAINER</code>
                   3492:     before making changes to the package, but are not required to
                   3493:     do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
                   3494:     to yourself. If you really can't maintain the package for future
                   3495:     updates, set it to
                   3496:     <code class="email">&lt;<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>&gt;</code>.</p></li>
                   3497: <li class="listitem"><p><code class="varname">OWNER</code> should be used instead
                   3498:     of <code class="varname">MAINTAINER</code> when you do not want other
                   3499:     developers to update or change the package without contacting
                   3500:     you first. A package Makefile should contain one of
                   3501:     <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
                   3502:     not both.  </p></li>
                   3503: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
                   3504:     find more information about the package.</p></li>
                   3505: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
                   3506:     description of the package (should not include the package
                   3507:     name).</p></li>
                   3508: <li class="listitem"><p><code class="varname">LICENSE</code> indicates the license(s)
                   3509:     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>
                   3510: </ul></div>
                   3511: <p>Other variables that affect the build:
                   3512:   </p>
                   3513: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
                   3514: <p><code class="varname">WRKSRC</code>: The directory where the
                   3515:       interesting distribution files of the package are found. The
                   3516:       default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
                   3517:       works for most packages.</p>
                   3518: <p>If a package doesn't create a subdirectory for itself
                   3519:       (most GNU software does, for instance), but extracts itself in
                   3520:       the current directory, you should set
                   3521:       <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
                   3522: <p>If a package doesn't create a subdirectory with the
                   3523:       name of <code class="varname">DISTNAME</code> but some different name,
                   3524:       set <code class="varname">WRKSRC</code> to point to the proper name in
                   3525:       <code class="filename">${WRKDIR}</code>, for example
                   3526:       <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
                   3527:       <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>
                   3528: <p>The name of the working directory created by pkgsrc is
                   3529:       taken from the <code class="varname">WRKDIR_BASENAME</code>
                   3530:       variable. By default, its value is
                   3531:       <code class="filename">work</code>. If you want to use the same
                   3532:       pkgsrc tree for building different kinds of binary packages,
                   3533:       you can change the variable according to your needs. Two
                   3534:       other variables handle common cases of setting
                   3535:       <code class="varname">WRKDIR_BASENAME</code> individually. If
                   3536:       <code class="varname">OBJHOSTNAME</code> is defined in
                   3537:       <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
                   3538:       the host's name is attached to the directory name. If
                   3539:       <code class="varname">OBJMACHINE</code> is defined, the platform name
                   3540:       is attached, which might look like
                   3541:       <code class="filename">work.i386</code> or
                   3542:       <code class="filename">work.sparc</code>.</p>
                   3543: </li></ul></div>
                   3544: <p>Please pay attention to the following gotchas:</p>
                   3545: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   3546: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
                   3547:       installed in compressed form by the package.  For packages using
                   3548:       BSD-style makefiles which honor MANZ, there is
                   3549:       <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
                   3550: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
                   3551:       <span class="quote">&#8220;<span class="quote">${PREFIX}</span>&#8221;</span> in all files (see patches,
                   3552:       below).</p></li>
                   3553: <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>
                   3554: </ul></div>
                   3555: </div>
1.41      asau     3556: <div class="sect1">
1.1       dsieger  3557: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   3558: <a name="components.distinfo"></a>12.2. <code class="filename">distinfo</code>
                   3559: </h2></div></div></div>
                   3560: <p>The <code class="filename">distinfo</code> file contains the message
                   3561:   digest, or checksum, of each distfile needed for the package. This
                   3562:   ensures that the distfiles retrieved from the Internet have not been
                   3563:   corrupted during transfer or altered by a malign force to introduce
                   3564:   a security hole. To provide maximum security, all distfiles are
                   3565:   protected using three different message digest algorithms (SHA1,
                   3566:   RMD160, SHA512), as well as the file size.</p>
                   3567: <p>The <code class="filename">distinfo</code> file also contains the
                   3568:   checksums for all the patches found in the
                   3569:   <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
                   3570:   are only applied intentionally and that they don't accidentally change,
                   3571:   e.g. when merging different changes together. They also make sure that
                   3572:   new patches are actually added to CVS and old ones are removed.
                   3573:   Too see whether the patches and the <code class="filename">distinfo</code> file
                   3574:   match, run <span class="command"><strong>pkglint</strong></span> after changing the patches.</p>
                   3575: <p>To regenerate the <code class="filename">distinfo</code> file, use the
                   3576:   <span class="command"><strong>make distinfo</strong></span> command.</p>
                   3577: <p>Some packages have different sets of distfiles depending on
                   3578:   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
                   3579:   <code class="filename">distinfo</code> file and care should be taken when
                   3580:   upgrading such a package to ensure distfile information is not
                   3581:   lost.</p>
                   3582: </div>
                   3583: <div class="sect1">
                   3584: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   3585: <a name="components.patches"></a>12.3. <code class="filename">patches/*</code>
                   3586: </h2></div></div></div>
                   3587: <p>Some packages don't work out-of-the box on the various
                   3588:   platforms that are supported by pkgsrc. These packages need
                   3589:   to be patched to make them work. The patch files can be
                   3590:   found in the <code class="filename">patches/</code> directory.</p>
                   3591: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
                   3592:   applied to the files in <code class="varname">WRKSRC</code> directory after
                   3593:   extracting them, in alphabetic order.</p>
1.41      asau     3594: <div class="sect2">
1.1       dsieger  3595: <div class="titlepage"><div><div><h3 class="title">
1.184     rillig   3596: <a name="components.patch.structure"></a>12.3.1. Structure of a single patch file</h3></div></div></div>
                   3597: <p>The <code class="filename">patch-*</code> files should be in
                   3598:   <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
                   3599:   problems. (To force patches to apply with fuzz you can set
                   3600:   <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
                   3601:   should contain only changes for a single file, and no file should be
                   3602:   patched by more than one patch file. This helps to keep future
                   3603:   modifications simple.</p>
                   3604: <p>Each patch file is structured as follows: In the first line,
                   3605:   there is the RCS Id of the patch itself. The second line should be
                   3606:   empty for aesthetic reasons. After that, there should be a comment for
                   3607:   each change that the patch does. There are a number of standard
                   3608:   cases:</p>
                   3609: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   3610: <li class="listitem"><p>Patches for commonly known vulnerabilities should
                   3611:   mention the vulnerability ID (CAN, CVE).</p></li>
                   3612: <li class="listitem"><p>Patches that change source code should mention the
                   3613:   platform and other environment (for example, the compiler) that the
                   3614:   patch is needed for.</p></li>
                   3615: </ul></div>
                   3616: <p>The patch should be commented so that any
                   3617:   developer who knows the code of the application can make some use of
                   3618:   the patch. Special care should be taken for the upstream developers,
                   3619:   since we generally want that they accept our patches, so we have less
                   3620:   work in the future.</p>
1.1       dsieger  3621: </div>
1.41      asau     3622: <div class="sect2">
1.1       dsieger  3623: <div class="titlepage"><div><div><h3 class="title">
1.184     rillig   3624: <a name="components.patches.caveats"></a>12.3.2. Creating patch files</h3></div></div></div>
                   3625: <p>One important thing to mention is to pay attention that no RCS
                   3626:   IDs get stored in the patch files, as these will cause problems when
                   3627:   later checked into the NetBSD CVS tree. Use the
                   3628:   <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
                   3629:   problems.</p>
                   3630: <p>For even more automation, we recommend using
                   3631:   <span class="command"><strong>mkpatches</strong></span> from the same package to make a
                   3632:   whole set of patches. You just have to backup files before you
                   3633:   edit them to <code class="filename">filename.orig</code>, e.g. with
                   3634:   <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
                   3635:   using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
                   3636:   you upgrade a package this way, you can easily compare the new
                   3637:   set of patches with the previously existing one with
                   3638:   <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
                   3639:   are replaced by new files, so carefully check if you want to take all
                   3640:   the changes.</p>
                   3641: <p>When you have finished a package, remember to generate
                   3642:   the checksums for the patch files by using the <span class="command"><strong>make
                   3643:   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>
                   3644: <p>When adding a patch that corrects a problem in the
                   3645:   distfile (rather than e.g. enforcing pkgsrc's view of where
                   3646:   man pages should go), send the patch as a bug report to the
                   3647:   maintainer.  This benefits non-pkgsrc users of the package,
                   3648:   and usually makes it possible to remove the patch in future
                   3649:   version.</p>
                   3650: <p>The file names of the patch files are usually of the form
                   3651:   <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
                   3652:   Many packages still use the previous convention
                   3653:   <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
                   3654:   but new patches should be of the form containing the filename.
                   3655:   <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
                   3656:   automatically.</p>
1.17      imil     3657: </div>
1.160     brook    3658: <div class="sect2">
                   3659: <div class="titlepage"><div><div><h3 class="title">
1.184     rillig   3660: <a name="components.patches.sources"></a>12.3.3. Sources where the patch files come from</h3></div></div></div>
                   3661: <p>If you want to share patches between multiple packages
                   3662:   in pkgsrc, e.g. because they use the same distfiles, set
                   3663:   <code class="varname">PATCHDIR</code> to the path where the patch files
                   3664:   can be found, e.g.:</p>
                   3665: <pre class="programlisting">
                   3666: PATCHDIR=       ../../editors/xemacs/patches
                   3667: </pre>
                   3668: <p>Patch files that are distributed by the author or other
                   3669:     maintainers can be listed in
                   3670:     <code class="varname">PATCHFILES</code>.</p>
                   3671: <p>If it is desired to store any patches that should not be
                   3672:     committed into pkgsrc, they can be kept outside the pkgsrc
                   3673:     tree in the <code class="filename">$LOCALPATCHES</code> directory. The
                   3674:     directory tree there is expected to have the same
                   3675:     <span class="quote">&#8220;<span class="quote">category/package</span>&#8221;</span> structure as pkgsrc, and
                   3676:     patches are expected to be stored inside these dirs (also
                   3677:     known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
                   3678:     example, if you want to keep a private patch for
                   3679:     <code class="filename">pkgsrc/graphics/png</code>, keep it in
                   3680:     <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
                   3681:     files in the named directory are expected to be patch files,
                   3682:     and <span class="emphasis"><em>they are applied after pkgsrc patches are
                   3683:     applied</em></span>.</p>
1.160     brook    3684: </div>
                   3685: <div class="sect2">
                   3686: <div class="titlepage"><div><div><h3 class="title">
1.184     rillig   3687: <a name="components.patches.guidelines"></a>12.3.4. Patching guidelines</h3></div></div></div>
                   3688: <p>When fixing a portability issue in the code do not use
                   3689:       preprocessor magic to check for the current operating system nor
                   3690:       platform.  Doing so hurts portability to other platforms because
                   3691:       the OS-specific details are not abstracted appropriately.</p>
                   3692: <p>The general rule to follow is: instead of checking for the
                   3693:       operating system the application is being built on, check for the
                   3694:       specific <span class="emphasis"><em>features</em></span> you need.  For example,
                   3695:       instead of assuming that kqueue is available under NetBSD and
                   3696:       using the <code class="varname">__NetBSD__</code> macro to conditionalize
                   3697:       kqueue support, add a check that detects kqueue itself &mdash;
                   3698:       yes, this generally involves patching the
                   3699:       <span class="command"><strong>configure</strong></span> script.  There is absolutely nothing
                   3700:       that prevents some OSes from adopting interfaces from other OSes
                   3701:       (e.g. Linux implementing kqueue), something that the above checks
                   3702:       cannot take into account.</p>
                   3703: <p>Of course, checking for features generally involves more
                   3704:       work on the developer's side, but the resulting changes are
                   3705:       cleaner and there are chances they will work on many other
                   3706:       platforms.  Not to mention that there are higher chances of being
                   3707:       later integrated into the mainstream sources.  Remember:
                   3708:       <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
                   3709: <p>Some typical examples:</p>
                   3710: <div class="table">
                   3711: <a name="patch-examples"></a><p class="title"><b>Table 12.1. Patching examples</b></p>
                   3712: <div class="table-contents"><table class="table" summary="Patching examples" border="1">
                   3713: <colgroup>
                   3714: <col>
                   3715: <col>
                   3716: <col>
                   3717: </colgroup>
                   3718: <thead><tr>
                   3719: <th>Where</th>
                   3720: <th>Incorrect</th>
                   3721: <th>Correct</th>
                   3722: </tr></thead>
                   3723: <tbody>
                   3724: <tr>
                   3725: <td>configure script</td>
                   3726: <td>
1.160     brook    3727: <pre class="programlisting">
1.184     rillig   3728: case ${target_os} in
                   3729: netbsd*) have_kvm=yes ;;
                   3730: *)       have_kvm=no  ;;
                   3731: esac
1.160     brook    3732: </pre>
1.184     rillig   3733:              </td>
                   3734: <td>
1.160     brook    3735: <pre class="programlisting">
1.184     rillig   3736: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
1.160     brook    3737: </pre>
1.184     rillig   3738:              </td>
                   3739: </tr>
                   3740: <tr>
                   3741: <td>C source file</td>
                   3742: <td>
1.1       dsieger  3743: <pre class="programlisting">
1.184     rillig   3744: #if defined(__NetBSD__)
                   3745: #  include &lt;sys/event.h&gt;
                   3746: #endif
1.1       dsieger  3747: </pre>
1.184     rillig   3748:              </td>
                   3749: <td>
1.1       dsieger  3750: <pre class="programlisting">
1.184     rillig   3751: #if defined(HAVE_SYS_EVENT_H)
                   3752: #  include &lt;sys/event.h&gt;
                   3753: #endif
1.1       dsieger  3754: </pre>
1.184     rillig   3755:              </td>
                   3756: </tr>
                   3757: <tr>
                   3758: <td>C source file</td>
                   3759: <td>
1.1       dsieger  3760: <pre class="programlisting">
1.184     rillig   3761: int
                   3762: monitor_file(...)
                   3763: {
                   3764: #if defined(__NetBSD__)
                   3765:         int fd = kqueue();
                   3766:         ...
                   3767: #else
                   3768:         ...
                   3769: #endif
                   3770: }
1.1       dsieger  3771: </pre>
1.184     rillig   3772:              </td>
                   3773: <td>
1.1       dsieger  3774: <pre class="programlisting">
1.184     rillig   3775: int
                   3776: monitor_file(...)
                   3777: {
                   3778: #if defined(HAVE_KQUEUE)
                   3779:         int fd = kqueue();
                   3780:         ...
                   3781: #else
                   3782:         ...
                   3783: #endif
                   3784: }
1.1       dsieger  3785: </pre>
1.184     rillig   3786:              </td>
                   3787: </tr>
                   3788: </tbody>
                   3789: </table></div>
                   3790: </div>
                   3791: <br class="table-break">
                   3792: </div>
                   3793: <div class="sect2">
                   3794: <div class="titlepage"><div><div><h3 class="title">
                   3795: <a name="components.patches.feedback"></a>12.3.5. Feedback to the author</h3></div></div></div>
                   3796: <p>Always, always, <span class="strong"><strong>always</strong></span>
                   3797:       feed back any <span class="emphasis"><em>portability fixes</em></span> or
                   3798:       improvements you do to a package to the mainstream developers.
                   3799:       This is the only way to get their attention on portability issues
                   3800:       and to ensure that future versions can be built out-of-the box on
                   3801:       NetBSD.  Furthermore, any user that gets newer distfiles will get
                   3802:       the fixes straight from the packaged code.</p>
                   3803: <p>This generally involves cleaning up the patches
                   3804:       (because sometimes the patches that are
                   3805:       added to pkgsrc are quick hacks), filing bug reports in the
                   3806:       appropriate trackers for the projects and working with the
                   3807:       mainstream authors to accept your changes.  It is
                   3808:       <span class="emphasis"><em>extremely important</em></span> that you do it so that
                   3809:       the packages in pkgsrc are kept simple and thus further changes
                   3810:       can be done without much hassle.</p>
                   3811: <p>When you have done this, please add a URL to the upstream
                   3812:       bug report to the patch comment.</p>
                   3813: <p>Support the idea of free software!</p>
                   3814: </div>
1.1       dsieger  3815: </div>
1.184     rillig   3816: <div class="sect1">
                   3817: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   3818: <a name="other-mandatory-files"></a>12.4. Other mandatory files</h2></div></div></div>
                   3819: <div class="variablelist"><dl class="variablelist">
                   3820: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
                   3821: <dd><p>A multi-line description of the piece of software.  This should include
                   3822:          any credits where they are due.  Please bear in mind that others do not
                   3823:          share your sense of humour (or spelling idiosyncrasies), and that others
                   3824:          will read everything that you write here.</p></dd>
                   3825: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
                   3826: <dd><p>This file governs the files that are installed on your
                   3827:          system: all the binaries, manual pages, etc. There are other
                   3828:          directives which may be entered in this file, to control the
                   3829:          creation and deletion of directories, and the location of
                   3830:          inserted files.  See <a class="xref" href="#plist" title="Chapter 19. PLIST issues">Chapter 19, <i>PLIST issues</i></a> for more
                   3831:          information.</p></dd>
                   3832: </dl></div>
                   3833: </div>
                   3834: <div class="sect1">
                   3835: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   3836: <a name="components.optional"></a>12.5. Optional files</h2></div></div></div>
                   3837: <div class="sect2">
                   3838: <div class="titlepage"><div><div><h3 class="title">
                   3839: <a name="components.optional.bin"></a>12.5.1. Files affecting the binary package</h3></div></div></div>
                   3840: <div class="variablelist"><dl class="variablelist">
                   3841: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
                   3842: <dd>
1.197     leot     3843: <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.184     rillig   3844:            First time after package extraction and before files are
                   3845:            moved in place, the second time after the files to install
                   3846:            are moved in place. This can be used to do any custom
                   3847:            procedures not possible with @exec commands in
1.197     leot     3848:            <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
                   3849:            <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.184     rillig   3850:            Please note that you can modify variables in it easily by using
                   3851:            <code class="varname">FILES_SUBST</code> in the package's
                   3852:            <code class="filename">Makefile</code>:</p>
1.1       dsieger  3853: <pre class="programlisting">
1.184     rillig   3854: FILES_SUBST+=  SOMEVAR="somevalue"
1.1       dsieger  3855: </pre>
1.184     rillig   3856: <p>replaces "@SOMEVAR@" with <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span> in the
                   3857:            <code class="filename">INSTALL</code>.  By default, substitution is
                   3858:            performed for <code class="varname">PREFIX</code>,
                   3859:            <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
                   3860:            <code class="varname">VARBASE</code>, and a few others, type
                   3861:            <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
                   3862:            complete list.</p>
                   3863: </dd>
                   3864: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
                   3865: <dd><p>This script is executed before and after any files are removed.  It is
                   3866:            this script's responsibility to clean up any additional messy details
                   3867:            around the package's installation, since all pkg_delete knows is how to
                   3868:            delete the files created in the original distribution.
1.197     leot     3869:            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>
                   3870:            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.184     rillig   3871:            The same methods to replace variables can be used as for
                   3872:            the <code class="filename">INSTALL</code> file.</p></dd>
                   3873: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
                   3874: <dd>
                   3875: <p>This file is displayed after installation of the package.
1.198     leot     3876:            While this was used often in the past, it has two
                   3877:            problems: the display will be missed if many packages are
                   3878:            intalled at once, and the person installing the package
                   3879:            and the one using or configuring it may be different.  It
                   3880:            should therefore be used only in exceptional circumstances
                   3881:            where lasting negative consequences would result from
                   3882:            someone not reading it.</p>
                   3883: <p>MESSAGE should not be used for:</p>
                   3884: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   3885: <li class="listitem"><p>exhortations to read the documentation</p></li>
                   3886: <li class="listitem"><p>reminders to install rc.d files and set variables</p></li>
                   3887: <li class="listitem"><p>anything that should be explained in the
                   3888:              installation/configuration documentation that should
                   3889:              come with the package</p></li>
                   3890: </ul></div>
                   3891: <p>If the documentation provided by upstream needs
                   3892:            enhancing, create e.g. files/README.pkgsrc and install it
                   3893:            in the package's documentation directory.
                   3894:            </p>
                   3895: <p>Note that MESSAGE is shown for all operating
                   3896:            systems and all init systems.  If a MESSAGE is necessary,
                   3897:            it should be narrowed to only those operating systems and
                   3898:            init systems to which it applies.</p>
                   3899: <p>Note that you can modify variables in it easily by using
1.184     rillig   3900:            <code class="varname">MESSAGE_SUBST</code> in the package's
                   3901:            <code class="filename">Makefile</code>:</p>
1.1       dsieger  3902: <pre class="programlisting">
1.184     rillig   3903: MESSAGE_SUBST+=  SOMEVAR="somevalue"
1.1       dsieger  3904: </pre>
1.184     rillig   3905: <p>replaces "${SOMEVAR}" with <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span> in
                   3906:            <code class="filename">MESSAGE</code>.  By default, substitution is
                   3907:            performed for <code class="varname">PKGNAME</code>,
                   3908:            <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
                   3909:            <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
                   3910:            <code class="varname">PKG_SYSCONFDIR</code>,
                   3911:            <code class="varname">ROOT_GROUP</code>, and
                   3912:            <code class="varname">ROOT_USER</code>.</p>
                   3913: <p>You can display a different or additional files by
                   3914:            setting the <code class="varname">MESSAGE_SRC</code> variable.  Its
                   3915:            default is <code class="filename">MESSAGE</code>, if the file
                   3916:            exists.</p>
                   3917: </dd>
                   3918: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
                   3919: <dd>
                   3920: <p>This file is used by the alternatives framework.
                   3921:            It creates, configures, and destroys generic wrappers used to
                   3922:            run programs with similar interfaces.
                   3923:            See pkg_alternatives(8) from pkgtools/pkg_alternatives
                   3924:             for more information.</p>
                   3925: <p>Each line of the file contains two filenames, first
                   3926:            the wrapper and then the alternative provided by the package.
                   3927:            Both paths are relative to <code class="varname">PREFIX</code>.</p>
                   3928: </dd>
                   3929: </dl></div>
                   3930: </div>
                   3931: <div class="sect2">
                   3932: <div class="titlepage"><div><div><h3 class="title">
                   3933: <a name="components.optional.build"></a>12.5.2. Files affecting the build process</h3></div></div></div>
                   3934: <div class="variablelist"><dl class="variablelist">
                   3935: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
                   3936: <dd><p>This file contains arbitrary things that could
                   3937:        also go into a <code class="filename">Makefile</code>, but its purpose is
                   3938:        to be used by more than one package. This file should only be
                   3939:        used when the packages that will use the file are known in
                   3940:        advance. For other purposes it is often better to write a
                   3941:        <code class="filename">*.mk</code> file and give it a good name that
                   3942:        describes what it does.</p></dd>
                   3943: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
                   3944: <dd><p>This file contains the dependency information
                   3945:        for the buildlink3 framework (see <a class="xref" href="#buildlink" title="Chapter 18. Buildlink methodology">Chapter 18, <i>Buildlink methodology</i></a>).</p></dd>
                   3946: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
                   3947: <dd><p>This file contains workarounds for compiler bugs
                   3948:        and similar things. It is included automatically by the pkgsrc
                   3949:        infrastructure, so you don't need an extra
                   3950:        <code class="literal">.include</code> line for
                   3951:        it.</p></dd>
                   3952: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
                   3953: <dd><p>This file contains the code for the
                   3954:        package-specific options (see <a class="xref" href="#options" title="Chapter 16. Options handling">Chapter 16, <i>Options handling</i></a>) that can be
                   3955:        selected by the user. If a package has only one or two options,
                   3956:        it is equally acceptable to put the code directly into the
                   3957:        <code class="filename">Makefile</code>.</p></dd>
                   3958: </dl></div>
                   3959: </div>
                   3960: <div class="sect2">
                   3961: <div class="titlepage"><div><div><h3 class="title">
                   3962: <a name="components.optional.none"></a>12.5.3. Files affecting nothing at all</h3></div></div></div>
                   3963: <div class="variablelist"><dl class="variablelist">
                   3964: <dt><span class="term"><code class="filename">README*</code></span></dt>
                   3965: <dd><p>These files do not take place in the creation of
                   3966:        a package and thus are purely informative to the package
                   3967:        developer.</p></dd>
                   3968: <dt><span class="term"><code class="filename">TODO</code></span></dt>
                   3969: <dd><p>This file contains things that need to be done
                   3970:        to make the package even
                   3971:        better.</p></dd>
                   3972: </dl></div>
                   3973: </div>
                   3974: </div>
                   3975: <div class="sect1">
                   3976: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   3977: <a name="work-dir"></a>12.6. <code class="filename">work*</code>
                   3978: </h2></div></div></div>
                   3979: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
                   3980:     unpacked into the directory denoted by
                   3981:     <code class="varname">WRKDIR</code>. It can be removed by running
                   3982:     <span class="command"><strong>make clean</strong></span>. Besides the sources, this
                   3983:     directory is also used to keep various timestamp files.
                   3984:     The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
                   3985:     The default is <code class="filename">${.CURDIR}/work</code>
                   3986:     or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
                   3987:     if <code class="varname">OBJMACHINE</code> is set.</p>
1.1       dsieger  3988: </div>
1.184     rillig   3989: <div class="sect1">
                   3990: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   3991: <a name="files-dir"></a>12.7. <code class="filename">files/*</code>
                   3992: </h2></div></div></div>
                   3993: <p>If you have any files that you wish to be placed in the package
                   3994:     prior to configuration or building, you can place these files here
                   3995:     and use a <span class="command"><strong>${CP}</strong></span> command in the
                   3996:     <span class="quote">&#8220;<span class="quote">post-extract</span>&#8221;</span> target to achieve this.</p>
                   3997: <p>If you want to share files in this way with other
                   3998:     packages, set the <code class="varname">FILESDIR</code> variable to point
                   3999:     to the other package's <code class="filename">files</code> directory,
                   4000:     e.g.:</p>
1.1       dsieger  4001: <pre class="programlisting">
1.184     rillig   4002: FILESDIR=       ../../editors/xemacs/files
1.1       dsieger  4003: </pre>
                   4004: </div>
                   4005: </div>
1.41      asau     4006: <div class="chapter">
1.1       dsieger  4007: <div class="titlepage"><div><div><h2 class="title">
1.184     rillig   4008: <a name="build"></a>Chapter 13. The build process</h2></div></div></div>
1.1       dsieger  4009: <div class="toc">
                   4010: <p><b>Table of Contents</b></p>
1.100     leot     4011: <dl class="toc">
1.184     rillig   4012: <dt><span class="sect1"><a href="#build.intro">13.1. Introduction</a></span></dt>
                   4013: <dt><span class="sect1"><a href="#build.prefix">13.2. Program location</a></span></dt>
                   4014: <dt><span class="sect1"><a href="#build.builddirs">13.3. Directories used during the build process</a></span></dt>
                   4015: <dt><span class="sect1"><a href="#build.running">13.4. Running a phase</a></span></dt>
                   4016: <dt><span class="sect1"><a href="#build.fetch">13.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                   4017: <dd><dl>
                   4018: <dt><span class="sect2"><a href="#build.fetch.what">13.5.1. What to fetch and where to get it from</a></span></dt>
                   4019: <dt><span class="sect2"><a href="#build.fetch.how">13.5.2. How are the files fetched?</a></span></dt>
                   4020: </dl></dd>
                   4021: <dt><span class="sect1"><a href="#build.checksum">13.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                   4022: <dt><span class="sect1"><a href="#build.extract">13.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                   4023: <dt><span class="sect1"><a href="#build.patch">13.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                   4024: <dt><span class="sect1"><a href="#build.tools">13.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                   4025: <dt><span class="sect1"><a href="#build.wrapper">13.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                   4026: <dt><span class="sect1"><a href="#build.configure">13.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   4027: <dt><span class="sect1"><a href="#build.build">13.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   4028: <dt><span class="sect1"><a href="#build.test">13.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                   4029: <dt><span class="sect1"><a href="#build.install">13.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   4030: <dt><span class="sect1"><a href="#build.package">13.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
                   4031: <dt><span class="sect1"><a href="#build.clean">13.16. Cleaning up</a></span></dt>
                   4032: <dt><span class="sect1"><a href="#build.helpful-targets">13.17. Other helpful targets</a></span></dt>
1.1       dsieger  4033: </dl>
                   4034: </div>
1.41      asau     4035: <div class="sect1">
1.1       dsieger  4036: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   4037: <a name="build.intro"></a>13.1. Introduction</h2></div></div></div>
                   4038: <p>This chapter gives a detailed description on how a package is
                   4039:     built. Building a package is separated into different
                   4040:     <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
                   4041:     <code class="varname">build</code>, <code class="varname">install</code>), all of which are
                   4042:     described in the following sections. Each phase is split into
                   4043:     so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
                   4044:     containing phase, prefixed by one of <code class="varname">pre-</code>,
                   4045:     <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
                   4046:     <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
                   4047:     of the actual work is done in the <code class="varname">do-*</code> stages.</p>
                   4048: <p>Never override the regular targets (like
                   4049:     <code class="varname">fetch</code>), if you have to, override the
                   4050:     <code class="varname">do-*</code> ones instead.</p>
                   4051: <p>The basic steps for building a program are always the same.  First
                   4052:     the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
                   4053:     the local system and then extracted. After any pkgsrc-specific patches
                   4054:     to compile properly are applied, the software can be configured, then
                   4055:     built (usually by compiling), and finally the generated binaries, etc.
                   4056:     can be put into place on the system.</p>
                   4057: <p>To get more details about what is happening at each step,
                   4058:     you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
                   4059:     <code class="varname">PATCH_DEBUG</code> variable if you are just interested
                   4060:     in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
                   4061: </div>
                   4062: <div class="sect1">
                   4063: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   4064: <a name="build.prefix"></a>13.2. Program location</h2></div></div></div>
                   4065: <p>Before outlining the process performed by the NetBSD package system in
                   4066:     the next section, here's a brief discussion on where programs are
                   4067:     installed, and which variables influence this.</p>
                   4068: <p>The automatic variable <code class="varname">PREFIX</code> indicates
                   4069:     where all files of the final program shall be installed. It is
                   4070:     usually set to <code class="varname">LOCALBASE</code>
                   4071:     (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
                   4072:     for pkgs in the <code class="filename">cross</code> category.  The value of
                   4073:     <code class="varname">PREFIX</code> needs to be put
                   4074:     into the various places in the program's source where paths to
                   4075:     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>
                   4076: <p>When choosing which of these variables to use,
                   4077:     follow the following rules:</p>
1.41      asau     4078: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.184     rillig   4079: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
                   4080:        where the current pkg will be installed.  When referring to a
                   4081:        pkg's own installation path, use
                   4082:        <span class="quote">&#8220;<span class="quote">${PREFIX}</span>&#8221;</span>.</p></li>
                   4083: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
                   4084:        are installed.  If you need to construct a -I or -L argument
                   4085:        to the compiler to find includes and libraries installed by
                   4086:        another non-X11 pkg, use <span class="quote">&#8220;<span class="quote">${LOCALBASE}</span>&#8221;</span>. The name
                   4087:        <code class="varname">LOCALBASE</code> stems from FreeBSD, which
                   4088:        installed all packages in <code class="filename">/usr/local</code>. As
                   4089:        pkgsrc leaves <code class="filename">/usr/local</code> for the system
                   4090:        administrator, this variable is a misnomer.</p></li>
                   4091: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
                   4092:        distribution (from xsrc, etc.) is installed. When looking for
                   4093:        <span class="emphasis"><em>standard</em></span> X11 includes (not those
                   4094:        installed by a package), use <span class="quote">&#8220;<span class="quote">${X11BASE}</span>&#8221;</span>.</p></li>
                   4095: <li class="listitem"><p>X11-based packages using imake must set
                   4096:        <code class="varname">USE_IMAKE</code> to be installed correctly under
                   4097:        <code class="varname">LOCALBASE</code>.</p></li>
                   4098: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.197     leot     4099:        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.184     rillig   4100:        manual pages go into <code class="filename">${PREFIX}/man</code>, not
                   4101:        <code class="filename">${PREFIX}/share/man</code>.</p></li>
                   4102: </ul></div>
                   4103: </div>
                   4104: <div class="sect1">
                   4105: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   4106: <a name="build.builddirs"></a>13.3. Directories used during the build process</h2></div></div></div>
                   4107: <p>When building a package, various directories are used to store
                   4108:     source files, temporary files, pkgsrc-internal files, and so on. These
                   4109:     directories are explained here.</p>
                   4110: <p>Some of the directory variables contain relative pathnames. There
                   4111:     are two common base directories for these relative directories:
                   4112:     <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
                   4113:     pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
                   4114:     inside the package itself.</p>
                   4115: <div class="variablelist"><dl class="variablelist">
                   4116: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
                   4117: <dd><p>This is an absolute pathname that points to the pkgsrc
                   4118:       root directory. Generally, you don't need
                   4119:       it.</p></dd>
                   4120: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
                   4121: <dd><p>This is an absolute pathname that points to the
                   4122:       current package.</p></dd>
                   4123: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
                   4124: <dd><p>This is a pathname relative to
                   4125:       <code class="varname">PKGSRCDIR</code> that points to the current
                   4126:       package.</p></dd>
                   4127: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
                   4128: <dd><p>This is an absolute pathname pointing to the directory
                   4129:       where all work takes place. The distfiles are extracted to this
                   4130:       directory. It also contains temporary directories and log files used by
                   4131:       the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
                   4132:       the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
                   4133: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
                   4134: <dd><p>This is an absolute pathname pointing to the directory
                   4135:       where the distfiles are extracted. It is usually a direct subdirectory
                   4136:       of <code class="varname">WRKDIR</code>, and often it's the only directory entry
                   4137:       that isn't hidden. This variable may be changed by a package
                   4138:       <code class="filename">Makefile</code>.</p></dd>
                   4139: </dl></div>
                   4140: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
                   4141:     the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
                   4142:     to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
                   4143:     <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
                   4144:     If users would like to have their pkgsrc trees behave in a
                   4145:     read-only manner, then the value of
                   4146:     <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
                   4147:     <span class="emphasis"><em>no</em></span>.</p>
1.1       dsieger  4148: </div>
1.41      asau     4149: <div class="sect1">
1.1       dsieger  4150: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   4151: <a name="build.running"></a>13.4. Running a phase</h2></div></div></div>
                   4152: <p>You can run a particular phase by typing <span class="command"><strong>make
                   4153:     phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
                   4154:     phase. This will automatically run all phases that are required for this
                   4155:     phase. The default phase is <code class="varname">build</code>, that is, when you
                   4156:     run <span class="command"><strong>make</strong></span> without parameters in a package directory,
                   4157:     the package will be built, but not installed.</p>
1.1       dsieger  4158: </div>
1.41      asau     4159: <div class="sect1">
1.1       dsieger  4160: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   4161: <a name="build.fetch"></a>13.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
                   4162: <p>The first step in building a package is to fetch the
                   4163:     distribution files (distfiles) from the sites that are providing
                   4164:     them. This is the task of the <span class="emphasis"><em>fetch</em></span>
                   4165:     phase.</p>
1.41      asau     4166: <div class="sect2">
1.1       dsieger  4167: <div class="titlepage"><div><div><h3 class="title">
1.184     rillig   4168: <a name="build.fetch.what"></a>13.5.1. What to fetch and where to get it from</h3></div></div></div>
                   4169: <p>In simple cases, <code class="varname">MASTER_SITES</code>
                   4170:       defines all URLs from where the distfile, whose name is
                   4171:       derived from the <code class="varname">DISTNAME</code> variable, is
                   4172:       fetched. The more complicated cases are described
                   4173:       below.</p>
                   4174: <p>The variable <code class="varname">DISTFILES</code> specifies
                   4175:       the list of distfiles that have to be fetched. Its value
                   4176:       defaults to <code class="literal">${DEFAULT_DISTFILES}</code> and
                   4177:       its value is <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
                   4178:       so that most packages don't need to define it at all.
                   4179:       <code class="varname">EXTRACT_SUFX</code> is
                   4180:       <code class="literal">.tar.gz</code> by default, but can be changed
                   4181:       freely. Note that if your package requires additional
                   4182:       distfiles to the default one, you cannot just append the
                   4183:       additional filenames using the <code class="literal">+=</code>
                   4184:       operator, but you have write for example:</p>
                   4185: <pre class="programlisting">
                   4186: DISTFILES=      ${DEFAULT_DISTFILES} additional-files.tar.gz
                   4187: </pre>
                   4188: <p>Each distfile is fetched from a list of sites, usually
                   4189:       <code class="varname">MASTER_SITES</code>. If the package has multiple
                   4190:       <code class="varname">DISTFILES</code> or multiple
                   4191:       <code class="varname">PATCHFILES</code> from different sites, you can
                   4192:       set
                   4193:       <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
                   4194:       to the list of URLs where the file
                   4195:       <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
                   4196:       (including the suffix) can be found.</p>
                   4197: <pre class="programlisting">
                   4198: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX}
                   4199: DISTFILES+=     foo-file.tar.gz
                   4200: SITES.foo-file.tar.gz= \
                   4201: https://www.somewhere.com/somehow/ \
                   4202: https://www.somewhereelse.com/mirror/somehow/
                   4203: </pre>
                   4204: <p>When actually fetching the distfiles, each item from
                   4205:       <code class="varname">MASTER_SITES</code> or
                   4206:       <code class="varname">SITES.*</code> gets the name of each distfile
                   4207:       appended to it, without an intermediate slash. Therefore,
                   4208:       all site values have to end with a slash or other separator
                   4209:       character. This allows for example to set
                   4210:       <code class="varname">MASTER_SITES</code> to a URL of a CGI script
                   4211:       that gets the name of the distfile as a parameter. In this
                   4212:       case, the definition would look like:</p>
                   4213: <pre class="programlisting">
                   4214: MASTER_SITES=   https://www.example.com/download.cgi?file=
                   4215: </pre>
                   4216: <p> The exception to this rule are URLs starting with a dash.
                   4217:       In that case the URL is taken as is, fetched and the result
                   4218:       stored under the name of the distfile. You can use this style
                   4219:       for the case when the download URL style does not match the
                   4220:       above common case. For example, if permanent download URL is a
                   4221:       redirector to the real download URL, or the download file name
                   4222:       is offered by an HTTP Content-Disposition header. In the
                   4223:       following example, <code class="filename">foo-1.0.0.tar.gz</code> will be
                   4224:       created instead of the default
                   4225:       <code class="filename">v1.0.0.tar.gz</code>.</p>
                   4226: <pre class="programlisting">
                   4227: DISTNAME=       foo-1.0.0
                   4228: MASTER_SITES=   -https://www.example.com/archive/v1.0.0.tar.gz
                   4229: </pre>
                   4230: <p>There are some predefined values for
                   4231:       <code class="varname">MASTER_SITES</code>, which can be used in
                   4232:       packages.  The names of the variables should speak for
                   4233:       themselves.</p>
                   4234: <table border="0" summary="Simple list" class="simplelist">
                   4235: <tr>
                   4236: <td>MASTER_SITE_APACHE</td>
                   4237: <td>MASTER_SITE_BACKUP</td>
                   4238: </tr>
                   4239: <tr>
                   4240: <td>MASTER_SITE_CRATESIO</td>
                   4241: <td>MASTER_SITE_CYGWIN</td>
                   4242: </tr>
                   4243: <tr>
                   4244: <td>MASTER_SITE_DEBIAN</td>
                   4245: <td>MASTER_SITE_FREEBSD</td>
                   4246: </tr>
                   4247: <tr>
                   4248: <td>MASTER_SITE_FREEBSD_LOCAL</td>
                   4249: <td>MASTER_SITE_GENTOO</td>
                   4250: </tr>
                   4251: <tr>
                   4252: <td>MASTER_SITE_GITHUB</td>
                   4253: <td>MASTER_SITE_GNOME</td>
                   4254: </tr>
                   4255: <tr>
                   4256: <td>MASTER_SITE_GNU</td>
                   4257: <td>MASTER_SITE_GNUSTEP</td>
                   4258: </tr>
                   4259: <tr>
                   4260: <td>MASTER_SITE_HASKELL_HACKAGE</td>
                   4261: <td>MASTER_SITE_IFARCHIVE</td>
                   4262: </tr>
                   4263: <tr>
                   4264: <td>MASTER_SITE_KDE</td>
                   4265: <td>MASTER_SITE_MOZILLA</td>
                   4266: </tr>
                   4267: <tr>
                   4268: <td>MASTER_SITE_MOZILLA_ALL</td>
                   4269: <td>MASTER_SITE_MYSQL</td>
                   4270: </tr>
                   4271: <tr>
                   4272: <td>MASTER_SITE_NETLIB</td>
                   4273: <td>MASTER_SITE_OPENBSD</td>
                   4274: </tr>
                   4275: <tr>
                   4276: <td>MASTER_SITE_OPENOFFICE</td>
                   4277: <td>MASTER_SITE_OSDN</td>
                   4278: </tr>
                   4279: <tr>
                   4280: <td>MASTER_SITE_PERL_CPAN</td>
                   4281: <td>MASTER_SITE_PGSQL</td>
                   4282: </tr>
                   4283: <tr>
                   4284: <td>MASTER_SITE_PYPI</td>
                   4285: <td>MASTER_SITE_RUBYGEMS</td>
                   4286: </tr>
                   4287: <tr>
                   4288: <td>MASTER_SITE_R_CRAN</td>
                   4289: <td>MASTER_SITE_SOURCEFORGE</td>
                   4290: </tr>
1.1       dsieger  4291: <tr>
1.184     rillig   4292: <td>MASTER_SITE_SUNSITE</td>
                   4293: <td>MASTER_SITE_SUSE</td>
1.1       dsieger  4294: </tr>
                   4295: <tr>
1.184     rillig   4296: <td>MASTER_SITE_TEX_CTAN</td>
                   4297: <td>MASTER_SITE_XCONTRIB</td>
1.1       dsieger  4298: </tr>
                   4299: <tr>
1.184     rillig   4300: <td>MASTER_SITE_XEMACS</td>
                   4301: <td>MASTER_SITE_XORG</td>
                   4302: </tr>
                   4303: </table>
                   4304: <p>Some explanations for the less self-explaining ones:
                   4305:       <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
                   4306:       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
                   4307:       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>
                   4308: <p>If you choose one of these predefined sites, you may
                   4309:       want to specify a subdirectory of that site. Since these
                   4310:       macros may expand to more than one actual site, you
                   4311:       <span class="emphasis"><em>must</em></span> use the following construct to
                   4312:       specify a subdirectory:</p>
1.1       dsieger  4313: <pre class="programlisting">
1.184     rillig   4314: MASTER_SITES=   ${MASTER_SITE_GNU:=subdirectory/name/}
                   4315: MASTER_SITES=   ${MASTER_SITE_SOURCEFORGE:=project_name/}
1.1       dsieger  4316: </pre>
1.184     rillig   4317: <p>Note the trailing slash after the subdirectory
                   4318:       name.</p>
                   4319: </div>
                   4320: <div class="sect2">
                   4321: <div class="titlepage"><div><div><h3 class="title">
                   4322: <a name="build.fetch.how"></a>13.5.2. How are the files fetched?</h3></div></div></div>
                   4323: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
                   4324:       all the distfiles exist in a local directory
                   4325:       (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
                   4326:       user). If the files do not exist, they are fetched using
                   4327:       commands of the form</p>
1.1       dsieger  4328: <pre class="programlisting">
1.184     rillig   4329: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
                   4330: </pre>
                   4331: <p>where <code class="literal">${site}</code> varies through
                   4332:       several possibilities in turn: first,
                   4333:       <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
                   4334:       sites specified in either <code class="varname">SITES.file</code> if
                   4335:       defined, else <code class="varname">MASTER_SITES</code> or
                   4336:       <code class="varname">PATCH_SITES</code>, as applies, then finally the
                   4337:       value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
                   4338:       all except the first and the last can be optionally sorted
                   4339:       by the user, via setting either
                   4340:       <code class="varname">MASTER_SORT_RANDOM</code>, and
                   4341:       <code class="varname">MASTER_SORT_AWK</code> or
                   4342:       <code class="varname">MASTER_SORT_REGEX</code>.</p>
                   4343: <p> The specific command and arguments used depend on the
                   4344:       <code class="varname">FETCH_USING</code> parameter. The example above is
                   4345:       for <code class="literal">FETCH_USING=custom</code>.</p>
                   4346: <p>The distfiles mirror run by the NetBSD Foundation uses the
                   4347:       <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
                   4348:       distfiles, if they are freely distributable.  Packages setting
                   4349:       <code class="varname">NO_SRC_ON_FTP</code> (usually to
                   4350:       <span class="quote">&#8220;<span class="quote">${RESTRICTED}</span>&#8221;</span>) will not have their distfiles
                   4351:       mirrored.</p>
1.1       dsieger  4352: </div>
                   4353: </div>
1.184     rillig   4354: <div class="sect1">
                   4355: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   4356: <a name="build.checksum"></a>13.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
                   4357: <p>After the distfile(s) are fetched, their checksum is
                   4358:     generated and compared with the checksums stored in the
                   4359:     distinfo file. If the checksums don't match, the build is
                   4360:     aborted. This is to ensure the same distfile is used for
                   4361:     building, and that the distfile wasn't changed, e.g. by some
                   4362:     malign force, deliberately changed distfiles on the master
                   4363:     distribution site or network lossage.</p>
1.1       dsieger  4364: </div>
1.41      asau     4365: <div class="sect1">
1.1       dsieger  4366: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   4367: <a name="build.extract"></a>13.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
                   4368: <p>When the distfiles are present on the local system, they
                   4369:     need to be extracted, as they usually come in the form of some
                   4370:     compressed archive format.</p>
                   4371: <p>By default, all <code class="varname">DISTFILES</code> are
                   4372:     extracted. If you only need some of them, you can set the
                   4373:     <code class="varname">EXTRACT_ONLY</code> variable to the list of those
                   4374:     files.</p>
                   4375: <p>Extracting the files is usually done by a little
                   4376:     program, <code class="filename">mk/extract/extract</code>, which
                   4377:     already knows how to extract various archive formats, so most
                   4378:     likely you will not need to change anything here. But if you
                   4379:     need, the following variables may help you:</p>
1.41      asau     4380: <div class="variablelist"><dl class="variablelist">
1.184     rillig   4381: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
                   4382: <dd><p>Use these variables to override the default
                   4383:       options for an extract command, which are defined in
                   4384:       <code class="filename">mk/extract/extract</code>.</p></dd>
                   4385: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
                   4386: <dd><p>This variable can be set to
                   4387:       <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
                   4388:       (which is the default value), <code class="literal">pax</code>, or an
                   4389:       absolute pathname pointing to the command with which tar
                   4390:       archives should be extracted.  It is preferred to choose bsdtar over gtar
                   4391:       if NetBSD's pax-as-tar is not good enough.</p></dd>
1.1       dsieger  4392: </dl></div>
1.184     rillig   4393: <p>If the <code class="filename">extract</code> program doesn't
                   4394:     serve your needs, you can also override the
                   4395:     <code class="varname">EXTRACT_CMD</code> variable, which holds the
                   4396:     command used for extracting the files. This command is
                   4397:     executed in the <code class="filename">${WRKSRC}</code>
                   4398:     directory. During execution of this command, the shell
                   4399:     variable <code class="varname">extract_file</code> holds the absolute
                   4400:     pathname of the file that is going to be extracted.</p>
                   4401: <p>And if that still does not suffice, you can override the
                   4402:     <code class="varname">do-extract</code> target in the package
                   4403:     Makefile.</p>
1.1       dsieger  4404: </div>
1.41      asau     4405: <div class="sect1">
1.1       dsieger  4406: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   4407: <a name="build.patch"></a>13.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
                   4408: <p>After extraction, all the patches named by the
                   4409:     <code class="varname">PATCHFILES</code>, those present in the patches
                   4410:     subdirectory of the package as well as in
                   4411:     $LOCALPATCHES/$PKGPATH (e.g.
                   4412:     <code class="filename">/usr/local/patches/graphics/png</code>) are
                   4413:     applied.  Patchfiles ending in <code class="filename">.Z</code> or
                   4414:     <code class="filename">.gz</code> are uncompressed before they are
                   4415:     applied, files ending in <code class="filename">.orig</code> or
                   4416:     <code class="filename">.rej</code> are ignored. Any special options to
1.197     leot     4417:     <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.184     rillig   4418:     <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.197     leot     4419: <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.184     rillig   4420:     fail if the expected text from the patch context is not found in the
                   4421:     patched file. If that happens, fix the patch file by comparing it
                   4422:     with the actual text in the file to be patched.</p>
1.1       dsieger  4423: </div>
1.41      asau     4424: <div class="sect1">
1.1       dsieger  4425: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   4426: <a name="build.tools"></a>13.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
                   4427: <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>.
                   4428:     </p>
1.1       dsieger  4429: </div>
1.41      asau     4430: <div class="sect1">
1.1       dsieger  4431: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   4432: <a name="build.wrapper"></a>13.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
                   4433: <p>This phase creates wrapper programs for the compilers and
                   4434:     linkers. The following variables can be used to tweak the
                   4435:     wrappers.</p>
                   4436: <div class="variablelist"><dl class="variablelist">
                   4437: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
                   4438: <dd><p>The command used to print progress
                   4439:       messages. Does nothing by default. Set to
                   4440:       <code class="literal">${ECHO}</code> to see the progress
                   4441:       messages.</p></dd>
                   4442: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
                   4443: <dd><p>This variable can be set to
                   4444:       <code class="literal">yes</code> (default) or <code class="literal">no</code>,
                   4445:       depending on whether you want additional information in the
                   4446:       wrapper log file.</p></dd>
                   4447: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
                   4448: <dd><p>This variable can be set to
                   4449:       <code class="literal">yes</code> or <code class="literal">no</code>, depending
                   4450:       on whether the wrapper should use its cache, which will
                   4451:       improve the speed. The default value is
                   4452:       <code class="literal">yes</code>, but is forced to
                   4453:       <code class="literal">no</code> if the platform does not support
                   4454:       it.</p></dd>
                   4455: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
                   4456: <dd><p>A list of reordering commands. A reordering
                   4457:       command has the form
                   4458:       <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
                   4459:       It ensures that that
                   4460:       <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
                   4461:       before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
                   4462:       </p></dd>
                   4463: </dl></div>
                   4464: </div>
                   4465: <div class="sect1">
                   4466: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   4467: <a name="build.configure"></a>13.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
                   4468: <p>Most pieces of software need information on the header
                   4469:     files, system calls, and library routines which are available
                   4470:     on the platform they run on. The process of determining this
                   4471:     information is known as configuration, and is usually
                   4472:     automated. In most cases, a script is supplied with the
                   4473:     distfiles, and its invocation results in generation of header
                   4474:     files, Makefiles, etc.</p>
                   4475: <p>If the package contains a configure script, this can be
                   4476:     invoked by setting <code class="varname">HAS_CONFIGURE</code> to
                   4477:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. If the configure script is a GNU autoconf
                   4478:     script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.187     rillig   4479:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> instead.</p>
                   4480: <p>In the <code class="literal">do-configure</code> stage, a rough
                   4481:     equivalent of the following command is run. See
                   4482:     <code class="filename">mk/configure/configure.mk</code>, target
                   4483:     <code class="literal">do-configure-script</code> for the exact
                   4484:     definition.</p>
                   4485: <pre class="programlisting">
                   4486: .for dir in ${CONFIGURE_DIRS}
                   4487:         cd ${WRKSRC} &amp;&amp; cd ${dir} \
                   4488:         &amp;&amp; env ${CONFIGURE_ENV} \
                   4489:             ${CONFIG_SHELL} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
1.184     rillig   4490: .endfor
1.1       dsieger  4491: </pre>
1.184     rillig   4492: <p><code class="varname">CONFIGURE_DIRS</code> (default:
                   4493:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span>) is a list of pathnames relative to
                   4494:     <code class="varname">WRKSRC</code>. In each of these directories, the
                   4495:     configure script is run with the environment
                   4496:     <code class="varname">CONFIGURE_ENV</code> and arguments
                   4497:     <code class="varname">CONFIGURE_ARGS</code>. The variables
                   4498:     <code class="varname">CONFIGURE_ENV</code>,
                   4499:     <code class="varname">CONFIGURE_SCRIPT</code> (default:
                   4500:     <span class="quote">&#8220;<span class="quote">./configure</span>&#8221;</span>) and
                   4501:     <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
                   4502:     package.</p>
                   4503: <p>If the program uses the Perl way of configuration (mainly Perl
                   4504:     modules, but not only), i.e. a file called
                   4505:     <code class="filename">Makefile.PL</code>, it should include
                   4506:     <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
                   4507:     <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
                   4508:     variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
                   4509: <p>If the program uses an <code class="filename">Imakefile</code>
                   4510:     for configuration, the appropriate steps can be invoked by
                   4511:     setting <code class="varname">USE_IMAKE</code> to
                   4512:     <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>.
                   4513:     You can add variables to xmkmf's environment by adding them to the
                   4514:     <code class="varname">SCRIPTS_ENV</code> variable.</p>
                   4515: <p>If the program uses <code class="filename">cmake</code>
                   4516:     for configuration, the appropriate steps can be invoked by
                   4517:     setting <code class="varname">USE_CMAKE</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.
                   4518:     You can add variables to cmake's environment by adding them to the
                   4519:     <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
                   4520:     by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
                   4521:     The top directory argument is given by the
                   4522:     <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
                   4523:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span> (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
                   4524: <p>If there is no configure step at all, set
                   4525:     <code class="varname">NO_CONFIGURE</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.</p>
1.1       dsieger  4526: </div>
1.41      asau     4527: <div class="sect1">
1.1       dsieger  4528: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   4529: <a name="build.build"></a>13.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.187     rillig   4530: <p>For building a package, a rough equivalent of the following
                   4531:     code is executed; see <code class="filename">mk/build/build.mk</code>, target
                   4532:     <code class="literal">do-build</code> for the exact definition.</p>
1.1       dsieger  4533: <pre class="programlisting">
1.187     rillig   4534: .for dir in ${BUILD_DIRS}
                   4535:         cd ${WRKSRC} &amp;&amp; cd ${dir} \
1.184     rillig   4536:         &amp;&amp; env ${MAKE_ENV} \
1.187     rillig   4537:             ${MAKE_PROGRAM} ${MAKE_FLAGS} ${BUILD_MAKE_FLAGS} \
1.184     rillig   4538:                 -f ${MAKE_FILE} \
                   4539:                 ${BUILD_TARGET}
                   4540: .endfor
1.1       dsieger  4541: </pre>
1.184     rillig   4542: <p><code class="varname">BUILD_DIRS</code> (default:
                   4543:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span>) is a list of pathnames relative to
                   4544:     <code class="varname">WRKSRC</code>. In each of these directories,
                   4545:     <code class="varname">MAKE_PROGRAM</code> is run with the environment
                   4546:     <code class="varname">MAKE_ENV</code> and arguments
                   4547:     <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
                   4548:     <code class="varname">MAKE_ENV</code>,
                   4549:     <code class="varname">BUILD_MAKE_FLAGS</code>,
                   4550:     <code class="varname">MAKE_FILE</code> and
                   4551:     <code class="varname">BUILD_TARGET</code> may all be changed by the
                   4552:     package.</p>
                   4553: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
                   4554:     <span class="quote">&#8220;<span class="quote">gmake</span>&#8221;</span> if <code class="varname">USE_TOOLS</code> contains
                   4555:     <span class="quote">&#8220;<span class="quote">gmake</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">make</span>&#8221;</span> otherwise. The
                   4556:     default value of <code class="varname">MAKE_FILE</code> is
                   4557:     <span class="quote">&#8220;<span class="quote">Makefile</span>&#8221;</span>, and <code class="varname">BUILD_TARGET</code>
                   4558:     defaults to <span class="quote">&#8220;<span class="quote">all</span>&#8221;</span>.</p>
                   4559: <p>If there is no build step at all, set
                   4560:     <code class="varname">NO_BUILD</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.</p>
1.1       dsieger  4561: </div>
1.41      asau     4562: <div class="sect1">
1.1       dsieger  4563: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   4564: <a name="build.test"></a>13.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
                   4565: <p>[TODO]</p>
1.1       dsieger  4566: </div>
1.41      asau     4567: <div class="sect1">
1.1       dsieger  4568: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   4569: <a name="build.install"></a>13.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
                   4570: <p>Once the build stage has completed, the final step is to
                   4571:     install the software in public directories, so users can
                   4572:     access the programs and files.</p>
1.187     rillig   4573: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough equivalent
                   4574:     of the following code is executed; see
                   4575:     <code class="filename">mk/install/install.mk</code>, target
                   4576:     <code class="literal">do-install</code> for the exact definition. Additionally,
                   4577:     before and after this code, several consistency checks are run
                   4578:     against the files-to-be-installed, see
                   4579:     <code class="filename">mk/check/*.mk</code> for details.</p>
                   4580: <pre class="programlisting">
                   4581: .for dir in ${INSTALL_DIRS}
                   4582:         cd ${WRKSRC} &amp;&amp; cd ${dir} \
                   4583:         &amp;&amp; env ${INSTALL_ENV} ${MAKE_ENV} \
                   4584:             ${MAKE_PROGRAM} ${MAKE_FLAGS} ${INSTALL_MAKE_FLAGS} \
                   4585:                 -f ${MAKE_FILE} ${INSTALL_TARGET}
1.184     rillig   4586: .endfor
1.1       dsieger  4587: </pre>
1.184     rillig   4588: <p>The variable's meanings are analogous to the ones in the
                   4589:     <span class="emphasis"><em>build</em></span> phase.
                   4590:     <code class="varname">INSTALL_DIRS</code> defaults to
                   4591:     <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
                   4592:     is <span class="quote">&#8220;<span class="quote">install</span>&#8221;</span> by default, plus
                   4593:     <span class="quote">&#8220;<span class="quote">install.man</span>&#8221;</span> if <code class="varname">USE_IMAKE</code> is
                   4594:     defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
                   4595:     defined.</p>
                   4596: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
                   4597:     variables are useful. They are all variations of the
1.197     leot     4598:     <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.184     rillig   4599:     permissions preset. <code class="varname">INSTALL</code> is the plain
                   4600:     install command. The specialized variants, together with their
                   4601:     intended use, are:</p>
                   4602: <div class="variablelist"><dl class="variablelist">
                   4603: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
                   4604: <dd><p>directories that contain
                   4605:       binaries</p></dd>
                   4606: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
                   4607: <dd><p>directories that contain
                   4608:       scripts</p></dd>
                   4609: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
                   4610: <dd><p>directories that contain shared and static
                   4611:       libraries</p></dd>
                   4612: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
                   4613: <dd><p>directories that contain data
                   4614:       files</p></dd>
                   4615: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
                   4616: <dd><p>directories that contain man
                   4617:       pages</p></dd>
                   4618: <dt><span class="term"><code class="varname">INSTALL_GAME_DIR</code></span></dt>
                   4619: <dd><p>directories that contain data files for games
                   4620:       </p></dd>
                   4621: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
                   4622: <dd><p>binaries that can be stripped from debugging
                   4623:       symbols</p></dd>
                   4624: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
                   4625: <dd><p>binaries that cannot be
                   4626:       stripped</p></dd>
                   4627: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
                   4628: <dd><p>game
                   4629:       binaries</p></dd>
                   4630: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
                   4631: <dd><p>shared and static
                   4632:       libraries</p></dd>
                   4633: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
                   4634: <dd><p>data files</p></dd>
                   4635: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
                   4636: <dd><p>data files for
                   4637:       games</p></dd>
                   4638: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
                   4639: <dd><p>man pages</p></dd>
                   4640: </dl></div>
                   4641: <p>Some other variables are:</p>
                   4642: <div class="variablelist"><dl class="variablelist">
                   4643: <dt><span class="term"><code class="varname">INSTALL_UNSTRIPPED</code></span></dt>
1.197     leot     4644: <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.184     rillig   4645:       when installing binaries. Any debugging sections and symbols present in
                   4646:       binaries will be preserved.
                   4647:       </p></dd>
                   4648: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
                   4649: <dd><p>A list of directories relative to
                   4650:       <code class="varname">PREFIX</code> that are created by pkgsrc at the
                   4651:       beginning of the <span class="emphasis"><em>install</em></span> phase.
                   4652:       The package is supposed to create all needed directories itself
                   4653:       before installing files to it and list all other directories here.
                   4654:       </p></dd>
                   4655: </dl></div>
                   4656: <p>In the rare cases that a package shouldn't install anything,
                   4657:     set <code class="varname">NO_INSTALL</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. This is
                   4658:     mostly relevant for packages in the <code class="filename">regress</code>
                   4659:     category.</p>
1.1       dsieger  4660: </div>
1.41      asau     4661: <div class="sect1">
1.1       dsieger  4662: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   4663: <a name="build.package"></a>13.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
                   4664: <p>Once the install stage has completed, a binary package of
                   4665:     the installed files can be built.  These binary packages can be
                   4666:     used for quick installation without previous compilation, e.g. by
                   4667:     the <span class="command"><strong>make bin-install</strong></span> or by using
                   4668:     <span class="command"><strong>pkg_add</strong></span>.</p>
                   4669: <p>By default, the binary packages are created in
                   4670:     <code class="filename">${PACKAGES}/All</code> and symlinks are created in
                   4671:     <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
                   4672:     one for each category in the <code class="varname">CATEGORIES</code>
                   4673:     variable.  <code class="varname">PACKAGES</code> defaults to
                   4674:     <code class="filename">pkgsrc/packages</code>.</p>
1.1       dsieger  4675: </div>
1.41      asau     4676: <div class="sect1">
1.1       dsieger  4677: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   4678: <a name="build.clean"></a>13.16. Cleaning up</h2></div></div></div>
                   4679: <p>Once you're finished with a package, you can clean the work
                   4680:     directory by running <span class="command"><strong>make clean</strong></span>.  If you want
                   4681:     to clean the work directories of all dependencies too, use
                   4682:     <span class="command"><strong>make clean-depends</strong></span>.</p>
1.1       dsieger  4683: </div>
1.41      asau     4684: <div class="sect1">
1.1       dsieger  4685: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   4686: <a name="build.helpful-targets"></a>13.17. Other helpful targets</h2></div></div></div>
1.41      asau     4687: <div class="variablelist"><dl class="variablelist">
1.184     rillig   4688: <dt><span class="term">pre/post-*</span></dt>
                   4689: <dd>
                   4690: <p>For any of the main targets described in the previous
                   4691:          section (configure, build, install, etc.), two auxiliary
                   4692:          targets exist with
                   4693:          <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
                   4694:          prefix for the main target's name.  These targets are
                   4695:          invoked before and after the main target is called,
                   4696:          allowing extra configuration or installation steps be
                   4697:          performed from a package's Makefile, for example, which
                   4698:          a program's configure script or install target
                   4699:          omitted.</p>
                   4700: <p>About 5% of the pkgsrc packages define their custom
                   4701:          post-extract target, another 5% define pre-configure, and 10%
                   4702:          define post-install. The other pre/post-* targets are defined
                   4703:          even less often.</p>
                   4704: </dd>
                   4705: <dt><span class="term">do-*</span></dt>
1.1       dsieger  4706: <dd>
1.184     rillig   4707: <p>Should one of the main targets do the wrong thing,
                   4708:          and should there be no variable to fix this, you can
                   4709:          redefine it with the do-* target.  (Note that redefining
                   4710:          the target itself instead of the do-* target is a bad
                   4711:          idea, as the pre-* and post-* targets won't be called
                   4712:          anymore, etc.)</p>
                   4713: <p>About 15% of the pkgsrc packages override the default
                   4714:          do-install, the other do-* targets are overridden even less
                   4715:          often.</p>
1.1       dsieger  4716: </dd>
1.184     rillig   4717: <dt><span class="term">reinstall</span></dt>
1.1       dsieger  4718: <dd>
1.184     rillig   4719: <p>If you did a <span class="command"><strong>make install</strong></span> and
                   4720:          you noticed some file was not installed properly, you
                   4721:          can repeat the installation with this target, which will
                   4722:          ignore the <span class="quote">&#8220;<span class="quote">already installed</span>&#8221;</span> flag.</p>
                   4723: <p>This is the default value of
                   4724:          <code class="varname">DEPENDS_TARGET</code> except in the case of
                   4725:          <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
                   4726:          package</strong></span>, where the defaults are
                   4727:          <span class="quote">&#8220;<span class="quote">package</span>&#8221;</span> and <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span>,
                   4728:          respectively.</p>
1.1       dsieger  4729: </dd>
1.184     rillig   4730: <dt><span class="term">deinstall</span></dt>
                   4731: <dd>
1.197     leot     4732: <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.184     rillig   4733:          current directory, effectively de-installing the
                   4734:          package. The following variables can be used to tune the
                   4735:          behaviour:</p>
                   4736: <div class="variablelist"><dl class="variablelist">
                   4737: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.197     leot     4738: <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.184     rillig   4739: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
                   4740: <dd><p>Remove all packages that require (depend on)
                   4741:                the given package.  This can be used to remove any
                   4742:                packages that may have been pulled in by a given
                   4743:                package, e.g. if <span class="command"><strong>make deinstall
                   4744:                DEINSTALLDEPENDS=1</strong></span> is done in
                   4745:                <code class="filename">pkgsrc/x11/kde</code>, this is
                   4746:                likely to remove whole KDE. Works by adding
1.197     leot     4747:                <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.184     rillig   4748:                command line.</p></dd>
                   4749: </dl></div>
                   4750: </dd>
                   4751: <dt><span class="term">bin-install</span></dt>
                   4752: <dd><p>Install a binary package from local disk and via FTP
                   4753:          from a list of sites (see the
                   4754:          <code class="varname">BINPKG_SITES</code> variable), and do a
                   4755:          <span class="command"><strong>make package</strong></span> if no binary package is
                   4756:          available anywhere.  The arguments given to
                   4757:          <span class="command"><strong>pkg_add</strong></span> can be set via
                   4758:          <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
                   4759:          operation, etc.</p></dd>
                   4760: <dt><span class="term">install-clean</span></dt>
                   4761: <dd><p>This target removes the state files for the "install" and later
                   4762:          phases so that the "install" target may be re-invoked. This can be
                   4763:          used after editing the PLIST to install the package without
                   4764:          rebuilding it.</p></dd>
                   4765: <dt><span class="term">build-clean</span></dt>
                   4766: <dd><p>This target removes the state files for the "build" and later
                   4767:          phases so that the "build" target may be re-invoked.</p></dd>
                   4768: <dt><span class="term">update</span></dt>
                   4769: <dd>
                   4770: <p>This target causes the current package to be
                   4771:          updated to the latest version.  The package and all
                   4772:          depending packages first get de-installed, then current
                   4773:          versions of the corresponding packages get compiled and
                   4774:          installed.  This is similar to manually noting which
                   4775:          packages are currently installed, then performing a
                   4776:          series of <span class="command"><strong>make deinstall</strong></span> and
                   4777:          <span class="command"><strong>make install</strong></span> (or whatever
                   4778:          <code class="varname">UPDATE_TARGET</code> is set to) for these
                   4779:          packages.</p>
                   4780: <p>You can use the <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> target to
                   4781:          resume package updating in case a previous <span class="command"><strong>make
                   4782:          update</strong></span> was interrupted for some reason.
                   4783:          However, in this case, make sure you don't call
                   4784:          <span class="command"><strong>make clean</strong></span> or otherwise remove the
                   4785:          list of dependent packages in <code class="varname">WRKDIR</code>.
                   4786:          Otherwise, you lose the ability to automatically update
                   4787:          the current package along with the dependent packages
                   4788:          you have installed.</p>
                   4789: <p>Resuming an interrupted <span class="command"><strong>make
                   4790:          update</strong></span> will only work as long as the package
                   4791:          tree remains unchanged.  If the source code for one of
                   4792:          the packages to be updated has been changed, resuming
                   4793:          <span class="command"><strong>make update</strong></span> will most certainly
                   4794:          fail!</p>
                   4795: <p>The following variables can be used either on the
                   4796:          command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
                   4797:          alter the behaviour of <span class="command"><strong>make
                   4798:          update</strong></span>:</p>
                   4799: <div class="variablelist"><dl class="variablelist">
                   4800: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
                   4801: <dd><p>Install target to recursively use for the
                   4802:                updated package and the dependent packages.
                   4803:                Defaults to <code class="varname">DEPENDS_TARGET</code> if
                   4804:                set, <span class="quote">&#8220;<span class="quote">install</span>&#8221;</span> otherwise for
                   4805:                <span class="command"><strong>make update</strong></span>.  Other good
                   4806:                targets are <span class="quote">&#8220;<span class="quote">package</span>&#8221;</span> or
                   4807:                <span class="quote">&#8220;<span class="quote">bin-install</span>&#8221;</span>.  Do not set this to
                   4808:                <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> or you will get stuck in an
                   4809:                endless loop!</p></dd>
                   4810: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
                   4811: <dd><p>Don't clean up after updating.  Useful if
                   4812:                you want to leave the work sources of the updated
                   4813:                packages around for inspection or other purposes.
                   4814:                Be sure you eventually clean up the source tree
                   4815:                (see the <span class="quote">&#8220;<span class="quote">clean-update</span>&#8221;</span> target below)
                   4816:                or you may run into troubles with old source code
                   4817:                still lying around on your next
                   4818:                <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
                   4819:                update</strong></span>.</p></dd>
                   4820: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
                   4821: <dd><p>Deinstall each package before installing
                   4822:                (making <code class="varname">DEPENDS_TARGET</code>). This
                   4823:                may be necessary if the
                   4824:                <span class="quote">&#8220;<span class="quote">clean-update</span>&#8221;</span> target (see below) was
                   4825:                called after interrupting a running <span class="command"><strong>make
                   4826:                update</strong></span>.</p></dd>
                   4827: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
                   4828: <dd><p>Allows you to disable recursion and hardcode
                   4829:                the target for packages.  The default is
                   4830:                <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> for the update target,
                   4831:                facilitating a recursive update of prerequisite
                   4832:                packages.  Only set
                   4833:                <code class="varname">DEPENDS_TARGET</code> if you want to
                   4834:                disable recursive updates. Use
                   4835:                <code class="varname">UPDATE_TARGET</code> instead to just
                   4836:                set a specific target for each package to be
                   4837:                installed during <span class="command"><strong>make update</strong></span>
                   4838:                (see above).</p></dd>
                   4839: </dl></div>
                   4840: </dd>
                   4841: <dt><span class="term">clean-update</span></dt>
                   4842: <dd>
                   4843: <p>Clean the source tree for all packages that would
                   4844:          get updated if <span class="command"><strong>make update</strong></span> was called
                   4845:          from the current directory.  This target should not be
                   4846:          used if the current package (or any of its depending
                   4847:          packages) have already been de-installed (e.g., after
                   4848:          calling <span class="command"><strong>make update</strong></span>) or you may lose
                   4849:          some packages you intended to update. As a rule of
                   4850:          thumb: only use this target <span class="emphasis"><em>before</em></span>
                   4851:          the first time you run <span class="command"><strong>make update</strong></span>
                   4852:          and only if you have a dirty package tree (e.g., if you
                   4853:          used <code class="varname">NOCLEAN</code>).</p>
                   4854: <p>If you are unsure about whether your tree is
                   4855:          clean, you can either perform a <span class="command"><strong>make
                   4856:          clean</strong></span> at the top of the tree, or use the
                   4857:          following sequence of commands from the directory of the
                   4858:          package you want to update (<span class="emphasis"><em>before</em></span>
                   4859:          running <span class="command"><strong>make update</strong></span> for the first
                   4860:          time, otherwise you lose all the packages you wanted to
                   4861:          update!):</p>
                   4862: <pre class="screen">
                   4863: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
                   4864: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
                   4865: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
                   4866:          </pre>
                   4867: <p>The following variables can be used either on the
                   4868:          command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
                   4869:          <span class="command"><strong>make clean-update</strong></span>:</p>
                   4870: <div class="variablelist"><dl class="variablelist">
                   4871: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
                   4872: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
                   4873:                reconstruct the list of directories to update for
                   4874:                this package.  Only use this if <span class="command"><strong>make
                   4875:                update</strong></span> successfully installed all
                   4876:                packages you wanted to update.  Normally, this is
                   4877:                done automatically on <span class="command"><strong>make
                   4878:                update</strong></span>, but may have been suppressed by
                   4879:                the <code class="varname">NOCLEAN</code> variable (see
                   4880:                above).</p></dd>
                   4881: </dl></div>
                   4882: </dd>
                   4883: <dt><span class="term">replace</span></dt>
                   4884: <dd>
                   4885: <p>Update the installation of the current package.  This
                   4886:          differs from update in that it does not replace dependent
                   4887:          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
                   4888:          target to work.</p>
                   4889: <p><span class="emphasis"><em>Be careful when using this
                   4890:          target!</em></span> There are no guarantees that dependent
                   4891:          packages will still work, in particular they will most
                   4892:          certainly break if you <span class="command"><strong>make replace</strong></span> a
                   4893:          library package whose shared library major version changed
                   4894:          between your installed version and the new one.  For this
                   4895:          reason, this target is not officially supported and only
                   4896:          recommended for advanced users.</p>
                   4897: </dd>
                   4898: <dt><span class="term">info</span></dt>
1.197     leot     4899: <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.184     rillig   4900:          package. You can use this to check which version of a
                   4901:          package is installed.</p></dd>
                   4902: <dt><span class="term">index</span></dt>
                   4903: <dd>
                   4904: <p>This is a top-level command, i.e. it should be used in
                   4905:          the <code class="filename">pkgsrc</code> directory.  It creates a
                   4906:          database of all packages in the local pkgsrc tree, including
                   4907:          dependencies, comment, maintainer, and some other useful
                   4908:          information.  Individual entries are created by running
                   4909:          <span class="command"><strong>make describe</strong></span> in the packages'
                   4910:          directories.  This index file is saved as
                   4911:          <code class="filename">pkgsrc/INDEX</code>.  It can be displayed in
                   4912:          verbose format by running <span class="command"><strong>make
                   4913:          print-index</strong></span>.  You can search in it with
                   4914:          <span class="command"><strong>make search
                   4915:          key=<em class="replaceable"><code>something</code></em></strong></span>.  You can
                   4916:          extract a list of all packages that depend on a particular
                   4917:          one by running <span class="command"><strong>make show-deps
                   4918:          PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
                   4919: <p>Running this command takes a very long time, some
                   4920:          hours even on fast machines!</p>
                   4921: </dd>
                   4922: <dt><span class="term">readme</span></dt>
                   4923: <dd>
                   4924: <p>This target generates a
1.199     nia      4925:          <code class="filename">index.html</code> file, which can be
1.184     rillig   4926:          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
                   4927:          contain references to any packages which are in the
                   4928:          <code class="varname">PACKAGES</code> directory on the local
                   4929:          host. The generated files can be made to refer to URLs
                   4930:          based on <code class="varname">FTP_PKG_URL_HOST</code> and
                   4931:          <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
1.199     nia      4932:          wanted to generate <code class="filename">index.html</code>
1.184     rillig   4933:          files which pointed to binary packages on the local
                   4934:          machine, in the directory
                   4935:          <code class="filename">/usr/packages</code>, set
                   4936:          <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
                   4937:          <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
                   4938:          <code class="varname">${PACKAGES}</code> directory and its
                   4939:          subdirectories will be searched for all the binary
                   4940:          packages.</p>
                   4941: <p>The target can be run at the toplevel or in category
                   4942:          directories, in which case it descends recursively.</p>
                   4943: </dd>
                   4944: <dt><span class="term">readme-all</span></dt>
                   4945: <dd><p>This is a top-level command, run it in
                   4946:          <code class="filename">pkgsrc</code>.  Use this target to create a
                   4947:          file <code class="filename">README-all.html</code> which contains a
                   4948:          list of all packages currently available in the NetBSD
                   4949:          Packages Collection, together with the category they belong
                   4950:          to and a short description. This file is compiled from the
1.199     nia      4951:          <code class="filename">pkgsrc/*/index.html</code> files, so be sure
1.184     rillig   4952:          to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
                   4953:          readme</strong></span>.</p></dd>
                   4954: <dt><span class="term">cdrom-readme</span></dt>
                   4955: <dd><p>This is very much the same as the
                   4956:          <span class="quote">&#8220;<span class="quote">readme</span>&#8221;</span> target (see above), but is to be
                   4957:          used when generating a pkgsrc tree to be written to a
                   4958:          CD-ROM.  This target also produces
1.199     nia      4959:          <code class="filename">index.html</code> files, and can be made
1.184     rillig   4960:          to refer to URLs based on
                   4961:          <code class="varname">CDROM_PKG_URL_HOST</code> and
                   4962:          <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
                   4963: <dt><span class="term">show-distfiles</span></dt>
                   4964: <dd><p>This target shows which distfiles and patchfiles
                   4965:          are needed to build the package
                   4966:          (<code class="varname">ALLFILES</code>, which contains all
                   4967:          <code class="varname">DISTFILES</code> and
                   4968:          <code class="varname">PATCHFILES</code>, but not
                   4969:          <code class="filename">patches/*</code>).</p></dd>
                   4970: <dt><span class="term">show-downlevel</span></dt>
                   4971: <dd><p>This target shows nothing if the package is not
                   4972:          installed. If a version of this package is installed,
                   4973:          but is not the version provided in this version of
                   4974:          pkgsrc, then a warning message is displayed. This target
                   4975:          can be used to show which of your installed packages are
                   4976:          downlevel, and so the old versions can be deleted, and
                   4977:          the current ones added.</p></dd>
                   4978: <dt><span class="term">show-pkgsrc-dir</span></dt>
                   4979: <dd><p>This target shows the directory in the pkgsrc
                   4980:          hierarchy from which the package can be built and
                   4981:          installed. This may not be the same directory as the one
                   4982:          from which the package was installed. This target is
                   4983:          intended to be used by people who may wish to upgrade
                   4984:          many packages on a single host, and can be invoked from
                   4985:          the top-level pkgsrc Makefile by using the
                   4986:          <span class="quote">&#8220;<span class="quote">show-host-specific-pkgs</span>&#8221;</span> target.</p></dd>
                   4987: <dt><span class="term">show-installed-depends</span></dt>
                   4988: <dd><p>This target shows which installed packages match
                   4989:          the current package's <code class="varname">DEPENDS</code>. Useful
                   4990:          if out of date dependencies are causing build
                   4991:          problems.</p></dd>
                   4992: <dt><span class="term">print-build-depends-list</span></dt>
                   4993: <dd><p>This target shows the list of packages that the current package
                   4994:            depends on for building.</p></dd>
                   4995: <dt><span class="term">print-run-depends-list</span></dt>
                   4996: <dd><p>This target shows the list of packages that the current package
                   4997:            depends on for running.</p></dd>
                   4998: <dt><span class="term">check-shlibs</span></dt>
                   4999: <dd><p>After a package is installed, check all its
                   5000:          binaries and (on ELF platforms) shared libraries to see
                   5001:          if they find the shared libs they need.  Run by default
                   5002:          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>
                   5003: <dt><span class="term">print-PLIST</span></dt>
                   5004: <dd>
                   5005: <p>After a <span class="quote">&#8220;<span class="quote">make install</span>&#8221;</span> from a new or
                   5006:          upgraded pkg, this prints out an attempt to generate a
                   5007:          new <code class="filename">PLIST</code> from a <span class="command"><strong>find
                   5008:          -newer work/.extract_done</strong></span>.  An attempt is made
                   5009:          to care for shared libs etc., but it is
                   5010:          <span class="emphasis"><em>strongly</em></span> recommended to review the
                   5011:          result before putting it into
                   5012:          <code class="filename">PLIST</code>. On upgrades, it's useful to
                   5013:          diff the output of this command against an already
                   5014:          existing <code class="filename">PLIST</code> file.</p>
1.197     leot     5015: <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.184     rillig   5016:          other methods that don't update file access times, be
                   5017:          sure to add these files manually to your
                   5018:          <code class="filename">PLIST</code>, as the <span class="quote">&#8220;<span class="quote">find
                   5019:          -newer</span>&#8221;</span> command used by this target won't catch
                   5020:          them!</p>
                   5021: <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
                   5022:          information on this target.</p>
                   5023: </dd>
                   5024: </dl></div>
                   5025: </div>
                   5026: </div>
                   5027: <div class="chapter">
                   5028: <div class="titlepage"><div><div><h2 class="title">
                   5029: <a name="creating"></a>Chapter 14. Creating a new pkgsrc package from scratch</h2></div></div></div>
                   5030: <div class="toc">
                   5031: <p><b>Table of Contents</b></p>
                   5032: <dl class="toc">
                   5033: <dt><span class="sect1"><a href="#creating.common">14.1. Common types of packages</a></span></dt>
                   5034: <dd><dl>
                   5035: <dt><span class="sect2"><a href="#creating.perl-module">14.1.1. Perl modules</a></span></dt>
                   5036: <dt><span class="sect2"><a href="#creating.python-module">14.1.2. Python modules and programs</a></span></dt>
                   5037: <dt><span class="sect2"><a href="#creating.R-package">14.1.3. R packages</a></span></dt>
                   5038: <dt><span class="sect2"><a href="#creating.TeX-package">14.1.4. TeXlive packages</a></span></dt>
                   5039: </dl></dd>
                   5040: <dt><span class="sect1"><a href="#creating.examples">14.2. Examples</a></span></dt>
                   5041: <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>
                   5042: </dl>
                   5043: </div>
                   5044: <p>When you find a package that is not yet in pkgsrc, you
                   5045: most likely have a URL from where you can download the source
                   5046: code. Starting with this URL, creating a package involves only a
                   5047: few steps.</p>
                   5048: <div class="procedure"><ol class="procedure" type="1">
                   5049: <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
                   5050: enable the basic quality checks.</p></li>
                   5051: <li class="step">
                   5052: <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
                   5053: install the utilities <span class="command"><strong>url2pkg</strong></span>,
                   5054: <span class="command"><strong>pkglint</strong></span>, <span class="command"><strong>pkgvi</strong></span> and
                   5055: <span class="command"><strong>mkpatches</strong></span>:</p>
                   5056: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   5057: <code class="prompt">$</code> <strong class="userinput"><code>(cd meta-pkgs/pkg_developer &amp;&amp; bmake update)</code></strong></pre>
                   5058: </li>
                   5059: <li class="step">
                   5060: <p>Choose one of the top-level directories as the category in
                   5061: which you want to place your package. You can also create a directory of
                   5062: your own (maybe called <code class="filename">local</code>). In that category
                   5063: directory, create another directory for your package and change into
                   5064: it:</p>
                   5065: <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>
                   5066: <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>
                   5067: </li>
                   5068: <li class="step">
                   5069: <p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
                   5070: you for a URL. Enter the URL of the distribution file (in most cases a
                   5071: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
                   5072: of your package are created automatically. The distribution file is
                   5073: extracted automatically to fill in some details in the
                   5074: <code class="filename">Makefile</code> that would otherwise have to be done
                   5075: manually:</p>
                   5076: <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>
                   5077: </li>
                   5078: <li class="step">
                   5079: <p>Examine the extracted files to determine the dependencies of
                   5080: your package. Ideally, this is mentioned in some
                   5081: <code class="filename">README</code> file, but things may differ. For each of
                   5082: these dependencies, look where it exists in pkgsrc, and if there is a
                   5083: file called <code class="filename">buildlink3.mk</code> in that directory, add a
                   5084: line to your package <code class="filename">Makefile</code> which includes that
                   5085: file just before the last line. If the
                   5086: <code class="filename">buildlink3.mk</code> file does not exist, it must be
                   5087: created first. The <code class="filename">buildlink3.mk</code> file makes sure
                   5088: that the package's include files and libraries are provided.</p>
                   5089: <p>If you just need binaries from a package, add a
                   5090: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
                   5091: version of the dependency and where it can be found in pkgsrc. This line
                   5092: should be placed in the third paragraph. If the dependency is only
                   5093: needed for building the package, but not when using it, use
                   5094: <code class="varname">TOOL_DEPENDS</code> or <code class="varname">BUILD_DEPENDS</code>
                   5095: instead of <code class="varname">DEPENDS</code>.
                   5096: The difference between <code class="varname">TOOL_DEPENDS</code> and
                   5097: <code class="varname">BUILD_DEPENDS</code> occurs when cross-compiling:
                   5098: <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
                   5099: packages, i.e. packages for the architecture where the package
                   5100: is built;
                   5101: <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
                   5102: packages, i.e. packages for the architecture for which the package
                   5103: is built. There is also <code class="varname">TEST_DEPENDS</code>, which is used
                   5104: to specify a dependency used only for testing the resulting package
                   5105: built, using the upstream project's included test suite.
                   5106: Your package may then look like this:</p>
                   5107: <pre class="programlisting">
                   5108: [...]
                   5109: 
                   5110: TOOL_DEPENDS+=  libxslt-[0-9]*:../../textproc/libxslt
                   5111: DEPENDS+=       screen-[0-9]*:../../misc/screen
                   5112: DEPENDS+=       screen&gt;=4.0:../../misc/screen
                   5113: 
                   5114: [...]
                   5115: 
                   5116: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
                   5117: .include "../../devel/glib2/buildlink3.mk"
                   5118: .include "../../mk/bsd.pkg.mk"
                   5119: </pre>
                   5120: </li>
                   5121: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
                   5122: to be done to make your package a <span class="quote">&#8220;<span class="quote">good</span>&#8221;</span> one. If you don't
                   5123: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
                   5124: --explain</strong></span> or <span class="command"><strong>pkglint -e</strong></span>, which outputs
                   5125: additional explanations.</p></li>
                   5126: <li class="step"><p>In many cases the package is not yet ready to build. You can
                   5127: 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
                   5128: over there, you can hopefully continue here.</p></li>
                   5129: <li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
                   5130: directory from the extracted files. Besides these files, a lot of cache
                   5131: files and other system information has been saved in the working
                   5132: directory, which may become wrong after you edited the
                   5133: <code class="filename">Makefile</code>.</p></li>
                   5134: <li class="step">
                   5135: <p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
                   5136: 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>
                   5137: <p>If the extracted files from the package need to be fixed, run multiple rounds of these commands:</p>
                   5138: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>make</code></strong>
                   5139: <code class="prompt">$</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
                   5140: <code class="prompt">$</code> <strong class="userinput"><code>mkpatches</code></strong>
                   5141: <code class="prompt">$</code> <strong class="userinput"><code>make mps</code></strong>
                   5142: <code class="prompt">$</code> <strong class="userinput"><code>make clean</code></strong></pre>
                   5143: </li>
                   5144: <li class="step"><p>When the package builds fine, the next step is to install
                   5145: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
                   5146: everything works.</p></li>
                   5147: <li class="step"><p>Up to now, the file <code class="filename">PLIST</code>, which
                   5148: contains a list of the files that are installed by the package, is
                   5149: nearly empty. Run <span class="command"><strong>bmake print-PLIST
                   5150: &gt;PLIST</strong></span> to generate a probably correct list. Check
                   5151: the file using your preferred text editor to see if the list of
                   5152: files looks plausible.</p></li>
                   5153: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
                   5154: <code class="filename">PLIST</code> contains garbage or not.</p></li>
                   5155: <li class="step"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
                   5156: had been registered in the database of installed files, but with an
                   5157: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
                   5158: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
                   5159: registered with the list of files from
                   5160: <code class="filename">PLIST</code>.</p></li>
                   5161: <li class="step"><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
                   5162: package from the set of installed files.</p></li>
                   5163: <li class="step"><p>Run <span class="command"><strong>bmake clean update</strong></span> to run everything
                   5164: from above again in a single step, making sure that the PLIST is correct
                   5165: and the whole package is created as intended.</p></li>
                   5166: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see if there's anything left to do.</p></li>
                   5167: <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>
                   5168: </ol></div>
                   5169: <div class="sect1">
                   5170: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   5171: <a name="creating.common"></a>14.1. Common types of packages</h2></div></div></div>
                   5172: <div class="sect2">
                   5173: <div class="titlepage"><div><div><h3 class="title">
                   5174: <a name="creating.perl-module"></a>14.1.1. Perl modules</h3></div></div></div>
                   5175: <p>Simple Perl modules are handled automatically by
                   5176: <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
                   5177: </div>
                   5178: <div class="sect2">
                   5179: <div class="titlepage"><div><div><h3 class="title">
                   5180: <a name="creating.python-module"></a>14.1.2. Python modules and programs</h3></div></div></div>
                   5181: <p>Python modules and programs packages are easily created using a
                   5182: set of predefined variables.</p>
                   5183: <p>
                   5184: If some Python versions are not supported by the software, set the
                   5185: <code class="varname">PYTHON_VERSIONS_INCOMPATIBLE</code> variable to the Python versions
                   5186: that are not supported, e.g.
                   5187: </p>
                   5188: <pre class="programlisting">
                   5189: PYTHON_VERSIONS_INCOMPATIBLE=       27
                   5190: </pre>
                   5191: <p>
                   5192: If the packaged software is a Python module, include one of
                   5193: <code class="filename">../../lang/python/egg.mk</code>,
                   5194: <code class="filename">../../lang/python/distutils.mk</code>, or
                   5195: <code class="filename">../../lang/python/extension.mk</code>.</p>
                   5196: <p>Most Python packages use either <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span> or
                   5197: easy-setup/setuptools (<span class="quote">&#8220;<span class="quote">eggs</span>&#8221;</span>).
                   5198: If the packaged software is using setuptools, you only need
                   5199: to include <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>&#8221;</span>.
                   5200: Otherwise, if the software uses <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span>, include 
                   5201: <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/distutils.mk</code></span>&#8221;</span>,
                   5202: so pkgsrc will use this framework.
                   5203: <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span> uses a script called <code class="filename">setup.py</code>;
                   5204: if the <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span> driver is not called
                   5205: <code class="filename">setup.py</code>, set the <code class="varname">PYSETUP</code> variable
                   5206: to the name of the script.</p>
                   5207: <p>Either way, the package directory should be called
                   5208: <span class="quote">&#8220;<span class="quote">py-software</span>&#8221;</span> and <code class="varname">PKGNAME</code> should be set to
                   5209: <span class="quote">&#8220;<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>&#8221;</span>, e.g.
                   5210: </p>
                   5211: <pre class="programlisting">
                   5212: DISTNAME=   foopymodule-1.2.10
                   5213: PKGNAME=    ${PYPKGPREFIX}-${DISTNAME}
                   5214: </pre>
                   5215: <p>If it is an application, include
                   5216: <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>&#8221;</span>.
                   5217: In order to correctly set the path to the Python interpreter, use the
                   5218: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
                   5219: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
                   5220: For example:
                   5221: </p>
                   5222: <pre class="programlisting">
                   5223: REPLACE_PYTHON=   *.py
                   5224: </pre>
                   5225: <p>Some Python modules have separate distributions for Python-2.x
                   5226: and Python-3.x support. In pkgsrc this is handled by the
                   5227: <code class="filename">versioned_dependencies.mk</code> file. Set
                   5228: <code class="varname">PYTHON_VERSIONED_DEPENDENCIES</code> to the list of
                   5229: packages that should be depended upon and include
                   5230: <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/versioned_dependencies.mk</code></span>&#8221;</span>,
                   5231: then the pkgsrc infrastructure will depend on the appropriate package
                   5232: version. For example:
                   5233: </p>
                   5234: <pre class="programlisting">
                   5235: PYTHON_VERSIONED_DEPENDENCIES=dialog
                   5236: </pre>
                   5237: <p>
                   5238: Look inside <code class="filename">versioned_dependencies.mk</code> for a list
                   5239: of supported packages.</p>
                   5240: </div>
                   5241: <div class="sect2">
                   5242: <div class="titlepage"><div><div><h3 class="title">
                   5243: <a name="creating.R-package"></a>14.1.3. R packages</h3></div></div></div>
                   5244: <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>
                   5245: are handled automatically by <span class="command"><strong>R2pkg</strong></span>, which is
                   5246: 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>.
                   5247: Individual packages (and optionally their dependencies) may be created
                   5248: and updated.  R packages generally follow the same form, and most of
                   5249: the relevant information needed is contained in a
                   5250: <code class="filename">DESCRIPTION</code> file as part of each R package on
                   5251: <a class="ulink" href="https://cran.r-project.org/web/packages/available_packages_by_name.html" target="_top">CRAN</a>.
                   5252: Consequently, <span class="command"><strong>R2pkg</strong></span> downloads that information and
                   5253: creates or updates a package in the canonical form.  The resulting
                   5254: package should be reviewed for correctness.</p>
                   5255: </div>
                   5256: <div class="sect2">
                   5257: <div class="titlepage"><div><div><h3 class="title">
                   5258: <a name="creating.TeX-package"></a>14.1.4. TeXlive packages</h3></div></div></div>
                   5259: <p>TeXlive packages from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> are handled automatically by
                   5260: <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>
                   5261: <p>If the TeXlive package name is not known, it may be useful to
                   5262: search <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>.  A
                   5263: <span class="quote">&#8220;<span class="quote">Contained in</span>&#8221;</span> field on the package page typically
                   5264: 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
                   5265: archive</a>.</p>
                   5266: <p>If the TeXlive package name is known, download the files from
                   5267: the <a class="ulink" href="https://www.ctan.org/tex-archive/systems/texlive/tlnet/archive" target="_top">TeXlive
                   5268: archive</a>.  For package <code class="filename">foo</code>, you will need
                   5269: to download <code class="filename">foo.tar.xz</code>.  Most TeXlive packages
                   5270: also have associated documentation packages, so download
                   5271: <code class="filename">foo.doc.tar.xz</code> at the same time.  These files
                   5272: should be placed in the appropriate category directory, which is often
                   5273: but not always <code class="filename">print</code>.  Then run the following
                   5274: command in the category directory.</p>
                   5275: <pre class="programlisting">
                   5276: texlive2pkg foo.tar.xz foo.doc.tar.xz
                   5277: </pre>
                   5278: <p>This will create two packages, <code class="filename">tex-foo</code> and
                   5279: <code class="filename">tex-foo-doc</code>.  Be sure to check that both packages
                   5280: are correct.</p>
                   5281: <p>Finally, <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>
                   5282: currently does not include version information in package filenames
                   5283: and changes their contents periodically when updates occur.
                   5284: Consequently, pkgsrc avoids downloading distfiles directly from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> and instead relies on the
                   5285: pkgsrc archives.  For each new or updated TeXlive package, e.g., the
                   5286: main one and the corresponding documentation, upload the distfiles
                   5287: with the following command in each package directory.</p>
                   5288: <pre class="programlisting">
                   5289: make upload-distfiles
                   5290: </pre>
                   5291: </div>
                   5292: </div>
                   5293: <div class="sect1">
                   5294: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   5295: <a name="creating.examples"></a>14.2. Examples</h2></div></div></div>
                   5296: <div class="sect2">
                   5297: <div class="titlepage"><div><div><h3 class="title">
                   5298: <a name="creating.nvu"></a>14.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
                   5299: <div class="sect3">
                   5300: <div class="titlepage"><div><div><h4 class="title">
                   5301: <a name="creating.nvu.init"></a>14.2.1.1. The initial package</h4></div></div></div>
                   5302: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
                   5303: that the <span class="quote">&#8220;<span class="quote">nvu</span>&#8221;</span> package has not yet been imported into
                   5304: pkgsrc. As the description says it has to do with the web, the obvious
                   5305: choice for the category is <span class="quote">&#8220;<span class="quote">www</span>&#8221;</span>.</p>
                   5306: <pre class="programlisting">
                   5307: <code class="prompt">$</code> mkdir www/nvu
                   5308: <code class="prompt">$</code> cd www/nvu
                   5309: </pre>
                   5310: <p>The web site says that the sources are available as a tar file, so
                   5311: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
                   5312: <pre class="programlisting">
                   5313: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
                   5314: </pre>
                   5315: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
                   5316: below the <code class="varname">DISTNAME</code> line, as the package name should
                   5317: not have the word <span class="quote">&#8220;<span class="quote">sources</span>&#8221;</span> in it. I also filled in the
                   5318: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
                   5319: <code class="varname">COMMENT</code> fields. Then the package
                   5320: <code class="filename">Makefile</code> looked like that:</p>
                   5321: <pre class="programlisting">
                   5322: # $NetBSD $
                   5323: #
                   5324: 
                   5325: DISTNAME=       nvu-1.0-sources
                   5326: PKGNAME=        nvu-1.0
                   5327: CATEGORIES=     www
                   5328: MASTER_SITES=   http://cvs.nvu.com/download/
                   5329: EXTRACT_SUFX=   .tar.bz2
                   5330: 
                   5331: MAINTAINER=     rillig@NetBSD.org
                   5332: HOMEPAGE=       http://cvs.nvu.com/
                   5333: COMMENT=        Web Authoring System
                   5334: 
                   5335: # url2pkg-marker (please do not remove this line.)
                   5336: .include "../../mk/bsd.pkg.mk"
                   5337: </pre>
                   5338: <p>On the first line of output above, an artificial space has been added between NetBSD and $,
                   5339: this is a workaround to prevent CVS expanding to the filename of the
                   5340: guide.</p>
                   5341: <p>Then, I quit the editor and watched pkgsrc downloading a large
                   5342: source archive:</p>
                   5343: <pre class="programlisting">
                   5344: url2pkg&gt; Running "make makesum" ...
                   5345: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   5346: =&gt; Fetching nvu-1.0-sources.tar.bz2
                   5347: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
                   5348: 100% |*************************************| 28992 KB  150.77 KB/s00:00 ETA
                   5349: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
                   5350: url2pkg&gt; Running "make extract" ...
                   5351: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   5352: =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   5353: =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   5354: work.bacc -&gt; /tmp/roland/pkgsrc/www/nvu/work.bacc
                   5355: ===&gt; Installing dependencies for nvu-1.0
                   5356: ===&gt; Overriding tools for nvu-1.0
                   5357: ===&gt; Extracting for nvu-1.0
                   5358: url2pkg&gt; Adjusting the Makefile.
                   5359: 
                   5360: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
                   5361: 
                   5362: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
                   5363: </pre>
                   5364: </div>
                   5365: <div class="sect3">
                   5366: <div class="titlepage"><div><div><h4 class="title">
                   5367: <a name="creating.nvu.problems"></a>14.2.1.2. Fixing all kinds of problems to make the package work</h4></div></div></div>
                   5368: <p>Now that the package has been extracted, let's see what's inside
                   5369: it. The package has a <code class="filename">README.txt</code>, but that only
                   5370: says something about mozilla, so it's probably useless for seeing what
                   5371: dependencies this package has. But since there is a GNU configure script
                   5372: in the package, let's hope that it will complain about everything it
                   5373: needs.</p>
                   5374: <pre class="programlisting">
                   5375: <code class="prompt">$</code> bmake
                   5376: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   5377: =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   5378: =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   5379: ===&gt; Patching for nvu-1.0
                   5380: ===&gt; Creating toolchain wrappers for nvu-1.0
                   5381: ===&gt; Configuring for nvu-1.0
                   5382: [...]
                   5383: configure: error: Perl 5.004 or higher is required.
                   5384: [...]
                   5385: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
                   5386: [...]
                   5387: </pre>
                   5388: <p>That worked quite well. So I opened the package Makefile in my
                   5389: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
                   5390: just appended <span class="quote">&#8220;<span class="quote">perl</span>&#8221;</span> to it. Since the dependencies of the
                   5391: package have changed now, and since a perl wrapper is automatically
                   5392: installed in the <span class="quote">&#8220;<span class="quote">tools</span>&#8221;</span> phase, I need to build the package
                   5393: from scratch.</p>
                   5394: <pre class="programlisting">
                   5395: <code class="prompt">$</code> bmake clean
                   5396: ===&gt; Cleaning for nvu-1.0
                   5397: <code class="prompt">$</code> bmake
                   5398: [...]
                   5399: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
                   5400: GNU Make.  You will not be able to build Mozilla without GNU Make.
                   5401: [...]
                   5402: </pre>
                   5403: <p>So I added <span class="quote">&#8220;<span class="quote">gmake</span>&#8221;</span> to the
                   5404: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
                   5405: <pre class="programlisting">
                   5406: [...]
                   5407: checking for GTK - version &gt;= 1.2.0... no
                   5408: *** Could not run GTK test program, checking why...
                   5409: [...]
                   5410: </pre>
                   5411: <p>Now to the other dependencies. The first question is: Where is the
                   5412: GTK package hidden in pkgsrc?</p>
                   5413: <pre class="programlisting">
                   5414: <code class="prompt">$</code> echo ../../*/gtk*
                   5415: [many packages ...]
                   5416: <code class="prompt">$</code> echo ../../*/gtk
                   5417: ../../x11/gtk
                   5418: <code class="prompt">$</code> echo ../../*/gtk2
                   5419: ../../x11/gtk2
                   5420: <code class="prompt">$</code> echo ../../*/gtk2/bui*
                   5421: ../../x11/gtk2/buildlink3.mk
                   5422: </pre>
                   5423: <p>The first try was definitely too broad. The second one had exactly
                   5424: one result, which is very good. But there is one pitfall with GNOME
                   5425: packages. Before GNOME 2 had been released, there were already many
                   5426: GNOME 1 packages in pkgsrc. To be able to continue to use these
                   5427: packages, the GNOME 2 packages were imported as separate packages, and
                   5428: their names usually have a <span class="quote">&#8220;<span class="quote">2</span>&#8221;</span> appended. So I checked
                   5429: whether this was the case here, and indeed it was.</p>
                   5430: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
                   5431: file, adding the dependency is very easy. I just inserted an
                   5432: <code class="literal">.include</code> line before the last line of the package
                   5433: <code class="filename">Makefile</code>, so that it now looks like this:</p>
                   5434: <pre class="programlisting">
                   5435: [...]
                   5436: .include "../../x11/gtk2/buildlink3.mk"
                   5437: .include "../../mk/bsd.pkg.mk
                   5438: </pre>
                   5439: <p>After another <span class="command"><strong>bmake clean &amp;&amp; bmake</strong></span>, the answer
                   5440: was:</p>
1.1       dsieger  5441: <pre class="programlisting">
1.184     rillig   5442: [...]
                   5443: checking for gtk-config... /home/roland/pkg/bin/gtk-config
                   5444: checking for GTK - version &gt;= 1.2.0... no
                   5445: *** Could not run GTK test program, checking why...
                   5446: *** The test program failed to compile or link. See the file config.log for the
                   5447: *** exact error that occured. This usually means GTK was incorrectly installed
                   5448: *** or that you have moved GTK since it was installed. In the latter case, you
                   5449: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
                   5450: configure: error: Test for GTK failed.
                   5451: [...]
1.111     sevan    5452: </pre>
1.184     rillig   5453: <p>In this particular case, the assumption that <span class="quote">&#8220;<span class="quote">every package
                   5454: prefers GNOME 2</span>&#8221;</span> had been wrong. The first of the lines above
                   5455: told me that this package really wanted to have the GNOME 1 version of
                   5456: GTK. If the package had looked for GTK2, it would have looked for
                   5457: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
                   5458: So I changed the <code class="literal">x11/gtk2</code> to
                   5459: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
                   5460: and tried again.</p>
1.18      snj      5461: <pre class="programlisting">
1.184     rillig   5462: [...]
                   5463: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\"  [...]
                   5464: In file included from xpidl.c:42:
                   5465: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
                   5466: In file included from xpidl.c:42:
                   5467: xpidl.h:132: error: parse error before "IDL_ns"
                   5468: [...]
1.111     sevan    5469: </pre>
1.184     rillig   5470: <p>The package still does not find all of its dependencies. Now the
                   5471: question is: Which package provides the
                   5472: <code class="filename">libIDL/IDL.h</code> header file?</p>
1.18      snj      5473: <pre class="programlisting">
1.184     rillig   5474: <code class="prompt">$</code> echo ../../*/*idl*
                   5475: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
                   5476: <code class="prompt">$</code> echo ../../*/*IDL*
                   5477: ../../net/libIDL
1.111     sevan    5478: </pre>
1.184     rillig   5479: <p>Let's take the one from the second try. So I included the
                   5480: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
                   5481: again. But the error didn't change. After digging through some of the
                   5482: code, I concluded that the build process of the package was broken and
                   5483: couldn't have ever worked, but since the Mozilla source tree is quite
                   5484: large, I didn't want to fix it. So I added the following to the package
                   5485: <code class="filename">Makefile</code> and tried again:</p>
1.86      wiz      5486: <pre class="programlisting">
1.184     rillig   5487: CPPFLAGS+=              -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
                   5488: BUILDLINK_TRANSFORM+=   l:IDL:IDL-2
1.111     sevan    5489: </pre>
1.184     rillig   5490: <p>The latter line is needed because the package expects the library
                   5491: <code class="filename">libIDL.so</code>, but only
                   5492: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
                   5493: wrapper to rewrite that on the fly.</p>
                   5494: <p>The next problem was related to a recent change of the FreeType
                   5495: 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>
                   5496: which patch files were relevant for this issue and copied them to the
                   5497: <code class="filename">patches</code> directory. Then I retried, fixed the
                   5498: patches so that they applied cleanly and retried again. This time,
                   5499: everything worked.</p>
1.86      wiz      5500: </div>
1.184     rillig   5501: <div class="sect3">
                   5502: <div class="titlepage"><div><div><h4 class="title">
                   5503: <a name="creating.nvu.inst"></a>14.2.1.3. Installing the package</h4></div></div></div>
1.1       dsieger  5504: <pre class="programlisting">
1.184     rillig   5505: <code class="prompt">$</code> bmake CHECK_FILES=no install
                   5506: [...]
                   5507: <code class="prompt">$</code> bmake print-PLIST &gt;PLIST
                   5508: <code class="prompt">$</code> bmake deinstall
                   5509: <code class="prompt">$</code> bmake install
1.111     sevan    5510: </pre>
1.184     rillig   5511: </div>
                   5512: </div>
1.1       dsieger  5513: </div>
                   5514: </div>
1.41      asau     5515: <div class="chapter">
1.1       dsieger  5516: <div class="titlepage"><div><div><h2 class="title">
1.184     rillig   5517: <a name="makefile"></a>Chapter 15. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.1       dsieger  5518: <div class="toc">
                   5519: <p><b>Table of Contents</b></p>
1.100     leot     5520: <dl class="toc">
1.184     rillig   5521: <dt><span class="sect1"><a href="#makefile.style">15.1. Caveats</a></span></dt>
                   5522: <dt><span class="sect1"><a href="#makefile.variables">15.2. <code class="filename">Makefile</code> variables</a></span></dt>
                   5523: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">15.2.1. Naming conventions</a></span></dt></dl></dd>
                   5524: <dt><span class="sect1"><a href="#makefile.code">15.3. Code snippets</a></span></dt>
                   5525: <dd><dl>
                   5526: <dt><span class="sect2"><a href="#adding-to-list">15.3.1. Adding things to a list</a></span></dt>
                   5527: <dt><span class="sect2"><a href="#echo-literal">15.3.2. Echoing a string exactly as-is</a></span></dt>
                   5528: <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>
                   5529: <dt><span class="sect2"><a href="#empty-variables">15.3.4. Handling possibly empty variables</a></span></dt>
1.1       dsieger  5530: </dl></dd>
                   5531: </dl>
                   5532: </div>
1.184     rillig   5533: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
                   5534:   each of which forms a well-defined part of the pkgsrc system. Using
1.197     leot     5535:   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.184     rillig   5536:   like pkgsrc requires some discipline to keep the code correct and
                   5537:   understandable.</p>
                   5538: <p>The basic ingredients for <code class="filename">Makefile</code>
                   5539:   programming are variables and shell
                   5540:   commands. Among these shell commands may even be more complex ones
1.197     leot     5541:   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.184     rillig   5542:   as intended it is necessary to quote all variables correctly when they
                   5543:   are used.</p>
                   5544: <p>This chapter describes some patterns that appear quite often in
                   5545:   <code class="filename">Makefile</code>s, including the pitfalls that come along
                   5546:   with them.</p>
1.41      asau     5547: <div class="sect1">
1.1       dsieger  5548: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   5549: <a name="makefile.style"></a>15.1. Caveats</h2></div></div></div>
                   5550: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
                   5551: <p>When you are creating a file as a
                   5552:     target of a rule, always write the data to a temporary file first
                   5553:     and finally rename that file. Otherwise there might occur an error
                   5554:     in the middle of generating the file, and when the user runs
1.197     leot     5555:     <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.184     rillig   5556:     regenerated properly. Example:</p>
1.1       dsieger  5557: <pre class="programlisting">
1.184     rillig   5558: wrong:
                   5559:         @echo "line 1" &gt; ${.TARGET}
                   5560:         @echo "line 2" &gt;&gt; ${.TARGET}
                   5561:         @false
                   5562: 
                   5563: correct:
                   5564:         @echo "line 1" &gt; ${.TARGET}.tmp
                   5565:         @echo "line 2" &gt;&gt; ${.TARGET}.tmp
                   5566:         @false
                   5567:         @mv ${.TARGET}.tmp ${.TARGET}
1.1       dsieger  5568: </pre>
1.184     rillig   5569: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
                   5570:     <code class="filename">wrong</code> will exist, although there was an error
                   5571:     message in the first run. On the other hand, running <span class="command"><strong>make
                   5572:     correct</strong></span> gives an error message twice, as expected.</p>
1.197     leot     5573: <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.184     rillig   5574:     <code class="literal">${.TARGET}</code> in case of error, but this only
                   5575:     happens when it is interrupted, for example by pressing
                   5576:     <code class="literal">Ctrl+C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.197     leot     5577:     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.184     rillig   5578: </li></ul></div>
                   5579: </div>
                   5580: <div class="sect1">
                   5581: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   5582: <a name="makefile.variables"></a>15.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
                   5583: <p><code class="filename">Makefile</code> variables contain strings that
                   5584:     can be processed using the five operators <code class="code">=</code>,
                   5585:     <code class="code">+=</code>, <code class="code">?=</code>, <code class="code">:=</code> and
1.197     leot     5586:     <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.184     rillig   5587:     page.</p>
                   5588: <p>When a variable's value is parsed from a
                   5589:     <code class="filename">Makefile</code>, the hash character <code class="code">#</code> and
                   5590:     the backslash character <code class="code">\</code> are handled specially. If a
                   5591:     backslash is the last character in a line, that backslash is removed
                   5592:     from the line and the line continues with the next line of the file.</p>
                   5593: <p>The <code class="code">#</code> character starts a comment that reaches
                   5594:     until the end of the line. To get an actual <code class="code">#</code> character,
                   5595:     such as in a URL, write <code class="code">\#</code> instead.</p>
                   5596: <p>The evaluation of variables either happens immediately or lazy.
                   5597:     It happens immediately when the variable occurs on the right-hand
                   5598:     side of the <code class="code">:=</code> or the <code class="code">!=</code> operator, in a
                   5599:     <code class="varname">.if</code> condition or a <code class="varname">.for</code> loop.
                   5600:     In the other cases, it is evaluated lazily.</p>
                   5601: <p>Some of the modifiers split the string into words and then
                   5602:     operate on the words, others operate on the string as a whole. When a
                   5603:     string is split into words, double quotes and single quotes are
1.197     leot     5604:     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.184     rillig   5605: <div class="sect2">
                   5606: <div class="titlepage"><div><div><h3 class="title">
                   5607: <a name="makefile.variables.names"></a>15.2.1. Naming conventions</h3></div></div></div>
                   5608: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   5609: <li class="listitem"><p>All variable names starting with an underscore
                   5610:        are reserved for use by the pkgsrc infrastructure. They shall
                   5611:        not be used by packages.</p></li>
                   5612: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
                   5613:        lowercase variable names for the iteration
                   5614:        variables.</p></li>
                   5615: <li class="listitem"><p>All list variables should have a plural name,
                   5616:        such as <code class="varname">PKG_OPTIONS</code> or
                   5617:        <code class="varname">DISTFILES</code>.</p></li>
                   5618: </ul></div>
                   5619: </div>
                   5620: </div>
                   5621: <div class="sect1">
                   5622: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   5623: <a name="makefile.code"></a>15.3. Code snippets</h2></div></div></div>
                   5624: <div class="sect2">
                   5625: <div class="titlepage"><div><div><h3 class="title">
                   5626: <a name="adding-to-list"></a>15.3.1. Adding things to a list</h3></div></div></div>
                   5627: <p>When adding a string that possibly contains whitespace or quotes to
                   5628: a list (example 1), it must be quoted using the <code class="code">:Q</code>
                   5629: modifier.</p>
                   5630: <p>When adding another list to a list (example 2), it must not be
                   5631: quoted, since its elements are already quoted.</p>
1.1       dsieger  5632: <pre class="programlisting">
1.184     rillig   5633: STRING=         foo * bar `date`
                   5634: LIST=           # empty
                   5635: ANOTHER_LIST=   a=b c=d
                   5636: 
                   5637: LIST+=          ${STRING:Q}       # 1
                   5638: LIST+=          ${ANOTHER_LIST}   # 2
1.1       dsieger  5639: </pre>
1.184     rillig   5640: </div>
                   5641: <div class="sect2">
                   5642: <div class="titlepage"><div><div><h3 class="title">
                   5643: <a name="echo-literal"></a>15.3.2. Echoing a string exactly as-is</h3></div></div></div>
                   5644: <p>Echoing a string containing special characters needs special
                   5645: work.</p>
1.1       dsieger  5646: <pre class="programlisting">
1.184     rillig   5647: STRING=         foo bar &lt;    &gt; * `date` $$HOME ' "
                   5648: EXAMPLE_ENV=    string=${STRING:Q} x=multiple\ quoted\ words
                   5649: 
                   5650: all:
                   5651:         echo ${STRING}                  # 1
                   5652:         echo ${STRING:Q}                # 2
                   5653:         printf '%s\n' ${STRING:Q}''     # 3
                   5654:         env ${EXAMPLE_ENV} sh -c 'echo "$$string"; echo "$$x"'   # 4
1.1       dsieger  5655: </pre>
1.184     rillig   5656: <p>Example 1 leads to a syntax error in the shell, as the characters
                   5657: are just copied.</p>
                   5658: <p>Example 2 quotes the string so that the shell interprets it
                   5659: correctly. But the echo command may additionally interpret strings with a
                   5660: leading dash or those containing backslashes.</p>
1.197     leot     5661: <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.184     rillig   5662: interprets the format string, but not the next argument. The trailing
                   5663: single quotes handle the case when the string is empty. In that case, the
                   5664: :Q modifier would result in an empty string too, which would then be
1.197     leot     5665: 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.184     rillig   5666: but other programs may care.</p>
                   5667: <p>In example 4, the <code class="varname">EXAMPLE_ENV</code> does not
                   5668: need to be quoted because the quoting has already been done
                   5669: when adding elements to the list.</p>
1.1       dsieger  5670: </div>
1.41      asau     5671: <div class="sect2">
1.1       dsieger  5672: <div class="titlepage"><div><div><h3 class="title">
1.184     rillig   5673: <a name="cflags-gnu-configure"></a>15.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</h3></div></div></div>
                   5674: <p>When passing <code class="varname">CFLAGS</code> or similar variables to a
                   5675: GNU-style configure script (especially those that call other configure
                   5676: scripts), it must not have leading or trailing whitespace, since
                   5677: otherwise the configure script gets confused. To trim leading and
                   5678: trailing whitespace, use the <code class="code">:M</code> modifier, as in the
                   5679: following example:</p>
1.1       dsieger  5680: <pre class="programlisting">
1.184     rillig   5681: CPPFLAGS=               # empty
                   5682: CPPFLAGS+=              -Wundef -DPREFIX=\"${PREFIX}\"
                   5683: CPPFLAGS+=              ${MY_CPPFLAGS}
1.1       dsieger  5684: 
1.184     rillig   5685: CONFIGURE_ARGS+=        CPPFLAGS=${CPPFLAGS:M*:Q}
1.1       dsieger  5686: 
1.184     rillig   5687: all:
                   5688:         echo x${CPPFLAGS:Q}x            # leading and trailing whitespace
                   5689:         echo x${CONFIGURE_ARGS:Q}x      # properly trimmed
                   5690: </pre>
                   5691: <p>In this example, <code class="varname">CPPFLAGS</code> has both leading and
                   5692: trailing whitespace because the <code class="code">+=</code> operator always adds a
                   5693: space.</p>
                   5694: </div>
                   5695: <div class="sect2">
                   5696: <div class="titlepage"><div><div><h3 class="title">
                   5697: <a name="empty-variables"></a>15.3.4. Handling possibly empty variables</h3></div></div></div>
                   5698: <p>When a possibly empty variable is used in a shell program, it may
                   5699: lead to a syntax error.</p>
                   5700: <pre class="programlisting">
                   5701: EGFILES=        # empty
1.1       dsieger  5702: 
1.184     rillig   5703: install-examples:   # produces a syntax error in the shell
                   5704:         for egfile in ${EGFILES}; do            \
                   5705:                 echo "Installing $$egfile";     \
                   5706:         done
                   5707: </pre>
                   5708: <p>The shell only sees the text <code class="code">for egfile in ; do</code>, since
1.197     leot     5709: <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.184     rillig   5710: To fix this syntax error, use one of the snippets below.</p>
                   5711: <pre class="programlisting">
                   5712: EMPTY=          # empty
1.1       dsieger  5713: 
1.184     rillig   5714: install-examples:
                   5715:         for egfile in ${EGFILES} ""; do         \
                   5716:                 [ -n "$$egfile" ] || continue;  \
                   5717:                 echo "Installing $$egfile";     \
                   5718:         done
                   5719: </pre>
                   5720: <p>In this case, an empty string is appended to the iteration list (to
                   5721: prevent the syntax error) and filtered out later.</p>
                   5722: <pre class="programlisting">
                   5723: EGFILES=        # empty
1.1       dsieger  5724: 
1.184     rillig   5725: install-examples:
                   5726: .for egfile in ${EGFILES}
                   5727:         echo "Installing ${egfile}"
                   5728: .endfor
1.1       dsieger  5729: </pre>
1.184     rillig   5730: <p>If one of the filenames contains special characters, it should be
                   5731: enclosed in single or double quotes.</p>
                   5732: <p>To have a shell command test whether a make variable is empty, use
                   5733: the following code: <code class="code">${TEST} -z ${POSSIBLY_EMPTY:Q}""</code>.</p>
                   5734: </div>
                   5735: </div>
                   5736: </div>
                   5737: <div class="chapter">
                   5738: <div class="titlepage"><div><div><h2 class="title">
                   5739: <a name="options"></a>Chapter 16. Options handling</h2></div></div></div>
                   5740: <div class="toc">
                   5741: <p><b>Table of Contents</b></p>
                   5742: <dl class="toc">
                   5743: <dt><span class="sect1"><a href="#global-default-options">16.1. Global default options</a></span></dt>
                   5744: <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>
                   5745: <dt><span class="sect1"><a href="#option-names">16.3. Option Names</a></span></dt>
                   5746: <dt><span class="sect1"><a href="#option-build">16.4. Determining the options of dependencies</a></span></dt>
                   5747: </dl>
1.1       dsieger  5748: </div>
1.184     rillig   5749: <p>Many packages have the ability to be built to support different
                   5750: sets of features.  <code class="filename">bsd.options.mk</code> is a framework
                   5751: in pkgsrc that provides generic handling of those options that
                   5752: determine different ways in which the packages can be built.  It's
                   5753: possible for the user to specify exactly which sets of options will be
                   5754: built into a package or to allow a set of global default options
                   5755: apply.</p>
                   5756: <p>There are two broad classes of behaviors that one might want to
                   5757: control via options.  One is whether some particular feature is
                   5758: enabled in a program that will be built anyway, often by including or
                   5759: not including a dependency on some other package.  The other is
                   5760: whether or not an additional program will be built as part of the
                   5761: package.  Generally, it is better to make a split package for such
                   5762: additional programs instead of using options, because it enables
                   5763: binary packages to be built which can then be added separately.  For
                   5764: example, the foo package might have minimal dependencies (those
                   5765: packages without which foo doesn't make sense), and then the foo-gfoo
                   5766: package might include the GTK frontend program gfoo.  This is better
                   5767: than including a gtk option to foo that adds gfoo, because either that
                   5768: option is default, in which case binary users can't get foo without
                   5769: gfoo, or not default, in which case they can't get gfoo.  With split
                   5770: packages, they can install foo without having GTK, and later decide to
                   5771: install gfoo (pulling in GTK at that time).  This is an advantage to
                   5772: source users too, avoiding the need for rebuilds.</p>
                   5773: <p>Plugins with widely varying dependencies should usually be split
                   5774: instead of options.</p>
                   5775: <p>It is often more work to maintain split packages, especially if
                   5776: the upstream package does not support this.  The decision of split
                   5777: vs. option should be made based on the likelihood that users will want
                   5778: or object to the various pieces, the size of the dependencies that are
                   5779: included, and the amount of work.</p>
                   5780: <p>A further consideration is licensing.  Non-free parts, or parts
                   5781: that depend on non-free dependencies (especially plugins) should
                   5782: almost always be split if feasible.</p>
                   5783: <div class="sect1">
                   5784: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   5785: <a name="global-default-options"></a>16.1. Global default options</h2></div></div></div>
                   5786: <p>Global default options are listed in
                   5787: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
                   5788: that should be built into every package if that option is supported.
                   5789: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1       dsieger  5790: </div>
1.41      asau     5791: <div class="sect1">
1.1       dsieger  5792: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   5793: <a name="converting-to-options"></a>16.2. Converting packages to use <code class="filename">bsd.options.mk</code>
                   5794: </h2></div></div></div>
                   5795: <p>The following example shows how
                   5796: <code class="filename">bsd.options.mk</code> should be used
                   5797: by the hypothetical ``wibble'' package, either in the package
                   5798: <code class="filename">Makefile</code>, or in a file,
                   5799: e.g. <code class="filename">options.mk</code>, that is included by the
                   5800: main package <code class="filename">Makefile</code>.</p>
1.1       dsieger  5801: <pre class="programlisting">
1.184     rillig   5802: PKG_OPTIONS_VAR=                PKG_OPTIONS.wibble
                   5803: PKG_SUPPORTED_OPTIONS=          wibble-foo ldap
                   5804: PKG_OPTIONS_OPTIONAL_GROUPS=    database
                   5805: PKG_OPTIONS_GROUP.database=     mysql pgsql
                   5806: PKG_SUGGESTED_OPTIONS=          wibble-foo
                   5807: PKG_OPTIONS_LEGACY_VARS+=       WIBBLE_USE_OPENLDAP:ldap
                   5808: PKG_OPTIONS_LEGACY_OPTS+=       foo:wibble-foo
                   5809: 
                   5810: .include "../../mk/bsd.prefs.mk"
                   5811: 
                   5812: # this package was previously named wibble2
                   5813: .if defined(PKG_OPTIONS.wibble2)
                   5814: PKG_LEGACY_OPTIONS+=            ${PKG_OPTIONS.wibble2}
                   5815: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
                   5816:         "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
                   5817: .endif
                   5818: 
                   5819: .include "../../mk/bsd.options.mk"
                   5820: 
                   5821: # Package-specific option-handling
1.1       dsieger  5822: 
1.184     rillig   5823: ###
                   5824: ### FOO support
                   5825: ###
                   5826: .if !empty(PKG_OPTIONS:Mwibble-foo)
                   5827: CONFIGURE_ARGS+=    --enable-foo
                   5828: .endif
1.1       dsieger  5829: 
1.184     rillig   5830: ###
                   5831: ### LDAP support
                   5832: ###
                   5833: .if !empty(PKG_OPTIONS:Mldap)
                   5834: .  include "../../databases/openldap-client/buildlink3.mk"
                   5835: CONFIGURE_ARGS+=    --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
                   5836: .endif
1.1       dsieger  5837: 
1.184     rillig   5838: ###
                   5839: ### database support
                   5840: ###
                   5841: .if !empty(PKG_OPTIONS:Mmysql)
                   5842: .  include "../../mk/mysql.buildlink3.mk"
                   5843: .endif
                   5844: .if !empty(PKG_OPTIONS:Mpgsql)
                   5845: .  include "../../mk/pgsql.buildlink3.mk"
                   5846: .endif
                   5847: </pre>
                   5848: <p>The first section contains the information about which build
                   5849: options are supported by the package, and any default options settings
                   5850: if needed.</p>
                   5851: <div class="orderedlist"><ol class="orderedlist" type="1">
                   5852: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.197     leot     5853: <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.184     rillig   5854: options.  It should be set to
                   5855: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
                   5856: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
                   5857: at the point where the options are processed.</p></li>
                   5858: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
                   5859: build options supported by the package.</p></li>
                   5860: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
                   5861: list of names of groups of mutually exclusive options.  The options in
                   5862: each group are listed in
                   5863: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
                   5864: The most specific setting of any option from the group takes
                   5865: precedence over all other options in the group.  Options from the
                   5866: groups will be automatically added to
                   5867: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
                   5868: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
                   5869: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
                   5870: packages will fail if no option from the group is
                   5871: selected.</p></li>
                   5872: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
                   5873: of names of sets of options.  At least one option from each set must
                   5874: be selected.  The options in each set are listed in
                   5875: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
                   5876: Options from the sets will be automatically added to
                   5877: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.  Building the package will
                   5878: fail if no option from the set is selected.</p></li>
                   5879: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
                   5880: build options which are enabled by default.</p></li>
                   5881: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
                   5882: of
                   5883: <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>
                   5884: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
                   5885: their option counterparts.  Pairs should be added with
                   5886: <span class="quote">&#8220;<span class="quote">+=</span>&#8221;</span> to keep the listing of global legacy variables.  A
                   5887: warning will be issued if the user uses a legacy
                   5888: variable.</p></li>
                   5889: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
                   5890: of
                   5891: <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>
                   5892: pairs that map options that have been renamed to their new
                   5893: counterparts.  Pairs should be added with <span class="quote">&#8220;<span class="quote">+=</span>&#8221;</span> to keep
                   5894: the listing of global legacy options.  A warning will be issued if
                   5895: the user uses a legacy option.</p></li>
                   5896: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
                   5897: options implied by deprecated variables used.  This can be used for
                   5898: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
                   5899: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
                   5900: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
                   5901: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
                   5902: a list of warnings about deprecated variables or options used, and
                   5903: what to use instead.</p></li>
                   5904: </ol></div>
                   5905: <p>A package should never modify
                   5906: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
                   5907: <code class="varname">PKG_OPTIONS_VAR</code>.  These are strictly user-settable.
                   5908: To suggest a default set of options, use
                   5909: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
                   5910: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
                   5911: including <code class="filename">bsd.options.mk</code>.  If none of
                   5912: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
                   5913: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
                   5914: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
                   5915: happen with platform-specific options if none of them is supported on
                   5916: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
                   5917: empty list and the package is otherwise treated as not using the
                   5918: options framework.</p>
                   5919: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
                   5920: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
                   5921: build options, properly filtered to remove unsupported and duplicate
                   5922: options.</p>
                   5923: <p>The remaining sections contain the logic that is specific to
                   5924: each option.  The correct way to check for an option is to check
                   5925: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
                   5926: <pre class="programlisting">
                   5927: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
1.1       dsieger  5928: </pre>
                   5929: </div>
1.184     rillig   5930: <div class="sect1">
                   5931: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   5932: <a name="option-names"></a>16.3. Option Names</h2></div></div></div>
                   5933: <p>Options that enable similar features in different packages (like
                   5934: optional support for a library) should use a common name in all
                   5935: packages that support it (like the name of the library).  If another
                   5936: package already has an option with the same meaning, use the same
                   5937: name.</p>
                   5938: <p>Options that enable features specific to one package, where it's
                   5939: unlikely that another (unrelated) package has the same (or a similar)
                   5940: optional feature, should use a name prefixed with
                   5941: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
                   5942: <p>If a group of related packages share an optional feature
                   5943: specific to that group, prefix it with the name of the
                   5944: <span class="quote">&#8220;<span class="quote">main</span>&#8221;</span> package
                   5945: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
                   5946: <p>For new options, add a line to
                   5947: <code class="filename">mk/defaults/options.description</code>.  Lines have two
                   5948: fields, separated by tab.  The first field is the option name, the
                   5949: second its description.  The description should be a whole sentence
                   5950: (starting with an uppercase letter and ending with a period) that
                   5951: describes what enabling the option does.  E. g. <span class="quote">&#8220;<span class="quote">Enable ispell
                   5952: support.</span>&#8221;</span> The file is sorted by option names.</p>
                   5953: </div>
                   5954: <div class="sect1">
                   5955: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   5956: <a name="option-build"></a>16.4. Determining the options of dependencies</h2></div></div></div>
                   5957: <p>When writing <a class="link" href="#buildlink3.mk"><code class="filename">buildlink3.mk</code></a> files, it is often necessary to list
                   5958: different dependencies based on the options with which the package was
                   5959: built. For querying these options, the file
                   5960: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
                   5961: typical example looks like this:</p>
1.1       dsieger  5962: <pre class="programlisting">
1.184     rillig   5963: pkgbase := libpurple
                   5964: .include "../../mk/pkg-build-options.mk"
                   5965: 
                   5966: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
                   5967: ...
                   5968: .endif
1.117     sevan    5969: </pre>
1.184     rillig   5970: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
                   5971: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
                   5972: options of the libpurple package, which can then be queried like
                   5973: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
                   5974: file. See the file <code class="filename">pkg-build-options.mk</code> for more
                   5975: details.</p>
1.1       dsieger  5976: </div>
                   5977: </div>
1.41      asau     5978: <div class="chapter">
1.1       dsieger  5979: <div class="titlepage"><div><div><h2 class="title">
1.184     rillig   5980: <a name="tools"></a>Chapter 17. Tools needed for building or running</h2></div></div></div>
1.1       dsieger  5981: <div class="toc">
                   5982: <p><b>Table of Contents</b></p>
1.100     leot     5983: <dl class="toc">
1.184     rillig   5984: <dt><span class="sect1"><a href="#pkgsrc-tools">17.1. Tools for pkgsrc builds</a></span></dt>
                   5985: <dt><span class="sect1"><a href="#package-tools">17.2. Tools needed by packages</a></span></dt>
                   5986: <dt><span class="sect1"><a href="#platform-tools">17.3. Tools provided by platforms</a></span></dt>
1.1       dsieger  5987: </dl>
                   5988: </div>
1.184     rillig   5989: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
                   5990: by pkgsrc and also for individual packages to define what commands
                   5991: are needed for building a package (like <code class="varname">TOOL_DEPENDS</code>)
                   5992: or for later run-time of an installed packaged (such as
                   5993: <code class="varname">DEPENDS</code>).
                   5994: If the native system provides an adequate tool, then in many cases, a pkgsrc
                   5995: package will not be used.</p>
                   5996: <p>When building a package, the replacement tools are
                   5997: made available in a directory (as symlinks or wrapper scripts)
                   5998: that is early in the executable search path. Just like the buildlink
                   5999: system, this helps with consistent builds.</p>
                   6000: <p>A tool may be needed to help build a specific package. For example,
                   6001: perl, GNU make (gmake) or yacc may be needed.</p>
                   6002: <p>Also a tool may be needed, for example, because the native system's supplied
                   6003: tool may be inefficient for building a package with pkgsrc.
                   6004: For example, a package may need GNU awk, bison (instead of
                   6005: yacc) or a better sed.</p>
                   6006: <p>The tools used by a package can be listed by running
                   6007: <span class="command"><strong>make show-tools</strong></span>.</p>
1.41      asau     6008: <div class="sect1">
1.1       dsieger  6009: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   6010: <a name="pkgsrc-tools"></a>17.1. Tools for pkgsrc builds</h2></div></div></div>
                   6011: <p>The default set of tools used by pkgsrc is defined in
                   6012: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
                   6013: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
                   6014: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
                   6015: These can be seen by running:
                   6016: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
                   6017: <p>If a package needs a specific program to build
                   6018: then the <code class="varname">USE_TOOLS</code> variable can be used
                   6019: to define the tools needed.</p>
1.1       dsieger  6020: </div>
1.184     rillig   6021: <div class="sect1">
                   6022: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   6023: <a name="package-tools"></a>17.2. Tools needed by packages</h2></div></div></div>
                   6024: <p>In the following examples, the :run means that it is needed at
                   6025: run-time (and becomes a DEPENDS).
                   6026: The default is a build dependency which can be set with
                   6027: :build. (So in this example, it is the same as gmake:build
                   6028: and pkg-config:build.)</p>
1.1       dsieger  6029: <pre class="programlisting">
1.184     rillig   6030: USE_TOOLS+=     gmake perl:run pkg-config
1.1       dsieger  6031: </pre>
1.184     rillig   6032: <p>When using the tools framework, a
                   6033: <code class="varname">TOOLS_PATH.foo</code> variable is defined
                   6034: which contains the full path to the appropriate tool. For example,
                   6035: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">&#8220;<span class="quote">/bin/bash</span>&#8221;</span>
                   6036: on Linux systems.</p>
                   6037: <p>If you always need a pkgsrc version of the
                   6038: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
                   6039: </p>
1.1       dsieger  6040: </div>
1.184     rillig   6041: <div class="sect1">
                   6042: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   6043: <a name="platform-tools"></a>17.3. Tools provided by platforms</h2></div></div></div>
                   6044: <p>When improving or porting pkgsrc to a new platform, have a look
                   6045: at (or create) the corresponding platform specific make file fragment under
                   6046: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
                   6047: the name of the common tools. For example:</p>
1.1       dsieger  6048: <pre class="programlisting">
1.184     rillig   6049: .if exists(/usr/bin/bzcat)
                   6050: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzcat
                   6051: .elif exists(/usr/bin/bzip2)
                   6052: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzip2 -cd
                   6053: .endif
                   6054: 
                   6055: TOOLS_PLATFORM.true?=           true                    # shell builtin
1.1       dsieger  6056: </pre>
                   6057: </div>
                   6058: </div>
1.184     rillig   6059: <div class="chapter">
                   6060: <div class="titlepage"><div><div><h2 class="title">
                   6061: <a name="buildlink"></a>Chapter 18. Buildlink methodology</h2></div></div></div>
                   6062: <div class="toc">
                   6063: <p><b>Table of Contents</b></p>
                   6064: <dl class="toc">
                   6065: <dt><span class="sect1"><a href="#converting-to-buildlink3">18.1. Converting packages to use buildlink3</a></span></dt>
                   6066: <dt><span class="sect1"><a href="#creating-buildlink3.mk">18.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
                   6067: <dd><dl>
                   6068: <dt><span class="sect2"><a href="#anatomy-of-bl3">18.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
                   6069: <dt><span class="sect2"><a href="#updating-buildlink-depends">18.2.2. Updating
                   6070:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6071:       and
                   6072:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6073:       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
                   6074: </dl></dd>
                   6075: <dt><span class="sect1"><a href="#writing-builtin.mk">18.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
                   6076: <dd><dl>
                   6077: <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>
                   6078: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">18.3.2. Global preferences for native or pkgsrc software</a></span></dt>
                   6079: </dl></dd>
                   6080: </dl>
1.1       dsieger  6081: </div>
1.184     rillig   6082: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
                   6083:   are seen by a package's configure and build processes.  This is implemented
                   6084:   in a two step process:</p>
                   6085: <div class="orderedlist"><ol class="orderedlist" type="1">
                   6086: <li class="listitem"><p>Symlink headers and libraries for dependencies into
                   6087:       <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
                   6088:       of <code class="varname">WRKDIR</code>.</p></li>
                   6089: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
                   6090:       tools that translate <code class="option">-I${LOCALBASE}/include</code> and
                   6091:       <code class="option">-L${LOCALBASE}/lib</code> into references to
                   6092:       <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
                   6093:       native compiler on some operating systems look like GCC, so that
                   6094:       packages that expect GCC won't require modifications to build with
                   6095:       those native compilers.</p></li>
                   6096: </ol></div>
                   6097: <p>This normalizes the environment in which a package is built so that the
                   6098:   package may be built consistently despite what other software may be
                   6099:   installed. Please note that the normal system header and library paths,
                   6100:   e.g. <code class="filename">/usr/include</code>,
                   6101:   <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
                   6102:   designed to insulate the package build from non-system-supplied
                   6103:   software.</p>
1.41      asau     6104: <div class="sect1">
1.1       dsieger  6105: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   6106: <a name="converting-to-buildlink3"></a>18.1. Converting packages to use buildlink3</h2></div></div></div>
                   6107: <p>The process of converting packages to use the buildlink3
                   6108:     framework (<span class="quote">&#8220;<span class="quote">bl3ifying</span>&#8221;</span>) is fairly straightforward.
                   6109:     The things to keep in mind are:</p>
1.23      wiz      6110: <div class="orderedlist"><ol class="orderedlist" type="1">
1.184     rillig   6111: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
                   6112:        instead of the actual toolchain.  Some packages are tricky,
                   6113:        and the only way to know for sure is the check
                   6114:        <code class="filename">${WRKDIR}/.work.log</code> to see if the
                   6115:        wrappers are being invoked.</p></li>
                   6116: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
                   6117:        the package Makefile, e.g. Java VMs, standalone shells,
                   6118:        etc., because the code to symlink files into
                   6119:        <code class="filename">${BUILDLINK_DIR}</code> looks for files
                   6120:        relative to <span class="quote">&#8220;<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>&#8221;</span>.
                   6121:        </p></li>
                   6122: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
                   6123:        <code class="filename">buildlink3.mk</code> files that you list in a
                   6124:        package's Makefile are added as dependencies for that package.
                   6125:        </p></li>
                   6126: </ol></div>
                   6127: <p>If a dependency on a particular package is required for its libraries and
                   6128:     headers, then we replace:</p>
                   6129: <pre class="programlisting">
                   6130: DEPENDS+=       foo&gt;=1.1.0:../../category/foo
                   6131: </pre>
                   6132: <p>with</p>
                   6133: <pre class="programlisting">
                   6134: .include "../../category/foo/buildlink3.mk"
                   6135: </pre>
                   6136: <p>The buildlink3.mk files usually define the required dependencies.
                   6137:     If you need a newer version of the dependency when using buildlink3.mk
                   6138:     files, then you can define it in your Makefile; for example:</p>
1.1       dsieger  6139: <pre class="programlisting">
1.184     rillig   6140: BUILDLINK_API_DEPENDS.foo+=   foo&gt;=1.1.0
                   6141: .include "../../category/foo/buildlink3.mk"
1.1       dsieger  6142: </pre>
1.184     rillig   6143: <p>There are several <code class="filename">buildlink3.mk</code>
                   6144:     files in <code class="filename">pkgsrc/mk</code>
                   6145:     that handle special package issues:</p>
                   6146: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6147: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
                   6148:        the native or a pkgsrc Berkeley DB implementation based on
                   6149:        the values of <code class="varname">BDB_ACCEPTED</code> and
                   6150:        <code class="varname">BDB_DEFAULT</code>.</p></li>
                   6151: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
                   6152:        comes with neither Curses nor NCurses, this will take care
                   6153:        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>
                   6154: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
                   6155:        of <code class="varname">KRB5_ACCEPTED</code> to choose between
                   6156:        adding a dependency on Heimdal or MIT-krb5 for packages that
                   6157:        require a Kerberos 5 implementation.</p></li>
                   6158: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
                   6159:        system-provided Motif installation or adds a dependency on
                   6160:        <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
                   6161:        <code class="varname">MOTIF_TYPE</code> to <span class="quote">&#8220;<span class="quote">dt</span>&#8221;</span>,
                   6162:        <span class="quote">&#8220;<span class="quote">lesstif</span>&#8221;</span> or <span class="quote">&#8220;<span class="quote">motif</span>&#8221;</span>
                   6163:        to choose which Motif version will be used.</p></li>
                   6164: <li class="listitem"><p><code class="filename">readline.buildlink3.mk</code> checks for a
                   6165:        system-provided GNU readline or editline (libedit) installation,
                   6166:        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>,
                   6167:        <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
                   6168:        <code class="varname">READLINE_DEFAULT</code> to choose readline implementation.
                   6169:        If your package really needs GNU readline library, its Makefile
                   6170:        should include <code class="filename">devel/readline/buildlink3.mk</code>
                   6171:        instead of <code class="filename">readline.buildlink3.mk</code>.</p></li>
                   6172: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
                   6173:        variables that may be used by packages that use the
                   6174:        Open Sound System (OSS) API.</p></li>
                   6175: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
                   6176:        any of the Postgres versions in the variable
                   6177:        <code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
                   6178:        the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
                   6179:        the file for more information.</p></li>
                   6180: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
                   6181:        <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
                   6182:        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>
                   6183: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
                   6184:        <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
                   6185:        library.</p></li>
                   6186: </ul></div>
                   6187: <p>The comments in those <code class="filename">buildlink3.mk</code>
                   6188:     files provide a more complete
                   6189:     description of how to use them properly.</p>
1.1       dsieger  6190: </div>
1.41      asau     6191: <div class="sect1">
1.1       dsieger  6192: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   6193: <a name="creating-buildlink3.mk"></a>18.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
                   6194: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
                   6195:     included by Makefiles to indicate the need to compile and link
                   6196:     against header files and libraries provided by the package.  A
                   6197:     <code class="filename">buildlink3.mk</code> file should always provide
                   6198:     enough information to add the correct type of dependency
                   6199:     relationship and include any other
                   6200:     <code class="filename">buildlink3.mk</code> files that it needs to find
                   6201:     headers and libraries that it needs in turn.</p>
                   6202: <p>To generate an initial <code class="filename">buildlink3.mk</code>
                   6203:     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>
                   6204:     package is highly recommended.  For most packages, the following
                   6205:     command will generate a good starting point for
                   6206:     <code class="filename">buildlink3.mk</code> files:</p>
                   6207: <pre class="screen">
                   6208: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
                   6209: <code class="prompt">%</code> createbuildlink &gt;buildlink3.mk</code></strong>
                   6210:     </pre>
1.41      asau     6211: <div class="sect2">
1.1       dsieger  6212: <div class="titlepage"><div><div><h3 class="title">
1.184     rillig   6213: <a name="anatomy-of-bl3"></a>18.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
                   6214: <p>The following real-life example
                   6215:       <code class="filename">buildlink3.mk</code> is taken
                   6216:       from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
1.1       dsieger  6217: <pre class="programlisting">
1.184     rillig   6218: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
                   6219: 
                   6220: BUILDLINK_TREE+=        tiff
                   6221: 
                   6222: .if !defined(TIFF_BUILDLINK3_MK)
                   6223: TIFF_BUILDLINK3_MK:=
                   6224: 
                   6225: BUILDLINK_API_DEPENDS.tiff+=    tiff&gt;=3.6.1
                   6226: BUILDLINK_ABI_DEPENDS.tiff+=    tiff&gt;=3.7.2nb1
                   6227: BUILDLINK_PKGSRCDIR.tiff?=      ../../graphics/tiff
                   6228: 
                   6229: .include "../../devel/zlib/buildlink3.mk"
                   6230: .include "../../graphics/jpeg/buildlink3.mk"
                   6231: .endif # TIFF_BUILDLINK3_MK
                   6232: 
                   6233: BUILDLINK_TREE+=        -tiff
1.1       dsieger  6234: </pre>
1.184     rillig   6235: <p>The header and footer manipulate
                   6236:       <code class="varname">BUILDLINK_TREE</code>, which is common across all
                   6237:       <code class="filename">buildlink3.mk</code> files and is used to track
                   6238:       the dependency tree.</p>
                   6239: <p>The main section is protected from multiple inclusion
                   6240:       and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
                   6241:       added.  Several important variables are set in the section:</p>
                   6242: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6243: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.185     wiz      6244:          is the dependency version recorded in the installed
1.184     rillig   6245:          package; this should always be set using
                   6246:          <span class="command"><strong>+=</strong></span> to ensure that
                   6247:          we're appending to any pre-existing list of values.  This
1.185     wiz      6248:          variable should be set to the last version of the
1.184     rillig   6249:          package that had an backwards-incompatible API change.
                   6250:          </p></li>
                   6251: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
                   6252:          is the location of the <em class="replaceable"><code>pkg</code></em>
                   6253:          pkgsrc directory.</p></li>
                   6254: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
                   6255:          (not shown above) controls whether we use
                   6256:          <code class="varname">BUILD_DEPENDS</code> or
                   6257:          <code class="varname">DEPENDS</code> to add the dependency on
                   6258:          <em class="replaceable"><code>pkg</code></em>.  The build dependency is
                   6259:          selected by setting
                   6260:          <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
                   6261:          to <span class="quote">&#8220;<span class="quote">build</span>&#8221;</span>.  By default, the full dependency is
                   6262:          used.</p></li>
                   6263: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
                   6264:            and
                   6265:            <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
                   6266:            (not shown above) are lists of subdirectories of
                   6267:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
                   6268:            to add to the header and library search paths.  These
                   6269:            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>
                   6270:          respectively.</p></li>
                   6271: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
                   6272:            (not shown above) is the list of preprocessor flags to add
                   6273:            to <code class="varname">CPPFLAGS</code>, which are passed on to the
                   6274:            configure and build phases.  The <span class="quote">&#8220;<span class="quote">-I</span>&#8221;</span> option
                   6275:            should be avoided and instead be handled using
                   6276:            <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
                   6277:          above.</p></li>
                   6278: </ul></div>
                   6279: <p>The following variables are all optionally defined within
                   6280:       this second section (protected against multiple inclusion) and
                   6281:       control which package files are symlinked into
                   6282:       <code class="filename">${BUILDLINK_DIR}</code> and how their names are
                   6283:       transformed during the symlinking:</p>
                   6284: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6285: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
                   6286:            (not shown above) is a shell glob pattern relative to
                   6287:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
                   6288:            to be symlinked into
                   6289:            <code class="filename">${BUILDLINK_DIR}</code>,
                   6290:          e.g. <code class="filename">include/*.h</code>.</p></li>
                   6291: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
                   6292:            (not shown above) is a shell pipeline that
                   6293:            outputs to stdout a list of files relative to
                   6294:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
                   6295:            The resulting files are to be symlinked
                   6296:            into <code class="filename">${BUILDLINK_DIR}</code>.  By default,
                   6297:            this takes the <code class="filename">+CONTENTS</code> of a
                   6298:            <em class="replaceable"><code>pkg</code></em> and filters it through
                   6299:            <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
                   6300: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
                   6301:            (not shown above) is a filter command that filters
                   6302:            <code class="filename">+CONTENTS</code> input into a list of files
                   6303:            relative to
                   6304:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
                   6305:            on stdout.  By default,
                   6306:            <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
                   6307:            outputs the contents of the <code class="filename">include</code>
                   6308:            and <code class="filename">lib</code> directories in the package
                   6309:            <code class="filename">+CONTENTS</code>.</p></li>
                   6310: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
                   6311:            (not shown above) is a list of sed arguments used to
                   6312:            transform the name of the source filename into a
                   6313:            destination filename, e.g. <span class="command"><strong>-e
                   6314:            "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
                   6315: </ul></div>
                   6316: <p>This section can additionally include any
                   6317:       <code class="filename">buildlink3.mk</code> needed for
                   6318:       <em class="replaceable"><code>pkg</code></em>'s library dependencies.
                   6319:       Including these <code class="filename">buildlink3.mk</code> files
                   6320:       means that the headers and libraries for these
                   6321:       dependencies are also symlinked into
                   6322:       <code class="filename">${BUILDLINK_DIR}</code>
                   6323:       whenever the <em class="replaceable"><code>pkg</code></em>
                   6324:       <code class="filename">buildlink3.mk</code>
                   6325:       file is included. Dependencies are only added for directly
                   6326:       include <code class="filename">buildlink3.mk</code> files.</p>
                   6327: <p>When providing a <code class="filename">buildlink3.mk</code> and
                   6328:       including other <code class="filename">buildlink3.mk</code> files in it,
                   6329:       please only add necessary ones, i.e., those whose libraries or
                   6330:       header files are automatically exposed when the package is
                   6331:       use.</p>
                   6332: <p>In particular, if only an executable
                   6333:       (<code class="filename">bin/foo</code>) is linked against a library, that
                   6334:       library does not need to be propagated in the
                   6335:       <code class="filename">buildlink3.mk</code> file.</p>
                   6336: <p>The following steps should help you decide if a
                   6337:       <code class="filename">buildlink3.mk</code> file needs to be included:
                   6338:       </p>
                   6339: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6340: <li class="listitem"><p>Look at the installed header files: What
                   6341:        headers do they include? The packages providing these files
                   6342:        must be buildlinked.</p></li>
                   6343: <li class="listitem"><p>Run <code class="filename">ldd</code> on all installed
                   6344:        libraries and look against what other libraries they link.
                   6345:        Some of the packages providing these probably need to be
                   6346:        buildlinked; however, it's not automatic, since e.g. GTK on
                   6347:        some systems pulls in the X libraries, so they will show up in
                   6348:        the <code class="filename">ldd</code> output, while on others (like OS
                   6349:        X) it won't. <code class="filename">ldd</code> output can thus only be
                   6350:        used as a hint.</p></li>
                   6351: </ul></div>
                   6352: <p>
                   6353:       </p>
                   6354: </div>
1.41      asau     6355: <div class="sect2">
1.1       dsieger  6356: <div class="titlepage"><div><div><h3 class="title">
1.184     rillig   6357: <a name="updating-buildlink-depends"></a>18.2.2. Updating
                   6358:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6359:       and
                   6360:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6361:       in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
1.185     wiz      6362: <p>Both variables set lower bounds for a version of this package.
                   6363:       The two variables differ in that one describes source
1.184     rillig   6364:       compatibility (API) and the other binary compatibility (ABI).
                   6365:       The difference is that a change in the API breaks compilation of
                   6366:       programs while changes in the ABI stop compiled programs from
                   6367:       running.</p>
1.185     wiz      6368: <p>The
                   6369:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6370:       variable in a <code class="filename">buildlink3.mk</code> should be
                   6371:       changed very rarely.  (One possible scenario: If all packages
                   6372:       using this package need a higher version than defined in the
                   6373:       <code class="filename">buildlink3.mk</code>,
1.184     rillig   6374:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.185     wiz      6375:       could be updated to that higher version.)</p>
                   6376: <p>On the other hand, changes to
1.184     rillig   6377:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.185     wiz      6378:       are more common.  The variable will need to be updated every
                   6379:       time the major version of one of its shared libraries is changed,
                   6380:       or any other change where a binary built against the previous
                   6381:       version of the package will not run against the new version any
                   6382:       longer.</p>
                   6383: <p>In such a case, the package's
1.184     rillig   6384:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.185     wiz      6385:       must be increased to require the new package version.  Then the
                   6386:       <code class="varname">PKGREVISION</code> of all packages
                   6387:       <em class="replaceable"><code>foo</code></em> that depend on this package need
                   6388:       to be increased, and if they have
                   6389:       <code class="filename">buildlink3.mk</code> files,
                   6390:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>foo</code></em></code>
                   6391:       in their <code class="filename">buildlink3.mk</code> files must be
                   6392:       increased to the new version as well. This is required so that a
                   6393:       package will pull in the versions of the packages that use the
                   6394:       new ABI and that the packages' <code class="varname">PKGREVISION</code>s
                   6395:       uniquely identify the packages built against the new ABI. The
                   6396:       <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
                   6397:       help with these updates.</p>
                   6398: <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
                   6399:       about dependencies on other packages, including the
                   6400:       <code class="varname">BUILDLINK_API_DEPENDS</code> definitions.</p>
1.184     rillig   6401: <p>Please take careful consideration before adjusting
                   6402:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6403:       or
                   6404:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.185     wiz      6405:       in a <code class="filename">buildlink3.mk</code> file as we don't want to
                   6406:       cause unneeded package deletions and rebuilds.  In many cases,
                   6407:       new versions of packages work just fine with older
                   6408:       dependencies.</p>
1.184     rillig   6409: <p>Also it is not needed to set
                   6410:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   6411:       when it is identical to
                   6412:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.        </p>
1.1       dsieger  6413: </div>
                   6414: </div>
1.41      asau     6415: <div class="sect1">
1.1       dsieger  6416: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   6417: <a name="writing-builtin.mk"></a>18.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
                   6418: <p>Some packages in pkgsrc install headers and libraries that
                   6419:       coincide with headers and libraries present in the base system.
                   6420:       Aside from a <code class="filename">buildlink3.mk</code> file, these
                   6421:       packages should also include a <code class="filename">builtin.mk</code>
                   6422:       file that includes the necessary checks to decide whether using
                   6423:       the built-in software or the pkgsrc software is
                   6424:     appropriate.</p>
                   6425: <p>The only requirements of a builtin.mk file for
                   6426:     <em class="replaceable"><code>pkg</code></em> are:</p>
                   6427: <div class="orderedlist"><ol class="orderedlist" type="1">
                   6428: <li class="listitem"><p>It should set
                   6429:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6430:        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>
                   6431:        after it is included.</p></li>
                   6432: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
                   6433:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6434:        which is already set before the
                   6435:        <code class="filename">builtin.mk</code> file is included.</p></li>
                   6436: <li class="listitem"><p>It should be written to allow multiple inclusion.  This
                   6437:        is <span class="emphasis"><em>very</em></span> important and takes careful
                   6438:        attention to <code class="filename">Makefile</code> coding.</p></li>
                   6439: </ol></div>
                   6440: <div class="sect2">
                   6441: <div class="titlepage"><div><div><h3 class="title">
                   6442: <a name="anatomy-of-builtin.mk"></a>18.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</h3></div></div></div>
                   6443: <p>The following is the recommended template for builtin.mk
                   6444:       files:</p>
1.1       dsieger  6445: <pre class="programlisting">
1.184     rillig   6446: .if !defined(IS_BUILTIN.foo)
                   6447: #
                   6448: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
                   6449: # genuinely exists in the system or not.
                   6450: #
                   6451: IS_BUILTIN.foo?=        no
1.1       dsieger  6452: 
1.184     rillig   6453: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
                   6454: # version can be determined.
                   6455: #
                   6456: .  if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
                   6457: BUILTIN_PKG.foo?=       foo-1.0
                   6458: .  endif
                   6459: .endif  # IS_BUILTIN.foo
1.1       dsieger  6460: 
1.184     rillig   6461: .if !defined(USE_BUILTIN.foo)
                   6462: USE_BUILTIN.foo?=       ${IS_BUILTIN.foo}
                   6463: .  if defined(BUILTIN_PKG.foo)
                   6464: .    for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
                   6465: .      if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
                   6466: USE_BUILTIN.foo!=                                                       \
                   6467:         ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo}            \
                   6468:         &amp;&amp; ${ECHO} "yes" || ${ECHO} "no"
                   6469: .      endif
                   6470: .    endfor
                   6471: .  endif
                   6472: .endif  # USE_BUILTIN.foo
1.1       dsieger  6473: 
1.184     rillig   6474: CHECK_BUILTIN.foo?=     no
                   6475: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
                   6476: #
                   6477: # Here we place code that depends on whether USE_BUILTIN.foo is set to
                   6478: # "yes" or "no".
                   6479: #
                   6480: .endif  # CHECK_BUILTIN.foo
1.1       dsieger  6481: </pre>
1.184     rillig   6482: <p>The first section sets
                   6483:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6484:       depending on if <em class="replaceable"><code>pkg</code></em> really exists
                   6485:       in the base system.  This should not be a base system software
                   6486:       with similar functionality to <em class="replaceable"><code>pkg</code></em>;
                   6487:       it should only be <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> if the actual package is
                   6488:       included as part of the base system.  This variable is only
                   6489:       used internally within the <code class="filename">builtin.mk</code>
                   6490:       file.</p>
                   6491: <p>The second section sets
                   6492:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   6493:       to the version of <em class="replaceable"><code>pkg</code></em> in the base
                   6494:       system if it exists (if
                   6495:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6496:       is <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>).  This variable is only used internally
                   6497:       within the <code class="filename">builtin.mk</code> file.</p>
                   6498: <p>The third section sets
                   6499:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6500:       and is <span class="emphasis"><em>required</em></span> in all
                   6501:       <code class="filename">builtin.mk</code> files.  The code in this
                   6502:       section must make the determination whether the built-in
                   6503:       software is adequate to satisfy the dependencies listed in
                   6504:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   6505:       This is typically done by comparing
                   6506:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   6507:       against each of the dependencies in
                   6508:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   6509:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6510:       <span class="emphasis"><em>must</em></span> be set to the correct value by the
                   6511:       end of the <code class="filename">builtin.mk</code> file.  Note that
                   6512:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6513:       may be <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> even if
                   6514:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6515:       is <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span> because we may make the determination
                   6516:       that the built-in version of the software is similar enough to
                   6517:       be used as a replacement.</p>
                   6518: <p>The last section is guarded by
                   6519:       <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
                   6520:       and includes code that uses the value of
                   6521:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   6522:       set in the previous section.  This typically includes, e.g.,
                   6523:       adding additional dependency restrictions and listing additional
                   6524:       files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
                   6525:       <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
                   6526: </div>
                   6527: <div class="sect2">
                   6528: <div class="titlepage"><div><div><h3 class="title">
                   6529: <a name="native-or-pkgsrc-preference"></a>18.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
                   6530: <p>When building packages, it's possible to choose whether to set
                   6531:        a global preference for using either the built-in (native)
                   6532:        version or the pkgsrc version of software to satisfy a
                   6533:        dependency.  This is controlled by setting
                   6534:        <code class="varname">PREFER_PKGSRC</code> and
                   6535:        <code class="varname">PREFER_NATIVE</code>.  These variables take values
                   6536:        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
                   6537:        packages.  <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
                   6538:        use the pkgsrc versions of software, while
                   6539:        <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
                   6540:        built-in versions.  Preferences are determined by the most
                   6541:        specific instance of the package in either
                   6542:        <code class="varname">PREFER_PKGSRC</code> or
                   6543:        <code class="varname">PREFER_NATIVE</code>.  If a package is specified
                   6544:        in neither or in both variables, then
                   6545:        <code class="varname">PREFER_PKGSRC</code> has precedence over
                   6546:        <code class="varname">PREFER_NATIVE</code>.  For example, to require
                   6547:        using pkgsrc versions of software for all but the most basic
                   6548:       bits on a NetBSD system, you can set:</p>
1.1       dsieger  6549: <pre class="programlisting">
1.184     rillig   6550: PREFER_PKGSRC=  yes
                   6551: PREFER_NATIVE=  getopt skey tcp_wrappers
                   6552: </pre>
                   6553: <p>A package <span class="emphasis"><em>must</em></span> have a
                   6554:       <code class="filename">builtin.mk</code>
                   6555:       file to be listed in <code class="varname">PREFER_NATIVE</code>,
                   6556:       otherwise it is simply ignored in that list.</p>
1.191     bacon    6557: <p><code class="varname">PREFER_PKGSRC</code> and
                   6558:       <code class="varname">PREFER_NATIVE</code> should be set during bootstrap
                   6559:       to ensure that the bootstrap process does not use inapropriate
                   6560:       native tools as dependencies for core packages.
                   6561: 
                   6562: </p>
                   6563: <pre class="screen">
                   6564: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap --prefer-pkgsrc yes --prefer-native openssl</code></strong>
                   6565: </pre>
                   6566: <p>
                   6567: 
1.184     rillig   6568:       Switching between settings globally at a later date can introduce
                   6569:       complications with dependency resolution. This is caused by packages
1.191     bacon    6570:       built with the opposite preference being installed alongside each
                   6571:       other.  Hence, any changes to these variables after bootstrap will
                   6572:       necessitate rebuilding all packages depending on one whose preference
                   6573:       has been changed.  This is not trivial and should be avoided.</p>
                   6574: <p>When using pkgsrc on Linux systems, there is high risk of
                   6575:       "leakage", where programs installed by pkgsrc may inadvertently use a
                   6576:       command or library not installed by pkgsrc, e.g. those installed by
                   6577:       yum or apt.  Such foreign dependencies may be installed, removed, or
                   6578:       upgraded to a version incompatible with the pkgsrc package at any
                   6579:       time, causing pkgsrc packages to subsequently malfunction.  Pkgsrc
                   6580:       cannot prevent this, as it has no control over other package managers.
                   6581:       Another potential problem is that under Redhat Enterprise and related
                   6582:       Linux systems, yum packages are only patched and never upgraded, so
                   6583:       eventually they may become too outdated for use by pkgsrc.  Even
                   6584:       intentionally using foreign dependencies, not considered leakage, can
                   6585:       lead to these problems, so it is generally discouraged.  In order to
                   6586:       minimize such problems, PREFER_PKGSRC defaults to "yes" on Linux systems.
                   6587:       This ensures that pkgsrc is aware of any changes to dependency packages
                   6588:       and can rebuild or upgrade the entire dependency tree as needed.  This
                   6589:       default can be overridden by setting --prefer-pkgsrc to "no" or a list of
                   6590:       packages, or by setting --prefer-native to "yes".</p>
1.1       dsieger  6591: </div>
1.7       rillig   6592: </div>
1.1       dsieger  6593: </div>
1.41      asau     6594: <div class="chapter">
1.1       dsieger  6595: <div class="titlepage"><div><div><h2 class="title">
1.184     rillig   6596: <a name="plist"></a>Chapter 19. PLIST issues</h2></div></div></div>
1.1       dsieger  6597: <div class="toc">
                   6598: <p><b>Table of Contents</b></p>
1.100     leot     6599: <dl class="toc">
1.184     rillig   6600: <dt><span class="sect1"><a href="#rcs-id">19.1. RCS ID</a></span></dt>
                   6601: <dt><span class="sect1"><a href="#automatic-plist-generation">19.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                   6602: <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>
                   6603: <dt><span class="sect1"><a href="#plist.misc">19.4. Variable substitution in PLIST</a></span></dt>
                   6604: <dt><span class="sect1"><a href="#manpage-compression">19.5. Man page compression</a></span></dt>
                   6605: <dt><span class="sect1"><a href="#using-PLIST_SRC">19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
                   6606: <dt><span class="sect1"><a href="#platform-specific-plist">19.7. Platform-specific and differing PLISTs</a></span></dt>
                   6607: <dt><span class="sect1"><a href="#build-plist">19.8. Build-specific PLISTs</a></span></dt>
                   6608: <dt><span class="sect1"><a href="#faq.common-dirs">19.9. Sharing directories between packages</a></span></dt>
1.1       dsieger  6609: </dl>
                   6610: </div>
1.184     rillig   6611: <p>The <code class="filename">PLIST</code> file contains a package's
                   6612:   <span class="quote">&#8220;<span class="quote">packing list</span>&#8221;</span>, i.e. a list of files that belong to
                   6613:   the package (relative to the <code class="filename">${PREFIX}</code>
                   6614:   directory it's been installed in) plus some additional statements
1.197     leot     6615:   - 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.184     rillig   6616:   This chapter addresses some issues that need attention when
                   6617:   dealing with the <code class="filename">PLIST</code> file (or files, see
                   6618:   below!).</p>
1.41      asau     6619: <div class="sect1">
1.1       dsieger  6620: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   6621: <a name="rcs-id"></a>19.1. RCS ID</h2></div></div></div>
                   6622: <p>Be sure to add a RCS ID line as the first thing in any
                   6623:     <code class="filename">PLIST</code> file you write:</p>
                   6624: <pre class="programlisting">
                   6625: @comment $NetBSD $
                   6626: </pre>
                   6627: <p>An artificial space has been added between NetBSD and $, this is a
                   6628: workaround here to prevent CVS expanding to the filename of the guide. When
                   6629: adding the RCS ID the space should be omitted.</p>
1.1       dsieger  6630: </div>
1.41      asau     6631: <div class="sect1">
1.1       dsieger  6632: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   6633: <a name="automatic-plist-generation"></a>19.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
                   6634: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
                   6635:     to output a PLIST that matches any new files since the package
                   6636:     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
                   6637:     more information on this target.</p>
1.1       dsieger  6638: </div>
1.41      asau     6639: <div class="sect1">
1.1       dsieger  6640: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   6641: <a name="print-PLIST"></a>19.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
                   6642: </h2></div></div></div>
                   6643: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
                   6644:     of AWK patterns and actions that are used to filter the output of
                   6645:     print-PLIST.  You can <span class="emphasis"><em>append</em></span> any chunk of AWK
                   6646:     scripting you like to it, but be careful with quoting.</p>
                   6647: <p>For example, to get all files inside the
                   6648:     <code class="filename">libdata/foo</code> directory removed from the
                   6649:     resulting PLIST:</p>
1.1       dsieger  6650: <pre class="programlisting">
1.184     rillig   6651: PRINT_PLIST_AWK+=       /^libdata\/foo/ { next; }
1.1       dsieger  6652: </pre>
1.185     wiz      6653: <p>The <code class="varname">PRINT_PLIST_AWK</code> transformations are
                   6654:     evaluated after the file list and directory list are sorted.
                   6655:     <code class="varname">EARLY_PRINT_PLIST_AWK</code> is like
                   6656:     <code class="varname">PRINT_PLIST_AWK</code> except it operates before the file
                   6657:     list and directory list are sorted.</p>
1.184     rillig   6658: </div>
                   6659: <div class="sect1">
                   6660: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   6661: <a name="plist.misc"></a>19.4. Variable substitution in PLIST</h2></div></div></div>
                   6662: <p>A number of variables are substituted automatically in
                   6663:     PLISTs when a package is installed on a system. This includes the
                   6664:     following variables:</p>
                   6665: <div class="variablelist"><dl class="variablelist">
                   6666: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
                   6667: <dd>
                   6668: <p>Some packages like emacs and perl embed information
                   6669:          about which architecture they were built on into the
                   6670:          pathnames where they install their files. To handle this
                   6671:          case, PLIST will be preprocessed before actually used, and
                   6672:          the symbol
                   6673:          <span class="quote">&#8220;<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>&#8221;</span> will be
                   6674:          replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
                   6675:          same is done if the string
                   6676:          <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
                   6677:          PLIST somewhere - use this on packages that have GNU
                   6678:          autoconf-created configure scripts.</p>
                   6679: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   6680: <h3 class="title">Legacy note</h3>
                   6681: <p>There used to be a symbol
                   6682:            <span class="quote">&#8220;<span class="quote"><code class="varname">$ARCH</code></span>&#8221;</span> that
                   6683:            was replaced by the output of <span class="command"><strong>uname
                   6684:            -m</strong></span>, but that's no longer supported and has
                   6685:            been removed.</p>
                   6686: </div>
                   6687: </dd>
                   6688: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
                   6689: <dd>
                   6690: <p>Some packages want to embed the OS name and version
                   6691:          into some paths.  To do this, use these variables in the
                   6692:          <code class="filename">PLIST</code>:
                   6693:          </p>
                   6694: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6695: <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>
                   6696: <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>
                   6697: <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>
                   6698: </ul></div>
                   6699: </dd>
                   6700: </dl></div>
                   6701: <p>For a list of values which are replaced by
                   6702:     default, the output of <span class="command"><strong>make help topic=PLIST_SUBST</strong></span> as
                   6703: well as searching the <code class="filename">pkgsrc/mk</code> directory with <span class="command"><strong>grep</strong></span> for
                   6704: <code class="varname">PLIST_SUBST</code> should help.</p>
                   6705: <p>If you want to change other variables not listed above, you
                   6706:     can add variables and their expansions to this variable in the
                   6707:     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.1       dsieger  6708: <pre class="programlisting">
1.184     rillig   6709: PLIST_SUBST+=   SOMEVAR="somevalue"
1.1       dsieger  6710: </pre>
1.184     rillig   6711: <p>This replaces all occurrences of <span class="quote">&#8220;<span class="quote">${SOMEVAR}</span>&#8221;</span>
                   6712:     in the <code class="filename">PLIST</code> with
                   6713:     <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span>.</p>
                   6714: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
                   6715:     the common case of conditionally including some
                   6716:     <code class="filename">PLIST</code> entries. It can be done by adding
                   6717:     <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
                   6718:     setting the corresponding <code class="varname">PLIST.foo</code> variable
                   6719:     to <code class="literal">yes</code> if the entry should be included.
                   6720:     This will substitute <span class="quote">&#8220;<span class="quote"><code class="varname">${PLIST.foo}</code></span>&#8221;</span>
                   6721:     in the <code class="filename">PLIST</code> with either
                   6722:     <span class="quote">&#8220;<span class="quote"><code class="literal">""</code></span>&#8221;</span> or
                   6723:     <span class="quote">&#8220;<span class="quote"><code class="literal">"@comment "</code></span>&#8221;</span>.
                   6724:     For example, in <code class="filename">Makefile</code>:</p>
1.66      asau     6725: <pre class="programlisting">
1.184     rillig   6726: PLIST_VARS+=    foo
                   6727: .if <em class="replaceable"><code>condition</code></em>
                   6728: PLIST.foo=      yes
                   6729: .else
1.66      asau     6730: </pre>
1.184     rillig   6731: <p>And then in <code class="filename">PLIST</code>:</p>
1.1       dsieger  6732: <pre class="programlisting">
1.184     rillig   6733: @comment $NetBSD $
                   6734: bin/bar
                   6735: man/man1/bar.1
                   6736: ${PLIST.foo}bin/foo
                   6737: ${PLIST.foo}man/man1/foo.1
                   6738: ${PLIST.foo}share/bar/foo.data
1.1       dsieger  6739: </pre>
1.184     rillig   6740: <p>An artificial space has been added between NetBSD and $, this is a
                   6741: workaround here to prevent CVS expanding to the filename of the guide. When
1.195     gutterid 6742: adding the RCS ID the space should be omitted.</p>
1.1       dsieger  6743: </div>
1.184     rillig   6744: <div class="sect1">
                   6745: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   6746: <a name="manpage-compression"></a>19.5. Man page compression</h2></div></div></div>
                   6747: <p>Man pages should be installed in compressed form if
                   6748:     <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
                   6749:     and uncompressed otherwise. To handle this in the
                   6750:     <code class="filename">PLIST</code> file, the suffix <span class="quote">&#8220;<span class="quote">.gz</span>&#8221;</span> is
                   6751:     appended/removed automatically for man pages according to
                   6752:     <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
                   6753:     or not, see above for details. This modification of the
                   6754:     <code class="filename">PLIST</code> file is done on a copy of it, not
                   6755:     <code class="filename">PLIST</code> itself.</p>
1.1       dsieger  6756: </div>
1.41      asau     6757: <div class="sect1">
1.1       dsieger  6758: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   6759: <a name="using-PLIST_SRC"></a>19.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
                   6760: </h2></div></div></div>
                   6761: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
                   6762:     in generating the binary package, set the variable
                   6763:     <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.197     leot     6764:     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.184     rillig   6765:     important. The default for <code class="varname">PLIST_SRC</code> is
                   6766:     <code class="filename">${PKGDIR}/PLIST</code>.</p>
1.1       dsieger  6767: </div>
1.41      asau     6768: <div class="sect1">
1.1       dsieger  6769: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   6770: <a name="platform-specific-plist"></a>19.7. Platform-specific and differing PLISTs</h2></div></div></div>
                   6771: <p>Some packages decide to install a different set of files based on
                   6772:     the operating system being used. These differences can be
                   6773:     automatically handled by using the following files:</p>
                   6774: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6775: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
                   6776: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
                   6777: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
                   6778: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
                   6779: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
                   6780: </ul></div>
1.1       dsieger  6781: </div>
1.41      asau     6782: <div class="sect1">
1.1       dsieger  6783: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   6784: <a name="build-plist"></a>19.8. Build-specific PLISTs</h2></div></div></div>
                   6785: <p>Some packages decide to generate hard-to-guess file names
                   6786:     during installation that are hard to wire down.</p>
                   6787: <p>In such cases, you can set the
                   6788:     <code class="varname">GENERATE_PLIST</code> variable to shell code
                   6789:     terminated (with a semicolon) that will output PLIST entries which
                   6790:     will be appended to the PLIST</p>
                   6791: <p>You can find one example in editors/xemacs:</p>
                   6792: <pre class="programlisting">
                   6793: GENERATE_PLIST+=        ${ECHO} bin/${DISTNAME}-`${WRKSRC}/src/xemacs -sd`.dmp ;
                   6794: </pre>
                   6795: <p>which will append something like
                   6796:     <code class="filename">bin/xemacs-21.4.23-54e8ea71.dmp</code> to the
                   6797:     <code class="filename">PLIST</code>.
                   6798:     </p>
1.1       dsieger  6799: </div>
1.41      asau     6800: <div class="sect1">
1.1       dsieger  6801: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   6802: <a name="faq.common-dirs"></a>19.9. Sharing directories between packages</h2></div></div></div>
                   6803: <p>A <span class="quote">&#8220;<span class="quote">shared directory</span>&#8221;</span> is a directory where
                   6804:     multiple (and unrelated) packages install files.  These
                   6805:     directories were problematic because you had to add special
                   6806:     tricks in the PLIST to conditionally remove them, or have some
                   6807:     centralized package handle them.</p>
                   6808: <p>In pkgsrc, it is now easy: Each package should create
                   6809:     directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
                   6810:     will remove any directories left empty after uninstalling a
                   6811:     package.</p>
                   6812: <p>If a package needs an empty directory to work, create
                   6813:     the directory during installation as usual, and also add an
                   6814:     entry to the PLIST:
                   6815: 
                   6816: </p>
                   6817: <pre class="programlisting">
                   6818: @pkgdir path/to/empty/directory
                   6819: </pre>
                   6820: <p>
                   6821: 
                   6822:     or take a look at <code class="varname">MAKE_DIRS</code> and
                   6823:     <code class="varname">OWN_DIRS</code>.
1.1       dsieger  6824:     </p>
                   6825: </div>
1.184     rillig   6826: </div>
                   6827: <div class="chapter">
                   6828: <div class="titlepage"><div><div><h2 class="title">
                   6829: <a name="pkginstall"></a>Chapter 20. The pkginstall framework</h2></div></div></div>
                   6830: <div class="toc">
                   6831: <p><b>Table of Contents</b></p>
                   6832: <dl class="toc">
                   6833: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">20.1. Files and directories outside the installation prefix</a></span></dt>
                   6834: <dd><dl>
                   6835: <dt><span class="sect2"><a href="#dirs-outside-prefix">20.1.1. Directory manipulation</a></span></dt>
                   6836: <dt><span class="sect2"><a href="#files-outside-prefix">20.1.2. File manipulation</a></span></dt>
                   6837: </dl></dd>
                   6838: <dt><span class="sect1"><a href="#conf-files">20.2. Configuration files</a></span></dt>
                   6839: <dd><dl>
                   6840: <dt><span class="sect2"><a href="#conf-files-sysconfdir">20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
                   6841: <dt><span class="sect2"><a href="#conf-files-configure">20.2.2. Telling the software where configuration files are</a></span></dt>
                   6842: <dt><span class="sect2"><a href="#conf-files-patching">20.2.3. Patching installations</a></span></dt>
                   6843: <dt><span class="sect2"><a href="#conf-files-disable">20.2.4. Disabling handling of configuration files</a></span></dt>
                   6844: </dl></dd>
                   6845: <dt><span class="sect1"><a href="#rcd-scripts">20.3. System startup scripts</a></span></dt>
                   6846: <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>
                   6847: <dt><span class="sect1"><a href="#users-and-groups">20.4. System users and groups</a></span></dt>
                   6848: <dt><span class="sect1"><a href="#shells">20.5. System shells</a></span></dt>
                   6849: <dd><dl><dt><span class="sect2"><a href="#shells-disable">20.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   6850: <dt><span class="sect1"><a href="#fonts">20.6. Fonts</a></span></dt>
                   6851: <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>
                   6852: </dl>
                   6853: </div>
                   6854: <p>This chapter describes the framework known as
                   6855: <code class="literal">pkginstall</code>, whose key features are:</p>
                   6856: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6857: <li class="listitem"><p>Generic installation and manipulation of directories and files
                   6858:     outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
                   6859: <li class="listitem"><p>Automatic handling of configuration files during installation,
                   6860:     provided that packages are correctly designed.</p></li>
                   6861: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
                   6862: <li class="listitem"><p>Registration of system users and groups.</p></li>
                   6863: <li class="listitem"><p>Registration of system shells.</p></li>
                   6864: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
                   6865: </ul></div>
                   6866: <p>The following sections inspect each of the above points in detail.</p>
                   6867: <p>You may be thinking that many of the things described here could be
                   6868: easily done with simple code in the package's post-installation target
                   6869: (<code class="literal">post-install</code>).  <span class="emphasis"><em>This is incorrect</em></span>,
                   6870: as the code in them is only executed when building from source.  Machines
                   6871: using binary packages could not benefit from it at all (as the code itself
                   6872: could be unavailable).  Therefore, the only way to achieve any of the items
                   6873: described above is by means of the installation scripts, which are
                   6874: automatically generated by pkginstall.</p>
1.41      asau     6875: <div class="sect1">
1.1       dsieger  6876: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   6877: <a name="files-and-dirs-outside-prefix"></a>20.1. Files and directories outside the installation prefix</h2></div></div></div>
                   6878: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
                   6879: of files and directories that belong to a package.  The names used in it
                   6880: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
                   6881: which means that it cannot register files outside this directory (absolute
                   6882: path names are not allowed).  Despite this restriction, some packages need
                   6883: to install files outside this location; e.g., under
                   6884: <code class="filename">${VARBASE}</code> or
                   6885: <code class="filename">${PKG_SYSCONFDIR}</code>.  The only way to achieve this
                   6886: is to create such files during installation time by using
                   6887: installation scripts.</p>
                   6888: <p>The generic installation scripts are shell scripts that can
                   6889: contain arbitrary code.  The list of scripts to execute is taken from
                   6890: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
                   6891: <code class="filename">INSTALL</code>.  A similar variable exists for package
                   6892: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
                   6893: <code class="filename">DEINSTALL</code>).  These scripts can run arbitrary
                   6894: commands, so they have the potential to create and manage files
                   6895: anywhere in the file system.</p>
                   6896: <p>Using these general installation files is not recommended, but
                   6897: may be needed in some special cases.  One reason for avoiding them is
                   6898: that the user has to trust the packager that there is no unwanted or
                   6899: simply erroneous code included in the installation script. Also,
                   6900: previously there were many similar scripts for the same functionality,
                   6901: and fixing a common error involved finding and changing all of
                   6902: them.</p>
                   6903: <p>The pkginstall framework offers another, standardized way.  It
                   6904: provides generic scripts to abstract the manipulation of such files
                   6905: and directories based on variables set in the package's
                   6906: <code class="filename">Makefile</code>.  The rest of this section describes
                   6907: these variables.</p>
                   6908: <div class="sect2">
                   6909: <div class="titlepage"><div><div><h3 class="title">
                   6910: <a name="dirs-outside-prefix"></a>20.1.1. Directory manipulation</h3></div></div></div>
                   6911: <p>The following variables can be set to request the creation of
                   6912: directories anywhere in the file system:</p>
                   6913: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6914: <li class="listitem">
                   6915: <p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
                   6916:     contain a list of directories that should be created and should attempt
                   6917:     to be destroyed by the installation scripts.  The difference between
                   6918:     the two is that the latter prompts the administrator to remove any
                   6919:     directories that may be left after deinstallation (because they were
                   6920:     not empty), while the former does not.  Example:</p>
                   6921: <pre class="programlisting">
                   6922: MAKE_DIRS+=             ${VARBASE}/foo/private
                   6923: </pre>
                   6924: </li>
                   6925: <li class="listitem">
                   6926: <p><code class="varname">MAKE_DIRS_PERMS</code> and
                   6927:     <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
                   6928:     which directories should be created and should attempt to be destroyed
                   6929:     by the installation scripts.  Each tuple holds the following values,
                   6930:     separated by spaces: the directory name, its owner, its group and its
                   6931:     numerical mode.  For example:</p>
                   6932: <pre class="programlisting">
                   6933: MAKE_DIRS_PERMS+=       ${VARBASE}/foo/private \
                   6934:                         ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
                   6935: </pre>
                   6936: <p>The difference between the two is exactly the same as their
                   6937:     non-<code class="varname">PERMS</code> counterparts.</p>
                   6938: </li>
                   6939: </ul></div>
1.1       dsieger  6940: </div>
1.184     rillig   6941: <div class="sect2">
                   6942: <div class="titlepage"><div><div><h3 class="title">
                   6943: <a name="files-outside-prefix"></a>20.1.2. File manipulation</h3></div></div></div>
                   6944: <p>Creating non-empty files outside the installation prefix is tricky
                   6945: because the <code class="filename">PLIST</code> forces all files to be inside it.
                   6946: To overcome this problem, the only solution is to extract the file in the
                   6947: known place (i.e., inside the installation prefix) and copy it to the
                   6948: appropriate location during installation (done by the installation scripts
                   6949: generated by pkginstall).  We will call the former the <span class="emphasis"><em>master
                   6950: file</em></span> in the following paragraphs, which describe the variables
                   6951: that can be used to automatically and consistently handle files outside the
                   6952: installation prefix:</p>
                   6953: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   6954: <li class="listitem">
                   6955: <p><code class="varname">CONF_FILES</code> and
                   6956:     <code class="varname">REQD_FILES</code> are pairs of master and target files.
                   6957:     During installation time, the master file is copied to the target one
                   6958:     if and only if the latter does not exist.  Upon deinstallation, the
                   6959:     target file is removed provided that it was not modified by the
                   6960:     installation.</p>
                   6961: <p>The difference between the two is that the latter prompts the
                   6962:     administrator to remove any files that may be left after
                   6963:     deinstallation (because they were not empty), while the former does
                   6964:     not.</p>
                   6965: </li>
                   6966: <li class="listitem">
                   6967: <p><code class="varname">CONF_FILES_PERMS</code> and
                   6968:     <code class="varname">REQD_FILES_PERMS</code> contain tuples describing master
                   6969:     files as well as their target locations.  For each of them, it also
                   6970:     specifies their owner, their group and their numeric permissions, in
                   6971:     this order.  For example:</p>
1.1       dsieger  6972: <pre class="programlisting">
1.184     rillig   6973: REQD_FILES_PERMS+=      ${PREFIX}/share/somefile ${VARBASE}/somefile \
                   6974:                         ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1       dsieger  6975: </pre>
1.184     rillig   6976: <p>The difference between the two is exactly the same as their
                   6977:     non-<code class="varname">PERMS</code> counterparts.</p>
                   6978: </li>
                   6979: </ul></div>
                   6980: </div>
1.1       dsieger  6981: </div>
1.41      asau     6982: <div class="sect1">
1.1       dsieger  6983: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   6984: <a name="conf-files"></a>20.2. Configuration files</h2></div></div></div>
                   6985: <p>Configuration files are special in the sense that they are installed
                   6986: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
                   6987: need special treatment during installation (most of which is automated by
                   6988: pkginstall).  The main concept you must bear in mind is that files marked
                   6989: as configuration files are automatically copied to the right place (somewhere
                   6990: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
                   6991: and only if</em></span> they didn't exist before.  Similarly, they will not
                   6992: be removed if they have local modifications.  This ensures that
                   6993: administrators never lose any custom changes they may have made.</p>
                   6994: <div class="sect2">
                   6995: <div class="titlepage"><div><div><h3 class="title">
                   6996: <a name="conf-files-sysconfdir"></a>20.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</h3></div></div></div>
                   6997: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
                   6998: specifies where configuration files shall be installed.  Its contents are
                   6999: set based upon the following variables:</p>
                   7000: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   7001: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
                   7002:     directory.  Defaults to <code class="filename">${PREFIX}/etc</code> although it may
                   7003:     be overridden by the user to point to his preferred location (e.g.,
                   7004:     <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
                   7005:     Packages must not use it directly.</p></li>
                   7006: <li class="listitem">
                   7007: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
                   7008:     <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
                   7009:     for the package being built shall be installed.  The definition of this
                   7010:     variable only makes sense in the package's
                   7011:     <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
                   7012: <p>As an example, consider the Apache package,
                   7013:     <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
                   7014:     configuration files under the
                   7015:     <code class="filename">httpd/</code> subdirectory of
                   7016:     <code class="varname">PKG_SYSCONFBASE</code>.  This should be set in the package
                   7017:     Makefile.</p>
                   7018: </li>
                   7019: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
                   7020:     variable that holds this package's configuration directory (if
                   7021:     different from <code class="varname">PKG_SYSCONFBASE</code>).  It defaults to
                   7022:     <code class="varname">PKGBASE</code>'s value, and is always prefixed with
                   7023:     <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
                   7024: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
                   7025:     directory where the configuration files for the package identified by
                   7026:     <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
                   7027: </ul></div>
                   7028: <p>Based on the above variables, pkginstall determines the value of
                   7029: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
                   7030: variable that can be used within a package to refer to its configuration
                   7031: directory.  The algorithm used to set its value is basically the
                   7032: following:</p>
                   7033: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7034: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
                   7035:     its value is used.</p></li>
                   7036: <li class="listitem"><p>If the previous variable is not defined but
                   7037:     <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
                   7038:     <code class="filename">Makefile</code>, the resulting value is
                   7039:     <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
                   7040: <li class="listitem"><p>Otherwise, it is set to
                   7041:     <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
                   7042: </ol></div>
                   7043: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
                   7044: 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
                   7045: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
                   7046: be created with OWN_DIRS or MAKE_DIRS.</p>
                   7047: </div>
                   7048: <div class="sect2">
                   7049: <div class="titlepage"><div><div><h3 class="title">
                   7050: <a name="conf-files-configure"></a>20.2.2. Telling the software where configuration files are</h3></div></div></div>
                   7051: <p>Given that pkgsrc (and users!) expect configuration files to be in a
                   7052: known place, you need to teach each package where it shall install its
                   7053: files.  In some cases you will have to patch the package Makefiles to
                   7054: achieve it.  If you are lucky, though, it may be as easy as passing an
                   7055: extra flag to the configuration script; this is the case of GNU Autoconf-
                   7056: generated files:</p>
1.1       dsieger  7057: <pre class="programlisting">
1.184     rillig   7058: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.1       dsieger  7059: </pre>
1.184     rillig   7060: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
                   7061: for</em></span> its configuration files, not where they will be originally
                   7062: installed (although the difference is never explicit,
                   7063: unfortunately).</p>
1.1       dsieger  7064: </div>
1.184     rillig   7065: <div class="sect2">
                   7066: <div class="titlepage"><div><div><h3 class="title">
                   7067: <a name="conf-files-patching"></a>20.2.3. Patching installations</h3></div></div></div>
                   7068: <p>As said before, pkginstall automatically handles configuration files.
                   7069: This means that <span class="strong"><strong>the packages themselves must not
                   7070: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
                   7071: directly</strong></span>.  Bad news is that many software installation scripts
                   7072: will, out of the box, mess with the contents of that directory.  So what is
                   7073: the correct procedure to fix this issue?</p>
                   7074: <p>You must teach the package (usually by manually patching it) to
                   7075: install any configuration files under the examples hierarchy,
                   7076: <code class="filename">share/examples/${PKGBASE}/</code>.  This way, the
                   7077: <code class="filename">PLIST</code> registers them and the administrator always
                   7078: has the original copies available.</p>
                   7079: <p>Once the required configuration files are in place (i.e., under the
                   7080: examples hierarchy), the pkginstall framework can use them as master copies
                   7081: during the package installation to update what is in
                   7082: <code class="filename">${PKG_SYSCONFDIR}</code>.  To achieve this, the variables
                   7083: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
                   7084: 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
                   7085: about their syntax and their purpose.  Here is an example, taken from the
                   7086: <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.1       dsieger  7087: <pre class="programlisting">
1.184     rillig   7088: EGDIR=        ${PREFIX}/share/doc/mutt/samples
                   7089: CONF_FILES=   ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
1.1       dsieger  7090: </pre>
1.184     rillig   7091: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
                   7092: package and has no meaning outside it.</p>
1.1       dsieger  7093: </div>
1.184     rillig   7094: <div class="sect2">
                   7095: <div class="titlepage"><div><div><h3 class="title">
                   7096: <a name="conf-files-disable"></a>20.2.4. Disabling handling of configuration files</h3></div></div></div>
                   7097: <p>The automatic copying of config files can be toggled by setting the
                   7098: environment variable <code class="varname">PKG_CONFIG</code> prior to package
                   7099: installation.</p>
1.1       dsieger  7100: </div>
                   7101: </div>
1.41      asau     7102: <div class="sect1">
1.1       dsieger  7103: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   7104: <a name="rcd-scripts"></a>20.3. System startup scripts</h2></div></div></div>
                   7105: <p>System startup scripts are special files because they must be
                   7106: installed in a place known by the underlying OS, usually outside the
                   7107: 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
                   7108: can be used.  However, pkginstall provides a special mechanism to handle
                   7109: these files.</p>
                   7110: <p>In order to provide system startup scripts, the package has
                   7111: to:</p>
                   7112: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7113: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
                   7114:     the <code class="literal">.sh</code> suffix appended.  Considering the
                   7115:     <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
                   7116:     <code class="filename">cupsd.sh</code> in its files directory.</p></li>
                   7117: <li class="listitem">
                   7118: <p>Tell pkginstall to handle it, appending the name of the script,
                   7119:     without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
                   7120:     Continuing the previous example:</p>
                   7121: <pre class="programlisting">
                   7122: RCD_SCRIPTS+=   cupsd
                   7123: </pre>
                   7124: </li>
                   7125: </ol></div>
                   7126: <p>Once this is done, pkginstall will do the following steps for each
                   7127: script in an automated fashion:</p>
                   7128: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7129: <li class="listitem"><p>Process the file found in the files directory applying all the
                   7130:     substitutions described in the <code class="filename">FILES_SUBST</code>
                   7131:     variable.</p></li>
                   7132: <li class="listitem"><p>Copy the script from the files directory to the examples
                   7133:     hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>.  Note
                   7134:     that this master file must be explicitly registered in the
                   7135:     <code class="filename">PLIST</code>.</p></li>
                   7136: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
                   7137:     from the examples hierarchy into the system-wide startup scripts
                   7138:     directory.</p></li>
                   7139: </ol></div>
                   7140: <div class="sect2">
                   7141: <div class="titlepage"><div><div><h3 class="title">
                   7142: <a name="rcd-scripts-disable"></a>20.3.1. Disabling handling of system startup scripts</h3></div></div></div>
                   7143: <p>The automatic copying of config files can be toggled by setting the
                   7144: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
                   7145: installation.  Note that the scripts will be always copied inside the
                   7146: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
                   7147: matter what the value of this variable is.</p>
1.1       dsieger  7148: </div>
                   7149: </div>
1.184     rillig   7150: <div class="sect1">
                   7151: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   7152: <a name="users-and-groups"></a>20.4. System users and groups</h2></div></div></div>
                   7153: <p>If a package needs to create special users and/or groups during
                   7154: installation, it can do so by using the pkginstall framework.</p>
                   7155: <p>Users can be created by adding entries to the
                   7156: <code class="varname">PKG_USERS</code> variable.  Each entry has the following
                   7157: syntax:</p>
                   7158: <pre class="programlisting">
                   7159: user:group
                   7160: </pre>
                   7161: <p>Further specification of user details may be done by setting
                   7162: per-user variables.
                   7163: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
                   7164: numeric UID for the user.
                   7165: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
                   7166: user's description or comment.
                   7167: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
                   7168: user's home directory, and defaults to
                   7169: <code class="filename">/nonexistent</code> if not specified.
                   7170: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
                   7171: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
                   7172: not specified.</p>
                   7173: <p>Similarly, groups can be created by adding entries to the
                   7174: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
                   7175: <pre class="programlisting">
                   7176: group
                   7177: </pre>
                   7178: <p>The numeric GID of the group may be set by defining
                   7179: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
                   7180: <p>If a package needs to create the users and groups at an earlier
                   7181: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to either
                   7182: <code class="literal">configure</code>,<code class="literal">build</code>, or
                   7183: <code class="literal">pre-install</code> to indicate the phase before which the
                   7184: users and groups are created. In this case, the numeric UIDs and GIDs
                   7185: of the created users and groups are automatically hardcoded into the
                   7186: final installation scripts.</p>
1.1       dsieger  7187: </div>
1.41      asau     7188: <div class="sect1">
1.1       dsieger  7189: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   7190: <a name="shells"></a>20.5. System shells</h2></div></div></div>
                   7191: <p>Packages that install system shells should register them in the shell
                   7192: database, <code class="filename">/etc/shells</code>, to make things easier to the
                   7193: administrator.  This must be done from the installation scripts to keep
                   7194: binary packages working on any system.  pkginstall provides an easy way to
                   7195: accomplish this task.</p>
                   7196: <p>When a package provides a shell interpreter, it has to set the
                   7197: <code class="varname">PKG_SHELL</code> variable to its absolute file name.  This will
                   7198: add some hooks to the installation scripts to handle it.  Consider the
                   7199: 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>
                   7200: <pre class="programlisting">
                   7201: PKG_SHELL=      ${PREFIX}/bin/zsh
                   7202: </pre>
                   7203: <div class="sect2">
                   7204: <div class="titlepage"><div><div><h3 class="title">
                   7205: <a name="shells-disable"></a>20.5.1. Disabling shell registration</h3></div></div></div>
                   7206: <p>The automatic registration of shell interpreters can be disabled by
                   7207: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
                   7208: environment variable to <code class="literal">NO</code>.</p>
                   7209: </div>
1.1       dsieger  7210: </div>
1.41      asau     7211: <div class="sect1">
1.1       dsieger  7212: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   7213: <a name="fonts"></a>20.6. Fonts</h2></div></div></div>
                   7214: <p>Packages that install X11 fonts should update the database files
                   7215: that index the fonts within each fonts directory.  This can easily be
                   7216: accomplished within the pkginstall framework.</p>
                   7217: <p>When a package installs X11 fonts, it must list the directories in
                   7218: which fonts are installed in the
                   7219: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
                   7220: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">&#8220;<span class="quote">ttf</span>&#8221;</span>,
                   7221: <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
                   7222: installation scripts to run the appropriate commands to update the fonts
                   7223: database files within each of those directories.  For convenience, if the
                   7224: directory path is relative, it is taken to be relative to the package's
                   7225: 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.1       dsieger  7226: <pre class="programlisting">
1.184     rillig   7227: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF
1.1       dsieger  7228: </pre>
1.184     rillig   7229: <div class="sect2">
                   7230: <div class="titlepage"><div><div><h3 class="title">
                   7231: <a name="fonts-disable"></a>20.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
                   7232: <p>The automatic update of fonts databases can be disabled by
                   7233: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
                   7234: environment variable to <code class="literal">NO</code>.</p>
1.1       dsieger  7235: </div>
                   7236: </div>
                   7237: </div>
1.41      asau     7238: <div class="chapter">
1.1       dsieger  7239: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   7240: <a name="fixes"></a>Chapter 21. Making your package work</h2></div></div></div>
1.1       dsieger  7241: <div class="toc">
                   7242: <p><b>Table of Contents</b></p>
1.100     leot     7243: <dl class="toc">
1.154     rillig   7244: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
1.1       dsieger  7245: <dd><dl>
1.154     rillig   7246: <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>
                   7247: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
                   7248: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
                   7249: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
                   7250: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
                   7251: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
                   7252: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
                   7253: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
                   7254: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
                   7255: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
                   7256: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                   7257: </dl></dd>
                   7258: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                   7259: <dd><dl>
                   7260: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   7261: <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>
                   7262: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
                   7263: </dl></dd>
                   7264: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   7265: <dd><dl>
                   7266: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
                   7267: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   7268: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
                   7269: </dl></dd>
                   7270: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
                   7271: <dd><dl>
                   7272: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
                   7273: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
1.203   ! nia      7274: <dt><span class="sect2"><a href="#perl-scripts">21.4.3. Packages containing Perl scripts</a></span></dt>
1.154     rillig   7275: <dt><span class="sect2"><a href="#shell-scripts">21.4.4. Packages containing shell scripts</a></span></dt>
                   7276: <dt><span class="sect2"><a href="#other-programming-languages">21.4.5. Other programming languages</a></span></dt>
                   7277: </dl></dd>
                   7278: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   7279: <dd><dl>
                   7280: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   7281: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.172     rillig   7282: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
                   7283: <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>
                   7284: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.154     rillig   7285: </dl></dd>
                   7286: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   7287: <dd><dl>
                   7288: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
                   7289: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
                   7290: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
                   7291: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
                   7292: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
1.203   ! nia      7293: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing Perl modules</a></span></dt>
1.154     rillig   7294: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
                   7295: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
1.203   ! nia      7296: <dt><span class="sect2"><a href="#x11-fonts">21.6.9. Packages installing X11 fonts</a></span></dt>
        !          7297: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.10. Packages installing SGML or XML data</a></span></dt>
        !          7298: <dt><span class="sect2"><a href="#mime-database">21.6.11. Packages installing extensions to the MIME database</a></span></dt>
        !          7299: <dt><span class="sect2"><a href="#intltool">21.6.12. Packages using intltool</a></span></dt>
        !          7300: <dt><span class="sect2"><a href="#startup-scripts">21.6.13. Packages installing startup scripts</a></span></dt>
        !          7301: <dt><span class="sect2"><a href="#tex-packages">21.6.14. Packages installing TeX modules</a></span></dt>
        !          7302: <dt><span class="sect2"><a href="#emulation-packages">21.6.15. Packages supporting running binaries in
1.1       dsieger  7303:     emulation</a></span></dt>
1.203   ! nia      7304: <dt><span class="sect2"><a href="#hicolor-theme">21.6.16. Packages installing hicolor icons</a></span></dt>
        !          7305: <dt><span class="sect2"><a href="#desktop-files">21.6.17. Packages installing desktop files</a></span></dt>
1.1       dsieger  7306: </dl></dd>
1.154     rillig   7307: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.1       dsieger  7308: </dl>
                   7309: </div>
1.41      asau     7310: <div class="sect1">
1.1       dsieger  7311: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   7312: <a name="general-operation"></a>21.1. General operation</h2></div></div></div>
1.1       dsieger  7313: <p>One appealing feature of pkgsrc is that it runs on many
1.108     rillig   7314:   different platforms. As a result, it is important to ensure,
                   7315:   where possible, that packages in pkgsrc are portable. This
                   7316:   chapter mentions some particular details you should pay
                   7317:   attention to while working on pkgsrc.</p>
1.41      asau     7318: <div class="sect2">
1.1       dsieger  7319: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   7320: <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.1       dsieger  7321: </h3></div></div></div>
                   7322: <p>The pkgsrc user can configure pkgsrc by overriding several
                   7323:     variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.10      hubertf  7324:     which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.1       dsieger  7325:     want to use those variables in the preprocessor directives of
1.197     leot     7326:     <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.1       dsieger  7327:     <code class="literal">.for</code>), you need to include the file
                   7328:     <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
                   7329:     loads the user preferences.</p>
                   7330: <p>But note that some variables may not be completely defined
                   7331:     after <code class="filename">../../mk/bsd.prefs.mk</code> has been
                   7332:     included, as they may contain references to variables that are
1.108     rillig   7333:     not yet defined. In shell commands (the lines in
                   7334:     <code class="filename">Makefile</code> that are indented with a tab) this
                   7335:     is no problem, since variables are only expanded when they are
                   7336:     used. But in the preprocessor directives mentioned above and in
                   7337:     dependency lines (of the form <code class="literal">target:
1.1       dsieger  7338:     dependencies</code>) the variables are expanded at load
                   7339:     time.</p>
1.41      asau     7340: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  7341: <h3 class="title">Note</h3>
1.108     rillig   7342: <p>To check whether a variable can be used at load time,
                   7343:     run <span class="command"><strong>pkglint -Wall</strong></span> on your package.</p>
1.1       dsieger  7344: </div>
                   7345: </div>
1.41      asau     7346: <div class="sect2">
1.1       dsieger  7347: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   7348: <a name="user-interaction"></a>21.1.2. User interaction</h3></div></div></div>
1.1       dsieger  7349: <p>Occasionally, packages require interaction from the user,
                   7350:     and this can be in a number of ways:</p>
1.41      asau     7351: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      7352: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.1       dsieger  7353:        interaction such as entering username/password or accepting a
                   7354:        license on a web page.</p></li>
1.23      wiz      7355: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.1       dsieger  7356:        passwords.</p></li>
1.23      wiz      7357: <li class="listitem"><p>help to configure the package before it is built</p></li>
                   7358: <li class="listitem"><p>help during the build process</p></li>
                   7359: <li class="listitem"><p>help during the installation of a package</p></li>
1.1       dsieger  7360: </ul></div>
1.108     rillig   7361: <p>A package can set the <code class="varname">INTERACTIVE_STAGE</code>
                   7362:     variable to define which stages need interaction. This should be
                   7363:     done in the package's <code class="filename">Makefile</code>, e.g.:</p>
1.1       dsieger  7364: <pre class="programlisting">
                   7365: INTERACTIVE_STAGE=      configure install
1.111     sevan    7366: </pre>
1.1       dsieger  7367: <p>The user can then decide to skip this package by setting the
1.108     rillig   7368:     <code class="varname">BATCH</code> variable. Packages that require interaction
                   7369:     are also excluded from bulk builds.</p>
1.1       dsieger  7370: </div>
1.41      asau     7371: <div class="sect2">
1.1       dsieger  7372: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   7373: <a name="handling-licenses"></a>21.1.3. Handling licenses</h3></div></div></div>
1.111     sevan    7374: <p>Authors of software can choose the licence under which software
                   7375:     can be copied.  The Free Software Foundation has declared some
                   7376:     licenses "Free", and the Open Source Initiative has a definition of
                   7377:     "Open Source".</p>
                   7378: <p>By default, pkgsrc allows packages with Free or Open Source
                   7379:     licenses to be built.  To allow packages with other licenses to be
                   7380:     built as well, the pkgsrc user needs to add these licenses to the
                   7381:     <code class="varname">ACCEPTABLE_LICENSES</code> variable in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  Note
                   7382:     that this variable only affects which packages may be
                   7383:     <span class="emphasis"><em>built</em></span>, while the license terms often also
                   7384:     restrict the actual use of the package and its redistribution.</p>
1.1       dsieger  7385: <p>One might want to only install packages with a BSD license,
1.108     rillig   7386:     or the GPL, and not the other.  The free licenses are added to the
1.111     sevan    7387:     default <code class="varname">ACCEPTABLE_LICENSES</code> variable.  The pkgsrc
1.19      jnemeth  7388:     user can override the default by setting the
                   7389:     <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
1.111     sevan    7390:     of "+=".  The licenses accepted by default are defined in the
                   7391:     <code class="varname">DEFAULT_ACCEPTABLE_LICENSES</code> variable in the file
                   7392:     <code class="filename">pkgsrc/mk/license.mk</code>.</p>
1.1       dsieger  7393: <p>The license tag mechanism is intended to address
                   7394:     copyright-related issues surrounding building, installing and
                   7395:     using a package, and not to address redistribution issues (see
                   7396:     <code class="varname">RESTRICTED</code> and
1.111     sevan    7397:     <code class="varname">NO_SRC_ON_FTP</code>, etc.).
1.19      jnemeth  7398:     Packages with redistribution restrictions should set these
                   7399:     tags.</p>
1.1       dsieger  7400: <p>Denoting that a package may be copied according to a
                   7401:     particular license is done by placing the license in
                   7402:     <code class="filename">pkgsrc/licenses</code> and setting the
                   7403:     <code class="varname">LICENSE</code> variable to a string identifying the
1.137     leot     7404:     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.1       dsieger  7405: <pre class="programlisting">
                   7406: LICENSE=        xv-license
1.111     sevan    7407: </pre>
1.1       dsieger  7408: <p>When trying to build, the user will get a notice that the
                   7409:     package is covered by a license which has not been placed in the
                   7410:     <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
                   7411: <pre class="programlisting">
                   7412: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   7413: ===&gt; xv-3.10anb9 has an unacceptable license: xv-license.
                   7414: ===&gt;     To view the license, enter "/usr/bin/make show-license".
                   7415: ===&gt;     To indicate acceptance, add this line to your /etc/mk.conf:
                   7416: ===&gt;     ACCEPTABLE_LICENSES+=xv-license
                   7417: *** Error code 1
1.111     sevan    7418: </pre>
1.10      hubertf  7419: <p>The license can be viewed with <span class="command"><strong>make
1.1       dsieger  7420:     show-license</strong></span>, and if the user so chooses, the line
1.10      hubertf  7421:     printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1       dsieger  7422:     convey to pkgsrc that it should not in the future fail because of
                   7423:     that license:</p>
                   7424: <pre class="programlisting">
                   7425: ACCEPTABLE_LICENSES+=xv-license
1.111     sevan    7426: </pre>
                   7427: <p>The use of <code class="varname">LICENSE=shareware</code>,
                   7428:     <code class="varname">LICENSE=no-commercial-use</code>, and similar language
                   7429:     is deprecated because it does not crisply refer to a particular
                   7430:     license text.  Another problem with such usage is that it does not
                   7431:     enable a user to tell pkgsrc to proceed for a single package
                   7432:     without also telling pkgsrc to proceed for all packages with that
                   7433:     tag.</p>
                   7434: <div class="sect3">
                   7435: <div class="titlepage"><div><div><h4 class="title">
1.154     rillig   7436: <a name="new-license"></a>21.1.3.1. Adding a package with a new license</h4></div></div></div>
1.48      rodent   7437: <p>When adding a package with a new license, the following steps
                   7438:     are required:</p>
                   7439: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7440: <li class="listitem">
1.169     rillig   7441: <p>Check whether the license qualifies as Free or Open Source by
                   7442:     referencing <a class="ulink" href="https://www.gnu.org/licenses/license-list.en.html" target="_top">Various
                   7443:     Licenses and Comments about Them</a> and <a class="ulink" href="https://opensource.org/licenses/alphabetical" target="_top">Licenses by Name |
1.111     sevan    7444:     Open Source Initiative</a>.  If this is the case, the filename in
                   7445:     <code class="filename">pkgsrc/licenses/</code> does not need the
                   7446:     <code class="filename">-license</code> suffix, and the license name should be
                   7447:     added to:</p>
1.48      rodent   7448: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.169     rillig   7449: <li class="listitem"><p>DEFAULT_ACCEPTABLE_LICENSES in
                   7450:     <code class="filename">pkgsrc/mk/license.mk</code></p></li>
                   7451: <li class="listitem"><p>default_acceptable_licenses in
                   7452:     <code class="filename">pkgsrc/pkgtools/pkg_install/files/lib/license.c</code></p></li>
1.48      rodent   7453: </ul></div>
                   7454: </li>
1.169     rillig   7455: <li class="listitem"><p>The license text should be added to
                   7456:     <code class="filename">pkgsrc/licenses</code> for displaying.  A list of known
                   7457:     licenses can be seen in this directory.</p></li>
1.48      rodent   7458: </ol></div>
1.111     sevan    7459: </div>
                   7460: <div class="sect3">
                   7461: <div class="titlepage"><div><div><h4 class="title">
1.154     rillig   7462: <a name="change-license"></a>21.1.3.2. Change to the license</h4></div></div></div>
1.1       dsieger  7463: <p>When the license changes (in a way other than formatting),
1.111     sevan    7464:     make sure that the new license has a different name (e.g.,
1.1       dsieger  7465:     append the version number if it exists, or the date).  Just
                   7466:     because a user told pkgsrc to build programs under a previous
                   7467:     version of a license does not mean that pkgsrc should build
                   7468:     programs under the new licenses.  The higher-level point is that
                   7469:     pkgsrc does not evaluate licenses for reasonableness; the only
                   7470:     test is a mechanistic test of whether a particular text has been
1.111     sevan    7471:     approved by either of two bodies (FSF or OSI).</p>
                   7472: </div>
1.1       dsieger  7473: </div>
1.41      asau     7474: <div class="sect2">
1.1       dsieger  7475: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   7476: <a name="restricted-packages"></a>21.1.4. Restricted packages</h3></div></div></div>
1.1       dsieger  7477: <p>Some licenses restrict how software may be re-distributed.
1.111     sevan    7478:     By declaring the restrictions, package tools can
1.1       dsieger  7479:     automatically refrain from e.g. placing binary packages on FTP
                   7480:     sites.</p>
1.111     sevan    7481: <p>There are four possible restrictions, which are
1.1       dsieger  7482:     the cross product of sources (distfiles) and binaries not being
                   7483:     placed on FTP sites and CD-ROMs.  Because this is rarely the exact
                   7484:     language in any license, and because non-Free licenses tend to be
                   7485:     different from each other, pkgsrc adopts a definition of FTP and
1.111     sevan    7486:     CD-ROM.
                   7487: 
                   7488:     "FTP" means making the source or binary file available over the
                   7489:     Internet at no charge.
                   7490: 
                   7491:     "CD-ROM" means making the source or binary available on some kind of
                   7492:     media, together with other source and binary packages, which is sold
                   7493:     for a distribution charge.
1.1       dsieger  7494:     </p>
                   7495: <p>In order to encode these restrictions, the package system
                   7496:     defines five make variables that can be set to note these
                   7497:     restrictions:</p>
1.41      asau     7498: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      7499: <li class="listitem">
1.1       dsieger  7500: <p><code class="varname">RESTRICTED</code></p>
                   7501: <p>This variable should be set whenever a restriction
                   7502:        exists (regardless of its kind).  Set this variable to a
                   7503:        string containing the reason for the restriction.  It should
                   7504:        be understood that those wanting to understand the restriction
                   7505:        will have to read the license, and perhaps seek advice of
                   7506:        counsel.</p>
                   7507: </li>
1.23      wiz      7508: <li class="listitem">
1.1       dsieger  7509: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
                   7510: <p>Binaries may not be placed on CD-ROM containing other
                   7511:        binary packages, for which a distribution charge may be made.
                   7512:        In this case, set this variable to
                   7513:        <code class="varname">${RESTRICTED}</code>.</p>
                   7514: </li>
1.23      wiz      7515: <li class="listitem">
1.1       dsieger  7516: <p><code class="varname">NO_BIN_ON_FTP</code></p>
                   7517: <p>Binaries may not made available on the Internet without
                   7518:        charge.  In this case, set this variable to
                   7519:        <code class="varname">${RESTRICTED}</code>.  If this variable is set,
                   7520:        binary packages will not be included on ftp.NetBSD.org.</p>
                   7521: </li>
1.23      wiz      7522: <li class="listitem">
1.1       dsieger  7523: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
                   7524: <p>Distfiles may not be placed on CD-ROM, together with
                   7525:        other distfiles, for which a fee may be charged.  In this
                   7526:        case, set this variable to <code class="varname">${RESTRICTED}</code>.
                   7527:        </p>
                   7528: </li>
1.23      wiz      7529: <li class="listitem">
1.1       dsieger  7530: <p><code class="varname">NO_SRC_ON_FTP</code></p>
                   7531: <p>Distfiles may not made available via FTP at no charge.
                   7532:        In this case, set this variable to
                   7533:        <code class="varname">${RESTRICTED}</code>.  If this variable is set,
                   7534:        the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
                   7535: </li>
                   7536: </ul></div>
1.111     sevan    7537: <p>Please note that packages will be removed from pkgsrc when the
                   7538:     distfiles are not distributable and cannot be obtained for a period
                   7539:     of one full quarter branch. Packages with manual/interactive fetch
                   7540:     must have a maintainer and it is his/her responsibility to ensure
                   7541:     this.</p>
1.1       dsieger  7542: </div>
1.41      asau     7543: <div class="sect2">
1.1       dsieger  7544: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   7545: <a name="dependencies"></a>21.1.5. Handling dependencies</h3></div></div></div>
1.175     gutterid 7546: <p>Your package may depend on some other package being present,
                   7547:     and there are various ways of expressing this dependency.
                   7548:     pkgsrc supports the <code class="varname">DEPENDS</code>,
                   7549:     <code class="varname">BUILD_DEPENDS</code>,
                   7550:     <code class="varname">TOOL_DEPENDS</code>, and
                   7551:     <code class="varname">TEST_DEPENDS</code> definitions, the
1.1       dsieger  7552:     <code class="varname">USE_TOOLS</code> definition, as well as dependencies
                   7553:     via <code class="filename">buildlink3.mk</code>, which is the preferred way
                   7554:     to handle dependencies, and which uses the variables named above.
1.184     rillig   7555:     See <a class="xref" href="#buildlink" title="Chapter 18. Buildlink methodology">Chapter 18, <i>Buildlink methodology</i></a> for more information.</p>
1.175     gutterid 7556: <p>The basic difference is that the <code class="varname">DEPENDS</code>
                   7557:     definition registers that pre-requisite in the binary package so it
                   7558:     will be pulled in when the binary package is later installed, whilst
                   7559:     the <code class="varname">BUILD_DEPENDS</code>, <code class="varname">TOOL_DEPENDS</code>,
                   7560:     and <code class="varname">TEST_DEPENDS</code> definitions do not, marking a
                   7561:     dependency that is only needed for building or testing the resulting
1.184     rillig   7562:     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.1       dsieger  7563: <p>This means that if you only need a package present whilst
1.175     gutterid 7564:     you are building or testing, it should be noted as a
                   7565:     <code class="varname">TOOL_DEPENDS</code>,
                   7566:     <code class="varname">BUILD_DEPENDS</code>, or
                   7567:     <code class="varname">TEST_DEPENDS</code>.  When cross-compiling,
1.156     leot     7568:     <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
                   7569:     packages, i.e. packages for the architecture where the package
                   7570:     is built;
                   7571:     <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
1.175     gutterid 7572:     packages, i.e., packages for the architecture for which the package
1.156     leot     7573:     is built.</p>
1.175     gutterid 7574: <p>The format for a <code class="varname">DEPENDS</code>,
                   7575:     <code class="varname">BUILD_DEPENDS</code>, <code class="varname">TOOL_DEPENDS</code>,
                   7576:     and <code class="varname">TEST_DEPENDS</code> definition is:</p>
1.1       dsieger  7577: <pre class="programlisting">
                   7578: &lt;pre-req-package-name&gt;:../../&lt;category&gt;/&lt;pre-req-package&gt;
1.111     sevan    7579: </pre>
1.23      wiz      7580: <p>Please note that the <span class="quote">&#8220;<span class="quote">pre-req-package-name</span>&#8221;</span>
1.1       dsieger  7581:     may include any of the wildcard version numbers recognized by
1.197     leot     7582:     <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.23      wiz      7583: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7584: <li class="listitem">
1.1       dsieger  7585: <p>If your package needs another package's binaries or
1.54      wiz      7586:        libraries to build and run, and if that package has a
1.1       dsieger  7587:        <code class="filename">buildlink3.mk</code> file available, use it:</p>
                   7588: <pre class="programlisting">
                   7589: .include "../../graphics/jpeg/buildlink3.mk"
1.111     sevan    7590: </pre>
1.1       dsieger  7591: </li>
1.23      wiz      7592: <li class="listitem">
1.54      wiz      7593: <p>If your package needs another package's binaries or
                   7594:        libraries only for building, and if that package has a
                   7595:        <code class="filename">buildlink3.mk</code> file available, use it:</p>
                   7596: <pre class="programlisting">
                   7597: .include "../../graphics/jpeg/buildlink3.mk"
1.111     sevan    7598: </pre>
1.54      wiz      7599: <p>but set
                   7600:        <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>jpeg</code></em>?=build</code>
                   7601:        to make it a build dependency only. This case is rather
                   7602:        rare.</p>
                   7603: </li>
                   7604: <li class="listitem">
1.25      spz      7605: <p>If your package needs binaries from another package to build,
1.156     leot     7606:        use the <code class="varname">TOOL_DEPENDS</code> definition:</p>
1.1       dsieger  7607: <pre class="programlisting">
1.156     leot     7608: TOOL_DEPENDS+= itstool-[0-9]*:../../textproc/itstool
1.111     sevan    7609: </pre>
1.1       dsieger  7610: </li>
1.156     leot     7611: <li class="listitem"><p>If your package needs static libraries to link against, header
                   7612:        files to include, etc. from another package to build,
                   7613:        use the <code class="varname">BUILD_DEPENDS</code> definition.</p></li>
1.25      spz      7614: <li class="listitem"><p>If your package needs a library with which to link and
                   7615:        there is no <code class="filename">buildlink3.mk</code> file
                   7616:        available, create one. Using
                   7617:        <code class="varname">DEPENDS</code> won't be sufficient because the
                   7618:        include files and libraries will be hidden from the compiler.</p></li>
1.23      wiz      7619: <li class="listitem">
1.25      spz      7620: <p>If your package needs some executable to be able to run
                   7621:        correctly and if there's no
                   7622:        <code class="filename">buildlink3.mk</code> file, this is specified
                   7623:        using the <code class="varname">DEPENDS</code> variable. The
1.137     leot     7624:        <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.129     wiz      7625:        be able to execute the latex binary from the tex-latex-bin package
1.25      spz      7626:        when it runs, and that is specified:</p>
1.1       dsieger  7627: <pre class="programlisting">
1.129     wiz      7628: DEPENDS+=        tex-latex-bin-[0-9]*:../../print/tex-latex-bin
1.111     sevan    7629: </pre>
1.25      spz      7630: </li>
1.175     gutterid 7631: <li class="listitem"><p>If your package includes a test suite that has extra
                   7632:         dependencies only required for this purpose (frequently this
                   7633:         can be run as a <span class="quote">&#8220;<span class="quote">make test</span>&#8221;</span> target), use the
                   7634:         <code class="varname">TEST_DEPENDS</code> variable.</p></li>
1.25      spz      7635: <li class="listitem">
                   7636: <p>You can use wildcards in package dependencies. Note that
                   7637:        such wildcard dependencies are retained when creating binary
                   7638:        packages. The dependency is checked when installing the binary
                   7639:        package and any package which matches the pattern will be
                   7640:        used. Wildcard dependencies should be used with care.</p>
1.23      wiz      7641: <p>The <span class="quote">&#8220;<span class="quote">-[0-9]*</span>&#8221;</span> should be used instead of
                   7642:        <span class="quote">&#8220;<span class="quote">-*</span>&#8221;</span> to avoid potentially ambiguous matches
                   7643:        such as <span class="quote">&#8220;<span class="quote">tk-postgresql</span>&#8221;</span> matching a
                   7644:        <span class="quote">&#8220;<span class="quote">tk-*</span>&#8221;</span> <code class="varname">DEPENDS</code>.</p>
1.1       dsieger  7645: <p>Wildcards can also be used to specify that a package
                   7646:        will only build against a certain minimum version of a
                   7647:        pre-requisite:</p>
                   7648: <pre class="programlisting">
1.25      spz      7649: DEPENDS+=       ImageMagick&gt;=6.0:../../graphics/ImageMagick
1.111     sevan    7650: </pre>
1.25      spz      7651: <p>This means that the package will build using version 6.0
                   7652:        of ImageMagick or newer. Such a dependency may be warranted
                   7653:        if, for example, the command line options of an executable
                   7654:        have changed.</p>
                   7655: <p>If you need to depend on minimum versions of libraries,
1.183     wiz      7656:        set
                   7657:        <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   7658:        to the appropriate pattern before including its
                   7659:        <code class="filename">buildlink3.mk</code> file, e.g.</p>
                   7660: <pre class="programlisting">
                   7661: BUILDLINK_API_DEPENDS.jpeg+=    jpeg&gt;=9.0
                   7662: .include "../../graphics/jpeg/buildlink3.mk"
                   7663: </pre>
1.1       dsieger  7664: <p>For security fixes, please update the package
1.154     rillig   7665:        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.1       dsieger  7666:        information.</p>
                   7667: </li>
                   7668: </ol></div>
                   7669: <p>If your package needs files from another package to build,
                   7670:     add the relevant distribution files to
                   7671:     <code class="varname">DISTFILES</code>, so they will be extracted
1.137     leot     7672:     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.1       dsieger  7673:     (It relies on the jpeg sources being present in source form
                   7674:     during the build.)</p>
                   7675: </div>
1.41      asau     7676: <div class="sect2">
1.1       dsieger  7677: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   7678: <a name="conflicts"></a>21.1.6. Handling conflicts with other packages</h3></div></div></div>
1.1       dsieger  7679: <p>Your package may conflict with other packages a user might
                   7680:     already have installed on his system, e.g. if your package
                   7681:     installs the same set of files as another package in the pkgsrc
1.80      wiz      7682:     tree or has the same <code class="varname">PKGNAME</code>.</p>
1.142     leot     7683: <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>
                   7684:     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>
                   7685:     install the same shared library, thus you set in
                   7686:     <code class="filename">pkgsrc/x11/libXaw3d/Makefile</code>:</p>
                   7687: <pre class="programlisting">
                   7688: CONFLICTS=      Xaw-Xpm-[0-9]*
                   7689:     </pre>
                   7690: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
                   7691: <pre class="programlisting">
                   7692: CONFLICTS=      libXaw3d-[0-9]*
                   7693:     </pre>
1.197     leot     7694: <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.142     leot     7695:     that conflict with existing packages and abort. However, in many
                   7696:     situations this is too late in the process. Binary package managers
                   7697:     will not know about the conflict until they attempt to install the
                   7698:     package after already downloading it and all its dependencies.
                   7699:     Users may also waste time building a package and its dependencies
                   7700:     only to find out at the end that it conflicts with another package
                   7701:     they have installed.</p>
                   7702: <p>To avoid these issues <code class="varname">CONFLICTS</code> entries
                   7703:     should be added in all cases where it is known that packages conflict
                   7704:     with each other.  These <code class="varname">CONFLICTS</code> entries are
1.197     leot     7705:     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.142     leot     7706:     managers to inform users that packages cannot be installed onto
                   7707:     the target system.</p>
1.1       dsieger  7708: </div>
1.41      asau     7709: <div class="sect2">
1.1       dsieger  7710: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   7711: <a name="not-building-packages"></a>21.1.7. Packages that cannot or should not be built</h3></div></div></div>
1.1       dsieger  7712: <p>There are several reasons why a package might be
                   7713:     instructed to not build under certain circumstances.  If the
                   7714:     package builds and runs on most platforms, the exceptions
1.83      dholland 7715:     should be noted with <code class="varname">BROKEN_ON_PLATFORM</code>.  If
                   7716:     the package builds and runs on a small handful of platforms,
                   7717:     set <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> instead.
                   7718:     Both <code class="varname">BROKEN_ON_PLATFORM</code> and
                   7719:     <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> are OS triples
                   7720:     (OS-version-platform) that can use glob-style
                   7721:     wildcards.</p>
                   7722: <p>If a package is not appropriate for some platforms (as
1.114     maya     7723:     opposed to merely broken), a different set of variables should be
1.83      dholland 7724:     used as this affects failure reporting and statistics.
                   7725:     If the package is appropriate for most platforms, the exceptions
1.1       dsieger  7726:     should be noted with <code class="varname">NOT_FOR_PLATFORM</code>.  If
1.83      dholland 7727:     the package is appropriate for only a small handful of platforms
                   7728:     (often exactly one), set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
1.1       dsieger  7729:     Both <code class="varname">ONLY_FOR_PLATFORM</code> and
                   7730:     <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
                   7731:     (OS-version-platform) that can use glob-style
                   7732:     wildcards.</p>
                   7733: <p>Some packages are tightly bound to a specific version of an
1.137     leot     7734:     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.1       dsieger  7735:     backwards compatible with other versions of the OS, and should be
                   7736:     uploaded to a version specific directory on the FTP server.  Mark
                   7737:     these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.23      wiz      7738:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.  This variable is not currently used by any of
1.1       dsieger  7739:     the package system internals, but may be used in the
                   7740:     future.</p>
                   7741: <p>If the package should be skipped (for example, because it
                   7742:     provides functionality already provided by the system), set
                   7743:     <code class="varname">PKG_SKIP_REASON</code> to a descriptive message.  If
                   7744:     the package should fail because some preconditions are not met,
                   7745:     set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
                   7746:     message.</p>
                   7747: </div>
1.41      asau     7748: <div class="sect2">
1.1       dsieger  7749: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   7750: <a name="undeletable-packages"></a>21.1.8. Packages which should not be deleted, once installed</h3></div></div></div>
1.1       dsieger  7751: <p>To ensure that a package may not be deleted, once it has been
                   7752:     installed, the <code class="varname">PKG_PRESERVE</code> definition should
                   7753:     be set in the package Makefile. This will be carried into any
                   7754:     binary package that is made from this pkgsrc entry. A
1.23      wiz      7755:     <span class="quote">&#8220;<span class="quote">preserved</span>&#8221;</span> package will
1.197     leot     7756:     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.23      wiz      7757:     <span class="quote">&#8220;<span class="quote">-f</span>&#8221;</span> option is used.</p>
1.1       dsieger  7758: </div>
1.41      asau     7759: <div class="sect2">
1.1       dsieger  7760: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   7761: <a name="security-handling"></a>21.1.9. Handling packages with security problems</h3></div></div></div>
1.1       dsieger  7762: <p>When a vulnerability is found, this should be noted in
                   7763:     <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
1.31      wiz      7764:     and after committing that file, ask pkgsrc-security@NetBSD.org to
                   7765:     update the file on ftp.NetBSD.org.</p>
1.1       dsieger  7766: <p>After fixing the vulnerability by a patch, its
1.31      wiz      7767:     <code class="varname">PKGREVISION</code> should be increased (this is of
                   7768:     course not necessary if the problem is fixed by using a newer
                   7769:     release of the software), and the pattern in the
                   7770:     pkg-vulnerabilities file must be updated.</p>
1.1       dsieger  7771: <p>Also, if the fix should be applied to the stable pkgsrc
                   7772:     branch, be sure to submit a pullup request!</p>
                   7773: <p>Binary packages already on ftp.NetBSD.org will be handled
                   7774:     semi-automatically by a weekly cron job.</p>
                   7775: </div>
1.41      asau     7776: <div class="sect2">
1.1       dsieger  7777: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   7778: <a name="bumping-pkgrevision"></a>21.1.10. How to handle incrementing versions when fixing an existing package</h3></div></div></div>
1.1       dsieger  7779: <p>When making fixes to an existing package it can be useful
                   7780:     to change the version number in <code class="varname">PKGNAME</code>. To
                   7781:     avoid conflicting with future versions by the original author, a
1.23      wiz      7782:     <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.1       dsieger  7783:     on package versions by setting <code class="varname">PKGREVISION=1</code>
1.23      wiz      7784:     (2, ...). The <span class="quote">&#8220;<span class="quote">nb</span>&#8221;</span> is treated like a
                   7785:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span> by the package tools. e.g.</p>
1.1       dsieger  7786: <pre class="programlisting">
                   7787: DISTNAME=       foo-17.42
                   7788: PKGREVISION=    9
1.111     sevan    7789: </pre>
1.1       dsieger  7790: <p>will result in a <code class="varname">PKGNAME</code> of
1.23      wiz      7791:     <span class="quote">&#8220;<span class="quote">foo-17.42nb9</span>&#8221;</span>. If you want to use the original
                   7792:     value of <code class="varname">PKGNAME</code> without the <span class="quote">&#8220;<span class="quote">nbX</span>&#8221;</span>
1.1       dsieger  7793:     suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
                   7794:     <code class="varname">PKGNAME_NOREV</code>.</p>
                   7795: <p>When a new release of the package is released, the
                   7796:     <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
                   7797:     minor release of the above package, things should be like:</p>
                   7798: <pre class="programlisting">
                   7799: DISTNAME=       foo-17.43
1.111     sevan    7800: </pre>
1.1       dsieger  7801: <p><code class="varname">PKGREVISION</code> should be incremented for any
                   7802:     non-trivial change in the resulting binary package.  Without a
                   7803:     <code class="varname">PKGREVISION</code> bump, someone with the previous
                   7804:     version installed has no way of knowing that their package is out
                   7805:     of date.  Thus, changes without increasing
                   7806:     <code class="varname">PKGREVISION</code> are essentially labeled "this is so
                   7807:     trivial that no reasonable person would want to upgrade", and this
                   7808:     is the rough test for when increasing
                   7809:     <code class="varname">PKGREVISION</code> is appropriate.  Examples of
                   7810:     changes that do not merit increasing
                   7811:     <code class="varname">PKGREVISION</code> are:</p>
1.41      asau     7812: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      7813: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.169     rillig   7814:       <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>, or
                   7815:       comments in Makefile.</p></li>
                   7816: <li class="listitem"><p>Changing build variables if the resulting binary
                   7817:       package is the same.</p></li>
                   7818: <li class="listitem"><p>Changing
                   7819:       <code class="filename">DESCR</code>.</p></li>
                   7820: <li class="listitem"><p>Adding <code class="varname">PKG_OPTIONS</code> if the
                   7821:       default options don't change.</p></li>
1.1       dsieger  7822: </ul></div>
                   7823: <p>Examples of changes that do merit an increase to
                   7824:     <code class="varname">PKGREVISION</code> include:</p>
1.41      asau     7825: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.169     rillig   7826: <li class="listitem"><p>Security fixes</p></li>
                   7827: <li class="listitem"><p>Changes or additions to a patch
                   7828:       file</p></li>
                   7829: <li class="listitem"><p>Changes to the
                   7830:       <code class="filename">PLIST</code></p></li>
                   7831: <li class="listitem"><p>A dependency is changed or
                   7832:       renamed.</p></li>
1.1       dsieger  7833: </ul></div>
                   7834: <p>PKGREVISION must also be incremented when dependencies have ABI
                   7835:     changes.</p>
                   7836: </div>
1.41      asau     7837: <div class="sect2">
1.1       dsieger  7838: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   7839: <a name="fixes.subst"></a>21.1.11. Substituting variable text in the package files (the SUBST framework)</h3></div></div></div>
1.180     rillig   7840: <p>When you want to replace the same text in multiple files, or
                   7841: multiple times in the same file, it is cumbersome to maintain a patch
                   7842: file for this. This is where the SUBST framework steps in. It provides an
                   7843: easy-to-use interface for replacing text in files. It just needs the
                   7844: following information:</p>
                   7845: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   7846: <li class="listitem"><p>In which phase of the package build cycle should the
                   7847: replacement happen?</p></li>
                   7848: <li class="listitem"><p>In which files should the replacement
1.172     rillig   7849: happen?</p></li>
1.180     rillig   7850: <li class="listitem"><p>Which text should be replaced with
                   7851: what?</p></li>
1.172     rillig   7852: </ul></div>
                   7853: <p>This information is encoded in a block of <code class="varname">SUBST</code>
1.180     rillig   7854: variables. A minimal example is:</p>
                   7855: <pre class="programlisting">
                   7856: SUBST_CLASSES+=         paths
                   7857: SUBST_STAGE.paths=      pre-configure
                   7858: SUBST_FILES.paths=      src/*.c
                   7859: SUBST_SED.paths=        -e 's,/usr/local,${PREFIX},g'
                   7860: </pre>
                   7861: <p>Translated into English, it means: In the pre-configure stage (that
                   7862: is, after applying the patches from the patches/ directory and before
                   7863: running the configure script and the portability check), replace the text
                   7864: <code class="literal">/usr/local</code> with the content of the variable
                   7865: <code class="varname">PREFIX</code>.</p>
                   7866: <p>Each SUBST block starts by appending an identifier to
                   7867: <code class="varname">SUBST_CLASSES</code> (note the <code class="literal">+=</code>). This
                   7868: identifier can be chosen freely by the package. If there should ever be
                   7869: duplicate identifiers, the pkgsrc infrastructure will catch this and fail
                   7870: early, so don't worry about name collisions.</p>
                   7871: <p>Except for <code class="varname">SUBST_CLASSES</code>, all variables in a
                   7872: SUBST block are parameterized using this identifier. In the remainder of
                   7873: this section, these parameterized variables are written as
                   7874: <code class="varname">SUBST_STAGE.*</code>.</p>
                   7875: <pre class="programlisting">
                   7876: SUBST_CLASSES+=         paths
                   7877: SUBST_STAGE.paths=      pre-configure
                   7878: SUBST_MESSAGE.paths=    Fixing absolute paths.
                   7879: SUBST_FILES.paths=      src/*.c
                   7880: SUBST_FILES.paths+=     scripts/*.sh
                   7881: SUBST_SED.paths=        -e 's,"/usr/local,"${PREFIX},g'
                   7882: SUBST_SED.paths+=       -e 's,"/var/log,"${VARBASE}/log,g'
                   7883: SUBST_VARS.paths=       LOCALBASE PREFIX PKGVERSION
                   7884: </pre>
                   7885: <p>To get a complete picture about the SUBST substitutions, run
                   7886: <span class="command"><strong>bmake show-all-subst</strong></span>. If something doesn't work as
                   7887: expected, run pkglint on the package, which detects several typical
                   7888: mistakes surrounding the SUBST blocks. For any questions that might
                   7889: remain after this, have a look at
                   7890: <code class="filename">mk/subst.mk</code>.</p>
                   7891: <div class="sect3">
                   7892: <div class="titlepage"><div><div><h4 class="title">
                   7893: <a name="fixes.subst.when"></a>21.1.11.1. Choosing the time where the substitutions happen</h4></div></div></div>
                   7894: <p>The <code class="varname">SUBST_STAGE.*</code> is one of
                   7895: {pre,do,post}-{extract,patch,configure,build,test,install}. Of these,
                   7896: <code class="literal">pre-configure</code> is used most often, by far. The most
                   7897: popular stages are, in chronological order:</p>
                   7898: <div class="variablelist"><dl class="variablelist">
                   7899: <dt><span class="term"><code class="literal">post-extract</code></span></dt>
                   7900: <dd>
                   7901: <p>The substitutions are applied immediately after the
                   7902: distfiles are extracted. Running <span class="command"><strong>bmake extract</strong></span> on the
                   7903: package will leave no traces of the original files.</p>
                   7904: <p>When the substitution applies to files for which there is also a
                   7905: patch in the <code class="filename">patches/</code> directory, this means that the
                   7906: patches will be computed based on the result of the substitution. When
                   7907: these patches are sent to the upstream maintainer later, to be fixed in
                   7908: the upstream package, these patches may no longer match what the upstream
                   7909: author is used to. Because of this, <code class="literal">pre-configure</code> is
                   7910: often a better choice.</p>
                   7911: </dd>
                   7912: <dt><span class="term"><code class="literal">pre-configure</code></span></dt>
                   7913: <dd>
                   7914: <p>The substitutions are applied after the patches from the
                   7915: <code class="filename">patches/</code> directory. This makes it possible to run
                   7916: <span class="command"><strong>bmake patch</strong></span> on the package, after which the patches
                   7917: 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>
                   7918: <p>When updating the patches, it is helpful to explicitly separate the
                   7919: <span class="command"><strong>bmake patch</strong></span> from the <span class="command"><strong>bmake
                   7920: configure</strong></span>, and to only edit the patches between these commands.
                   7921: Otherwise the substitutions from the SUBST block will end up in the patch
                   7922: file. When this happens in really obvious ways, pkglint will complain
                   7923: about patches that contain a hard-coded <code class="literal">/usr/pkg</code>
                   7924: instead of the correct and intended <code class="literal">@PREFIX@</code>, but it
                   7925: can only detect these really obvious
                   7926: cases.</p>
                   7927: </dd>
                   7928: <dt><span class="term"><code class="literal">do-configure</code></span></dt>
                   7929: <dd><p>This stage should only be used if the package defines a
                   7930: <code class="literal">pre-configure</code> action itself, and the substitution must
                   7931: happen after that. Typical examples are packages that use the
                   7932: <code class="literal">pre-configure</code> stage to regenerate the GNU configure
                   7933: script from
                   7934: <code class="filename">configure.ac</code>.</p></dd>
                   7935: <dt><span class="term"><code class="literal">post-configure</code></span></dt>
                   7936: <dd><p>This stage is used to fix up any mistakes by the
                   7937: configure stage.</p></dd>
                   7938: <dt><span class="term"><code class="literal">pre-build</code></span></dt>
                   7939: <dd><p>This stage should only be used for substitutions that are
                   7940: clearly related to building the package, not for fixing the
                   7941: configuration. Substitutions for pathnames (such as replacing
                   7942: <code class="filename">/usr/local</code> with <code class="literal">${PREFIX}</code>) or
                   7943: user names (such as replacing <code class="literal">@MY_USER@</code> with the
                   7944: actual username) belong in pre-configure or post-configure
                   7945: instead.</p></dd>
                   7946: <dt><span class="term"><code class="literal">post-build</code></span></dt>
                   7947: <dd>
                   7948: <p>Just as with pre-build, this stage should only be used
                   7949: for substitutions that are clearly related to building the package, not
                   7950: for fixing the configuration. Substitutions for pathnames (such as
                   7951: replacing <code class="filename">/usr/local</code> with
                   7952: <code class="literal">${PREFIX}</code>) or user names (such as replacing
                   7953: <code class="literal">@MY_USER@</code> with the actual username) belong in
                   7954: pre-configure or post-configure instead.</p>
                   7955: <p>A typical use is to update pkg-config files to include the rpath
                   7956: compiler options.</p>
                   7957: </dd>
                   7958: <dt><span class="term"><code class="literal">pre-install</code></span></dt>
                   7959: <dd><p>In general, the install phase should be as simple as
                   7960: possible. As with the pre-build and post-build stages, it should not be
                   7961: used to fix pathnames or user names, these belong in pre-configure
                   7962: instead. There are only few legitimate use cases for applying
                   7963: substitutions in this stage.</p></dd>
                   7964: </dl></div>
                   7965: </div>
                   7966: <div class="sect3">
                   7967: <div class="titlepage"><div><div><h4 class="title">
1.181     rillig   7968: <a name="fixes.subst.where"></a>21.1.11.2. Choosing the files where the substitutions happen</h4></div></div></div>
1.180     rillig   7969: <p>The <code class="varname">SUBST_FILES.*</code> variable contains a list of
                   7970: filename patterns. These patterns are relative to
                   7971: <code class="varname">WRKSRC</code> since that is where most substitutions happen.
                   7972: A typical example is:</p>
                   7973: <pre class="programlisting">
                   7974: SUBST_FILES.path=       Makefile */Makefile */*/Makefile *.[ch]
                   7975: </pre>
                   7976: <p>The above patterns, especially the last, are quite broad. The SUBST
                   7977: implementation checks that each filename pattern that is mentioned here
                   7978: has an effect. For example, if none of the
                   7979: <code class="filename">*/*/Makefile</code> files contains the patterns to be found
                   7980: and substituted, that filename pattern is redundant and should be left
1.181     rillig   7981: out. By default, the SUBST framework will complain with an error message.
                   7982: If the text to be substituted occurs in some of the files from a single
                   7983: pattern, but not in all of them, that is totally ok, and the SUBST
1.180     rillig   7984: framework will only print an INFO message for those files.</p>
                   7985: <p>If there is a good reason for having redundant filename patterns,
1.181     rillig   7986: set <code class="varname">SUBST_NOOP_OK.*</code> to <code class="literal">yes</code>.</p>
1.180     rillig   7987: <p>Another popular way of choosing the files for the substitutions is
                   7988: via a shell command, like this:</p>
                   7989: <pre class="programlisting">
1.181     rillig   7990: C_FILES_CMD=            cd ${WRKSRC} &amp;&amp; ${FIND} . -name '*.c'
1.180     rillig   7991: SUBST_FILES.path=       ${C_FILES_CMD:sh}
                   7992: </pre>
                   7993: <p>The variable name <code class="varname">C_FILES_CMD</code> in this example is
                   7994: freely chosen and independent of the SUBST framework.</p>
                   7995: <p>In this variant, the <code class="varname">SUBST_FILES.*</code> variable
                   7996: lists each file individually. Thereby chances are higher that there are
                   7997: filename patterns in which no substitution happens. Since the SUBST
                   7998: framework cannot know whether the filename patterns in
                   7999: <code class="varname">SUBST_FILES.*</code> have been explicitly listed in the
                   8000: Makefile (where any redundant filename pattern would be suspicious) or
                   8001: been generated by a shell command (in which redundant filename patterns
                   8002: are more likely and to be expected), it will complain about these
                   8003: redundant filename patterns. Therefore, SUBST blocks that use a shell
                   8004: command to generate the list of filename patterns often need to set
                   8005: <code class="varname">SUBST_NOOP_OK.*</code> to <code class="literal">yes</code>.</p>
                   8006: </div>
                   8007: <div class="sect3">
                   8008: <div class="titlepage"><div><div><h4 class="title">
                   8009: <a name="fixes.subst.what"></a>21.1.11.3. Choosing what to substitute</h4></div></div></div>
                   8010: <p>In most cases, the substitutions are given using one or more
1.197     leot     8011: <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.180     rillig   8012: <pre class="programlisting">
                   8013: SUBST_SED.path=         -e 's|/usr/local|${PREFIX}|g'
                   8014: </pre>
                   8015: <p>Each of the sed commands needs to be preceded by the
                   8016: <code class="literal">-e</code> option and should be specified on a line of its
                   8017: own, to avoid hiding short sed commands at the end of a line.</p>
                   8018: <p>Since the sed commands often contain shell metacharacters as the
                   8019: separator (the <code class="literal">|</code> in the above example), it is common
                   8020: to enclose them in single quotes.</p>
                   8021: <p>A common substitution is to replace placeholders of the form
                   8022: <code class="literal">@VARNAME@</code> with their pkgsrc counterpart variable
                   8023: <code class="literal">${VARNAME}</code>. A typical example is:</p>
                   8024: <pre class="programlisting">
                   8025: SUBST_VARS.path=        PREFIX
                   8026: </pre>
                   8027: <p>This type of substitutions is typically done by the GNU configure
1.181     rillig   8028: scripts during the do-configure stage, but in some cases these need to be
                   8029: overridden. The same pattern is also used when a package defines patches
                   8030: that replace previously hard-coded paths like
                   8031: <code class="literal">/usr/local</code> with a <code class="literal">@PREFIX@</code>
                   8032: placeholder first, which then gets substituted by the actual
                   8033: <code class="literal">${PREFIX}</code> in the pre-configure stage. In many of these
                   8034: cases, it works equally well to just use the SUBST framework to directly
                   8035: replace <code class="literal">/usr/local</code> with <code class="literal">${PREFIX}</code>,
                   8036: thereby omitting the intermediate patch file.</p>
1.180     rillig   8037: <p>If the above is not flexible enough, it is possible to not use sed
                   8038: at all for the substitution but to specify an entirely different command,
                   8039: like this:</p>
1.1       dsieger  8040: <pre class="programlisting">
1.180     rillig   8041: SUBST_FILTER_CMD.path=  LC_ALL=C ${TR} -d '\r'
                   8042: </pre>
                   8043: <p>This is used for the few remaining packages in which the
                   8044: distributed files use Windows-style line endings that need to be
                   8045: converted to UNIX-style line endings.</p>
                   8046: </div>
                   8047: <div class="sect3">
                   8048: <div class="titlepage"><div><div><h4 class="title">
                   8049: <a name="fixes.subst.other"></a>21.1.11.4. Other SUBST variables</h4></div></div></div>
                   8050: <p>When a SUBST block is applied during a package build, a message is
                   8051: logged. The default message is fine for most purposes but can be
                   8052: overridden by setting <code class="literal">SUBST_MESSAGE.*</code> to an individual
                   8053: message.</p>
                   8054: </div>
1.1       dsieger  8055: </div>
                   8056: </div>
1.41      asau     8057: <div class="sect1">
1.1       dsieger  8058: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   8059: <a name="fixes.fetch"></a>21.2. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.41      asau     8060: <div class="sect2">
1.1       dsieger  8061: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8062: <a name="no-plain-download"></a>21.2.1. Packages whose distfiles aren't available for plain downloading</h3></div></div></div>
1.1       dsieger  8063: <p>If you need to download from a dynamic URL you can set
1.10      hubertf  8064:     <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.1       dsieger  8065:     fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
                   8066:     with the name of each file to download as an argument, expecting
                   8067:     it to output the URL of the directory from which to download
1.137     leot     8068:     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.1       dsieger  8069:     example of this usage.</p>
                   8070: <p>If the download can't be automated, because the user must
                   8071:     submit personal information to apply for a password, or must pay
                   8072:     for the source, or whatever, you can set
                   8073:     <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
                   8074:     displayed to the user before aborting the build. Example:</p>
                   8075: <pre class="programlisting">
                   8076: FETCH_MESSAGE=  "Please download the files"
                   8077: FETCH_MESSAGE+= "    "${DISTFILES:Q}
                   8078: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.111     sevan    8079: </pre>
1.1       dsieger  8080: </div>
1.41      asau     8081: <div class="sect2">
1.1       dsieger  8082: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8083: <a name="modified-distfiles-same-name"></a>21.2.2. How to handle modified distfiles with the 'old' name</h3></div></div></div>
1.1       dsieger  8084: <p>Sometimes authors of a software package make some
                   8085:     modifications after the software was released, and they put up a
                   8086:     new distfile without changing the package's version number. If a
                   8087:     package is already in pkgsrc at that time, the checksum will
                   8088:     no longer match. The contents of the new distfile should be
                   8089:     compared against the old one before changing anything, to make
                   8090:     sure the distfile was really updated on purpose, and that
                   8091:     no trojan horse or so crept in.
                   8092:     Please mention that the distfiles were compared and what was found
1.53      rodent   8093:     in your commit message.</p>
1.109     wiz      8094: <p>Then, the correct way to work around this is to set
                   8095:     <code class="varname">DIST_SUBDIR</code> to a unique directory name, usually
                   8096:     based on <code class="varname">PKGNAME_NOREV</code> (but take care with
                   8097:     python or ruby packages, where <code class="varname">PKGNAME</code> includes
                   8098:     a variable prefix). All <code class="varname">DISTFILES</code> and
1.1       dsieger  8099:     <code class="varname">PATCHFILES</code> for this package will be put in that
1.154     rillig   8100:     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.1       dsieger  8101:     happens more often, <code class="varname">PKGNAME</code> can be used (thus
1.109     wiz      8102:     including the <code class="filename">nbX</code> suffix) or a date stamp can
                   8103:     be appended, like
                   8104:     <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.</p>
1.169     rillig   8105: <p><code class="varname">DIST_SUBDIR</code> is also used when a distfile's
                   8106:     name does not contain a version and the distfile is apt to change. In
                   8107:     cases where the likelihood of this is very small,
                   8108:     <code class="varname">DIST_SUBDIR</code> might not be required. Additionally,
                   8109:     <code class="varname">DIST_SUBDIR</code> must not be removed unless the
                   8110:     distfile name changes, even if a package is being moved or
                   8111:     renamed.</p>
1.53      rodent   8112: <p>Do not forget regenerating the <code class="filename">distinfo</code> file
1.1       dsieger  8113:     after that, since it contains the <code class="varname">DIST_SUBDIR</code>
                   8114:     path in the filenames.
1.53      rodent   8115:     Also, increase the PKGREVISION if the installed package is different.
1.1       dsieger  8116:     Furthermore, a mail to the package's authors seems appropriate
                   8117:     telling them that changing distfiles after releases without
                   8118:     changing the file names is not good practice.</p>
                   8119: </div>
1.88      tnn      8120: <div class="sect2">
                   8121: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8122: <a name="build.fetch.github"></a>21.2.3. Packages hosted on github.com</h3></div></div></div>
1.169     rillig   8123: <p>Helper methods exist for packages hosted on github.com which
                   8124:     will often have distfile names that clash with other packages, for
                   8125:     example <code class="filename">1.0.tar.gz</code>. Use one of the three recipes
                   8126:     from below:</p>
1.88      tnn      8127: <div class="sect3">
                   8128: <div class="titlepage"><div><div><h4 class="title">
1.154     rillig   8129: <a name="build.fetch.github.tag"></a>21.2.3.1. Fetch based on a tagged release</h4></div></div></div>
1.169     rillig   8130: <p>If your distfile URL looks similar to
1.189     bacon    8131:       <code class="literal">https://github.com/username/example/archive/v1.0.zip</code>,
1.169     rillig   8132:       then you are packaging a tagged release.</p>
1.88      tnn      8133: <pre class="programlisting">
1.189     bacon    8134: DISTNAME=       example-1.0
1.90      tnn      8135: MASTER_SITES=   ${MASTER_SITE_GITHUB:=username/}
1.189     bacon    8136: #GITHUB_PROJECT= example    # can be omitted if same as DISTNAME
1.90      tnn      8137: GITHUB_TAG=     v${PKGVERSION_NOREV}
1.88      tnn      8138: EXTRACT_SUFX=   .zip
                   8139: </pre>
                   8140: </div>
                   8141: <div class="sect3">
                   8142: <div class="titlepage"><div><div><h4 class="title">
1.189     bacon    8143: <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>
                   8144: <p>If your distfile looks similar to
                   8145:       <code class="literal">https://github.com/username/example/archive/988881adc9fc3655077dc2d4d757d480b5ea0e11</code> and is from a commit before the first
                   8146:       release, then set the package version to 0.0.0.N, where N is the number
                   8147:       of commits to the repository, and set GITHUB_TAG to the commit hash.
                   8148:       This will (almost) ensure that the first tagged release will have a
                   8149:       version greater than this one so that package upgrades will function
                   8150:       properly.</p>
                   8151: <pre class="programlisting">
                   8152: DISTNAME=       example-0.0.0.347
                   8153: MASTER_SITES=   ${MASTER_SITE_GITHUB:=username/}
                   8154: #GITHUB_PROJECT= example    # can be omitted if same as DISTNAME
                   8155: GITHUB_TAG=     988881adc9fc3655077dc2d4d757d480b5ea0e11
                   8156: </pre>
                   8157: </div>
                   8158: <div class="sect3">
                   8159: <div class="titlepage"><div><div><h4 class="title">
                   8160: <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>
                   8161: <p>If your distfile looks similar to
                   8162:       <code class="literal">https://github.com/username/example/archive/988881adc9fc3655077dc2d4d757d480b5ea0e11</code> and is from a commit after a release,
                   8163:       then include the last release version and the commit count since that
                   8164:       release in the package version and set GITHUB_TAG to the commit hash.
                   8165:       The latest release and commit count are shown in the output of
                   8166:       "git describe --tags":
                   8167:       </p>
                   8168: <pre class="screen">
                   8169: # git clone https://github.com/username/example
                   8170: # cd example
                   8171: # git describe --tags
                   8172: 1.2.3-5-g988881a
                   8173: </pre>
1.88      tnn      8174: <pre class="programlisting">
1.189     bacon    8175: DISTNAME=       example-1.2.3.5
                   8176: MASTER_SITES=   ${MASTER_SITE_GITHUB:=username/}
                   8177: #GITHUB_PROJECT= example    # can be omitted if same as DISTNAME
1.90      tnn      8178: GITHUB_TAG=     988881adc9fc3655077dc2d4d757d480b5ea0e11
1.111     sevan    8179: </pre>
1.88      tnn      8180: </div>
                   8181: <div class="sect3">
                   8182: <div class="titlepage"><div><div><h4 class="title">
1.189     bacon    8183: <a name="build.fetch.github.release"></a>21.2.3.4. Fetch based on release</h4></div></div></div>
1.169     rillig   8184: <p>If your distfile URL looks similar to
1.189     bacon    8185:       <code class="literal">https://github.com/username/example/releases/download/rel-1.6/offensive-1.6.zip</code>,
1.169     rillig   8186:       then you are packaging a release.</p>
1.88      tnn      8187: <pre class="programlisting">
                   8188: DISTNAME=       offensive-1.6
1.90      tnn      8189: PKGNAME=        ${DISTNAME:S/offensive/proper/}
                   8190: MASTER_SITES=   ${MASTER_SITE_GITHUB:=username/}
1.189     bacon    8191: GITHUB_PROJECT= example
1.90      tnn      8192: GITHUB_RELEASE= rel-${PKGVERSION_NOREV} # usually just set this to ${DISTNAME}
                   8193: EXTRACT_SUFX=   .zip
1.111     sevan    8194: </pre>
1.88      tnn      8195: </div>
                   8196: </div>
1.1       dsieger  8197: </div>
1.41      asau     8198: <div class="sect1">
1.1       dsieger  8199: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   8200: <a name="fixes.configure"></a>21.3. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.41      asau     8201: <div class="sect2">
1.1       dsieger  8202: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8203: <a name="fixes.libtool"></a>21.3.1. Shared libraries - libtool</h3></div></div></div>
1.1       dsieger  8204: <p>pkgsrc supports many different machines, with different
                   8205:     object formats like a.out and ELF, and varying abilities to do
                   8206:     shared library and dynamic loading at all. To accompany this,
                   8207:     varying commands and options have to be passed to the
                   8208:     compiler, linker, etc. to get the Right Thing, which can be
                   8209:     pretty annoying especially if you don't have all the machines
                   8210:     at your hand to test things.  The
1.137     leot     8211:     <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.23      wiz      8212:     can help here, as it just <span class="quote">&#8220;<span class="quote">knows</span>&#8221;</span> how to build
1.1       dsieger  8213:     both static and dynamic libraries from a set of source files,
                   8214:     thus being platform-independent.</p>
                   8215: <p>Here's how to use libtool in a package in seven simple
                   8216:     steps:</p>
1.23      wiz      8217: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8218: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.1       dsieger  8219:        Makefile.</p></li>
1.23      wiz      8220: <li class="listitem"><p>For library objects, use <span class="quote">&#8220;<span class="quote">${LIBTOOL} --mode=compile
                   8221:        ${CC}</span>&#8221;</span> in place of <span class="quote">&#8220;<span class="quote">${CC}</span>&#8221;</span>. You could even
1.1       dsieger  8222:        add it to the definition of <code class="varname">CC</code>, if only
                   8223:        libraries are being built in a given Makefile. This one command
                   8224:        will build both PIC and non-PIC library objects, so you need not
                   8225:        have separate shared and non-shared library rules.</p></li>
1.23      wiz      8226: <li class="listitem">
1.1       dsieger  8227: <p>For the linking of the library, remove any
1.23      wiz      8228:        <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
                   8229:        -Bshareable</span>&#8221;</span> commands, and instead use:</p>
1.1       dsieger  8230: <pre class="programlisting">
                   8231: ${LIBTOOL} --mode=link \
                   8232:     ${CC} -o ${.TARGET:.a=.la} \
                   8233:         ${OBJS:.o=.lo} \
                   8234:         -rpath ${PREFIX}/lib \
                   8235:         -version-info major:minor
1.111     sevan    8236: </pre>
1.1       dsieger  8237: <p>Note that the library is changed to have a
                   8238:        <code class="filename">.la</code> extension, and the objects are
                   8239:        changed to have a <code class="filename">.lo</code>
                   8240:        extension. Change <code class="varname">OBJS</code> as
                   8241:        necessary. This automatically creates all of the
                   8242:        <code class="filename">.a</code>,
                   8243:        <code class="filename">.so.major.minor</code>, and ELF symlinks (if
                   8244:        necessary) in the build directory. Be sure to include
1.23      wiz      8245:        <span class="quote">&#8220;<span class="quote">-version-info</span>&#8221;</span>, especially when major and
1.1       dsieger  8246:        minor are zero, as libtool will otherwise strip off the
                   8247:        shared library version.</p>
                   8248: <p>From the libtool manual:</p>
                   8249: <pre class="programlisting">
                   8250: So, libtool library versions are described by three integers:
                   8251: 
                   8252: CURRENT
                   8253: The most recent interface number that this library implements.
                   8254: 
                   8255: REVISION
                   8256: The implementation number of the CURRENT interface.
                   8257: 
                   8258: AGE
                   8259: The difference between the newest and oldest interfaces that
                   8260: this library implements.  In other words, the library implements
                   8261: all the interface numbers in the range from number `CURRENT -
                   8262: AGE' to `CURRENT'.
                   8263: 
                   8264: If two libraries have identical CURRENT and AGE numbers, then the
                   8265: dynamic linker chooses the library with the greater REVISION number.
1.111     sevan    8266: </pre>
1.23      wiz      8267: <p>The <span class="quote">&#8220;<span class="quote">-release</span>&#8221;</span> option will produce
1.1       dsieger  8268:        different results for a.out and ELF (excluding symlinks)
                   8269:        in only one case. An ELF library of the form
1.23      wiz      8270:        <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.1       dsieger  8271:        will have a symlink of
1.23      wiz      8272:        <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.1       dsieger  8273:        on an a.out platform. This is handled
                   8274:        automatically.</p>
1.23      wiz      8275: <p>The <span class="quote">&#8220;<span class="quote">-rpath argument</span>&#8221;</span> is the install
1.1       dsieger  8276:        directory of the library being built.</p>
                   8277: <p>In the <code class="filename">PLIST</code>, include only the
                   8278:        <code class="filename">.la</code> file, the other files will be
                   8279:        added automatically.</p>
                   8280: </li>
1.23      wiz      8281: <li class="listitem">
1.1       dsieger  8282: <p>When linking shared object (<code class="filename">.so</code>)
1.197     leot     8283:        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.23      wiz      8284:        shared libraries, use <span class="quote">&#8220;<span class="quote">-module
                   8285:        -avoid-version</span>&#8221;</span> to prevent them getting version
1.1       dsieger  8286:        tacked on.</p>
                   8287: <p>The <code class="filename">PLIST</code> file gets the
                   8288:        <code class="filename">foo.so</code> entry.</p>
                   8289: </li>
1.23      wiz      8290: <li class="listitem">
1.1       dsieger  8291: <p>When linking programs that depend on these libraries
                   8292:        <span class="emphasis"><em>before</em></span> they are installed, preface
1.197     leot     8293:        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.23      wiz      8294:        --mode=link</span>&#8221;</span>, and it will find the correct
1.1       dsieger  8295:        libraries (static or shared), but please be aware that
                   8296:        libtool will not allow you to specify a relative path in
1.23      wiz      8297:        -L (such as <span class="quote">&#8220;<span class="quote">-L../somelib</span>&#8221;</span>), because it
1.1       dsieger  8298:        expects you to change that argument to be the
                   8299:        <code class="filename">.la</code> file. e.g.</p>
                   8300: <pre class="programlisting">
                   8301: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.111     sevan    8302: </pre>
1.1       dsieger  8303: <p>should be changed to:</p>
                   8304: <pre class="programlisting">
                   8305: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.111     sevan    8306: </pre>
1.1       dsieger  8307: <p>and it will do the right thing with the libraries.</p>
                   8308: </li>
1.23      wiz      8309: <li class="listitem">
1.197     leot     8310: <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>
                   8311:        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.23      wiz      8312:        --mode=install</span>&#8221;</span>, and change the library name to
1.1       dsieger  8313:        <code class="filename">.la</code>. e.g.</p>
                   8314: <pre class="programlisting">
1.22      jakllsch 8315: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.111     sevan    8316: </pre>
1.1       dsieger  8317: <p>This will install the static <code class="filename">.a</code>,
                   8318:        shared library, any needed symlinks, and run
1.197     leot     8319:        <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.1       dsieger  8320: </li>
1.23      wiz      8321: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.1       dsieger  8322:        the <code class="filename">.la</code>
                   8323:        file (this is a change from previous behaviour).</p></li>
                   8324: </ol></div>
                   8325: </div>
1.41      asau     8326: <div class="sect2">
1.1       dsieger  8327: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8328: <a name="using-libtool"></a>21.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.1       dsieger  8329: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
                   8330:     package Makefile. This will override the package's own libtool
                   8331:     in most cases.  For older libtool using packages,  libtool is
                   8332:     made by ltconfig script during the do-configure step; you can
1.10      hubertf  8333:     check the libtool script location by doing <span class="command"><strong>make
1.1       dsieger  8334:     configure; find work*/ -name libtool</strong></span>.</p>
                   8335: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
                   8336:     scripts, relative to <code class="varname">WRKSRC</code>, to override.  By
1.23      wiz      8337:     default, it is set to <span class="quote">&#8220;<span class="quote">libtool */libtool
                   8338:     */*/libtool</span>&#8221;</span>.  If this does not match the location of the
1.1       dsieger  8339:     package's libtool script(s), set it as appropriate.</p>
                   8340: <p>If you do not need <code class="filename">*.a</code> static
                   8341:     libraries built and installed, then use
                   8342:     <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
                   8343: <p>If your package makes use of the platform-independent library
                   8344:     for loading dynamic shared objects, that comes with libtool
                   8345:     (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
                   8346: <p>Some packages use libtool incorrectly so that the package
                   8347:     may not work or build in some circumstances. Some of the more
                   8348:     common errors are:</p>
1.41      asau     8349: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      8350: <li class="listitem">
1.1       dsieger  8351: <p>The inclusion of a shared object (-module) as a dependent library in an
                   8352:        executable or library. This in itself isn't a problem if one of two things
                   8353:        has been done:</p>
1.23      wiz      8354: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8355: <li class="listitem"><p>The shared object is named correctly, i.e.
1.1       dsieger  8356:            <code class="filename">libfoo.la</code>, not
                   8357:            <code class="filename">foo.la</code></p></li>
1.23      wiz      8358: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.1       dsieger  8359: </ol></div>
                   8360: </li>
1.23      wiz      8361: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.1       dsieger  8362:        The function lt_dlinit() should be called and the macro
                   8363:        <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
                   8364:        executables.</p></li>
                   8365: </ul></div>
                   8366: </div>
1.41      asau     8367: <div class="sect2">
1.1       dsieger  8368: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8369: <a name="autoconf-automake"></a>21.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.1       dsieger  8370: <p>If a package needs GNU autoconf or automake to be executed
                   8371:     to regenerate the configure script and Makefile.in makefile
                   8372:     templates, then they should be executed in a pre-configure
                   8373:     target.</p>
                   8374: <p>For packages that need only autoconf:</p>
                   8375: <pre class="programlisting">
                   8376: AUTOCONF_REQD=  2.50            # if default version is not good enough
                   8377: USE_TOOLS+=     autoconf        # use "autoconf213" for autoconf-2.13
                   8378: ...
                   8379: 
                   8380: pre-configure:
                   8381:         cd ${WRKSRC} &amp;&amp; autoconf
                   8382: 
                   8383: ...
1.111     sevan    8384: </pre>
1.1       dsieger  8385: <p>and for packages that need automake and autoconf:</p>
                   8386: <pre class="programlisting">
                   8387: AUTOMAKE_REQD=  1.7.1           # if default version is not good enough
                   8388: USE_TOOLS+=     automake        # use "automake14" for automake-1.4
                   8389: ...
                   8390: 
                   8391: pre-configure:
                   8392:         set -e; cd ${WRKSRC}; \
                   8393:         aclocal; autoheader; automake -a --foreign -i; autoconf
                   8394: 
                   8395: ...
1.111     sevan    8396: </pre>
1.1       dsieger  8397: <p>Packages which use GNU Automake will almost certainly
                   8398:     require GNU Make.</p>
                   8399: <p>There are times when the configure process makes
                   8400:     additional changes to the generated files, which then causes
                   8401:     the build process to try to re-execute the automake sequence.
                   8402:     This is prevented by touching various files in the configure
                   8403:     stage. If this causes problems with your package you can set
                   8404:     <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
                   8405:     Makefile.</p>
                   8406: </div>
                   8407: </div>
1.41      asau     8408: <div class="sect1">
1.1       dsieger  8409: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   8410: <a name="programming-languages"></a>21.4. Programming languages</h2></div></div></div>
1.41      asau     8411: <div class="sect2">
1.1       dsieger  8412: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8413: <a name="basic-programming-languages"></a>21.4.1. C, C++, and Fortran</h3></div></div></div>
1.1       dsieger  8414: <p>Compilers for the C, C++, and Fortran languages comes with
                   8415:     the NetBSD base system.  By default, pkgsrc assumes that a package
                   8416:     is written in C and will hide all other compilers (via the wrapper
1.184     rillig   8417:     framework, see <a class="xref" href="#buildlink" title="Chapter 18. Buildlink methodology">Chapter 18, <i>Buildlink methodology</i></a>).</p>
1.1       dsieger  8418: <p>To declare which language's compiler a package needs, set
                   8419:     the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.23      wiz      8420:     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
                   8421:     <span class="quote">&#8220;<span class="quote">fortran</span>&#8221;</span> (and any combination).  The default is
                   8422:     <span class="quote">&#8220;<span class="quote">c</span>&#8221;</span>.  Packages using GNU configure scripts, even if
1.1       dsieger  8423:     written in C++, usually need a C compiler for the configure
                   8424:     phase.</p>
                   8425: </div>
1.41      asau     8426: <div class="sect2">
1.1       dsieger  8427: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8428: <a name="java-programming-language"></a>21.4.2. Java</h3></div></div></div>
1.1       dsieger  8429: <p>If a program is written in Java, use the Java framework in
                   8430:     pkgsrc.  The package must include
                   8431:     <code class="filename">../../mk/java-vm.mk</code>.  This Makefile fragment
                   8432:     provides the following variables:</p>
1.41      asau     8433: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      8434: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.1       dsieger  8435:       dependency on the JDK is added.  If
1.23      wiz      8436:       <code class="varname">USE_JAVA</code> is set to <span class="quote">&#8220;<span class="quote">run</span>&#8221;</span>, then
1.1       dsieger  8437:       there is only a runtime dependency on the JDK.  The default is
1.23      wiz      8438:       <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>, which also adds a build dependency on the
1.1       dsieger  8439:       JDK.</p></li>
1.23      wiz      8440: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.1       dsieger  8441:       a package needs a Java2 implementation.  The supported values
1.23      wiz      8442:       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
                   8443:       <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
                   8444:       implementation, <span class="quote">&#8220;<span class="quote">1.4</span>&#8221;</span> insists on versions 1.4 or
                   8445:       above, and <span class="quote">&#8220;<span class="quote">1.5</span>&#8221;</span> only accepts versions 1.5 or
1.1       dsieger  8446:       above. This variable is not set by default.</p></li>
1.24      wiz      8447: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
                   8448:       automatically set to the runtime location of the used Java
                   8449:       implementation dependency. It may be used to set
                   8450:       <code class="varname">JAVA_HOME</code> to a good value if the program
                   8451:       needs this variable to be defined.
                   8452:       </p></li>
1.1       dsieger  8453: </ul></div>
                   8454: </div>
1.41      asau     8455: <div class="sect2">
1.1       dsieger  8456: <div class="titlepage"><div><div><h3 class="title">
1.203   ! nia      8457: <a name="perl-scripts"></a>21.4.3. Packages containing Perl scripts</h3></div></div></div>
        !          8458: <p>If your package contains interpreted Perl scripts, add
1.23      wiz      8459:     <span class="quote">&#8220;<span class="quote">perl</span>&#8221;</span> to the <code class="varname">USE_TOOLS</code> variable
1.1       dsieger  8460:     and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
                   8461:     interpreter path is set. <code class="varname">REPLACE_PERL</code> should
                   8462:     contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
1.74      wiz      8463:     that you want adjusted. Every occurrence of
                   8464:     <code class="filename">*/bin/perl</code> in a she-bang line will be
                   8465:     replaced with the full path to the perl executable.</p>
1.1       dsieger  8466: <p>If a particular version of perl is needed, set the
                   8467:     <code class="varname">PERL5_REQD</code> variable to the version number.  The
1.23      wiz      8468:     default is <span class="quote">&#8220;<span class="quote">5.0</span>&#8221;</span>.</p>
1.203   ! nia      8469: <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.1       dsieger  8470:     about handling perl modules.</p>
                   8471: </div>
1.41      asau     8472: <div class="sect2">
1.1       dsieger  8473: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8474: <a name="shell-scripts"></a>21.4.4. Packages containing shell scripts</h3></div></div></div>
1.40      wiz      8475: <p><code class="varname">REPLACE_SH</code>,
                   8476:     <code class="varname">REPLACE_BASH</code>, <code class="varname">REPLACE_CSH</code>,
                   8477:     and <code class="varname">REPLACE_KSH</code> can be used to replace shell
1.195     gutterid 8478:     hash bangs in files. Please use the appropriate one, preferring
1.40      wiz      8479:     <code class="varname">REPLACE_SH</code> in case this shell is sufficient.
1.74      wiz      8480:     Each should contain a list of scripts, relative to
                   8481:     <code class="varname">WRKSRC</code>, that you want adjusted. Every
                   8482:     occurrence of the matching shell in a she-bang line will be
                   8483:     replaced with the full path to the shell executable.
1.40      wiz      8484:     When using <code class="varname">REPLACE_BASH</code>, don't forget to add
                   8485:     <code class="filename">bash</code> to <code class="varname">USE_TOOLS</code>.</p>
                   8486: </div>
1.41      asau     8487: <div class="sect2">
1.40      wiz      8488: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8489: <a name="other-programming-languages"></a>21.4.5. Other programming languages</h3></div></div></div>
1.1       dsieger  8490: <p>Currently, there is no special handling for other languages
                   8491:     in pkgsrc.  If a compiler package provides a
                   8492:     <code class="filename">buildlink3.mk</code> file, include that, otherwise
                   8493:     just add a (build) dependency on the appropriate compiler
                   8494:     package.</p>
                   8495: </div>
                   8496: </div>
1.41      asau     8497: <div class="sect1">
1.1       dsieger  8498: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   8499: <a name="fixes.build"></a>21.5. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.1       dsieger  8500: <p>The most common failures when building a package are that
                   8501:        some platforms do not provide certain header files, functions or
                   8502:        libraries, or they provide the functions in a library that the
                   8503:        original package author didn't know. To work around this, you
                   8504:        can rewrite the source code in most cases so that it does not
                   8505:        use the missing functions or provides a replacement function.</p>
1.41      asau     8506: <div class="sect2">
1.1       dsieger  8507: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8508: <a name="fixes.build.cpp"></a>21.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.1       dsieger  8509: <p>If a package already comes with a GNU configure script, the
                   8510:        preferred way to fix the build failure is to change the
                   8511:        configure script, not the code. In the other cases, you can
                   8512:        utilize the C preprocessor, which defines certain macros
                   8513:        depending on the operating system and hardware architecture it
                   8514:        compiles for. These macros can be queried using for example
                   8515:        <code class="varname">#if defined(__i386)</code>. Almost every operating
                   8516:        system, hardware architecture and compiler has its own macro.
                   8517:        For example, if the macros <code class="varname">__GNUC__</code>,
                   8518:        <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
                   8519:        are all defined, you know that you are using NetBSD on an i386
                   8520:        compatible CPU, and your compiler is GCC.</p>
                   8521: <p>The list of the following macros for hardware and
                   8522:        operating system depends on the compiler that is used. For
                   8523:        example, if you want to conditionally compile code on Solaris,
                   8524:        don't use <code class="varname">__sun__</code>, as the SunPro compiler
                   8525:        does not define it. Use <code class="varname">__sun</code> instead.</p>
1.41      asau     8526: <div class="sect3">
1.1       dsieger  8527: <div class="titlepage"><div><div><h4 class="title">
1.154     rillig   8528: <a name="fixes.build.cpp.os"></a>21.5.1.1. C preprocessor macros to identify the operating system</h4></div></div></div>
1.1       dsieger  8529: <p>To distinguish between 4.4 BSD-derived systems and the
                   8530:         rest of the world, you should use the following code.</p>
                   8531: <pre class="programlisting">
                   8532: #include &lt;sys/param.h&gt;
                   8533: #if (defined(BSD) &amp;&amp; BSD &gt;= 199306)
                   8534: /* BSD-specific code goes here */
                   8535: #else
                   8536: /* non-BSD-specific code goes here */
                   8537: #endif
                   8538: </pre>
                   8539: <p>If this distinction is not fine enough, you can also test
                   8540:        for the following macros.</p>
                   8541: <pre class="programlisting">
1.45      obache   8542: Cygwin      __CYGWIN__
                   8543: DragonFly   __DragonFly__
1.1       dsieger  8544: FreeBSD     __FreeBSD__
1.45      obache   8545: Haiku       __HAIKU__
1.1       dsieger  8546: Interix     __INTERIX
                   8547: IRIX        __sgi (TODO: get a definite source for this)
                   8548: Linux       linux, __linux, __linux__
1.83      dholland 8549: Mac OS X    __APPLE__
1.45      obache   8550: MirBSD      __MirBSD__ (__OpenBSD__ is also defined)
                   8551: Minix3      __minix
1.1       dsieger  8552: NetBSD      __NetBSD__
                   8553: OpenBSD     __OpenBSD__
                   8554: Solaris     sun, __sun
                   8555: </pre>
                   8556: </div>
1.41      asau     8557: <div class="sect3">
1.1       dsieger  8558: <div class="titlepage"><div><div><h4 class="title">
1.154     rillig   8559: <a name="fixes.build.cpp.arch"></a>21.5.1.2. C preprocessor macros to identify the hardware architecture</h4></div></div></div>
1.1       dsieger  8560: <pre class="programlisting">
                   8561: i386        i386, __i386, __i386__
                   8562: MIPS        __mips
                   8563: SPARC       sparc, __sparc
                   8564: </pre>
                   8565: </div>
1.41      asau     8566: <div class="sect3">
1.1       dsieger  8567: <div class="titlepage"><div><div><h4 class="title">
1.154     rillig   8568: <a name="fixes.build.cpp.compiler"></a>21.5.1.3. C preprocessor macros to identify the compiler</h4></div></div></div>
1.1       dsieger  8569: <pre class="programlisting">
                   8570: GCC         __GNUC__ (major version), __GNUC_MINOR__
                   8571: MIPSpro     _COMPILER_VERSION (0x741 for MIPSpro 7.41)
                   8572: SunPro      __SUNPRO_C (0x570 for Sun C 5.7)
                   8573: SunPro C++  __SUNPRO_CC (0x580 for Sun C++ 5.8)
                   8574: </pre>
                   8575: </div>
                   8576: </div>
1.41      asau     8577: <div class="sect2">
1.1       dsieger  8578: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8579: <a name="compiler-bugs"></a>21.5.2. How to handle compiler bugs</h3></div></div></div>
1.1       dsieger  8580: <p>Some source files trigger bugs in the compiler, based on
                   8581:         combinations of compiler version and architecture and almost
                   8582:         always relation to optimisation being enabled.  Common symptoms
                   8583:         are gcc internal errors or never finishing compiling a
                   8584:        file.</p>
                   8585: <p>Typically, a workaround involves testing the
                   8586:         <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
                   8587:         optimisation for that combination of file,
1.87      tnn      8588:        <code class="varname">MACHINE_ARCH</code> and compiler.</p>
                   8589: <p>This used to be a big problem in the past, but is rarely
                   8590:        needed now as compiler technology has matured. If you still need
                   8591:        to add a compiler specific workaround, please do so in the file
                   8592:        <code class="filename">hacks.mk</code> and describe the symptom and
                   8593:        compiler version as detailed as possible.</p>
1.1       dsieger  8594: </div>
1.41      asau     8595: <div class="sect2">
1.1       dsieger  8596: <div class="titlepage"><div><div><h3 class="title">
1.172     rillig   8597: <a name="fixes.build.header"></a>21.5.3. No such file or directory</h3></div></div></div>
                   8598: <p>Compilation sometimes fails with an error message like this:</p>
                   8599: <pre class="programlisting">
                   8600: .../x11/gtk3/work/gtk+-3.24.12/gdk/gdktypes.h:35:10:
                   8601:     fatal error: pango/pango.h: No such file or directory
                   8602: </pre>
                   8603: <p>The proper way to fix this problem depends on the type of the
                   8604: header, which is described in the following sections.</p>
                   8605: <div class="sect3">
                   8606: <div class="titlepage"><div><div><h4 class="title">
                   8607: <a name="fixes.build.header.bl3"></a>21.5.3.1. Headers from other packages</h4></div></div></div>
                   8608: <p>If the header name looks like it comes from a different package,
                   8609: that other package should be included via the buildlink3
                   8610: framework.</p>
                   8611: <p>First, look whether the header is somewhere in the buildlink3
                   8612: directory below <code class="varname">WRKDIR</code>. In the above case of
                   8613: the missing Pango header:</p>
                   8614: <pre class="programlisting">
                   8615: <code class="prompt">$</code> find work/.buildlink/ -print | grep -F pango/pango.h
                   8616: </pre>
                   8617: <p>In the case of Pango, the output is:</p>
                   8618: <pre class="programlisting">
                   8619: work/.buildlink/include/pango-1.0/pango/pango.h
                   8620: </pre>
                   8621: <p>If the <code class="filename">pango/pango.h</code> file were placed directly
                   8622: in the <code class="filename">.buildlink</code> directory, it would have been
                   8623: found automatically. There is an extra <code class="filename">pango-1.0</code>
                   8624: path component though, which means that the compiler command line must
                   8625: contain an option of the form
                   8626: <code class="literal">-I${BUILDLINK3_PREFIX.pango}/include/pango-1.0</code>. In
                   8627: most cases this option is generated by the configure script, which can be examined using:</p>
                   8628: <pre class="programlisting">
                   8629: <code class="prompt">$</code> $ grep -o '[-]I[^[:space:]]*/pango[^[:space:]]*' work/*/Makefile
                   8630: -I/usr/pkg/include/pango-1.0
                   8631: -I/usr/pkg/include/pango-1.0
                   8632: -I/usr/pkg/include/pango-1.0
                   8633: -I/usr/pkg/include/pango-1.0
                   8634: -I/usr/pkg/include/pango-1.0
                   8635: </pre>
                   8636: <p>This looks good. These options are transformed by the buildlink
                   8637: wrapper to refer to the correct path inside
                   8638: <code class="filename">work/.buildlink</code>.</p>
                   8639: <p>Since the compilation fails though, examine the compiler command
                   8640: lines in <code class="filename">work/.work.log</code> to see whether the
                   8641: <code class="literal">-I</code> option is included in the particular command
                   8642: line.</p>
                   8643: <p>To further analyze the situation, run <span class="command"><strong>bmake
                   8644: build-env</strong></span>, which sets up an interactive, realistic environment
                   8645: including all the pkgsrc wrapper commands and environment variables. From
                   8646: there, try to compile some simple example programs that use the
                   8647: header.</p>
                   8648: </div>
                   8649: <div class="sect3">
                   8650: <div class="titlepage"><div><div><h4 class="title">
                   8651: <a name="fixes.build.header.gen"></a>21.5.3.2. Headers generated during the build</h4></div></div></div>
                   8652: <p>If the name of the header seems to come from the package itself,
                   8653: and if the build is run with parallel jobs, the package may have some
                   8654: undeclared dependencies between the <code class="filename">.c</code> and the
                   8655: <code class="filename">.h</code> files, and a C file is compiled before its
                   8656: required header is generated.</p>
                   8657: <p>To see whether the build runs with parallel jobs, run
                   8658: <span class="command"><strong>bmake show-all-build | grep JOBS</strong></span>. Its output looks
                   8659: like this:</p>
                   8660: <pre class="programlisting">
                   8661:   usr   MAKE_JOBS=              7
                   8662:   pkg   MAKE_JOBS_SAFE          # undefined
                   8663:   def   _MAKE_JOBS_N=           7
                   8664: </pre>
                   8665: <p>In this case the pkgsrc user has asked pkgsrc to build packages
                   8666: with 7 jobs in parallel (<code class="varname">MAKE_JOBS</code>). The
                   8667: package could have disabled parallel builds by setting
                   8668: <code class="varname">MAKE_JOBS_SAFE</code> to <code class="literal">no</code>, but
                   8669: in this case it hasn't.</p>
                   8670: <p>To see whether the build failure is caused by parallel builds,
                   8671: first save the exact error message and a bit of context, maybe you need
                   8672: it later for reporting a bug. Next, run:</p>
                   8673: <pre class="programlisting">
                   8674: MAKE_JOBS_SAFE=no bmake clean build
                   8675: </pre>
                   8676: <p>If that succeeds, <a class="ulink" href="https://www.NetBSD.org/cgi-bin/sendpr.cgi?gndb=netbsd" target="_top">file a bug
                   8677: report</a> against the pkgsrc package, including the exact error
                   8678: message and the contents of your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file.</p>
                   8679: </div>
1.173     rillig   8680: <div class="sect3">
                   8681: <div class="titlepage"><div><div><h4 class="title">
                   8682: <a name="fixes.build.header.symlink"></a>21.5.3.3. Symlinks</h4></div></div></div>
                   8683: <p>Pkgsrc does not work reliably if any of
                   8684: <code class="varname">LOCALBASE</code>, <code class="varname">VARBASE</code> or
                   8685: <code class="varname">WRKDIR</code> contains a symlink. Since 2019Q2, the pkgsrc
                   8686: bootstrap program prevents installing pkgsrc in symlink-based
                   8687: directories. Existing pkgsrc installations are not checked for symlinks
                   8688: though.</p>
                   8689: <p>The "No such file or directory" error messages are a typical
                   8690: symptom of symlinks, and it's quite difficult to find out that this is
                   8691: the actual cause.</p>
                   8692: </div>
                   8693: <div class="sect3">
                   8694: <div class="titlepage"><div><div><h4 class="title">
                   8695: <a name="fixes.build.header.stale"></a>21.5.3.4. Stale working directories</h4></div></div></div>
                   8696: <p>When building a hierarchy of packages, it may happen that one
                   8697: package is built and then pkgsrc is updated. This situation can provoke
                   8698: various hard to diagnose build errors. To clean up the situation:</p>
                   8699: <pre class="programlisting">
                   8700: <code class="prompt">$</code> (cd ../../ &amp;&amp; test -f mk/bsd.pkg.mk &amp;&amp; rm -rf */*/work)
                   8701: </pre>
                   8702: <p>(The test for <code class="filename">bsd.pkg.mk</code> just prevents running
                   8703: this command in the wrong directory.)</p>
                   8704: <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
                   8705: that directory as well.</p>
                   8706: </div>
                   8707: <div class="sect3">
                   8708: <div class="titlepage"><div><div><h4 class="title">
                   8709: <a name="fixes.build.header.misc"></a>21.5.3.5. Other possible reasons</h4></div></div></div>
                   8710: <p>On platforms other than BSD, third-party packages are installed in
                   8711: <code class="filename">/usr/include</code>, together with the base system. This
                   8712: means that pkgsrc cannot distinguish between headers provided by the base
                   8713: system (which it needs) and headers from third-party packages (which are
                   8714: often included in pkgsrc as well). This can lead to subtle version
                   8715: mismatches.</p>
                   8716: <p>In pkgsrc installations that have been active for several years, it
                   8717: may happen that some files are manually deleted. To exclude this unlikely
                   8718: reason, run <span class="command"><strong>pkg_admin check</strong></span>.</p>
                   8719: <p>It may help to run <span class="command"><strong>pkg_admin rebuild-tree</strong></span> to
                   8720: check/fix dependencies.</p>
                   8721: <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>
                   8722: for contact information. Be prepared to describe what you have tried so
                   8723: far and what any error messages were.</p>
                   8724: </div>
1.172     rillig   8725: </div>
                   8726: <div class="sect2">
                   8727: <div class="titlepage"><div><div><h3 class="title">
                   8728: <a name="undefined-reference"></a>21.5.4. Undefined reference to <span class="quote">&#8220;<span class="quote">...</span>&#8221;</span>
1.23      wiz      8729: </h3></div></div></div>
1.1       dsieger  8730: <p>This error message often means that a package did not
                   8731:        link to a shared library it needs. The following functions are
                   8732:        known to cause this error message over and over.</p>
                   8733: <div class="informaltable">
1.106     tnn      8734: <a name="undefined-reference-functions"></a><table class="informaltable" border="1">
1.1       dsieger  8735: <colgroup>
                   8736: <col>
                   8737: <col>
                   8738: <col>
                   8739: </colgroup>
                   8740: <thead><tr>
                   8741: <th>Function</th>
                   8742: <th>Library</th>
                   8743: <th>Affected platforms</th>
                   8744: </tr></thead>
                   8745: <tbody>
                   8746: <tr>
                   8747: <td>accept, bind, connect</td>
                   8748: <td>-lsocket</td>
                   8749: <td>Solaris</td>
                   8750: </tr>
                   8751: <tr>
                   8752: <td>crypt</td>
                   8753: <td>-lcrypt</td>
                   8754: <td>DragonFly, NetBSD</td>
                   8755: </tr>
                   8756: <tr>
                   8757: <td>dlopen, dlsym</td>
                   8758: <td>-ldl</td>
                   8759: <td>Linux</td>
                   8760: </tr>
                   8761: <tr>
                   8762: <td>gethost*</td>
                   8763: <td>-lnsl</td>
                   8764: <td>Solaris</td>
                   8765: </tr>
                   8766: <tr>
                   8767: <td>inet_aton</td>
                   8768: <td>-lresolv</td>
                   8769: <td>Solaris</td>
                   8770: </tr>
                   8771: <tr>
                   8772: <td>nanosleep, sem_*, timer_*</td>
                   8773: <td>-lrt</td>
                   8774: <td>Solaris</td>
                   8775: </tr>
                   8776: <tr>
                   8777: <td>openpty</td>
                   8778: <td>-lutil</td>
                   8779: <td>Linux</td>
                   8780: </tr>
                   8781: </tbody>
                   8782: </table>
                   8783: </div>
                   8784: <p>To fix these linker errors, it is often sufficient to say
                   8785:     <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
                   8786:     -l<em class="replaceable"><code>foo</code></em></code> to the package
1.10      hubertf  8787:     <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
1.1       dsieger  8788:     bmake</strong></span>.</p>
1.41      asau     8789: <div class="sect3">
1.1       dsieger  8790: <div class="titlepage"><div><div><h4 class="title">
1.172     rillig   8791: <a name="undefined-reference-sunpro"></a>21.5.4.1. Special issue: The SunPro compiler</h4></div></div></div>
1.1       dsieger  8792: <p>When you are using the SunPro compiler, there is another
                   8793: possibility. That compiler cannot handle the following code:</p>
                   8794: <pre class="programlisting">
                   8795: extern int extern_func(int);
                   8796: 
                   8797: static inline int
                   8798: inline_func(int x)
                   8799: {
                   8800:         return extern_func(x);
                   8801: }
                   8802: 
                   8803: int main(void)
                   8804: {
                   8805:         return 0;
                   8806: }
                   8807: </pre>
                   8808: <p>It generates the code for <code class="function">inline_func</code> even if
                   8809: that function is never used. This code then refers to
                   8810: <code class="function">extern_func</code>, which can usually not be resolved. To
                   8811: solve this problem you can try to tell the package to disable inlining
                   8812: of functions.</p>
                   8813: </div>
                   8814: </div>
1.41      asau     8815: <div class="sect2">
1.1       dsieger  8816: <div class="titlepage"><div><div><h3 class="title">
1.172     rillig   8817: <a name="out-of-memory"></a>21.5.5. Running out of memory</h3></div></div></div>
1.1       dsieger  8818: <p>Sometimes packages fail to build because the compiler runs
                   8819:     into an operating system specific soft limit.  With the
                   8820:     <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
1.94      wiz      8821:     to unlimit the resources.  Currently, the allowed values are any combination of
                   8822:     <span class="quote">&#8220;<span class="quote">cputime</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">datasize</span>&#8221;</span>,
                   8823:     <span class="quote">&#8220;<span class="quote">memorysize</span>&#8221;</span>, and <span class="quote">&#8220;<span class="quote">stacksize</span>&#8221;</span>.
1.1       dsieger  8824:     Setting this variable is similar to running the shell builtin
1.10      hubertf  8825:     <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.1       dsieger  8826:     segment size or maximum stack size of a process, respectively, to
                   8827:     their hard limits.</p>
                   8828: </div>
                   8829: </div>
1.41      asau     8830: <div class="sect1">
1.1       dsieger  8831: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   8832: <a name="fixes.install"></a>21.6. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.41      asau     8833: <div class="sect2">
1.1       dsieger  8834: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8835: <a name="install-scripts"></a>21.6.1. Creating needed directories</h3></div></div></div>
1.10      hubertf  8836: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.1       dsieger  8837:     with some operating systems cannot create more than one
                   8838:     directory at a time. As such, you should call
                   8839:     <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
                   8840: <pre class="programlisting">
                   8841: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
                   8842: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.111     sevan    8843: </pre>
1.23      wiz      8844: <p>You can also just append <span class="quote">&#8220;<span class="quote"><code class="literal">dir1
                   8845:     dir2</code></span>&#8221;</span> to the
1.1       dsieger  8846:     <code class="varname">INSTALLATION_DIRS</code> variable, which will
                   8847:     automatically do the right thing.</p>
                   8848: </div>
1.41      asau     8849: <div class="sect2">
1.1       dsieger  8850: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8851: <a name="where-to-install-documentation"></a>21.6.2. Where to install documentation</h3></div></div></div>
1.1       dsieger  8852: <p>In general, documentation should be installed into
                   8853:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
                   8854:     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
                   8855:     includes the version number of the package).</p>
                   8856: <p>Many modern packages using GNU autoconf allow to set the
                   8857:     directory where HTML documentation is installed with the
1.23      wiz      8858:     <span class="quote">&#8220;<span class="quote">--with-html-dir</span>&#8221;</span> option. Sometimes using this flag
1.1       dsieger  8859:     is needed because otherwise the documentation ends up in
                   8860:     <code class="filename">${PREFIX}/share/doc/html</code> or other
                   8861:     places.</p>
                   8862: <p>An exception to the above is that library API documentation
1.137     leot     8863:     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.1       dsieger  8864:     browsers (devhelp) should be left at their default location, which
                   8865:     is <code class="filename">${PREFIX}/share/gtk-doc</code>.  Such
                   8866:     documentation can be recognized from files ending in
                   8867:     <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
                   8868:     (It is also acceptable to install such files in
                   8869:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
                   8870:     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
                   8871:     <code class="filename">.devhelp*</code> file must be directly in that
                   8872:     directory then, no additional subdirectory level is allowed in
                   8873:     this case. This is usually achieved by using
1.23      wiz      8874:     <span class="quote">&#8220;<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>&#8221;</span>.
1.1       dsieger  8875:     <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
                   8876:     though.)</p>
                   8877: </div>
1.41      asau     8878: <div class="sect2">
1.1       dsieger  8879: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8880: <a name="installing-score-files"></a>21.6.3. Installing highscore files</h3></div></div></div>
1.1       dsieger  8881: <p>Certain packages, most of them in the games category, install
                   8882:     a score file that allows all users on the system to record their
                   8883:     highscores.  In order for this to work, the binaries need to be
                   8884:     installed setgid and the score files owned by the appropriate
1.35      wiz      8885:     group and/or owner (traditionally the "games" user/group).  Set
                   8886:     <code class="varname">USE_GAMESGROUP</code> to yes to support this. The
1.1       dsieger  8887:     following variables, documented in more detail in
                   8888:     <code class="filename">mk/defaults/mk.conf</code>, control this
1.35      wiz      8889:     behaviour: <code class="varname">GAMEDATAMODE</code>,
                   8890:     <code class="varname">GAMEDIRMODE</code>, <code class="varname">GAMES_GROUP</code>,
1.100     leot     8891:     <code class="varname">GAMEMODE</code>, <code class="varname">GAME_USER</code>.
                   8892:     Other useful variables are: <code class="varname">GAMEDIR_PERMS</code>,
                   8893:     <code class="varname">GAMEDATA_PERMS</code> and
                   8894:     <code class="varname">SETGID_GAMES_PERMS</code>.</p>
                   8895: <p>An example that illustrates some of the variables described above is
                   8896:     <code class="filename">games/moon-buggy</code>. <code class="varname">OWN_DIRS_PERMS</code> is
                   8897:     used to properly set directory permissions of the directory where the
                   8898:     scorefile is saved, <code class="varname">REQD_FILES_PERMS</code> is used to create a
                   8899:     dummy scorefile (<code class="filename">mbscore</code>) with the proper permissions
                   8900:     and <code class="varname">SPECIAL_PERMS</code> is used to install setgid the game
                   8901:     binary:</p>
                   8902: <pre class="programlisting">
1.112     rillig   8903: USE_GAMESGROUP=         yes
1.100     leot     8904: 
1.112     rillig   8905: BUILD_DEFS+=            VARBASE
1.100     leot     8906: 
1.112     rillig   8907: OWN_DIRS_PERMS+=        ${VARBASE}/games/moon-buggy ${GAMEDIR_PERMS}
                   8908: REQD_FILES_PERMS+=      /dev/null ${VARBASE}/games/moon-buggy/mbscore ${GAMEDATA_PERMS}
                   8909: SPECIAL_PERMS+=         ${PREFIX}/bin/moon-buggy ${SETGID_GAMES_PERMS}
1.111     sevan    8910: </pre>
1.100     leot     8911: <p>Various <code class="varname">INSTALL_*</code> variables are also available:
                   8912:     <code class="varname">INSTALL_GAME</code> to install setgid game binaries,
                   8913:     <code class="varname">INSTALL_GAME_DIR</code> to install game directories that are
                   8914:     needed to be accessed by setgid games and
                   8915:     <code class="varname">INSTALL_GAME_DATA</code> to install scorefiles.</p>
1.14      jmcneill 8916: <p>A package should therefore never hard code file ownership or
1.100     leot     8917:     access permissions but rely on <code class="varname">*_PERMS</code> as described above
                   8918:     or alternatively on <code class="varname">INSTALL_GAME</code>,
                   8919:     <code class="varname">INSTALL_GAME_DATA</code> and
                   8920:     <code class="varname">INSTALL_GAME_DIR</code> to set these correctly.</p>
1.1       dsieger  8921: </div>
1.41      asau     8922: <div class="sect2">
1.1       dsieger  8923: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8924: <a name="destdir-support"></a>21.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.14      jmcneill 8925: <p><code class="varname">DESTDIR</code> support means that a package
                   8926:     installs into a staging directory, not the final location of the
                   8927:     files. Then a binary package is created which can be used for
                   8928:     installation as usual. There are two ways: Either the package must
1.23      wiz      8929:     install as root (<span class="quote">&#8220;<span class="quote">destdir</span>&#8221;</span>) or the package can
                   8930:     install as non-root user (<span class="quote">&#8220;<span class="quote">user-destdir</span>&#8221;</span>).</p>
1.41      asau     8931: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      8932: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
1.113     leot     8933:       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>.
                   8934:       By default <code class="varname">PKG_DESTDIR_SUPPORT</code>
1.38      wiz      8935:       is set to <span class="quote">&#8220;<span class="quote">user-destdir</span>&#8221;</span> to help catching more
                   8936:       potential packaging problems. If bsd.prefs.mk is included in the Makefile,
1.14      jmcneill 8937:       <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
                   8938:       the inclusion.</p></li>
1.23      wiz      8939: <li class="listitem"><p>All installation operations have to be prefixed with
1.4       rillig   8940:       <code class="filename">${DESTDIR}</code>.</p></li>
1.23      wiz      8941: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.4       rillig   8942:       automatically. Many manual rules and pre/post-install often are
                   8943:       incorrect; fix them.</p></li>
1.23      wiz      8944: <li class="listitem"><p>If files are installed with special owner/group
1.17      imil     8945:       use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.23      wiz      8946: <li class="listitem"><p>In general, packages should support
1.4       rillig   8947:       <code class="varname">UNPRIVILEGED</code> to be able to use
                   8948:       DESTDIR.</p></li>
                   8949: </ul></div>
                   8950: </div>
1.41      asau     8951: <div class="sect2">
1.4       rillig   8952: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8953: <a name="hardcoded-paths"></a>21.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.1       dsieger  8954: <p>Your package may also contain scripts with hardcoded paths to
1.203   ! nia      8955:       other interpreters besides (or as well as) Perl.  To correct the
1.1       dsieger  8956:       full pathname to the script interpreter, you need to set the
                   8957:       following definitions in your <code class="filename">Makefile</code> (we
1.10      hubertf  8958:     shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.1       dsieger  8959: <pre class="programlisting">
                   8960: REPLACE_INTERPRETER+=   tcl
                   8961: REPLACE.tcl.old=        .*/bin/tclsh
                   8962: REPLACE.tcl.new=        ${PREFIX}/bin/tclsh
                   8963: REPLACE_FILES.tcl=      # list of tcl scripts which need to be fixed,
                   8964: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.111     sevan    8965: </pre>
1.41      asau     8966: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  8967: <h3 class="title">Note</h3>
                   8968: <p>Before March 2006, these variables were called
                   8969:     <code class="varname">_REPLACE.*</code> and
                   8970:     <code class="varname">_REPLACE_FILES.*</code>.</p>
                   8971: </div>
                   8972: </div>
1.41      asau     8973: <div class="sect2">
1.1       dsieger  8974: <div class="titlepage"><div><div><h3 class="title">
1.203   ! nia      8975: <a name="perl-modules"></a>21.6.6. Packages installing Perl modules</h3></div></div></div>
1.1       dsieger  8976: <p>Makefiles of packages providing perl5 modules should include
                   8977:     the Makefile fragment
                   8978:     <code class="filename">../../lang/perl5/module.mk</code>.  It provides a
1.10      hubertf  8979:     <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.1       dsieger  8980:     configuration for such modules as well as various hooks to tune
                   8981:     this configuration.  See comments in this file for
                   8982:     details.</p>
                   8983: <p>Perl5 modules will install into different places depending
                   8984:     on the version of perl used during the build process.  To
                   8985:     address this, pkgsrc will append lines to the
                   8986:     <code class="filename">PLIST</code> corresponding to the files listed in
                   8987:     the installed <code class="filename">.packlist</code> file generated by
                   8988:     most perl5 modules.  This is invoked by defining
                   8989:     <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
1.47      wiz      8990:     packlist files relative to <code class="varname">PERL5_PACKLIST_DIR</code>
                   8991:     (<code class="varname">PERL5_INSTALLVENDORARCH</code> by default),
                   8992:     e.g.:</p>
1.1       dsieger  8993: <pre class="programlisting">
1.47      wiz      8994: PERL5_PACKLIST= auto/Pg/.packlist
1.111     sevan    8995: </pre>
1.47      wiz      8996: <p>The perl5 config variables
                   8997:     <code class="varname">installarchlib</code>,
                   8998:     <code class="varname">installscript</code>,
                   8999:     <code class="varname">installvendorbin</code>,
                   9000:     <code class="varname">installvendorscript</code>,
                   9001:     <code class="varname">installvendorarch</code>,
                   9002:     <code class="varname">installvendorlib</code>,
                   9003:     <code class="varname">installvendorman1dir</code>, and
                   9004:     <code class="varname">installvendorman3dir</code> represent those
                   9005:     locations in which components of perl5 modules may be installed,
                   9006:     provided as variable with uppercase and prefixed with
                   9007:     <code class="varname">PERL5_</code>, e.g. <code class="varname">PERL5_INSTALLARCHLIB</code>
                   9008:     and may be used by perl5 packages that don't have a packlist.
                   9009:     These variables are also substituted for in the
                   9010:     <code class="filename">PLIST</code> as uppercase prefixed with
                   9011:     <code class="varname">PERL5_SUB_</code>.</p>
1.1       dsieger  9012: </div>
1.41      asau     9013: <div class="sect2">
1.1       dsieger  9014: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   9015: <a name="faq.info-files"></a>21.6.7. Packages installing info files</h3></div></div></div>
1.1       dsieger  9016: <p>Some packages install info files or use the
1.23      wiz      9017:     <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.1       dsieger  9018:     commands.  <code class="varname">INFO_FILES</code> should be defined in
                   9019:     the package Makefile so that <code class="filename">INSTALL</code> and
                   9020:     <code class="filename">DEINSTALL</code> scripts will be generated to
                   9021:     handle registration of the info files in the Info directory
1.23      wiz      9022:     file. The <span class="quote">&#8220;<span class="quote">install-info</span>&#8221;</span> command used for the info
1.1       dsieger  9023:     files registration is either provided by the system, or by a
                   9024:     special purpose package automatically added as dependency if
                   9025:     needed.</p>
                   9026: <p><code class="varname">PKGINFODIR</code> is the directory under
                   9027:     <code class="filename">${PREFIX}</code> where info files are primarily
                   9028:     located. <code class="varname">PKGINFODIR</code> defaults to
1.23      wiz      9029:     <span class="quote">&#8220;<span class="quote">info</span>&#8221;</span> and can be overridden by the user.</p>
1.1       dsieger  9030: <p>The info files for the package should be listed in the
                   9031:     package <code class="filename">PLIST</code>; however any split info files
                   9032:     need not be listed.</p>
1.23      wiz      9033: <p>A package which needs the <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> command
                   9034:     at build time must add <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> to
1.1       dsieger  9035:     <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.23      wiz      9036:     version of the <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> command is needed it
1.1       dsieger  9037:     should be noted with the <code class="varname">TEXINFO_REQD</code>
                   9038:     variable in the package <code class="filename">Makefile</code>. By
                   9039:     default, a minimum version of 3.12 is required. If the system
1.10      hubertf  9040:     does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.1       dsieger  9041:     does not match the required minimum, a build dependency on the
1.137     leot     9042:     <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.1       dsieger  9043:     be added automatically.</p>
                   9044: <p>The build and installation process of the software provided
                   9045:     by the package should not use the
1.10      hubertf  9046:     <span class="command"><strong>install-info</strong></span> command as the registration of
1.1       dsieger  9047:     info files is the task of the package
                   9048:     <code class="filename">INSTALL</code> script, and it must use the
1.10      hubertf  9049:     appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.1       dsieger  9050: <p>To achieve this goal, the pkgsrc infrastructure creates
1.10      hubertf  9051:     overriding scripts for the <span class="command"><strong>install-info</strong></span> and
                   9052:     <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.1       dsieger  9053:     in <code class="varname">PATH</code>.</p>
1.10      hubertf  9054: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.1       dsieger  9055:     no effect except the logging of a message. The script overriding
1.10      hubertf  9056:     <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.1       dsieger  9057:     value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.10      hubertf  9058:     <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.1       dsieger  9059: </div>
1.41      asau     9060: <div class="sect2">
1.1       dsieger  9061: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   9062: <a name="manpages"></a>21.6.8. Packages installing man pages</h3></div></div></div>
1.1       dsieger  9063: <p>All packages that install manual pages should install them
                   9064:     into the same directory, so that there is one common place to look
                   9065:     for them. In pkgsrc, this place is
                   9066:     <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
                   9067:     should be used in packages. The default for
                   9068:     <code class="varname">PKGMANDIR</code> is
1.23      wiz      9069:     <span class="quote">&#8220;<span class="quote"><code class="filename">man</code></span>&#8221;</span>. Another often-used value
                   9070:     is <span class="quote">&#8220;<span class="quote"><code class="filename">share/man</code></span>&#8221;</span>.</p>
1.41      asau     9071: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  9072: <h3 class="title">Note</h3>
                   9073: <p>The support for a custom <code class="varname">PKGMANDIR</code>
                   9074:     is far from complete.</p>
                   9075: </div>
                   9076: <p>The <code class="filename">PLIST</code> files can just use
                   9077:     <code class="filename">man/</code> as the top level directory for the man
                   9078:     page file entries, and the pkgsrc framework will convert as
                   9079:     needed. In all other places, the correct
                   9080:     <code class="varname">PKGMANDIR</code> must be used.</p>
                   9081: <p>Packages that are
                   9082:     configured with <code class="varname">GNU_CONFIGURE</code> set as
1.23      wiz      9083:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>, by default will use the
1.1       dsieger  9084:     <code class="filename">./configure</code>
                   9085:     --mandir switch to set where the man pages should be installed.
                   9086:     The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
                   9087:     to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
                   9088: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
                   9089:     use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.23      wiz      9090:     to <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span>.
1.1       dsieger  9091:     Or if the <code class="filename">./configure</code> script uses
                   9092:     a non-standard use of --mandir, you can set
                   9093:     <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.184     rillig   9094: <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.1       dsieger  9095:     information on installation of compressed manual pages.</p>
                   9096: </div>
1.41      asau     9097: <div class="sect2">
1.1       dsieger  9098: <div class="titlepage"><div><div><h3 class="title">
1.203   ! nia      9099: <a name="x11-fonts"></a>21.6.9. Packages installing X11 fonts</h3></div></div></div>
1.1       dsieger  9100: <p>If a package installs font files, you will need to rebuild
                   9101:     the fonts database in the directory where they get installed at
                   9102:     installation and deinstallation time.  This can be automatically
                   9103:     done by using the pkginstall framework.</p>
                   9104: <p>You can list the directories where fonts are installed in the
                   9105:     <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
                   9106:     variables, where <em class="replaceable"><code>type</code></em> can be one of
1.23      wiz      9107:     <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.1       dsieger  9108:     Also make sure that the database file
                   9109:     <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
                   9110: <p>Note that you should not create new directories for fonts;
                   9111:     instead use the standard ones to avoid that the user needs to
                   9112:     manually configure his X server to find them.</p>
                   9113: </div>
1.41      asau     9114: <div class="sect2">
1.1       dsieger  9115: <div class="titlepage"><div><div><h3 class="title">
1.203   ! nia      9116: <a name="sgml-xml-data"></a>21.6.10. Packages installing SGML or XML data</h3></div></div></div>
1.1       dsieger  9117: <p>If a package installs SGML or XML data files that need to be
                   9118:     registered in system-wide catalogs (like DTDs, sub-catalogs,
                   9119:     etc.), you need to take some extra steps:</p>
1.23      wiz      9120: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9121: <li class="listitem"><p>Include
1.1       dsieger  9122:        <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
                   9123:        your <code class="filename">Makefile</code>, which takes care of
                   9124:        registering those files in system-wide catalogs at
                   9125:        installation and deinstallation time.</p></li>
1.23      wiz      9126: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.1       dsieger  9127:        any SGML catalogs installed by the package.</p></li>
1.23      wiz      9128: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.1       dsieger  9129:        any XML catalogs installed by the package.</p></li>
1.23      wiz      9130: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.1       dsieger  9131:        to be added to the SGML catalog.  These come in groups of
                   9132:        three strings; see xmlcatmgr(1) for more information
                   9133:        (specifically, arguments recognized by the 'add' action).
                   9134:        Note that you will normally not use this variable.</p></li>
1.23      wiz      9135: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.1       dsieger  9136:        to be added to the XML catalog.  These come in groups of three
                   9137:        strings; see xmlcatmgr(1) for more information (specifically,
                   9138:        arguments recognized by the 'add' action).  Note that you will
                   9139:        normally not use this variable.</p></li>
                   9140: </ol></div>
                   9141: </div>
1.41      asau     9142: <div class="sect2">
1.1       dsieger  9143: <div class="titlepage"><div><div><h3 class="title">
1.203   ! nia      9144: <a name="mime-database"></a>21.6.11. Packages installing extensions to the MIME database</h3></div></div></div>
1.1       dsieger  9145: <p>If a package provides extensions to the MIME database by
                   9146:     installing <code class="filename">.xml</code> files inside
                   9147:     <code class="filename">${PREFIX}/share/mime/packages</code>, you
                   9148:     need to take some extra steps to ensure that the database is kept
                   9149:     consistent with respect to these new files:</p>
1.23      wiz      9150: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9151: <li class="listitem"><p>Include
1.1       dsieger  9152:        <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
                   9153:        (avoid using the <code class="filename">buildlink3.mk</code> file from
                   9154:        this same directory, which is reserved for inclusion from
                   9155:        other <code class="filename">buildlink3.mk</code> files).  It takes
                   9156:        care of rebuilding the MIME database at installation and
                   9157:        deinstallation time, and disallows any access to it directly
                   9158:        from the package.</p></li>
1.23      wiz      9159: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.1       dsieger  9160:        <code class="filename">share/mime</code> directory,
                   9161:        <span class="emphasis"><em>except</em></span> for files saved under
                   9162:        <code class="filename">share/mime/packages</code>.  The former are
                   9163:        handled automatically by
                   9164:        the update-mime-database program, but the latter are
                   9165:        package-dependent and must be removed by the package that
                   9166:        installed them in the first place.</p></li>
1.23      wiz      9167: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.1       dsieger  9168:        from the PLIST.  They will be handled by the shared-mime-info
                   9169:        package.</p></li>
                   9170: </ol></div>
                   9171: </div>
1.41      asau     9172: <div class="sect2">
1.1       dsieger  9173: <div class="titlepage"><div><div><h3 class="title">
1.203   ! nia      9174: <a name="intltool"></a>21.6.12. Packages using intltool</h3></div></div></div>
1.1       dsieger  9175: <p>If a package uses intltool during its build, add
                   9176:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
                   9177:     which forces it to use the intltool package provided by pkgsrc,
                   9178:     instead of the one bundled with the distribution file.</p>
                   9179: <p>This tracks intltool's build-time dependencies and uses the
                   9180:     latest available version; this way, the package benefits of any
                   9181:     bug fixes that may have appeared since it was released.</p>
                   9182: </div>
1.41      asau     9183: <div class="sect2">
1.1       dsieger  9184: <div class="titlepage"><div><div><h3 class="title">
1.203   ! nia      9185: <a name="startup-scripts"></a>21.6.13. Packages installing startup scripts</h3></div></div></div>
1.1       dsieger  9186: <p>If a package contains a rc.d script, it won't be copied into
                   9187:     the startup directory by default, but you can enable it, by adding
                   9188:     the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.10      hubertf  9189:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.1       dsieger  9190:     into <code class="filename">/etc/rc.d</code> when a package is installed, and
                   9191:     it will automatically remove the scripts when the package is
                   9192:     deinstalled.</p>
                   9193: </div>
1.41      asau     9194: <div class="sect2">
1.1       dsieger  9195: <div class="titlepage"><div><div><h3 class="title">
1.203   ! nia      9196: <a name="tex-packages"></a>21.6.14. Packages installing TeX modules</h3></div></div></div>
1.1       dsieger  9197: <p>If a package installs TeX packages into the texmf tree,
                   9198:     the <code class="filename">ls-R</code> database of the tree needs to be
                   9199:     updated.</p>
1.41      asau     9200: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  9201: <h3 class="title">Note</h3>
1.22      jakllsch 9202: <p>Except the main TeX packages such as kpathsea,
1.1       dsieger  9203:     packages should install files
1.22      jakllsch 9204:     into <code class="filename">${PREFIX}/share/texmf-dist</code>,
                   9205:     not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.1       dsieger  9206: </div>
1.23      wiz      9207: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9208: <li class="listitem"><p>Include
1.22      jakllsch 9209:       <code class="filename">../../print/kpathsea/texmf.mk</code>.  This
1.1       dsieger  9210:       takes care of rebuilding the <code class="filename">ls-R</code>
                   9211:       database at installation and deinstallation time.</p></li>
1.23      wiz      9212: <li class="listitem">
1.1       dsieger  9213: <p>If your package installs files into a texmf
                   9214:       tree other than the one
1.22      jakllsch 9215:       at <code class="filename">${PREFIX}/share/texmf-dist</code>,
                   9216:       set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.1       dsieger  9217:       trees that need database update.</p>
                   9218: <p>If your package also installs font map files that need
1.10      hubertf  9219:       to be registered using <span class="command"><strong>updmap</strong></span>,
1.29      dholland 9220:       include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.22      jakllsch 9221:       set <code class="varname">TEX_MAP_FILES</code> and/or
                   9222:       <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.10      hubertf  9223:       such font map files.  Then <span class="command"><strong>updmap</strong></span> will
1.1       dsieger  9224:       be run automatically at installation/deinstallation to
                   9225:       enable/disable font map files for TeX output
                   9226:       drivers.</p>
                   9227: </li>
1.23      wiz      9228: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.1       dsieger  9229:       databases are included in <code class="filename">PLIST</code>, as
1.29      dholland 9230:       they will be removed only by the kpathsea package.</p></li>
1.1       dsieger  9231: </ol></div>
                   9232: </div>
1.41      asau     9233: <div class="sect2">
1.1       dsieger  9234: <div class="titlepage"><div><div><h3 class="title">
1.203   ! nia      9235: <a name="emulation-packages"></a>21.6.15. Packages supporting running binaries in
1.1       dsieger  9236:     emulation</h3></div></div></div>
                   9237: <p>There are some packages that provide libraries and
                   9238:     executables for running binaries from a one operating system
                   9239:     on a different one (if the latter supports it).  One example
                   9240:     is running Linux binaries on NetBSD.</p>
1.137     leot     9241: <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.1       dsieger  9242:     helps in extracting and packaging Linux rpm packages.</p>
                   9243: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.10      hubertf  9244:     avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.1       dsieger  9245:     if all libraries for each installed executable can be found by
                   9246:     the dynamic linker.  Since the standard dynamic linker is run,
                   9247:     this fails for emulation packages, because the libraries used
                   9248:     by the emulation are not in the standard directories.</p>
                   9249: </div>
1.184     rillig   9250: <div class="sect2">
                   9251: <div class="titlepage"><div><div><h3 class="title">
1.203   ! nia      9252: <a name="hicolor-theme"></a>21.6.16. Packages installing hicolor icons</h3></div></div></div>
1.184     rillig   9253: <p>If a package installs images under the
                   9254:     <code class="filename">share/icons/hicolor</code> and/or updates the
                   9255:     <code class="filename">share/icons/hicolor/icon-theme.cache</code>
                   9256:     database, you need to take some extra steps to make sure that the
                   9257:     shared theme directory is handled appropriately and that the cache
                   9258:     database is rebuilt:</p>
                   9259: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9260: <li class="listitem"><p>Include
                   9261:        <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
                   9262: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
                   9263:        entry that refers to the theme cache.</p></li>
                   9264: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
                   9265:          directories from the <code class="filename">share/icons/hicolor</code>
                   9266:          hierarchy because they will be handled automatically.</p></li>
                   9267: </ol></div>
                   9268: <p>The best way to verify that the PLIST is correct with
                   9269:       respect to the last two points is to regenerate it using
                   9270:       <span class="command"><strong>make print-PLIST</strong></span>.</p>
                   9271: </div>
                   9272: <div class="sect2">
                   9273: <div class="titlepage"><div><div><h3 class="title">
1.203   ! nia      9274: <a name="desktop-files"></a>21.6.17. Packages installing desktop files</h3></div></div></div>
1.184     rillig   9275: <p>If a package installs <code class="filename">.desktop</code> files
                   9276:       under <code class="filename">share/applications</code> and these include
                   9277:       MIME information (MimeType key), you need to take extra steps to
                   9278:       ensure that they are registered into the MIME database:</p>
                   9279: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9280: <li class="listitem"><p>Include
                   9281:          <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
                   9282: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
                   9283:          <code class="filename">share/applications/mimeinfo.cache</code> file.
                   9284:          It will be handled automatically.</p></li>
                   9285: </ol></div>
                   9286: <p>The best way to verify that the PLIST is correct with
                   9287:       respect to the last point is to regenerate it using <span class="command"><strong>make
                   9288:       print-PLIST</strong></span>.</p>
                   9289: </div>
                   9290: </div>
                   9291: <div class="sect1">
                   9292: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   9293: <a name="punting"></a>21.7. Marking packages as having problems</h2></div></div></div>
                   9294: <p>In some cases one does not have the time to solve a problem
                   9295:   immediately. In this case, one can plainly mark a package as broken.  For
                   9296:   this, one just sets the variable <code class="varname">BROKEN</code> to the
                   9297:   reason why the package is broken (similar to the
                   9298:   <code class="varname">PKG_FAIL_REASON</code> variable).  A user trying to build
                   9299:   the package will immediately be shown this message, and the build
                   9300:   will not be even tried.</p>
                   9301: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
                   9302:   intervals.</p>
                   9303: </div>
                   9304: </div>
                   9305: <div class="chapter">
                   9306: <div class="titlepage"><div><div><h2 class="title">
                   9307: <a name="gnome"></a>Chapter 22. GNOME packaging and porting</h2></div></div></div>
                   9308: <div class="toc">
                   9309: <p><b>Table of Contents</b></p>
                   9310: <dl class="toc">
                   9311: <dt><span class="sect1"><a href="#meta-packages">22.1. Meta packages</a></span></dt>
                   9312: <dt><span class="sect1"><a href="#new-package">22.2. Packaging a GNOME application</a></span></dt>
                   9313: <dt><span class="sect1"><a href="#full-update">22.3. Updating GNOME to a newer version</a></span></dt>
                   9314: <dt><span class="sect1"><a href="#patching">22.4. Patching guidelines</a></span></dt>
                   9315: </dl>
                   9316: </div>
                   9317: <p>Quoting <a class="ulink" href="https://www.gnome.org/" target="_top">GNOME's web
                   9318: site</a>:</p>
                   9319: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
                   9320:   environment, an intuitive and attractive desktop for users, and the
                   9321:   GNOME development platform, an extensive framework for building
                   9322:   applications that integrate into the rest of the desktop.</p></blockquote></div>
                   9323: <p>pkgsrc provides a seamless way to automatically build and install
                   9324: a complete GNOME environment <span class="emphasis"><em>under many different
                   9325: platforms</em></span>.  We can say with confidence that pkgsrc is one of
                   9326: the most advanced build and packaging systems for GNOME due to its
                   9327: included technologies buildlink3, the wrappers and tools framework and
                   9328: automatic configuration file management.  Lots of efforts are put into
                   9329: achieving a completely clean deinstallation of installed software
                   9330: components.</p>
                   9331: <p>Given that pkgsrc is <a class="ulink" href="https://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
                   9332: the above also means that great efforts are put into making GNOME work
1.201     cirnatda 9333: under this operating system.</p>
1.184     rillig   9334: <p>This chapter is aimed at pkgsrc developers and other people
                   9335: interested in helping our GNOME porting and packaging efforts.  It
                   9336: provides instructions on how to manage the existing packages and some
                   9337: important information regarding their internals.</p>
                   9338: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   9339: <h3 class="title">We need your help!</h3>
                   9340: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
                   9341:   and GNOME and are willing to learn new exciting stuff, please jump
                   9342:   straight to the <a class="ulink" href="https://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
                   9343:   work</a> list!  There is still a long way to go to get a
                   9344:   fully-functional GNOME desktop under NetBSD and we need your help to
                   9345:   achieve it!</p>
                   9346: </div>
                   9347: <div class="sect1">
                   9348: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   9349: <a name="meta-packages"></a>22.1. Meta packages</h2></div></div></div>
                   9350: <p>pkgsrc includes three GNOME-related meta packages:</p>
                   9351: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   9352: <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
                   9353:     the core GNOME desktop environment.  It only includes the necessary
                   9354:     bits to get it to boot correctly, although it may lack important
                   9355:     functionality for daily operation.  The idea behind this package is
                   9356:     to let end users build their own configurations on top of this one,
                   9357:     first installing this meta package to achieve a functional setup and
                   9358:     then adding individual applications.</p></li>
                   9359: <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
                   9360:     complete installation of the GNOME platform and desktop as defined
                   9361:     by the GNOME project; this is based on the components distributed in
                   9362:     the <code class="filename">platform/x.y/x.y.z/sources</code> and
                   9363:     <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
                   9364:     official FTP server.  Developer-only tools found in those
                   9365:     directories are not installed unless required by some other
                   9366:     component to work properly.  Similarly, packages from the bindings
                   9367:     set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
                   9368:     in unless required as a dependency for an end-user component.  This
                   9369:     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>
                   9370: <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>:
                   9371:     Installs all the tools required to build a GNOME component when
                   9372:     fetched from the CVS repository.  These are required to let the
                   9373:     <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
                   9374: </ul></div>
                   9375: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
                   9376: sorted in a way that eases updates: a package may depend on other
                   9377: packages listed before it but not on any listed after it.  It is very
                   9378: important to keep this order to ease updates so... <span class="emphasis"><em>do not
                   9379: change it to alphabetical sorting!</em></span></p>
                   9380: </div>
                   9381: <div class="sect1">
                   9382: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   9383: <a name="new-package"></a>22.2. Packaging a GNOME application</h2></div></div></div>
                   9384: <p>Almost all GNOME applications are written in C and use a common
                   9385: set of tools as their build system.  Things get different with the new
                   9386: bindings to other languages (such as Python), but the following will
                   9387: give you a general idea on the minimum required tools:</p>
                   9388: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   9389: <li class="listitem">
                   9390: <p>Almost all GNOME applications use the GNU Autotools as their
                   9391:     build system.  As a general rule you will need to tell this to your
                   9392:     package:</p>
                   9393: <pre class="programlisting">
                   9394: GNU_CONFIGURE=yes
                   9395: USE_LIBTOOL=yes
                   9396: USE_TOOLS+=gmake
                   9397: </pre>
                   9398: </li>
                   9399: <li class="listitem">
                   9400: <p>If the package uses pkg-config to detect dependencies, add this
                   9401:     tool to the list of required utilities:</p>
                   9402: <pre class="programlisting">
                   9403: USE_TOOLS+=pkg-config
                   9404: </pre>
                   9405: <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
                   9406:     the end of the build process to ensure that you did not miss to
                   9407:     specify any dependency in your package and that the version
                   9408:     requirements are all correct.</p>
                   9409: </li>
                   9410: <li class="listitem"><p>If the package uses intltool, be sure to add
                   9411:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
                   9412:     to handle dependencies and to force the package to use the latest
                   9413:     available version.</p></li>
                   9414: <li class="listitem">
                   9415: <p>If the package uses gtk-doc (a documentation generation
                   9416:     utility), do <span class="emphasis"><em>not</em></span> add a dependency on it.  The
                   9417:     tool is rather big and the distfile should come with pregenerated
                   9418:     documentation anyway; if it does not, it is a bug that you ought to
                   9419:     report.  For such packages you should disable gtk-doc (unless it is
                   9420:     the default):</p>
                   9421: <pre class="programlisting">
                   9422: CONFIGURE_ARGS+=--disable-gtk-doc
                   9423: </pre>
                   9424: <p>The default location of installed HTML files
                   9425:     (<code class="filename">share/gtk-doc/&lt;package-name&gt;</code>) is correct
                   9426:     and should not be changed unless the package insists on installing
                   9427:     them somewhere else.  Otherwise programs as
                   9428:     <span class="command"><strong>devhelp</strong></span> will not be able to open them.  You can
                   9429:     do that with an entry similar to:</p>
                   9430: <pre class="programlisting">
                   9431: CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...
                   9432: </pre>
                   9433: </li>
                   9434: </ul></div>
                   9435: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
                   9436: files under the installation prefix to maintain databases.  In this
                   9437: context, shared means that those exact same directories and files are
                   9438: used among several different packages, leading to conflicts in the
                   9439: <code class="filename">PLIST</code>.  pkgsrc currently includes functionality to
                   9440: handle the most common cases, so you have to forget about using
                   9441: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
                   9442: omitting shared files from them.  If you find yourself doing those,
                   9443: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
                   9444: <p>The following table lists the common situations that result in
                   9445: using shared directories or files.  For each of them, the appropriate
                   9446: solution is given.  After applying the solution be sure to
                   9447: <span class="emphasis"><em>regenerate the package's file list</em></span> with
                   9448: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
                   9449: <div class="table">
                   9450: <a name="plist-handling"></a><p class="title"><b>Table 22.1. PLIST handling for GNOME packages</b></p>
                   9451: <div class="table-contents"><table class="table" summary="PLIST handling for GNOME packages" border="1">
                   9452: <colgroup>
                   9453: <col>
                   9454: <col>
                   9455: </colgroup>
                   9456: <thead><tr>
                   9457: <th>If the package...</th>
                   9458: <th>Then...</th>
                   9459: </tr></thead>
                   9460: <tbody>
                   9461: <tr>
                   9462: <td>Installs icons under the
                   9463:         <code class="filename">share/icons/hicolor</code> hierarchy or updates
                   9464:         <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.203   ! nia      9465: <td>See <a class="xref" href="#hicolor-theme" title="21.6.16. Packages installing hicolor icons">Section 21.6.16, &#8220;Packages installing hicolor icons&#8221;</a>.</td>
1.184     rillig   9466: </tr>
                   9467: <tr>
                   9468: <td>Installs files under
                   9469:         <code class="filename">share/mime/packages</code>.</td>
1.203   ! nia      9470: <td>See <a class="xref" href="#mime-database" title="21.6.11. Packages installing extensions to the MIME database">Section 21.6.11, &#8220;Packages installing extensions to the MIME database&#8221;</a>.</td>
1.184     rillig   9471: </tr>
                   9472: <tr>
                   9473: <td>Installs <code class="filename">.desktop</code> files under
                   9474:         <code class="filename">share/applications</code> and these include MIME
                   9475:         information.</td>
1.203   ! nia      9476: <td>See <a class="xref" href="#desktop-files" title="21.6.17. Packages installing desktop files">Section 21.6.17, &#8220;Packages installing desktop files&#8221;</a>.</td>
1.184     rillig   9477: </tr>
                   9478: </tbody>
                   9479: </table></div>
1.1       dsieger  9480: </div>
1.184     rillig   9481: <br class="table-break">
1.1       dsieger  9482: </div>
1.41      asau     9483: <div class="sect1">
1.1       dsieger  9484: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   9485: <a name="full-update"></a>22.3. Updating GNOME to a newer version</h2></div></div></div>
                   9486: <p>When seeing GNOME as a whole, there are two kinds of
                   9487: updates:</p>
                   9488: <div class="variablelist"><dl class="variablelist">
                   9489: <dt><span class="term">Major update</span></dt>
                   9490: <dd>
                   9491: <p>Given that there is still a very long way for GNOME 3 (if it
                   9492:       ever appears), we consider a major update one that goes from a
                   9493:       <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
                   9494:       where <code class="literal">Y</code> is even and greater than
                   9495:       <code class="literal">X</code>.  These are hard to achieve because they
                   9496:       introduce lots of changes in the components' code and almost all
                   9497:       GNOME distfiles are updated to newer versions.  Some of them can
                   9498:       even break API and ABI compatibility with the previous major
                   9499:       version series.  As a result, the update needs to be done all at
                   9500:       once to minimize breakage.</p>
                   9501: <p>A major update typically consists of around 80 package
                   9502:       updates and the addition of some new ones.</p>
                   9503: </dd>
                   9504: <dt><span class="term">Minor update</span></dt>
                   9505: <dd>
                   9506: <p>We consider a minor update one that goes from a
                   9507:       <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
                   9508:       one where <code class="literal">Y</code> is greater than
                   9509:       <code class="literal">X</code>.  These are easy to achieve because they do
                   9510:       not update all GNOME components, can be done in an incremental way
                   9511:       and do not break API nor ABI compatibility.</p>
                   9512: <p>A minor update typically consists of around 50 package
                   9513:       updates, although the numbers here may vary a lot.</p>
                   9514: </dd>
                   9515: </dl></div>
                   9516: <p>In order to update the GNOME components in pkgsrc to a new stable
                   9517: release (either major or minor), the following steps should be
                   9518: followed:</p>
                   9519: <div class="orderedlist"><ol class="orderedlist" type="1">
1.23      wiz      9520: <li class="listitem">
1.184     rillig   9521: <p>Get a list of all the tarballs that form the new release by
                   9522:     using the following commands.  These will leave the full list of the
                   9523:     components' distfiles into the <code class="filename">list.txt</code>
                   9524:     file:</p>
                   9525: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
                   9526:     ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
                   9527:     awk '{ print $9 }' &gt;list.txt</code></strong>
                   9528: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
                   9529:     ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
                   9530:     awk '{ print $9 }' &gt;&gt;list.txt</code></strong></pre>
1.1       dsieger  9531: </li>
1.184     rillig   9532: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
                   9533:     bump their version to the release you are updating them to.  The
                   9534:     three meta packages should be always consistent with versioning.
                   9535:     Obviously remove any <code class="varname">PKGREVISION</code>s that might be
                   9536:     in them.</p></li>
1.23      wiz      9537: <li class="listitem">
1.184     rillig   9538: <p>For each meta package, update all its
                   9539:     <code class="varname">DEPENDS</code> lines to match the latest versions as
                   9540:     shown by the above commands.  Do <span class="emphasis"><em>not</em></span> list any
                   9541:     newer version (even if found in the FTP) because the meta packages
                   9542:     are supposed to list the exact versions that form a specific GNOME
                   9543:     release.  Exceptions are permitted here if a newer version solves a
                   9544:     serious issue in the overall desktop experience; these typically
                   9545:     come in the form of a revision bump in pkgsrc, not in newer versions
                   9546:     from the developers.</p>
                   9547: <p>Packages not listed in the <code class="filename">list.txt</code> file
                   9548:     should be updated to the latest version available (if found in
                   9549:     pkgsrc).  This is the case, for example, of the dependencies on the
                   9550:     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.1       dsieger  9551: </li>
1.23      wiz      9552: <li class="listitem">
1.184     rillig   9553: <p>Generate a patch from the modified meta packages and extract the
                   9554:     list of "new" lines.  This will provide you an outline on what
                   9555:     packages need to be updated in pkgsrc and in what order:</p>
                   9556: <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.1       dsieger  9557: </li>
1.184     rillig   9558: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
                   9559:     installed packages and start over from scratch at this point.</p></li>
                   9560: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
                   9561:     of <code class="filename">todo.txt</code> and update the packages listed in
                   9562:     it in order.  For major desktop updates none of these should be
                   9563:     committed until the entire set is completed because there are chances
                   9564:     of breaking not-yet-updated packages.</p></li>
                   9565: <li class="listitem"><p>Once the packages are up to date and working, commit them to
                   9566:     the tree one by one with appropriate log messages.  At the end,
                   9567:     commit the three meta package updates and all the corresponding
                   9568:     changes to the <code class="filename">doc/CHANGES-&lt;YEAR&gt;</code> and
                   9569:     <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>
                   9570: </ol></div>
                   9571: </div>
                   9572: <div class="sect1">
                   9573: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   9574: <a name="patching"></a>22.4. Patching guidelines</h2></div></div></div>
                   9575: <p>GNOME is a very big component in pkgsrc which approaches 100
                   9576: packages.  Please, it is very important that you always, always,
                   9577: <span class="strong"><strong>always</strong></span> feed back any portability
                   9578: 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
                   9579: their attention on portability issues and to ensure that future versions
                   9580: can be built out-of-the box on NetBSD.  The less custom patches in
                   9581: pkgsrc, the easier further updates are.  Those developers in charge of
                   9582: issuing major GNOME updates will be grateful if you do that.</p>
1.200     cirnatda 9583: <p>The most common places to report bugs are the <a class="ulink" href="https://gitlab.gnome.org/GNOME" target="_top">GNOME's GitLab</a> and the <a class="ulink" href="https://gitlab.freedesktop.org/explore/groups" target="_top">freedesktop.org's
                   9584: GitLab</a>.  Not all components use these to track bugs, but most
1.184     rillig   9585: of them do.  Do not be short on your reports: always provide detailed
                   9586: explanations of the current failure, how it can be improved to achieve
1.200     cirnatda 9587: maximum portability and, if at all possible, provide a patch against the
                   9588: main Git branch.  The more verbose you are, the higher chances of your
                   9589: patch being accepted.</p>
1.184     rillig   9590: <p>Also, please avoid using preprocessor magic to fix portability
                   9591: issues.  While the FreeBSD GNOME people are doing a great job in porting
                   9592: GNOME to their operating system, the official GNOME sources are now
                   9593: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
                   9594: and similar macros.  This hurts portability.  Please see our patching
                   9595: 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
                   9596: details.</p>
                   9597: </div>
1.1       dsieger  9598: </div>
1.41      asau     9599: <div class="chapter">
1.1       dsieger  9600: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   9601: <a name="submit"></a>Chapter 23. Submitting and Committing</h2></div></div></div>
1.1       dsieger  9602: <div class="toc">
                   9603: <p><b>Table of Contents</b></p>
1.100     leot     9604: <dl class="toc">
1.154     rillig   9605: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
                   9606: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   9607: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
                   9608: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
                   9609: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
                   9610: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
                   9611: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
                   9612: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
1.1       dsieger  9613: </dl>
                   9614: </div>
1.41      asau     9615: <div class="sect1">
1.1       dsieger  9616: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   9617: <a name="submitting-binary-packages"></a>23.1. Submitting binary packages</h2></div></div></div>
1.1       dsieger  9618: <p>Our policy is that we accept binaries only from pkgsrc
                   9619:        developers to guarantee that the packages don't contain any
                   9620:        trojan horses etc. This is not to annoy anyone but rather to
                   9621:        protect our users! You're still free to put up your home-made
                   9622:        binary packages and tell the world where to get them. NetBSD
                   9623:        developers doing bulk builds and wanting to upload them please
1.154     rillig   9624:        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.66      asau     9625: builds)</i></a>.</p>
1.1       dsieger  9626: </div>
1.41      asau     9627: <div class="sect1">
1.1       dsieger  9628: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   9629: <a name="submitting-your-package"></a>23.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.1       dsieger  9630: <p>First, check that your package is complete, compiles and
1.184     rillig   9631:        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.197     leot     9632:        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.1       dsieger  9633:        archive that contains all files that make up the package.
                   9634:        Finally, send this package to the pkgsrc bug tracking system,
1.197     leot     9635:        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.1       dsieger  9636:        that, go to the web page
1.174     leot     9637:        <a class="ulink" href="https://www.NetBSD.org/support/send-pr.html" target="_top">https://www.NetBSD.org/support/send-pr.html</a>,
1.21      snj      9638:        which contains some instructions and a link to a form where you
                   9639:        can submit packages.  The
1.137     leot     9640:        <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.21      snj      9641:        also available as a substitute for either of the above two tools.
                   9642:        </p>
1.1       dsieger  9643: <p>In the form of the problem report, the category should be
1.23      wiz      9644:        <span class="quote">&#8220;<span class="quote">pkg</span>&#8221;</span>, the synopsis should include the package name
1.1       dsieger  9645:        and version number, and the description field should contain a
                   9646:        short description of your package (contents of the COMMENT
                   9647:        variable or DESCR file are OK). The uuencoded package data should
1.23      wiz      9648:        go into the <span class="quote">&#8220;<span class="quote">fix</span>&#8221;</span> field.</p>
1.1       dsieger  9649: <p>If you want to submit several packages, please send a
                   9650:        separate PR for each one, it's easier for us to track things
                   9651:        that way.</p>
                   9652: <p>Alternatively, you can also import new packages into
1.23      wiz      9653:        pkgsrc-wip (<span class="quote">&#8220;<span class="quote">pkgsrc work-in-progress</span>&#8221;</span>); see the
1.174     leot     9654:        homepage at <a class="ulink" href="https://pkgsrc.org/wip/" target="_top">https://pkgsrc.org/wip/</a>
1.1       dsieger  9655:        for details.</p>
                   9656: </div>
1.41      asau     9657: <div class="sect1">
1.1       dsieger  9658: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   9659: <a name="general-notes-for-changes"></a>23.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.1       dsieger  9660: <p>Please note all package additions, updates, moves, and
                   9661:        removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
                   9662:        important to keep this file up to date and conforming to the
                   9663:        existing format, because it will be used by scripts to
1.174     leot     9664:        automatically update pages on <a class="ulink" href="https://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.1       dsieger  9665:        sites. Additionally, check the
                   9666:        <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
                   9667:        for the package you updated or removed, in case it was mentioned
                   9668:        there.</p>
                   9669: <p>When the <code class="varname">PKGREVISION</code> of a package is
                   9670:        bumped, the change should appear in
                   9671:        <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
                   9672:        related or otherwise relevant. Mass bumps that result from a
                   9673:        dependency being updated should not be mentioned. In all other
                   9674:        cases it's the developer's decision.</p>
                   9675: <p>There is a make target that helps in creating proper
1.10      hubertf  9676:   <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries:  <span class="command"><strong>make
1.1       dsieger  9677:   changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
                   9678:   and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
                   9679:   usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
                   9680:   file is up-to-date (to avoid having to resolve conflicts later-on)
1.10      hubertf  9681:   and then to <span class="command"><strong>cd</strong></span> to the package directory.  For
                   9682:   package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.1       dsieger  9683:   For new packages, or package moves or removals, set the
                   9684:   <code class="varname">CTYPE</code> variable on the command line to "Added",
                   9685:   "Moved", or "Removed".  You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.10      hubertf  9686:   in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.22      jakllsch 9687:   not the same as your NetBSD login name. The target also automatically
                   9688:   removes possibly existing entries for the package in the
                   9689:   <code class="filename">TODO</code> file. Don't forget to commit
1.66      asau     9690:   the changes, e.g. by using <span class="command"><strong>make commit-changes-entry</strong></span>!
1.22      jakllsch 9691:   If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
                   9692:   a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
                   9693:   makes the cvs commands use the main repository.
                   9694:   </p>
1.1       dsieger  9695: </div>
1.41      asau     9696: <div class="sect1">
1.1       dsieger  9697: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   9698: <a name="commit-messages"></a>23.4. Commit Messages</h2></div></div></div>
1.130     wiz      9699: <p>For several years, there have been mirrors of pkgsrc in
                   9700:   fossil, git, and hg. Standard practise when using these tools is to
                   9701:   make the first line of a commit message function as a summary that
                   9702:   can be read without the rest, such as is commonly done with "git log
                   9703:   --oneline". For this reason, we have the following guidelines for
                   9704:   pkgsrc commit messages:</p>
                   9705: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   9706: <li class="listitem"><p>Start the commit message with a line that explains the
1.131     wiz      9707:     big picture in 65 characters or less. When a commit is for one
1.130     wiz      9708:     package, include the name of the package. For updates, include the
                   9709:     version to which it is updated.</p></li>
                   9710: <li class="listitem"><p>Leave the next line empty.</p></li>
                   9711: <li class="listitem"><p>Then come the details for the commit (changes in that
                   9712:     package, reason for a change) and any relevant PRs. Wrap this
                   9713:     section.</p></li>
                   9714: </ul></div>
                   9715: <p>Here is an example:
                   9716:   </p>
                   9717: <pre class="programlisting">
                   9718:   libxslt: update to 1.0.30
                   9719: 
                   9720:   Changes since 1.0.29:
                   9721:   ...
                   9722:   </pre>
                   9723: <p>
                   9724:   </p>
                   9725: <p>Here is another example:
                   9726:   </p>
                   9727: <pre class="programlisting">
                   9728:   mk/bsd.pkg.mk: enable SSP by default on NetBSD
                   9729: 
                   9730:   (rationale)
                   9731:   </pre>
                   9732: <p>
                   9733:   </p>
                   9734: <p>Commit messages are final: no <span class="quote">&#8220;<span class="quote">cvs admin</span>&#8221;</span> is
                   9735:   allowed on the pkgsrc repository to change commit messages.</p>
                   9736: </div>
                   9737: <div class="sect1">
                   9738: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   9739: <a name="committing-importing"></a>23.5. Committing: Adding a package to CVS</h2></div></div></div>
1.1       dsieger  9740: <p>This section is only of interest for pkgsrc developers with write
1.33      wiz      9741:   access to the pkgsrc repository.</p>
                   9742: <p>When the package is finished, <span class="quote">&#8220;<span class="quote">cvs add</span>&#8221;</span> the files.
                   9743: Start by adding the directory and then files in the directory. Don't
                   9744: forget to add the new package to the category's
                   9745: <code class="filename">Makefile</code>. Make sure you don't forget any files;
                   9746: you can check by running <span class="quote">&#8220;<span class="quote">cvs status</span>&#8221;</span>. An example:</p>
                   9747: <pre class="programlisting">
                   9748: <code class="prompt">$</code> cd .../pkgsrc/category
                   9749: <code class="prompt">$</code> cvs add pkgname
                   9750: <code class="prompt">$</code> cd pkgname
                   9751: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
                   9752: <code class="prompt">$</code> cvs add patches/p*
                   9753: <code class="prompt">$</code> cvs status | less
1.34      wiz      9754: <code class="prompt">$</code> cvs commit
1.33      wiz      9755: <code class="prompt">$</code> cd ..
                   9756: <code class="prompt">$</code> vi Makefile # add SUBDIRS+=pkgname line
1.34      wiz      9757: <code class="prompt">$</code> cvs commit Makefile
1.66      asau     9758: <code class="prompt">$</code> cd pkgname
1.73      jnemeth  9759: <code class="prompt">$</code> make CTYPE=Added commit-changes-entry
1.33      wiz      9760: </pre>
1.1       dsieger  9761: <p>The commit message of the initial import should include part of the
                   9762:   <code class="filename">DESCR</code> file, so people reading the mailing lists know
                   9763:   what the package is/does.</p>
1.33      wiz      9764: <p>Also mention the new package in
                   9765: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
                   9766: <p>Previously, <span class="quote">&#8220;<span class="quote">cvs import</span>&#8221;</span> was suggested, but it was
                   9767: much easier to get wrong than <span class="quote">&#8220;<span class="quote">cvs add</span>&#8221;</span>.</p>
1.1       dsieger  9768: </div>
1.41      asau     9769: <div class="sect1">
1.1       dsieger  9770: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   9771: <a name="updating-package"></a>23.6. Updating a package to a newer version</h2></div></div></div>
1.1       dsieger  9772: <p>Please always put a concise, appropriate and relevant summary of the
                   9773:   changes between old and new versions into the commit log when updating
                   9774:   a package. There are various reasons for this:</p>
1.41      asau     9775: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      9776: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.1       dsieger  9777:   or its information may be overwritten by newer information.</p></li>
1.23      wiz      9778: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1       dsieger  9779:   repository is very useful for people who use either cvs or anoncvs.</p></li>
1.23      wiz      9780: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1       dsieger  9781:   repository is very useful for people who read the pkgsrc-changes mailing
                   9782:   list, so that they can make tactical decisions about when to upgrade
                   9783:   the package.</p></li>
                   9784: </ul></div>
                   9785: <p>Please also recognize that, just because a new version of a package
                   9786:   has been released, it should not automatically be upgraded in the CVS
                   9787:   repository.  We prefer to be conservative in the packages that are
                   9788:   included in pkgsrc - development or beta packages are not really the
                   9789:   best thing for most places in which pkgsrc is used. Please use your
                   9790:   judgement about what should go into pkgsrc, and bear in mind that
                   9791:   stability is to be preferred above new and possibly untested features.</p>
                   9792: </div>
1.41      asau     9793: <div class="sect1">
1.1       dsieger  9794: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   9795: <a name="renaming-package"></a>23.7. Renaming a package in pkgsrc</h2></div></div></div>
1.20      snj      9796: <p>Renaming packages is not recommended.</p>
1.175     gutterid 9797: <p>When renaming packages, be sure to fix any references to the old name
1.20      snj      9798:   in other Makefiles, options, buildlink files, etc.</p>
1.167     leot     9799: <p>
1.175     gutterid 9800:   Also, when renaming a package, please add
1.167     leot     9801:   the package name and version pattern(s) of the previous package
                   9802:   to <code class="varname">SUPERSEDES</code>.
1.20      snj      9803:   This may be repeated for multiple renames.
                   9804:   The new package would be an exact replacement.
1.167     leot     9805:   Example:
1.20      snj      9806: </p>
1.167     leot     9807: <pre class="programlisting">
                   9808: SUPERSEDES+=    p5-IO-Compress-Zlib&lt;2.017
                   9809: SUPERSEDES+=    optcomp-[0-9]*
                   9810: </pre>
1.23      wiz      9811: <p>Note that <span class="quote">&#8220;<span class="quote">successor</span>&#8221;</span> in the
1.20      snj      9812:   CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
                   9813:   mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
                   9814:   not be an exact replacement but is a suggestion for the replaced
                   9815:   functionality.</p>
                   9816: </div>
1.41      asau     9817: <div class="sect1">
1.20      snj      9818: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   9819: <a name="moving-package"></a>23.8. Moving a package in pkgsrc</h2></div></div></div>
1.20      snj      9820: <p>It is preferred that packages are not renamed or moved, but if needed
                   9821:   please follow these steps.
                   9822: </p>
1.23      wiz      9823: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9824: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
                   9825: <li class="listitem">
1.1       dsieger  9826: <p>Remove all CVS dirs.</p>
                   9827: <p>Alternatively to the first two steps you can also do:</p>
                   9828: <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>
                   9829: <p>and use that for further work.</p>
                   9830: </li>
1.23      wiz      9831: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
                   9832: <code class="varname">DEPENDS</code> paths that just did <span class="quote">&#8220;<span class="quote">../package</span>&#8221;</span>
                   9833: instead of <span class="quote">&#8220;<span class="quote">../../category/package</span>&#8221;</span>.</p></li>
                   9834: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.20      snj      9835: <code class="varname">PREV_PKGPATH</code> to the previous category/package
                   9836: pathname.  The <code class="varname">PREV_PKGPATH</code> can be used by tools
                   9837: for doing an update using pkgsrc building; for example, it can
1.197     leot     9838: 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.20      snj      9839: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
                   9840: new <code class="varname">PKGPATH</code> for that moved package.  Note that
                   9841: it may have multiple matches, so the tool should also check on the
                   9842: <code class="varname">PKGBASE</code> too.  The <code class="varname">PREV_PKGPATH</code>
                   9843: probably has no value unless <code class="varname">SUPERSEDES</code> is not
                   9844: set, i.e.  <code class="varname">PKGBASE</code> stays the same.  </p></li>
1.23      wiz      9845: <li class="listitem"><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.1       dsieger  9846: place.</p></li>
1.23      wiz      9847: <li class="listitem">
1.1       dsieger  9848: <p>Check if any package depends on it:
                   9849: </p>
                   9850: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   9851: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
                   9852: </li>
1.23      wiz      9853: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
                   9854: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
                   9855: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
                   9856: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
                   9857: <li class="listitem">
1.1       dsieger  9858: <p>Commit the changed and removed files:</p>
                   9859: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile</code></strong></pre>
                   9860: <p>(and any packages from step 5, of course).</p>
                   9861: </li>
                   9862: </ol></div>
                   9863: </div>
                   9864: </div>
1.41      asau     9865: <div class="chapter">
1.1       dsieger  9866: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   9867: <a name="devfaq"></a>Chapter 24. Frequently Asked Questions</h2></div></div></div>
1.1       dsieger  9868: <p>This section contains the answers to questions that may
                   9869:        arise when you are writing a package. If you don't find your
                   9870:        question answered here, first have a look in the other chapters,
                   9871:        and if you still don't have the answer, ask on the
                   9872:        <code class="literal">pkgsrc-users</code> mailing list.</p>
1.41      asau     9873: <div class="qandaset">
1.174     leot     9874: <a name="devfaq.qandaset"></a><dl>
1.154     rillig   9875: <dt>24.1. <a href="#devfaq.makeflags">What is the difference between
1.1       dsieger  9876:        MAKEFLAGS, .MAKEFLAGS and
                   9877:        MAKE_FLAGS?</a>
                   9878: </dt>
1.154     rillig   9879: <dt>24.2. <a href="#devfaq.make">What is the difference between
1.1       dsieger  9880:        MAKE, GMAKE and
                   9881:        MAKE_PROGRAM?</a>
                   9882: </dt>
1.154     rillig   9883: <dt>24.3. <a href="#devfaq.cc">What is the difference between
1.1       dsieger  9884:        CC, PKG_CC and
                   9885:        PKGSRC_COMPILER?</a>
                   9886: </dt>
1.154     rillig   9887: <dt>24.4. <a href="#devfaq.bl3flags">What is the difference between
1.1       dsieger  9888:        BUILDLINK_LDFLAGS,
                   9889:        BUILDLINK_LDADD and
                   9890:        BUILDLINK_LIBS?</a>
                   9891: </dt>
1.154     rillig   9892: <dt>24.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.1       dsieger  9893:        VARNAME=BUILDLINK_PREFIX.foo
                   9894:        say it's empty?</a>
                   9895: </dt>
1.154     rillig   9896: <dt>24.6. <a href="#devfaq.master_sites">What does
1.1       dsieger  9897:        ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
                   9898:        don't understand the := inside
                   9899:        it.</a>
                   9900: </dt>
1.154     rillig   9901: <dt>24.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.1       dsieger  9902:        developers?</a>
                   9903: </dt>
1.154     rillig   9904: <dt>24.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.1       dsieger  9905:        documentation?</a>
                   9906: </dt>
1.174     leot     9907: <dt>24.9. <a href="#devfaq.too-much-time">I have a little time to kill. 
                   9908: What shall I do?</a>
1.1       dsieger  9909: </dt>
                   9910: </dl>
1.41      asau     9911: <table border="0" style="width: 100%;">
                   9912: <colgroup>
1.1       dsieger  9913: <col align="left" width="1%">
1.23      wiz      9914: <col>
1.41      asau     9915: </colgroup>
1.1       dsieger  9916: <tbody>
1.41      asau     9917: <tr class="question">
1.1       dsieger  9918: <td align="left" valign="top">
1.174     leot     9919: <a name="devfaq.makeflags"></a><a name="devfaq.makeflags.q"></a><p><b>24.1.</b></p>
1.1       dsieger  9920: </td>
                   9921: <td align="left" valign="top"><p>What is the difference between
                   9922:        <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
                   9923:        <code class="varname">MAKE_FLAGS</code>?</p></td>
                   9924: </tr>
                   9925: <tr class="answer">
                   9926: <td align="left" valign="top"></td>
                   9927: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
1.197     leot     9928:        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.1       dsieger  9929:        <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
                   9930:        the <code class="varname">MAKE_PROGRAM</code> when building the
                   9931:        package. [FIXME: What is .MAKEFLAGS for?]</p></td>
                   9932: </tr>
1.41      asau     9933: <tr class="question">
1.1       dsieger  9934: <td align="left" valign="top">
1.174     leot     9935: <a name="devfaq.make"></a><a name="devfaq.make.q"></a><p><b>24.2.</b></p>
1.1       dsieger  9936: </td>
                   9937: <td align="left" valign="top"><p>What is the difference between
                   9938:        <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
                   9939:        <code class="varname">MAKE_PROGRAM</code>?</p></td>
                   9940: </tr>
                   9941: <tr class="answer">
                   9942: <td align="left" valign="top"></td>
                   9943: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
1.197     leot     9944:        <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.1       dsieger  9945:        infrastructure. <code class="varname">GMAKE</code> is the path to GNU
                   9946:        Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
                   9947:        use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
                   9948:        Make program that is used for building the
                   9949:        package.</p></td>
                   9950: </tr>
1.41      asau     9951: <tr class="question">
1.1       dsieger  9952: <td align="left" valign="top">
1.174     leot     9953: <a name="devfaq.cc"></a><a name="devfaq.cc.q"></a><p><b>24.3.</b></p>
1.1       dsieger  9954: </td>
                   9955: <td align="left" valign="top"><p>What is the difference between
                   9956:        <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
                   9957:        <code class="varname">PKGSRC_COMPILER</code>?</p></td>
                   9958: </tr>
                   9959: <tr class="answer">
                   9960: <td align="left" valign="top"></td>
                   9961: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
                   9962:        compiler, which can be configured by the pkgsrc user.
                   9963:        <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
                   9964:        <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
                   9965:        path to a compiler, but the type of compiler that should be
                   9966:        used. See <code class="filename">mk/compiler.mk</code> for more
                   9967:        information about the latter variable.</p></td>
                   9968: </tr>
1.41      asau     9969: <tr class="question">
1.1       dsieger  9970: <td align="left" valign="top">
1.174     leot     9971: <a name="devfaq.bl3flags"></a><a name="devfaq.bl3flags.q"></a><p><b>24.4.</b></p>
1.1       dsieger  9972: </td>
                   9973: <td align="left" valign="top"><p>What is the difference between
                   9974:        <code class="varname">BUILDLINK_LDFLAGS</code>,
                   9975:        <code class="varname">BUILDLINK_LDADD</code> and
                   9976:        <code class="varname">BUILDLINK_LIBS</code>?</p></td>
                   9977: </tr>
                   9978: <tr class="answer">
                   9979: <td align="left" valign="top"></td>
                   9980: <td align="left" valign="top"><p>[FIXME]</p></td>
                   9981: </tr>
1.41      asau     9982: <tr class="question">
1.1       dsieger  9983: <td align="left" valign="top">
1.174     leot     9984: <a name="devfaq.bl3prefix"></a><a name="devfaq.bl3prefix.q"></a><p><b>24.5.</b></p>
1.1       dsieger  9985: </td>
1.10      hubertf  9986: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.1       dsieger  9987:        VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
                   9988:        say it's empty?</p></td>
                   9989: </tr>
                   9990: <tr class="answer">
                   9991: <td align="left" valign="top"></td>
                   9992: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.23      wiz      9993:        available in the <span class="quote">&#8220;<span class="quote">wrapper</span>&#8221;</span> phase and later. To
                   9994:        <span class="quote">&#8220;<span class="quote">simulate</span>&#8221;</span> the wrapper phase, append
1.10      hubertf  9995:        <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.1       dsieger  9996:        command.</p></td>
                   9997: </tr>
1.41      asau     9998: <tr class="question">
1.1       dsieger  9999: <td align="left" valign="top">
1.174     leot     10000: <a name="devfaq.master_sites"></a><a name="devfaq.master_sites.q"></a><p><b>24.6.</b></p>
1.1       dsieger  10001: </td>
                   10002: <td align="left" valign="top"><p>What does
1.108     rillig   10003:        <code class="code">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
                   10004:        don't understand the <code class="code">:=</code> inside
1.1       dsieger  10005:        it.</p></td>
                   10006: </tr>
                   10007: <tr class="answer">
                   10008: <td align="left" valign="top"></td>
1.108     rillig   10009: <td align="left" valign="top"><p>The <code class="code">:=</code> is not really an
                   10010:        assignment operator, although it looks like it.
1.1       dsieger  10011:        Instead, it is a degenerate form of
1.108     rillig   10012:        <code class="code">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.197     leot     10013:        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.108     rillig   10014:        commonly used in the form <code class="code">${SRCS:.c=.o}</code>. In the
1.1       dsieger  10015:        case of <code class="varname">MASTER_SITE_*</code>,
                   10016:        <em class="replaceable"><code>old_string</code></em> is the empty string and
                   10017:        <em class="replaceable"><code>new_string</code></em> is
1.108     rillig   10018:        <code class="code">package/</code>. That's where the
                   10019:        <code class="code">:</code> and the <code class="code">=</code> fall
1.1       dsieger  10020:        together.</p></td>
                   10021: </tr>
1.41      asau     10022: <tr class="question">
1.1       dsieger  10023: <td align="left" valign="top">
1.174     leot     10024: <a name="devfaq.mailinglists"></a><a name="devfaq.mailinglists.q"></a><p><b>24.7.</b></p>
1.1       dsieger  10025: </td>
                   10026: <td align="left" valign="top"><p>Which mailing lists are there for package
                   10027:        developers?</p></td>
                   10028: </tr>
                   10029: <tr class="answer">
                   10030: <td align="left" valign="top"></td>
1.41      asau     10031: <td align="left" valign="top"><div class="variablelist"><dl class="variablelist">
1.174     leot     10032: <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.1       dsieger  10033: <dd><p>This is a list for technical discussions related
                   10034:        to pkgsrc development, e.g. soliciting feedback for changes to
                   10035:        pkgsrc infrastructure, proposed new features, questions related
                   10036:        to porting pkgsrc to a new platform, advice for maintaining a
                   10037:        package, patches that affect many packages, help requests moved
                   10038:        from pkgsrc-users when an infrastructure bug is found,
                   10039:        etc.</p></dd>
1.174     leot     10040: <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.1       dsieger  10041: <dd><p>All bug reports in category "pkg" sent with
1.197     leot     10042:        <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.1       dsieger  10043:        directly; use one of the other mailing
                   10044:        lists.</p></dd>
                   10045: </dl></div></td>
                   10046: </tr>
1.41      asau     10047: <tr class="question">
1.1       dsieger  10048: <td align="left" valign="top">
1.174     leot     10049: <a name="devfaq.documentation"></a><a name="devfaq.documentation.q"></a><p><b>24.8.</b></p>
1.1       dsieger  10050: </td>
                   10051: <td align="left" valign="top"><p>Where is the pkgsrc
                   10052:        documentation?</p></td>
                   10053: </tr>
                   10054: <tr class="answer">
                   10055: <td align="left" valign="top"></td>
                   10056: <td align="left" valign="top">
                   10057: <p>There are many places where you can find
                   10058:        documentation about pkgsrc:</p>
1.41      asau     10059: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      10060: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.1       dsieger  10061:        of chapters that explain large parts of pkgsrc, but some
                   10062:        chapters tend to be outdated. Which ones they are is hard to
                   10063:        say.</p></li>
1.174     leot     10064: <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.1       dsieger  10065:        about certain features, announcements of new parts of the pkgsrc
                   10066:        infrastructure and sometimes even announcements that a certain
                   10067:        feature has been marked as obsolete. The benefit here is that
                   10068:        each message has a date appended to it.</p></li>
1.23      wiz      10069: <li class="listitem"><p>Many of the files in the
1.1       dsieger  10070:        <code class="filename">mk/</code> directory start with a comment that
                   10071:        describes the purpose of the file and how it can be used by the
                   10072:        pkgsrc user and package authors. An easy way to find this
1.10      hubertf  10073:        documentation is to run <span class="command"><strong>bmake
1.1       dsieger  10074:        help</strong></span>.</p></li>
1.23      wiz      10075: <li class="listitem"><p>The CVS log messages are a rich source of
1.1       dsieger  10076:        information, but they tend to be highly abbreviated, especially
                   10077:        for actions that occur often. Some contain a detailed
                   10078:        description of what has changed, but they are geared towards the
                   10079:        other pkgsrc developers, not towards an average pkgsrc user.
                   10080:        They also only document <span class="emphasis"><em>changes</em></span>, so if you
                   10081:        don't know what has been before, these messages may not be worth
                   10082:        too much to you.</p></li>
1.23      wiz      10083: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">&#8220;<span class="quote">implicitly
                   10084:        documented</span>&#8221;</span>, that is the documentation exists only in the
1.1       dsieger  10085:        mind of the developer who wrote the code. To get this
1.10      hubertf  10086:        information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.1       dsieger  10087:        to see who has written it and ask on the
                   10088:        <code class="literal">tech-pkg</code> mailing list, so that others can
                   10089:        find your questions later (see above). To be sure that the
                   10090:        developer in charge reads the mail, you may CC him or
                   10091:        her.</p></li>
                   10092: </ul></div>
1.184     rillig   10093: </td>
                   10094: </tr>
                   10095: <tr class="question">
                   10096: <td align="left" valign="top">
                   10097: <a name="devfaq.too-much-time"></a><a name="devfaq.too-much-time.q"></a><p><b>24.9.</b></p>
                   10098: </td>
                   10099: <td align="left" valign="top"><p>I have a little time to kill. 
                   10100: What shall I do?</p></td>
                   10101: </tr>
                   10102: <tr class="answer">
                   10103: <td align="left" valign="top"></td>
                   10104: <td align="left" valign="top">
                   10105: <p>This is not really an FAQ yet, but here's the answer
                   10106: anyway.</p>
1.41      asau     10107: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.184     rillig   10108: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
                   10109:     <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
                   10110:     will tell you about newer versions of installed packages that are
                   10111:     available, but not yet updated in pkgsrc.</p></li>
                   10112: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
                   10113:     &mdash; it contains a list of suggested new packages and a list of
                   10114:     cleanups and enhancements for pkgsrc that would be nice to
                   10115:     have.</p></li>
                   10116: <li class="listitem"><p>Review packages for which review was requested on
                   10117:     the <a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a>
                   10118:     mailing list.</p></li>
1.1       dsieger  10119: </ul></div>
1.184     rillig   10120: </td>
1.1       dsieger  10121: </tr>
                   10122: </tbody>
1.184     rillig   10123: </table>
1.1       dsieger  10124: </div>
                   10125: </div>
                   10126: </div>
1.41      asau     10127: <div class="part">
1.1       dsieger  10128: <div class="titlepage"><div><div><h1 class="title">
                   10129: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.41      asau     10130: <div class="partintro">
1.1       dsieger  10131: <div></div>
                   10132: <p>This part of the guide deals with everything
                   10133:        from the infrastructure that is behind the interfaces described
                   10134:        in the developer's guide. A casual package maintainer should not
                   10135:        need anything from this part.</p>
                   10136: <div class="toc">
                   10137: <p><b>Table of Contents</b></p>
1.100     leot     10138: <dl class="toc">
1.184     rillig   10139: <dt><span class="chapter"><a href="#infr.design">25. Design of the pkgsrc infrastructure</a></span></dt>
1.1       dsieger  10140: <dd><dl>
1.184     rillig   10141: <dt><span class="sect1"><a href="#infr.vardef">25.1. The meaning of variable definitions</a></span></dt>
                   10142: <dt><span class="sect1"><a href="#infr.vardef.problems">25.2. Avoiding problems before they arise</a></span></dt>
                   10143: <dt><span class="sect1"><a href="#infr.var">25.3. Variable evaluation</a></span></dt>
1.1       dsieger  10144: <dd><dl>
1.184     rillig   10145: <dt><span class="sect2"><a href="#infr.var.load">25.3.1. At load time</a></span></dt>
                   10146: <dt><span class="sect2"><a href="#infr.var.run">25.3.2. At runtime</a></span></dt>
1.1       dsieger  10147: </dl></dd>
1.184     rillig   10148: <dt><span class="sect1"><a href="#infr.varspec">25.4. How can variables be specified?</a></span></dt>
                   10149: <dt><span class="sect1"><a href="#infr.design.intf">25.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1       dsieger  10150: <dd><dl>
1.184     rillig   10151: <dt><span class="sect2"><a href="#infr.design.intf.proc">25.5.1. Procedures with parameters</a></span></dt>
                   10152: <dt><span class="sect2"><a href="#infr.design.intf.action">25.5.2. Actions taken on behalf of parameters</a></span></dt>
1.1       dsieger  10153: </dl></dd>
1.184     rillig   10154: <dt><span class="sect1"><a href="#infr.order">25.6. The order in which files are loaded</a></span></dt>
1.1       dsieger  10155: <dd><dl>
1.184     rillig   10156: <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>
                   10157: <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.1       dsieger  10158: </dl></dd>
                   10159: </dl></dd>
1.184     rillig   10160: <dt><span class="chapter"><a href="#regression">26. Regression tests</a></span></dt>
1.1       dsieger  10161: <dd><dl>
1.184     rillig   10162: <dt><span class="sect1"><a href="#regression.run">26.1. Running the regression tests</a></span></dt>
                   10163: <dt><span class="sect1"><a href="#regression.new">26.2. Adding a new regression test</a></span></dt>
1.1       dsieger  10164: <dd><dl>
1.184     rillig   10165: <dt><span class="sect2"><a href="#regression.fun.override">26.2.1. Overridable functions</a></span></dt>
                   10166: <dt><span class="sect2"><a href="#regression.fun.helper">26.2.2. Helper functions</a></span></dt>
1.1       dsieger  10167: </dl></dd>
                   10168: </dl></dd>
1.184     rillig   10169: <dt><span class="chapter"><a href="#porting">27. Porting pkgsrc</a></span></dt>
                   10170: <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.1       dsieger  10171: </dl>
                   10172: </div>
                   10173: </div>
1.41      asau     10174: <div class="chapter">
1.1       dsieger  10175: <div class="titlepage"><div><div><h2 class="title">
1.184     rillig   10176: <a name="infr.design"></a>Chapter 25. Design of the pkgsrc infrastructure</h2></div></div></div>
1.1       dsieger  10177: <div class="toc">
                   10178: <p><b>Table of Contents</b></p>
1.100     leot     10179: <dl class="toc">
1.184     rillig   10180: <dt><span class="sect1"><a href="#infr.vardef">25.1. The meaning of variable definitions</a></span></dt>
                   10181: <dt><span class="sect1"><a href="#infr.vardef.problems">25.2. Avoiding problems before they arise</a></span></dt>
                   10182: <dt><span class="sect1"><a href="#infr.var">25.3. Variable evaluation</a></span></dt>
1.1       dsieger  10183: <dd><dl>
1.184     rillig   10184: <dt><span class="sect2"><a href="#infr.var.load">25.3.1. At load time</a></span></dt>
                   10185: <dt><span class="sect2"><a href="#infr.var.run">25.3.2. At runtime</a></span></dt>
1.1       dsieger  10186: </dl></dd>
1.184     rillig   10187: <dt><span class="sect1"><a href="#infr.varspec">25.4. How can variables be specified?</a></span></dt>
                   10188: <dt><span class="sect1"><a href="#infr.design.intf">25.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1       dsieger  10189: <dd><dl>
1.184     rillig   10190: <dt><span class="sect2"><a href="#infr.design.intf.proc">25.5.1. Procedures with parameters</a></span></dt>
                   10191: <dt><span class="sect2"><a href="#infr.design.intf.action">25.5.2. Actions taken on behalf of parameters</a></span></dt>
1.1       dsieger  10192: </dl></dd>
1.184     rillig   10193: <dt><span class="sect1"><a href="#infr.order">25.6. The order in which files are loaded</a></span></dt>
1.1       dsieger  10194: <dd><dl>
1.184     rillig   10195: <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>
                   10196: <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.1       dsieger  10197: </dl></dd>
                   10198: </dl>
                   10199: </div>
                   10200: <p>The pkgsrc infrastructure consists of many small Makefile
                   10201:        fragments. Each such fragment needs a properly specified
                   10202:        interface. This chapter explains how such an interface looks
                   10203:        like.</p>
1.41      asau     10204: <div class="sect1">
1.1       dsieger  10205: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   10206: <a name="infr.vardef"></a>25.1. The meaning of variable definitions</h2></div></div></div>
1.1       dsieger  10207: <p>Whenever a variable is defined in the pkgsrc
                   10208:        infrastructure, the location and the way of definition provide
                   10209:        much information about the intended use of that variable.
                   10210:        Additionally, more documentation may be found in a header
                   10211:        comment or in this pkgsrc guide.</p>
                   10212: <p>A special file is
                   10213:        <code class="filename">mk/defaults/mk.conf</code>, which lists all
                   10214:        variables that are intended to be user-defined. They are either
                   10215:        defined using the <code class="literal">?=</code> operator or they are
                   10216:        left undefined because defining them to anything would
1.23      wiz      10217:        effectively mean <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. All these variables may be
1.1       dsieger  10218:        overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
                   10219:        file.</p>
                   10220: <p>Outside this file, the following conventions apply:
                   10221:        Variables that are defined using the <code class="literal">?=</code>
                   10222:        operator may be overridden by a package.</p>
                   10223: <p>Variables that are defined using the <code class="literal">=</code>
                   10224:        operator may be used read-only at run-time.</p>
                   10225: <p>Variables whose name starts with an underscore must not be
                   10226:        accessed outside the pkgsrc infrastructure at all. They may
                   10227:        change without further notice.</p>
1.41      asau     10228: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  10229: <h3 class="title">Note</h3>
                   10230: <p>These conventions are currently not applied
                   10231:        consistently to the complete pkgsrc
                   10232:        infrastructure.</p>
                   10233: </div>
                   10234: </div>
1.41      asau     10235: <div class="sect1">
1.1       dsieger  10236: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   10237: <a name="infr.vardef.problems"></a>25.2. Avoiding problems before they arise</h2></div></div></div>
1.1       dsieger  10238: <p>All variables that contain lists of things should default
                   10239:        to being empty. Two examples that do not follow this rule are
                   10240:        <code class="varname">USE_LANGUAGES</code> and
                   10241:        <code class="varname">DISTFILES</code>. These variables cannot simply be
                   10242:        modified using the <code class="literal">+=</code> operator in package
                   10243:        <code class="filename">Makefile</code>s (or other files included by
                   10244:        them), since there is no guarantee whether the variable is
                   10245:        already set or not, and what its value is. In the case of
1.23      wiz      10246:        <code class="varname">DISTFILES</code>, the packages <span class="quote">&#8220;<span class="quote">know</span>&#8221;</span>
1.1       dsieger  10247:        the default value and just define it as in the following
                   10248:        example.</p>
                   10249: <pre class="programlisting">
                   10250: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
                   10251: </pre>
                   10252: <p>Because of the selection of this default value, the same
                   10253:        value appears in many package Makefiles. Similarly for
                   10254:        <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.23      wiz      10255:        value (<span class="quote">&#8220;<span class="quote"><code class="literal">c</code></span>&#8221;</span>) is so short that it
1.1       dsieger  10256:        doesn't stand out. Nevertheless it is mentioned in many
                   10257:        files.</p>
                   10258: </div>
1.41      asau     10259: <div class="sect1">
1.1       dsieger  10260: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   10261: <a name="infr.var"></a>25.3. Variable evaluation</h2></div></div></div>
1.41      asau     10262: <div class="sect2">
1.1       dsieger  10263: <div class="titlepage"><div><div><h3 class="title">
1.184     rillig   10264: <a name="infr.var.load"></a>25.3.1. At load time</h3></div></div></div>
1.1       dsieger  10265: <p>Variable evaluation takes place either at load time or at
                   10266:        runtime, depending on the context in which they occur. The
                   10267:        contexts where variables are evaluated at load time are:</p>
1.41      asau     10268: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      10269: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.1       dsieger  10270:        and <code class="literal">!=</code> operators,</p></li>
1.23      wiz      10271: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.1       dsieger  10272:        <code class="literal">.for</code>,</p></li>
1.23      wiz      10273: <li class="listitem"><p>Dependency lines.</p></li>
1.1       dsieger  10274: </ul></div>
                   10275: <p>A special exception are references to the iteration
                   10276:        variables of <code class="literal">.for</code> loops, which are expanded
                   10277:        inline, no matter in which context they appear.</p>
                   10278: <p>As the values of variables may change during load time,
                   10279:        care must be taken not to evaluate them by accident. Typical
                   10280:        examples for variables that should not be evaluated at load time
                   10281:        are <code class="varname">DEPENDS</code> and
                   10282:        <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
                   10283:        clear, here is an example:</p>
                   10284: <pre class="programlisting">
                   10285: CONFIGURE_ARGS=         # none
                   10286: CFLAGS=                 -O
                   10287: CONFIGURE_ARGS+=        CFLAGS=${CFLAGS:Q}
                   10288: 
                   10289: CONFIGURE_ARGS:=        ${CONFIGURE_ARGS}
                   10290: 
                   10291: CFLAGS+=                -Wall
1.111     sevan    10292: </pre>
1.1       dsieger  10293: <p>This code shows how the use of the <code class="literal">:=</code>
                   10294:        operator can quickly lead to unexpected results. The first
                   10295:        paragraph is fairly common code. The second paragraph evaluates
                   10296:        the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
                   10297:        <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
                   10298:        <code class="literal">-Wall</code> is appended to the
                   10299:        <code class="varname">CFLAGS</code>, but this addition will not appear in
                   10300:        <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
                   10301:        paragraphs from above typically occur in completely unrelated
                   10302:        files.</p>
                   10303: </div>
1.41      asau     10304: <div class="sect2">
1.1       dsieger  10305: <div class="titlepage"><div><div><h3 class="title">
1.184     rillig   10306: <a name="infr.var.run"></a>25.3.2. At runtime</h3></div></div></div>
1.1       dsieger  10307: <p>After all the files have been loaded, the values of the
                   10308:        variables cannot be changed anymore. Variables that are used in
                   10309:        the shell commands are expanded at this point.</p>
                   10310: </div>
                   10311: </div>
1.41      asau     10312: <div class="sect1">
1.1       dsieger  10313: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   10314: <a name="infr.varspec"></a>25.4. How can variables be specified?</h2></div></div></div>
1.1       dsieger  10315: <p>There are many ways in which the definition and use of a
1.108     rillig   10316:        variable can be restricted in order to detect bugs and violations
                   10317:        of the (mostly unwritten) policies. A package can be checked with
                   10318:        <code class="literal">pkglint -Wall</code> to see whether it meets these
                   10319:        rules.</p>
1.1       dsieger  10320: </div>
1.41      asau     10321: <div class="sect1">
1.1       dsieger  10322: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   10323: <a name="infr.design.intf"></a>25.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.1       dsieger  10324: <p>Most of the <code class="filename">.mk</code> files fall into one
                   10325:        of the following classes. Cases where a file falls into more
                   10326:        than one class should be avoided as it often leads to subtle
                   10327:        bugs.</p>
1.41      asau     10328: <div class="sect2">
1.1       dsieger  10329: <div class="titlepage"><div><div><h3 class="title">
1.184     rillig   10330: <a name="infr.design.intf.proc"></a>25.5.1. Procedures with parameters</h3></div></div></div>
1.1       dsieger  10331: <p>In a traditional imperative programming language some of
                   10332:        the <code class="filename">.mk</code> files could be described as
1.14      jmcneill 10333:        procedures. They take some input parameters and&mdash;after
                   10334:        inclusion&mdash;provide a result in output parameters. Since all
1.1       dsieger  10335:        variables in <code class="filename">Makefile</code>s have global scope
                   10336:        care must be taken not to use parameter names that have already
                   10337:        another meaning. For example, <code class="varname">PKGNAME</code> is a
                   10338:        bad choice for a parameter name.</p>
                   10339: <p>Procedures are completely evaluated at preprocessing time.
                   10340:        That is, when calling a procedure all input parameters must be
                   10341:        completely resolvable. For example,
                   10342:        <code class="varname">CONFIGURE_ARGS</code> should never be an input
                   10343:        parameter since it is very likely that further text will be
                   10344:        added after calling the procedure, which would effectively apply
                   10345:        the procedure to only a part of the variable. Also, references
1.108     rillig   10346:        to other variables will be modified after calling the
1.1       dsieger  10347:        procedure.</p>
                   10348: <p>A procedure can declare its output parameters either as
                   10349:        suitable for use in preprocessing directives or as only
                   10350:        available at runtime. The latter alternative is for variables
                   10351:        that contain references to other runtime variables.</p>
                   10352: <p>Procedures shall be written such that it is possible to
                   10353:        call the procedure more than once. That is, the file must not
                   10354:        contain multiple-inclusion guards.</p>
                   10355: <p>Examples for procedures are
                   10356:        <code class="filename">mk/bsd.options.mk</code> and
                   10357:        <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
                   10358:        that the parameters are evaluated at load time, they should be
                   10359:        assigned using the <code class="literal">:=</code> operator, which should
                   10360:        be used only for this purpose.</p>
                   10361: </div>
1.41      asau     10362: <div class="sect2">
1.1       dsieger  10363: <div class="titlepage"><div><div><h3 class="title">
1.184     rillig   10364: <a name="infr.design.intf.action"></a>25.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.1       dsieger  10365: <p>Action files take some input parameters and may define
                   10366:        runtime variables. They shall not define loadtime variables.
                   10367:        There are action files that are included implicitly by the
                   10368:        pkgsrc infrastructure, while other must be included
                   10369:        explicitly.</p>
                   10370: <p>An example for action files is
                   10371:        <code class="filename">mk/subst.mk</code>.</p>
                   10372: </div>
                   10373: </div>
1.41      asau     10374: <div class="sect1">
1.1       dsieger  10375: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   10376: <a name="infr.order"></a>25.6. The order in which files are loaded</h2></div></div></div>
1.1       dsieger  10377: <p>Package <code class="filename">Makefile</code>s usually consist of
                   10378:        a set of variable definitions, and include the file
                   10379:        <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
                   10380:        Before that, they may also include various other
                   10381:        <code class="filename">*.mk</code> files if they need to query the
                   10382:        availability of certain features like the type of compiler or
                   10383:        the X11 implementation. Due to the heavy use of preprocessor
                   10384:        directives like <code class="literal">.if</code> and
                   10385:        <code class="literal">.for</code>, the order in which the files are loaded
                   10386:        matters.</p>
                   10387: <p>This section describes at which point the various files
                   10388:        are loaded and gives reasons for that order.</p>
1.41      asau     10389: <div class="sect2">
1.1       dsieger  10390: <div class="titlepage"><div><div><h3 class="title">
1.184     rillig   10391: <a name="infr.order.prefs"></a>25.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.1       dsieger  10392: </h3></div></div></div>
                   10393: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
                   10394:        is to define some essential variables like
                   10395:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
                   10396:        <code class="varname">MACHINE_ARCH</code>.</p>
                   10397: <p>Then, the user settings are loaded from the file specified
1.10      hubertf  10398:        in <code class="varname">MAKECONF</code>, which is usually <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.
1.4       rillig   10399:        After that, those variables
1.1       dsieger  10400:        that have not been overridden by the user are loaded from
                   10401:        <code class="filename">mk/defaults/mk.conf</code>.</p>
                   10402: <p>After the user settings, the system settings and platform
                   10403:        settings are loaded, which may override the user
                   10404:        settings.</p>
                   10405: <p>Then, the tool definitions are loaded. The tool wrappers
                   10406:        are not yet in effect. This only happens when building a
                   10407:        package, so the proper variables must be used instead of the
                   10408:        direct tool names.</p>
                   10409: <p>As the last steps, some essential variables from the
                   10410:        wrapper and the package system flavor are loaded, as well as the
                   10411:        variables that have been cached in earlier phases of a package
                   10412:        build.</p>
                   10413: </div>
1.41      asau     10414: <div class="sect2">
1.1       dsieger  10415: <div class="titlepage"><div><div><h3 class="title">
1.184     rillig   10416: <a name="infr.order.pkg"></a>25.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.1       dsieger  10417: </h3></div></div></div>
                   10418: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
                   10419: <p>Then, the various <code class="filename">*-vars.mk</code> files are
                   10420:        loaded, which fill default values for those variables that have
                   10421:        not been defined by the package. These variables may later
                   10422:        be used even in unrelated files.</p>
                   10423: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
                   10424:        provides the target <code class="literal">error-check</code> that is added
                   10425:        as a special dependency to all other targets that use
                   10426:        <code class="varname">DELAYED_ERROR_MSG</code> or
                   10427:        <code class="varname">DELAYED_WARNING_MSG</code>.</p>
                   10428: <p>Then, the package-specific hacks from
                   10429:        <code class="filename">hacks.mk</code> are included.</p>
                   10430: <p>Then, various other files follow. Most of them don't have
                   10431:        any dependencies on what they need to have included before or
                   10432:        after them, though some do.</p>
                   10433: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
                   10434:        <code class="varname">PKG_SKIP_REASON</code> is then executed, which
                   10435:        restricts the use of these variables to all the files that have
                   10436:        been included before. Appearances in later files will be
                   10437:        silently ignored.</p>
                   10438: <p>Then, the files for the main targets are included, in the
                   10439:        order of later execution, though the actual order should not
                   10440:        matter.</p>
                   10441: <p>At last, some more files are included that don't set any
                   10442:        interesting variables but rather just define make targets to be
                   10443:        executed.</p>
                   10444: </div>
                   10445: </div>
                   10446: </div>
1.41      asau     10447: <div class="chapter">
1.1       dsieger  10448: <div class="titlepage"><div><div><h2 class="title">
1.184     rillig   10449: <a name="regression"></a>Chapter 26. Regression tests</h2></div></div></div>
1.1       dsieger  10450: <div class="toc">
                   10451: <p><b>Table of Contents</b></p>
1.100     leot     10452: <dl class="toc">
1.184     rillig   10453: <dt><span class="sect1"><a href="#regression.run">26.1. Running the regression tests</a></span></dt>
                   10454: <dt><span class="sect1"><a href="#regression.new">26.2. Adding a new regression test</a></span></dt>
1.1       dsieger  10455: <dd><dl>
1.184     rillig   10456: <dt><span class="sect2"><a href="#regression.fun.override">26.2.1. Overridable functions</a></span></dt>
                   10457: <dt><span class="sect2"><a href="#regression.fun.helper">26.2.2. Helper functions</a></span></dt>
1.1       dsieger  10458: </dl></dd>
                   10459: </dl>
                   10460: </div>
                   10461: <p>The pkgsrc infrastructure consists of a large codebase,
                   10462:        and there are many corners where every little bit of a file is
                   10463:        well thought out, making pkgsrc likely to fail as soon as
                   10464:        anything is changed near those parts. To prevent most changes
                   10465:        from breaking anything, a suite of regression tests should go
                   10466:        along with every important part of the pkgsrc infrastructure.
                   10467:        This chapter describes how regression tests work in pkgsrc and
                   10468:        how you can add new tests.</p>
1.41      asau     10469: <div class="sect1">
1.1       dsieger  10470: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   10471: <a name="regression.run"></a>26.1. Running the regression tests</h2></div></div></div>
1.137     leot     10472: <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.10      hubertf  10473:        provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.1       dsieger  10474:        can simply run that command, which will run all tests in the
1.168     rillig   10475:        <code class="filename">regress/</code> directory.</p>
1.1       dsieger  10476: </div>
1.41      asau     10477: <div class="sect1">
1.1       dsieger  10478: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   10479: <a name="regression.new"></a>26.2. Adding a new regression test</h2></div></div></div>
1.168     rillig   10480: <p>Every directory in the <code class="filename">regress/</code>
                   10481:        directory that contains a file called <code class="filename">spec</code>
1.1       dsieger  10482:        is considered a regression test. This file is a shell program
1.10      hubertf  10483:        that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.1       dsieger  10484:        The following functions can be overridden to suit your
                   10485:        needs.</p>
1.41      asau     10486: <div class="sect2">
1.1       dsieger  10487: <div class="titlepage"><div><div><h3 class="title">
1.184     rillig   10488: <a name="regression.fun.override"></a>26.2.1. Overridable functions</h3></div></div></div>
1.108     rillig   10489: <p>These functions do not take any parameters. Although they
                   10490:        are called in <span class="quote">&#8220;<span class="quote">set -e</span>&#8221;</span> mode, they don't stop at the
1.174     leot     10491:        first failing command. See <a class="ulink" href="https://stackoverflow.com/q/4072984" target="_top">this Stack Overflow
1.108     rillig   10492:        question</a> for details.</p>
1.41      asau     10493: <div class="variablelist"><dl class="variablelist">
1.108     rillig   10494: <dt><span class="term"><code class="varname">do_setup</code></span></dt>
1.1       dsieger  10495: <dd><p>This function prepares the environment for the
                   10496:        test. By default it does nothing.</p></dd>
1.108     rillig   10497: <dt><span class="term"><code class="varname">do_test</code></span></dt>
                   10498: <dd>
                   10499: <p>This function runs the actual test. By default,
1.1       dsieger  10500:        it calls <code class="varname">TEST_MAKE</code> with the arguments
                   10501:        <code class="varname">MAKEARGS_TEST</code> and writes its output including
                   10502:        error messages into the file
1.108     rillig   10503:        <code class="varname">TEST_OUTFILE</code>.</p>
                   10504: <p>When defining this function, make sure that all output that
                   10505:        needs to be checked is written to the correct output file.
                   10506:        Example:</p>
                   10507: <pre class="programlisting">
                   10508: do_test() {
1.112     rillig   10509:         echo "Example output"
1.108     rillig   10510: } 1&gt;$TEST_OUTFILE 2&gt;&amp;1
                   10511: </pre>
                   10512: </dd>
                   10513: <dt><span class="term"><code class="varname">check_result</code></span></dt>
                   10514: <dd>
                   10515: <p>This function is run after the test and is
1.1       dsieger  10516:        typically used to compare the actual output from the one that is
                   10517:        expected. It can make use of the various helper functions from
1.108     rillig   10518:        the next section. Example:</p>
                   10519: <pre class="programlisting">
                   10520: check_result() {
1.112     rillig   10521:         exit_status 0
                   10522:         output_require "Example"
                   10523:         output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
                   10524:         output_prohibit "no such file or directory"
1.168     rillig   10525:         regress_fail "expected $expected but got $actual for input $input"
1.108     rillig   10526: }
                   10527: </pre>
                   10528: </dd>
                   10529: <dt><span class="term"><code class="varname">do_cleanup</code></span></dt>
1.1       dsieger  10530: <dd><p>This function cleans everything up after the
                   10531:        test has been run. By default it does nothing.</p></dd>
                   10532: </dl></div>
                   10533: </div>
1.41      asau     10534: <div class="sect2">
1.1       dsieger  10535: <div class="titlepage"><div><div><h3 class="title">
1.184     rillig   10536: <a name="regression.fun.helper"></a>26.2.2. Helper functions</h3></div></div></div>
1.41      asau     10537: <div class="variablelist"><dl class="variablelist">
1.168     rillig   10538: <dt><span class="term"><code class="varname">regress_fail <em class="replaceable"><code>message...</code></em></code></span></dt>
                   10539: <dd><p>This function makes the test fail with the given error message.</p></dd>
1.108     rillig   10540: <dt><span class="term"><code class="varname">exit_status expected</code></span></dt>
1.1       dsieger  10541: <dd><p>This function compares the exitcode of the
1.108     rillig   10542:        <span class="command"><strong>do_test</strong></span> function with its first parameter.
1.1       dsieger  10543:        If they differ, the test will fail.</p></dd>
1.108     rillig   10544: <dt><span class="term"><code class="varname">output_require regex...</code></span></dt>
                   10545: <dd>
                   10546: <p>This function checks for each of its parameters
                   10547:        if the output from <span class="command"><strong>do_test</strong></span> matches the
1.1       dsieger  10548:        extended regular expression. If it does not, the test will
1.108     rillig   10549:        fail. Example:</p>
                   10550: <pre class="programlisting">
                   10551: output_require "looks fine"
                   10552: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
                   10553: </pre>
                   10554: </dd>
1.177     leot     10555: <dt><span class="term"><code class="varname">output_prohibit regex...</code></span></dt>
1.1       dsieger  10556: <dd><p>This function checks for each of its parameters
1.10      hubertf  10557:        if the output from <span class="command"><strong>do_test()</strong></span> does
1.1       dsieger  10558:        <span class="emphasis"><em>not</em></span> match the extended regular expression.
                   10559:        If any of the regular expressions matches, the test will
                   10560:        fail.</p></dd>
                   10561: </dl></div>
                   10562: </div>
                   10563: </div>
                   10564: </div>
1.41      asau     10565: <div class="chapter">
1.1       dsieger  10566: <div class="titlepage"><div><div><h2 class="title">
1.184     rillig   10567: <a name="porting"></a>Chapter 27. Porting pkgsrc</h2></div></div></div>
1.1       dsieger  10568: <div class="toc">
                   10569: <p><b>Table of Contents</b></p>
1.184     rillig   10570: <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.1       dsieger  10571: </div>
                   10572: <p>The pkgsrc system has already been ported to many
                   10573:        operating systems, hardware architectures and compilers. This
                   10574:        chapter explains the necessary steps to make pkgsrc even more
                   10575:        portable.</p>
1.41      asau     10576: <div class="sect1">
1.1       dsieger  10577: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.184     rillig   10578: <a name="porting.opsys"></a>27.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.1       dsieger  10579: <p>To port pkgsrc to a new operating system (called
                   10580:        <code class="literal">MyOS</code> in this example), you need to touch the
                   10581:        following files:</p>
1.41      asau     10582: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  10583: <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>
                   10584: <dd><p>This file contains some basic definitions, for
                   10585:        example the name of the C
                   10586:        compiler.</p></dd>
                   10587: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
                   10588: <dd><p>Insert code that defines the variables
                   10589:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
                   10590:        <code class="varname">LOWER_OS_VERSION</code>,
                   10591:        <code class="varname">LOWER_VENDOR</code>,
                   10592:        <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
                   10593:        <code class="varname">APPEND_ELF</code>, and the other variables that
                   10594:        appear in this file.</p></dd>
                   10595: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
                   10596: <dd><p>This file contains the platform-specific
                   10597:        definitions that are used by pkgsrc. Start by copying one of the
                   10598:        other files and edit it to your
                   10599:        needs.</p></dd>
                   10600: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
                   10601: <dd><p>This file defines the paths to all the tools
                   10602:        that are needed by one or the other package in pkgsrc, as well
                   10603:        as by pkgsrc itself. Find out where these tools are on your
                   10604:        platform and add them.</p></dd>
                   10605: </dl></div>
                   10606: <p>Now, you should be able to build some basic packages, like
1.137     leot     10607:        <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.1       dsieger  10608: </div>
                   10609: </div>
                   10610: </div>
1.41      asau     10611: <div class="appendix">
                   10612: <div class="titlepage"><div><div><h1 class="title">
                   10613: <a name="examples"></a>Appendix A. A simple example package: bison</h1></div></div></div>
1.1       dsieger  10614: <div class="toc">
                   10615: <p><b>Table of Contents</b></p>
1.100     leot     10616: <dl class="toc">
1.1       dsieger  10617: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
                   10618: <dd><dl>
                   10619: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
                   10620: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
                   10621: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.172     rillig   10622: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with pkglint</a></span></dt>
1.1       dsieger  10623: </dl></dd>
                   10624: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
                   10625: </dl>
                   10626: </div>
                   10627: <p>We checked to find a piece of software that wasn't in the packages
                   10628:     collection, and picked GNU bison. Quite why someone would want to have
1.10      hubertf  10629:     <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.1       dsieger  10630:     present in the tree is beyond us, but it's useful for the purposes of
                   10631:     this exercise.</p>
1.41      asau     10632: <div class="sect1">
1.1       dsieger  10633: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10634: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.41      asau     10635: <div class="sect2">
1.1       dsieger  10636: <div class="titlepage"><div><div><h3 class="title">
                   10637: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
                   10638: <pre class="programlisting">
                   10639: # $NetBSD$
                   10640: #
                   10641: 
                   10642: DISTNAME=       bison-1.25
                   10643: CATEGORIES=     devel
1.171     rillig   10644: MASTER_SITES=   ${MASTER_SITE_GNU:=bison/}
1.1       dsieger  10645: 
1.29      dholland 10646: MAINTAINER=     pkgsrc-users@NetBSD.org
1.174     leot     10647: HOMEPAGE=       https://www.gnu.org/software/bison/bison.html
1.1       dsieger  10648: COMMENT=        GNU yacc clone
                   10649: 
                   10650: GNU_CONFIGURE=  yes
1.46      wiz      10651: INFO_FILES=     yes
1.1       dsieger  10652: 
                   10653: .include "../../mk/bsd.pkg.mk"
                   10654: </pre>
                   10655: </div>
1.41      asau     10656: <div class="sect2">
1.1       dsieger  10657: <div class="titlepage"><div><div><h3 class="title">
                   10658: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
                   10659: <pre class="programlisting">
                   10660: GNU version of yacc.  Can make re-entrant parsers, and numerous other
1.197     leot     10661: 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.1       dsieger  10662: of the NetBSD source tree is beyond me.
                   10663: </pre>
                   10664: </div>
1.41      asau     10665: <div class="sect2">
1.1       dsieger  10666: <div class="titlepage"><div><div><h3 class="title">
                   10667: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
                   10668: <pre class="programlisting">
                   10669: @comment $NetBSD$
                   10670: bin/bison
                   10671: man/man1/bison.1.gz
                   10672: share/bison.simple
                   10673: share/bison.hairy
                   10674: </pre>
                   10675: </div>
1.41      asau     10676: <div class="sect2">
1.1       dsieger  10677: <div class="titlepage"><div><div><h3 class="title">
1.172     rillig   10678: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with pkglint</h3></div></div></div>
1.1       dsieger  10679: <p>The NetBSD package system comes with
1.137     leot     10680:         <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>
1.1       dsieger  10681:        which helps to check the contents of these
                   10682:        files. After installation it is quite easy to use, just change to the
1.171     rillig   10683:        directory of the package you wish to examine and run
1.10      hubertf  10684:        <span class="command"><strong>pkglint</strong></span>:</p>
1.1       dsieger  10685: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
1.171     rillig   10686: ERROR: Makefile: Each package must define its LICENSE.
                   10687: WARN: Makefile:9: HOMEPAGE should migrate from http to https.
                   10688: NOTE: PLIST:3: The .gz extension is unnecessary for manual pages.
                   10689: WARN: PLIST:5: "share/bison.hairy" should be sorted before "share/bison.simple".
                   10690: 1 error, 2 warnings and 1 note found.
                   10691: (Run "pkglint -e" to show explanations.)
                   10692: (Run "pkglint -fs" to show what can be fixed automatically.)
1.172     rillig   10693: (Run "pkglint -F" to automatically fix some issues.)</pre>
1.1       dsieger  10694: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.170     rillig   10695:        more checks will be performed. Use e.g. <span class="command"><strong>pkglint
1.1       dsieger  10696:        -Wall</strong></span> for a very thorough check.</p>
                   10697: </div>
                   10698: </div>
1.41      asau     10699: <div class="sect1">
1.1       dsieger  10700: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10701: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
                   10702: <p>Create the directory where the package lives,
                   10703:       plus any auxiliary directories:</p>
                   10704: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
                   10705: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
                   10706: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
                   10707: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
                   10708: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.184     rillig   10709:       <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.1       dsieger  10710:       then continue with fetching the distfile:</p>
                   10711: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
                   10712: &gt;&gt; bison-1.25.tar.gz doesn't seem to exist on this system.
                   10713: &gt;&gt; Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
                   10714: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   10715: ftp: Error retrieving file: 500 Internal error
                   10716: 
                   10717: &gt;&gt; Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
                   10718: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   10719: ftp: Error retrieving file: 500 Internal error
                   10720: 
                   10721: &gt;&gt; Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
                   10722: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   10723: Successfully retrieved file.</pre>
                   10724: <p>Generate the checksum of the distfile into
                   10725:       <code class="filename">distinfo</code>:</p>
                   10726: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
                   10727: <p>Now compile:</p>
                   10728: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
                   10729: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10730: ===&gt;  Extracting for bison-1.25
                   10731: ===&gt;  Patching for bison-1.25
                   10732: ===&gt;   Ignoring empty patch directory
                   10733: ===&gt;  Configuring for bison-1.25
                   10734: creating cache ./config.cache
                   10735: checking for gcc... cc
                   10736: checking whether we are using GNU C... yes
                   10737: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
                   10738: checking how to run the C preprocessor... cc -E
                   10739: checking for minix/config.h... no
                   10740: checking for POSIXized ISC... no
                   10741: checking whether cross-compiling... no
                   10742: checking for ANSI C header files... yes
                   10743: checking for string.h... yes
                   10744: checking for stdlib.h... yes
                   10745: checking for memory.h... yes
                   10746: checking for working const... yes
                   10747: checking for working alloca.h... no
                   10748: checking for alloca... yes
                   10749: checking for strerror... yes
                   10750: updating cache ./config.cache
                   10751: creating ./config.status
                   10752: creating Makefile
                   10753: ===&gt;  Building for bison-1.25
                   10754: 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
                   10755: 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
                   10756: 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
                   10757: 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
                   10758: 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
                   10759: 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
                   10760: 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
                   10761: 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
                   10762: 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
                   10763: 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
                   10764: 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
                   10765: 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
                   10766: 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
                   10767: 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
                   10768: 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
                   10769: 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
                   10770: 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
                   10771: 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
                   10772: 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
                   10773: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g getopt.c
                   10774: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g getopt1.c
                   10775: 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
                   10776: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
                   10777: rm -f bison.s1
                   10778: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" &lt; ./bison.simple &gt; bison.s1</pre>
                   10779: <p>Everything seems OK, so install the files:</p>
                   10780: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   10781: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10782: ===&gt;  Installing for bison-1.25
                   10783: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share  /usr/pkg/info /usr/pkg/man/man1
                   10784: rm -f /usr/pkg/bin/bison
                   10785: cd /usr/pkg/share; rm -f bison.simple bison.hairy
                   10786: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
                   10787: install -c  -o bin -g bin -m 555 bison /usr/pkg/bin/bison
                   10788: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
                   10789: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
                   10790: cd .; for f in bison.info*;  do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
                   10791: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
                   10792: ===&gt;  Registering installation for bison-1.25</pre>
                   10793: <p>You can now use bison, and also - if you decide so - remove it with
1.10      hubertf  10794:       <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.1       dsieger  10795:       binary package, do this now:</p>
                   10796: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
                   10797: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10798: ===&gt;  Building package for bison-1.25
                   10799: Creating package bison-1.25.tgz
                   10800: Registering depends:.
                   10801: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
                   10802: <p>Now that you don't need the source and object files
                   10803:       any more, clean up:</p>
                   10804: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
                   10805: ===&gt;  Cleaning for bison-1.25</pre>
                   10806: </div>
                   10807: </div>
1.41      asau     10808: <div class="appendix">
                   10809: <div class="titlepage"><div><div><h1 class="title">
                   10810: <a name="logs"></a>Appendix B. Build logs</h1></div></div></div>
1.1       dsieger  10811: <div class="toc">
                   10812: <p><b>Table of Contents</b></p>
1.100     leot     10813: <dl class="toc">
1.1       dsieger  10814: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
                   10815: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
                   10816: </dl>
                   10817: </div>
1.41      asau     10818: <div class="sect1">
1.1       dsieger  10819: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10820: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
                   10821: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
                   10822: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10823: =&gt; figlet221.tar.gz doesn't seem to exist on this system.
                   10824: =&gt; Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
                   10825: =&gt; [172219 bytes]
                   10826: Connected to ftp.plig.net.
                   10827: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
                   10828: 331 Guest login ok, send your complete e-mail address as password.
                   10829: 230-You are user #5 of 500 simultaneous users allowed.
                   10830: 230-
                   10831: 230-  ___ _             _ _
                   10832: 230- |  _| |_ ___   ___| |_|___   ___ ___ ___
                   10833: 230- |  _|  _| . |_| . | | | . |_| . |  _| . |
                   10834: 230- |_| |_| |  _|_|  _|_|_|_  |_|___|_| |_  |
                   10835: 230-         |_|   |_|     |___|         |___|
                   10836: 230-
                   10837: 230-** Welcome to ftp.plig.org **
                   10838: 230-
                   10839: 230-Please note that all transfers from this FTP site are logged. If you
                   10840: 230-do not like this, please disconnect now.
                   10841: 230-
1.18      snj      10842: 230-This archive is available via
1.1       dsieger  10843: 230-
                   10844: 230-HTTP:  http://ftp.plig.org/
                   10845: 230-FTP:   ftp://ftp.plig.org/     (max 500 connections)
                   10846: 230-RSYNC: rsync://ftp.plig.org/   (max  30 connections)
                   10847: 230-
                   10848: 230-Please email comments, bug reports and requests for packages to be
                   10849: 230-mirrored to ftp-admin@plig.org.
                   10850: 230-
                   10851: 230-
                   10852: 230 Logged in anonymously.
                   10853: Remote system type is UNIX.
                   10854: Using binary mode to transfer files.
                   10855: 200 Type okay.
                   10856: 250 "/pub" is new cwd.
                   10857: 250-"/pub/figlet" is new cwd.
                   10858: 250-
                   10859: 250-Welcome to the figlet archive at ftp.figlet.org
                   10860: 250-
                   10861: 250-   ftp://ftp.figlet.org/pub/figlet/
                   10862: 250-
                   10863: 250-The official FIGlet web page is:
                   10864: 250-   http://www.figlet.org/
                   10865: 250-
                   10866: 250-If you have questions, please mailto:info@figlet.org. If you want to
                   10867: 250-contribute a font or something else, you can email us.
                   10868: 250
                   10869: 250 "/pub/figlet/program" is new cwd.
                   10870: 250 "/pub/figlet/program/unix" is new cwd.
                   10871: local: figlet221.tar.gz remote: figlet221.tar.gz
                   10872: 502 Unimplemented command.
                   10873: 227 Entering Passive Mode (195,40,6,41,246,104)
                   10874: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
                   10875: 38% |**************                       | 65800      64.16 KB/s    00:01 ETA
                   10876: 226 Transfer completed.
                   10877: 172219 bytes received in 00:02 (75.99 KB/s)
                   10878: 221 Goodbye.
                   10879: =&gt; Checksum OK for figlet221.tar.gz.
                   10880: ===&gt; Extracting for figlet-2.2.1nb2
                   10881: ===&gt; Required installed package ccache-[0-9]*: ccache-2.3nb1 found
                   10882: ===&gt; Patching for figlet-2.2.1nb2
                   10883: ===&gt; Applying pkgsrc patches for figlet-2.2.1nb2
                   10884: ===&gt; Overriding tools for figlet-2.2.1nb2
                   10885: ===&gt; Creating toolchain wrappers for figlet-2.2.1nb2
                   10886: ===&gt; Configuring for figlet-2.2.1nb2
                   10887: ===&gt; Building for figlet-2.2.1nb2
                   10888: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\"  -DDEFAULTFONTFILE=\"standard.flf\"  figlet.c zipio.c crc.c inflate.c -o figlet
                   10889: chmod a+x figlet
                   10890: gcc -O2 -o chkfont chkfont.c
                   10891: =&gt; Unwrapping files-to-be-installed.
                   10892: <code class="prompt">#</code>
                   10893: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   10894: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10895: ===&gt; Installing for figlet-2.2.1nb2
                   10896: install -d -o root -g wheel -m 755 /usr/pkg/bin
                   10897: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
                   10898: mkdir -p /usr/pkg/share/figlet
                   10899: cp figlet /usr/pkg/bin
                   10900: cp chkfont /usr/pkg/bin
                   10901: chmod 555 figlist showfigfonts
                   10902: cp figlist /usr/pkg/bin
                   10903: cp showfigfonts /usr/pkg/bin
                   10904: cp fonts/*.flf /usr/pkg/share/figlet
                   10905: cp fonts/*.flc /usr/pkg/share/figlet
                   10906: cp figlet.6 /usr/pkg/man/man6
                   10907: ===&gt; Registering installation for figlet-2.2.1nb2
                   10908: <code class="prompt">#</code></pre>
                   10909: </div>
1.41      asau     10910: <div class="sect1">
1.1       dsieger  10911: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10912: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
                   10913: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
                   10914: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10915: ===&gt; Packaging figlet-2.2.1nb2
                   10916: ===&gt; Building binary package for figlet-2.2.1nb2
                   10917: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
                   10918: Using SrcDir value of /usr/pkg
                   10919: Registering depends:.
                   10920: <code class="prompt">#</code></pre>
                   10921: </div>
                   10922: </div>
1.41      asau     10923: <div class="appendix">
                   10924: <div class="titlepage"><div><div><h1 class="title">
                   10925: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h1></div></div></div>
1.1       dsieger  10926: <div class="toc">
                   10927: <p><b>Table of Contents</b></p>
1.100     leot     10928: <dl class="toc">
1.23      wiz      10929: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
                   10930: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
                   10931: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
                   10932: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
                   10933: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
1.148     leot     10934: <code class="filename">stable</code>,
1.23      wiz      10935: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1       dsieger  10936: source packages</a></span></dt>
                   10937: </dl>
                   10938: </div>
                   10939: <p>As in other big projects, the directory layout of pkgsrc
                   10940:        is quite complex for newbies. This chapter explains where you
                   10941:        find things on the FTP server. The base directory on
1.10      hubertf  10942:        <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.1       dsieger  10943:        On other servers it may be different, but inside this directory,
                   10944:        everything should look the same, no matter on which server you
                   10945:        are. This directory contains some subdirectories, which are
                   10946:        explained below.</p>
1.41      asau     10947: <div class="sect1">
1.1       dsieger  10948: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22      jakllsch 10949: <a name="ftp-distfiles"></a>C.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
1.1       dsieger  10950: <p>The directory <code class="filename">distfiles</code> contains lots
                   10951:        of archive files from all pkgsrc packages, which are mirrored
                   10952:        here. The subdirectories are called after their package names
                   10953:        and are used when the distributed files have names that don't
                   10954:        explicitly contain a version number or are otherwise too generic
                   10955:        (for example <code class="filename">release.tar.gz</code>).</p>
                   10956: </div>
1.41      asau     10957: <div class="sect1">
1.1       dsieger  10958: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22      jakllsch 10959: <a name="ftp-misc"></a>C.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
1.1       dsieger  10960: <p>This directory contains things that individual pkgsrc
                   10961:        developers find worth publishing.</p>
                   10962: </div>
1.41      asau     10963: <div class="sect1">
1.1       dsieger  10964: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22      jakllsch 10965: <a name="ftp-packages"></a>C.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
1.3       rillig   10966: <p>This directory contains binary packages for the various
                   10967:        platforms that are supported by pkgsrc.
                   10968:        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.41      asau     10969: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      10970: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
1.9       rillig   10971:        operating system for which the packages have been built. The
1.10      hubertf  10972:        name is taken from the output of the <span class="command"><strong>uname</strong></span>
1.9       rillig   10973:        command, so it may differ from the one you are used to
                   10974:        hear.</p></li>
1.23      wiz      10975: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
1.8       rillig   10976:        architecture of the platform for which the packages have been
1.10      hubertf  10977:        built. It also includes the <code class="varname">ABI</code> (Application
                   10978:        Binary Interface) for platforms that have several of
                   10979:        them.</p></li>
1.23      wiz      10980: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
1.8       rillig   10981:        the operating system. For version numbers that change often (for
                   10982:        example NetBSD-current), the often-changing part should be
                   10983:        replaced with an <code class="literal">x</code>, for example
                   10984:        <code class="literal">4.99.x</code>.</p></li>
1.23      wiz      10985: <li class="listitem"><p><code class="varname">TAG</code> is either
1.22      jakllsch 10986:        <code class="literal">20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
1.8       rillig   10987:        for a stable branch, or <code class="literal">head</code> for packages
                   10988:        built from the HEAD branch. The latter should only be used when
                   10989:        the packages are updated on a regular basis. Otherwise the date
                   10990:        from checking out pkgsrc should be appended, for example
                   10991:        <code class="literal">head_20071015</code>.</p></li>
1.3       rillig   10992: </ul></div>
                   10993: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
                   10994:        can quickly click through the directories on the
                   10995:        server and find the best binary packages for their machines. Since they
                   10996:        usually know the operating system and the hardware architecture, OPSYS
                   10997:        and ARCH are placed first. After these choices, they can select the
                   10998:        best combination of OSVERSION and TAG together, since it is usually the
                   10999:        case that packages stay compatible between different version of the
                   11000:        operating system.</p>
                   11001: <p>In each of these directories, there is a
                   11002:        whole binary packages collection for a specific platform. It has a directory called
1.1       dsieger  11003:        <code class="filename">All</code> which contains all binary packages.
                   11004:        Besides that, there are various category directories that
                   11005:        contain symbolic links to the real binary packages.</p>
                   11006: </div>
1.41      asau     11007: <div class="sect1">
1.1       dsieger  11008: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22      jakllsch 11009: <a name="ftp-reports"></a>C.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.8       rillig   11010: <p>Here are the reports from bulk builds, for those who want
                   11011:        to fix packages that didn't build on some of the platforms. The
1.23      wiz      11012:        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.8       rillig   11013: </div>
1.41      asau     11014: <div class="sect1">
1.8       rillig   11015: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22      jakllsch 11016: <a name="ftp-source"></a>C.5. <code class="filename">current</code>,
1.148     leot     11017: <code class="filename">stable</code>,
1.22      jakllsch 11018: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1       dsieger  11019: source packages</h2></div></div></div>
1.23      wiz      11020: <p>These directories contain the <span class="quote">&#8220;<span class="quote">real</span>&#8221;</span> pkgsrc,
1.1       dsieger  11021:        that is the files that define how to create binary packages from
                   11022:        source archives.</p>
1.149     leot     11023: <p>Each of the <code class="filename">current</code>,
                   11024:        <code class="filename">stable</code> and
                   11025:        <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
                   11026:        directories share the same structure.  They each contain a
                   11027:        <code class="filename">pkgsrc</code> directory and
                   11028:        <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> file.</p>
1.1       dsieger  11029: <p>The directory <code class="filename">pkgsrc</code> contains a
                   11030:        snapshot of the CVS repository, which is updated regularly. The
1.149     leot     11031:        file <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> contains the same
                   11032:        as the directory, ready to be downloaded as a whole.</p>
                   11033: <p>The <code class="filename">current</code> directory contains files
                   11034:        related to the HEAD branch of the CVS repository.
                   11035:        In this directory there is an additional file called
                   11036:        <code class="filename">pkgsrc-readmes.tar.{bz,gz,xz}</code> that contains
                   11037:        all pkgsrc <code class="filename">README</code>s with information about
                   11038:        categories and packages.
                   11039:        </p>
                   11040: <p>The <code class="filename">stable</code> directory is a symlink to
                   11041:        the latest 
                   11042:        <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
                   11043:        </p>
                   11044: <p>The
                   11045:        <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
                   11046:        directories contain files related to the 
                   11047:        <code class="filename">-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
                   11048:        stable branch of the CVS repository. In these directories there is
                   11049:        an additional file called
                   11050:        <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.1       dsieger  11051:        which contains the state of pkgsrc when it was branched.</p>
                   11052: </div>
                   11053: </div>
1.41      asau     11054: <div class="appendix">
                   11055: <div class="titlepage"><div><div><h1 class="title">
1.154     rillig   11056: <a name="help-topics"></a>Appendix D. Help topics</h1></div></div></div>
                   11057: <p>
                   11058:        The following list contains all help topics that are available
                   11059:        when running <span class="command"><strong>bmake help topic=:index</strong></span>.
                   11060: </p>
1.156     leot     11061: <table border="0" summary="Simple list" class="simplelist">
                   11062: <tr>
                   11063: <td>#!</td>
                   11064: <td>-lintl</td>
                   11065: </tr>
                   11066: <tr>
                   11067: <td>64bit</td>
                   11068: <td>ABI</td>
                   11069: </tr>
                   11070: <tr>
                   11071: <td>ACCEPTABLE_LICENSES</td>
                   11072: <td>ACROREAD_FONTPATH</td>
                   11073: </tr>
                   11074: <tr>
                   11075: <td>ADDITIONAL</td>
                   11076: <td>AFAIK</td>
                   11077: </tr>
                   11078: <tr>
                   11079: <td>AIX</td>
                   11080: <td>ALLOW_VULNERABLE_PACKAGES</td>
                   11081: </tr>
                   11082: <tr>
                   11083: <td>ALL_ENV</td>
1.200     cirnatda 11084: <td>ALTERNATIVES_SRC</td>
1.197     leot     11085: </tr>
                   11086: <tr>
                   11087: <td>AMANDA_TMP</td>
1.200     cirnatda 11088: <td>AMANDA_USER</td>
1.177     leot     11089: </tr>
                   11090: <tr>
1.197     leot     11091: <td>AMANDA_VAR</td>
1.200     cirnatda 11092: <td>APACHE_GROUP</td>
1.161     leot     11093: </tr>
                   11094: <tr>
1.197     leot     11095: <td>APACHE_MODULE_NAME</td>
1.200     cirnatda 11096: <td>APACHE_MODULE_SRC</td>
1.159     rillig   11097: </tr>
                   11098: <tr>
1.197     leot     11099: <td>APACHE_MODULE_SRCDIR</td>
1.200     cirnatda 11100: <td>APACHE_PKG_PREFIX</td>
1.156     leot     11101: </tr>
                   11102: <tr>
1.197     leot     11103: <td>APACHE_SUEXEC_CONFIGURE_ARGS</td>
1.200     cirnatda 11104: <td>APACHE_SUEXEC_DOCROOT</td>
1.156     leot     11105: </tr>
                   11106: <tr>
1.197     leot     11107: <td>APACHE_USER</td>
1.200     cirnatda 11108: <td>APPEND_ABI</td>
1.156     leot     11109: </tr>
                   11110: <tr>
1.197     leot     11111: <td>APPEND_ELF</td>
1.200     cirnatda 11112: <td>ARLA_CACHE</td>
1.156     leot     11113: </tr>
                   11114: <tr>
1.197     leot     11115: <td>AUDIT_PACKAGES_FLAGS</td>
1.200     cirnatda 11116: <td>AUTOCONF_REQD</td>
1.156     leot     11117: </tr>
                   11118: <tr>
1.197     leot     11119: <td>AUTOMAKE_OVERRIDE</td>
1.200     cirnatda 11120: <td>AUTOMAKE_REQD</td>
1.156     leot     11121: </tr>
                   11122: <tr>
1.197     leot     11123: <td>AUTO_MKDIRS</td>
1.200     cirnatda 11124: <td>BDB185_DEFAULT</td>
1.156     leot     11125: </tr>
                   11126: <tr>
1.197     leot     11127: <td>BDBBASE</td>
1.200     cirnatda 11128: <td>BDB_ACCEPTED</td>
1.156     leot     11129: </tr>
                   11130: <tr>
1.197     leot     11131: <td>BDB_DEFAULT</td>
1.200     cirnatda 11132: <td>BDB_LIBS</td>
1.156     leot     11133: </tr>
                   11134: <tr>
1.197     leot     11135: <td>BDB_TYPE</td>
1.200     cirnatda 11136: <td>BINCIMAP_GROUP</td>
1.156     leot     11137: </tr>
                   11138: <tr>
1.198     leot     11139: <td>BINCIMAP_USER</td>
1.200     cirnatda 11140: <td>BIND_DIR</td>
1.198     leot     11141: </tr>
                   11142: <tr>
1.197     leot     11143: <td>BIND_GROUP</td>
1.200     cirnatda 11144: <td>BIND_USER</td>
1.156     leot     11145: </tr>
                   11146: <tr>
1.197     leot     11147: <td>BINOWN</td>
1.200     cirnatda 11148: <td>BINPKG_SITES</td>
1.156     leot     11149: </tr>
                   11150: <tr>
1.197     leot     11151: <td>BIN_INSTALL_FLAGS</td>
1.200     cirnatda 11152: <td>BISON_PKGDATADIR</td>
1.189     bacon    11153: </tr>
                   11154: <tr>
1.197     leot     11155: <td>BLAS_ACCEPTED</td>
1.200     cirnatda 11156: <td>BLAS_LIBS</td>
1.156     leot     11157: </tr>
                   11158: <tr>
1.197     leot     11159: <td>BLAS_TYPE</td>
1.200     cirnatda 11160: <td>BOOTSTRAP_DEPENDS</td>
1.177     leot     11161: </tr>
                   11162: <tr>
1.197     leot     11163: <td>BOOTSTRAP_SETUPTOOLS</td>
1.200     cirnatda 11164: <td>BROKEN</td>
1.156     leot     11165: </tr>
                   11166: <tr>
1.197     leot     11167: <td>BROKEN_EXCEPT_ON_PLATFORM</td>
1.200     cirnatda 11168: <td>BROKEN_ON_PLATFORM</td>
1.156     leot     11169: </tr>
                   11170: <tr>
1.197     leot     11171: <td>BSDSRCDIR</td>
1.200     cirnatda 11172: <td>BSDXSRCDIR</td>
1.156     leot     11173: </tr>
                   11174: <tr>
1.197     leot     11175: <td>BSD_MAKE_ENV</td>
1.200     cirnatda 11176: <td>BUILDLINK_AUTO_DIRS</td>
1.156     leot     11177: </tr>
                   11178: <tr>
1.197     leot     11179: <td>BUILDLINK_AUTO_VARS</td>
1.200     cirnatda 11180: <td>BUILDLINK_CFLAGS</td>
1.156     leot     11181: </tr>
                   11182: <tr>
1.197     leot     11183: <td>BUILDLINK_CONTENTS_FILTER</td>
1.156     leot     11184: <td>BUILDLINK_CPPFLAGS</td>
                   11185: </tr>
                   11186: <tr>
                   11187: <td>BUILDLINK_FILES</td>
1.189     bacon    11188: <td>BUILDLINK_FILES_CMD</td>
1.156     leot     11189: </tr>
                   11190: <tr>
                   11191: <td>BUILDLINK_FNAME_TRANSFORM</td>
1.189     bacon    11192: <td>BUILDLINK_LDFLAGS</td>
1.156     leot     11193: </tr>
                   11194: <tr>
                   11195: <td>BUILDLINK_LIBS</td>
1.189     bacon    11196: <td>BUILDLINK_OPSYS_SUPPORT_PTHREAD</td>
1.156     leot     11197: </tr>
                   11198: <tr>
                   11199: <td>BUILDLINK_PKGNAME</td>
1.189     bacon    11200: <td>BUILDLINK_PREFIX</td>
1.156     leot     11201: </tr>
                   11202: <tr>
                   11203: <td>BUILDLINK_RPATHDIRS</td>
1.189     bacon    11204: <td>BUILDLINK_TREE</td>
1.156     leot     11205: </tr>
                   11206: <tr>
                   11207: <td>BUILD_DEFS</td>
1.189     bacon    11208: <td>BUILD_DEFS_EFFECTS</td>
1.156     leot     11209: </tr>
                   11210: <tr>
                   11211: <td>BUILD_DEPENDS</td>
1.189     bacon    11212: <td>BUILD_DIRS</td>
1.156     leot     11213: </tr>
                   11214: <tr>
                   11215: <td>BUILD_ENV_SHELL</td>
1.189     bacon    11216: <td>BUILD_MAKE_CMD</td>
1.156     leot     11217: </tr>
                   11218: <tr>
                   11219: <td>BUILD_MAKE_FLAGS</td>
1.189     bacon    11220: <td>BUILD_TARGET</td>
1.156     leot     11221: </tr>
                   11222: <tr>
                   11223: <td>BUILTIN_FIND_FILES</td>
1.189     bacon    11224: <td>BUILTIN_FIND_FILES_VAR</td>
1.156     leot     11225: </tr>
                   11226: <tr>
                   11227: <td>BUILTIN_FIND_GREP</td>
1.189     bacon    11228: <td>BUILTIN_FIND_HEADERS</td>
1.156     leot     11229: </tr>
                   11230: <tr>
                   11231: <td>BUILTIN_FIND_HEADERS_VAR</td>
1.195     gutterid 11232: <td>BUILTIN_FIND_PKGCONFIG</td>
                   11233: </tr>
                   11234: <tr>
                   11235: <td>BUILTIN_FIND_PKGCONFIG_VAR</td>
1.189     bacon    11236: <td>BUILTIN_PKG</td>
1.156     leot     11237: </tr>
                   11238: <tr>
                   11239: <td>BUILTIN_TEST_CURSES_DEFINES</td>
1.189     bacon    11240: <td>BUILTIN_TEST_CURSES_FUNCS</td>
1.156     leot     11241: </tr>
                   11242: <tr>
                   11243: <td>BUILTIN_VERSION_SCRIPT</td>
1.189     bacon    11244: <td>BUILTIN_X11_TYPE</td>
1.156     leot     11245: </tr>
                   11246: <tr>
                   11247: <td>BUILTIN_X11_VERSION</td>
1.189     bacon    11248: <td>CACTI_GROUP</td>
1.156     leot     11249: </tr>
                   11250: <tr>
                   11251: <td>CACTI_USER</td>
1.189     bacon    11252: <td>CANNA_GROUP</td>
1.156     leot     11253: </tr>
                   11254: <tr>
                   11255: <td>CANNA_USER</td>
1.189     bacon    11256: <td>CAT</td>
1.156     leot     11257: </tr>
                   11258: <tr>
                   11259: <td>CCACHE_BASE</td>
1.189     bacon    11260: <td>CCACHE_DIR</td>
1.156     leot     11261: </tr>
                   11262: <tr>
                   11263: <td>CCACHE_LOGFILE</td>
1.189     bacon    11264: <td>CC_VERSION</td>
1.156     leot     11265: </tr>
                   11266: <tr>
                   11267: <td>CC_VERSION_STRING</td>
1.189     bacon    11268: <td>CDRECORD_CONF</td>
1.156     leot     11269: </tr>
                   11270: <tr>
                   11271: <td>CDROM_PKG_URL_DIR</td>
1.189     bacon    11272: <td>CDROM_PKG_URL_HOST</td>
1.156     leot     11273: </tr>
                   11274: <tr>
1.189     bacon    11275: <td>CHECK_COMPILER</td>
1.200     cirnatda 11276: <td>CHECK_FAKEHOME</td>
1.197     leot     11277: </tr>
                   11278: <tr>
                   11279: <td>CHECK_FILES</td>
1.200     cirnatda 11280: <td>CHECK_FILES_SKIP</td>
1.177     leot     11281: </tr>
                   11282: <tr>
1.197     leot     11283: <td>CHECK_FILES_STRICT</td>
1.200     cirnatda 11284: <td>CHECK_HEADERS</td>
1.161     leot     11285: </tr>
                   11286: <tr>
1.197     leot     11287: <td>CHECK_HEADERS_SKIP</td>
1.200     cirnatda 11288: <td>CHECK_INTERPRETER</td>
1.159     rillig   11289: </tr>
                   11290: <tr>
1.197     leot     11291: <td>CHECK_INTERPRETER_SKIP</td>
1.200     cirnatda 11292: <td>CHECK_PERMS</td>
1.156     leot     11293: </tr>
                   11294: <tr>
1.197     leot     11295: <td>CHECK_PERMS_AUTOFIX</td>
1.200     cirnatda 11296: <td>CHECK_PERMS_SKIP</td>
1.156     leot     11297: </tr>
                   11298: <tr>
1.197     leot     11299: <td>CHECK_PORTABILITY</td>
1.200     cirnatda 11300: <td>CHECK_PORTABILITY_EXPERIMENTAL</td>
1.156     leot     11301: </tr>
                   11302: <tr>
1.197     leot     11303: <td>CHECK_PORTABILITY_SKIP</td>
1.200     cirnatda 11304: <td>CHECK_RELRO</td>
1.156     leot     11305: </tr>
                   11306: <tr>
1.197     leot     11307: <td>CHECK_RELRO_SKIP</td>
1.200     cirnatda 11308: <td>CHECK_RELRO_SUPPORTED</td>
1.156     leot     11309: </tr>
                   11310: <tr>
1.197     leot     11311: <td>CHECK_SHLIBS</td>
1.200     cirnatda 11312: <td>CHECK_SHLIBS_BLACKLIST</td>
1.156     leot     11313: </tr>
                   11314: <tr>
1.197     leot     11315: <td>CHECK_SHLIBS_SKIP</td>
1.200     cirnatda 11316: <td>CHECK_SHLIBS_SUPPORTED</td>
1.156     leot     11317: </tr>
                   11318: <tr>
1.197     leot     11319: <td>CHECK_SSP</td>
1.200     cirnatda 11320: <td>CHECK_SSP_SKIP</td>
1.156     leot     11321: </tr>
                   11322: <tr>
1.197     leot     11323: <td>CHECK_SSP_SUPPORTED</td>
1.200     cirnatda 11324: <td>CHECK_STRIPPED</td>
1.156     leot     11325: </tr>
                   11326: <tr>
1.197     leot     11327: <td>CHECK_STRIPPED_SKIP</td>
1.200     cirnatda 11328: <td>CHECK_WRKREF</td>
1.156     leot     11329: </tr>
                   11330: <tr>
1.197     leot     11331: <td>CHECK_WRKREF_EXTRA_DIRS</td>
1.200     cirnatda 11332: <td>CHECK_WRKREF_SKIP</td>
1.156     leot     11333: </tr>
                   11334: <tr>
1.197     leot     11335: <td>CLAMAV_DBDIR</td>
1.200     cirnatda 11336: <td>CLAMAV_GROUP</td>
1.156     leot     11337: </tr>
                   11338: <tr>
1.197     leot     11339: <td>CLAMAV_USER</td>
1.200     cirnatda 11340: <td>CLANGBASE</td>
1.156     leot     11341: </tr>
                   11342: <tr>
1.197     leot     11343: <td>CLEANDEPENDS</td>
1.200     cirnatda 11344: <td>CMAKE_DEPENDENCIES_REWRITE</td>
1.156     leot     11345: </tr>
                   11346: <tr>
1.197     leot     11347: <td>CMAKE_INSTALL_NAME_DIR</td>
1.200     cirnatda 11348: <td>CMAKE_INSTALL_PREFIX</td>
1.156     leot     11349: </tr>
                   11350: <tr>
1.197     leot     11351: <td>CMAKE_MODULE_PATH_OVERRIDE</td>
1.200     cirnatda 11352: <td>CMAKE_PKGSRC_BUILD_FLAGS</td>
1.156     leot     11353: </tr>
                   11354: <tr>
1.197     leot     11355: <td>CMAKE_PREFIX_PATH</td>
1.191     bacon    11356: <td>CMAKE_USE_GNU_INSTALL_DIRS</td>
1.177     leot     11357: </tr>
                   11358: <tr>
1.191     bacon    11359: <td>COMPILER_RPATH_FLAG</td>
1.156     leot     11360: <td>COMPILER_USE_SYMLINKS</td>
                   11361: </tr>
                   11362: <tr>
1.191     bacon    11363: <td>CONFIGURE_ARGS</td>
1.156     leot     11364: <td>CONFIGURE_DIRS</td>
                   11365: </tr>
                   11366: <tr>
1.191     bacon    11367: <td>CONFIGURE_ENV</td>
1.172     rillig   11368: <td>CONFIGURE_ENV_SHELL</td>
1.156     leot     11369: </tr>
                   11370: <tr>
1.191     bacon    11371: <td>CONFIGURE_HAS_INFODIR</td>
1.156     leot     11372: <td>CONFIGURE_HAS_MANDIR</td>
                   11373: </tr>
                   11374: <tr>
1.191     bacon    11375: <td>CONFIGURE_SCRIPT</td>
1.156     leot     11376: <td>CONFIG_SHELL</td>
                   11377: </tr>
                   11378: <tr>
1.191     bacon    11379: <td>CONFIG_SHELL_FLAGS</td>
1.156     leot     11380: <td>CONF_FILES</td>
                   11381: </tr>
                   11382: <tr>
1.191     bacon    11383: <td>CONF_FILES_MODE</td>
1.156     leot     11384: <td>CONF_FILES_PERMS</td>
                   11385: </tr>
                   11386: <tr>
1.191     bacon    11387: <td>CONSERVER_DEFAULTHOST</td>
1.156     leot     11388: <td>CONSERVER_DEFAULTPORT</td>
                   11389: </tr>
                   11390: <tr>
1.191     bacon    11391: <td>CP</td>
1.156     leot     11392: <td>CPP</td>
                   11393: </tr>
                   11394: <tr>
1.191     bacon    11395: <td>CPP_PRECOMP_FLAGS</td>
1.156     leot     11396: <td>CREATE_WRKDIR_SYMLINK</td>
                   11397: </tr>
                   11398: <tr>
1.191     bacon    11399: <td>CROSSBASE</td>
1.156     leot     11400: <td>CTFCONVERT</td>
                   11401: </tr>
                   11402: <tr>
1.191     bacon    11403: <td>CTF_FILES_SKIP</td>
1.156     leot     11404: <td>CTF_SUPPORTED</td>
                   11405: </tr>
                   11406: <tr>
1.191     bacon    11407: <td>CTYPE</td>
1.156     leot     11408: <td>CUPS_GROUP</td>
                   11409: </tr>
                   11410: <tr>
1.191     bacon    11411: <td>CUPS_SYSTEM_GROUPS</td>
1.156     leot     11412: <td>CUPS_USER</td>
                   11413: </tr>
                   11414: <tr>
1.191     bacon    11415: <td>CURSES_DEFAULT</td>
1.156     leot     11416: <td>CURSES_TYPE</td>
1.177     leot     11417: </tr>
                   11418: <tr>
1.160     brook    11419: <td>CXX</td>
1.200     cirnatda 11420: <td>CYRUS_GROUP</td>
1.197     leot     11421: </tr>
                   11422: <tr>
                   11423: <td>CYRUS_IDLE</td>
1.200     cirnatda 11424: <td>CYRUS_USER</td>
1.159     rillig   11425: </tr>
                   11426: <tr>
1.197     leot     11427: <td>DAEMONTOOLS_GROUP</td>
1.200     cirnatda 11428: <td>DAEMONTOOLS_LOG_USER</td>
1.156     leot     11429: </tr>
                   11430: <tr>
1.197     leot     11431: <td>DARWIN_NO_SYSTEM_LIBS</td>
1.200     cirnatda 11432: <td>DARWIN_REQUIRES_FILTER</td>
1.156     leot     11433: </tr>
                   11434: <tr>
1.197     leot     11435: <td>DBUS_GROUP</td>
1.200     cirnatda 11436: <td>DBUS_USER</td>
1.195     gutterid 11437: </tr>
                   11438: <tr>
1.197     leot     11439: <td>DEFANG_GROUP</td>
1.200     cirnatda 11440: <td>DEFANG_USER</td>
1.156     leot     11441: </tr>
                   11442: <tr>
1.197     leot     11443: <td>DEFAULT_ACCEPTABLE_LICENSES</td>
1.200     cirnatda 11444: <td>DEFAULT_DISTFILES</td>
1.156     leot     11445: </tr>
                   11446: <tr>
1.197     leot     11447: <td>DEFAULT_IRC_SERVER</td>
1.200     cirnatda 11448: <td>DEFAULT_SERIAL_DEVICE</td>
1.156     leot     11449: </tr>
                   11450: <tr>
1.197     leot     11451: <td>DEF_UMASK</td>
1.200     cirnatda 11452: <td>DEINSTALLDEPENDS</td>
1.156     leot     11453: </tr>
                   11454: <tr>
1.197     leot     11455: <td>DEINSTALL_SRC</td>
1.200     cirnatda 11456: <td>DEINSTALL_TEMPLATES</td>
1.156     leot     11457: </tr>
                   11458: <tr>
1.197     leot     11459: <td>DELAYED_ERROR_MSG</td>
1.200     cirnatda 11460: <td>DELAYED_WARNING_MSG</td>
1.156     leot     11461: </tr>
                   11462: <tr>
1.197     leot     11463: <td>DEPENDS</td>
1.200     cirnatda 11464: <td>DEPENDS_TARGET</td>
1.156     leot     11465: </tr>
                   11466: <tr>
1.197     leot     11467: <td>DEPENDS_TYPE</td>
1.200     cirnatda 11468: <td>DESTDIR</td>
1.156     leot     11469: </tr>
                   11470: <tr>
1.197     leot     11471: <td>DESTDIR_VARNAME</td>
1.200     cirnatda 11472: <td>DIALER_GROUP</td>
1.156     leot     11473: </tr>
                   11474: <tr>
1.197     leot     11475: <td>DIGEST_REQD</td>
1.200     cirnatda 11476: <td>DISTDIR</td>
1.156     leot     11477: </tr>
                   11478: <tr>
1.197     leot     11479: <td>DISTFILES</td>
1.200     cirnatda 11480: <td>DISTINFO_FILE</td>
1.156     leot     11481: </tr>
                   11482: <tr>
1.197     leot     11483: <td>DISTNAME</td>
1.200     cirnatda 11484: <td>DIST_PATH</td>
1.156     leot     11485: </tr>
                   11486: <tr>
1.197     leot     11487: <td>DIST_SUBDIR</td>
1.200     cirnatda 11488: <td>DJBDNS_AXFR_USER</td>
1.156     leot     11489: </tr>
                   11490: <tr>
1.197     leot     11491: <td>DJBDNS_CACHE_USER</td>
1.200     cirnatda 11492: <td>DJBDNS_DJBDNS_GROUP</td>
1.156     leot     11493: </tr>
                   11494: <tr>
1.197     leot     11495: <td>DJBDNS_LOG_USER</td>
1.200     cirnatda 11496: <td>DJBDNS_RBL_USER</td>
1.156     leot     11497: </tr>
                   11498: <tr>
1.197     leot     11499: <td>DJBDNS_TINY_USER</td>
1.200     cirnatda 11500: <td>DLOPEN_REQUIRE_PTHREADS</td>
1.156     leot     11501: </tr>
                   11502: <tr>
1.197     leot     11503: <td>DL_AUTO_VARS</td>
1.200     cirnatda 11504: <td>DL_CFLAGS</td>
1.156     leot     11505: </tr>
                   11506: <tr>
1.197     leot     11507: <td>DL_LDFLAGS</td>
1.200     cirnatda 11508: <td>DL_LIBS</td>
1.156     leot     11509: </tr>
                   11510: <tr>
1.197     leot     11511: <td>DNS</td>
1.200     cirnatda 11512: <td>DOCOWN</td>
1.156     leot     11513: </tr>
                   11514: <tr>
1.197     leot     11515: <td>DOWNLOADED_DISTFILE</td>
1.200     cirnatda 11516: <td>DT_LAYOUT</td>
1.156     leot     11517: </tr>
                   11518: <tr>
1.197     leot     11519: <td>DYNAMIC_SITES_CMD</td>
1.200     cirnatda 11520: <td>DYNAMIC_SITES_SCRIPT</td>
1.156     leot     11521: </tr>
                   11522: <tr>
1.197     leot     11523: <td>ECHO</td>
1.200     cirnatda 11524: <td>ECHO_N</td>
1.156     leot     11525: </tr>
                   11526: <tr>
1.197     leot     11527: <td>ELK_GUI</td>
1.200     cirnatda 11528: <td>EMACS_TYPE</td>
1.156     leot     11529: </tr>
                   11530: <tr>
1.197     leot     11531: <td>EMULDIR</td>
1.200     cirnatda 11532: <td>EMULSUBDIR</td>
1.156     leot     11533: </tr>
                   11534: <tr>
1.197     leot     11535: <td>EMULSUBDIRSLASH</td>
1.200     cirnatda 11536: <td>EMUL_ARCH</td>
1.156     leot     11537: </tr>
                   11538: <tr>
1.197     leot     11539: <td>EMUL_DISTRO</td>
1.200     cirnatda 11540: <td>EMUL_EXEC_FMT</td>
1.156     leot     11541: </tr>
                   11542: <tr>
1.197     leot     11543: <td>EMUL_IS_NATIVE</td>
1.200     cirnatda 11544: <td>EMUL_MODULES</td>
1.156     leot     11545: </tr>
                   11546: <tr>
1.197     leot     11547: <td>EMUL_OPSYS</td>
1.200     cirnatda 11548: <td>EMUL_PKG_FMT</td>
1.156     leot     11549: </tr>
                   11550: <tr>
1.197     leot     11551: <td>EMUL_PLATFORM</td>
1.200     cirnatda 11552: <td>EMUL_PLATFORMS</td>
1.156     leot     11553: </tr>
                   11554: <tr>
1.197     leot     11555: <td>EMUL_PREFER</td>
1.200     cirnatda 11556: <td>EMUL_REQD</td>
1.156     leot     11557: </tr>
                   11558: <tr>
1.197     leot     11559: <td>EMUL_TYPE</td>
1.200     cirnatda 11560: <td>ERROR_MSG</td>
1.156     leot     11561: </tr>
                   11562: <tr>
1.197     leot     11563: <td>EXIM_GROUP</td>
1.200     cirnatda 11564: <td>EXIM_USER</td>
1.156     leot     11565: </tr>
                   11566: <tr>
1.197     leot     11567: <td>EXPORT_SYMBOLS_LDFLAGS</td>
1.200     cirnatda 11568: <td>EXTRACTOR</td>
1.156     leot     11569: </tr>
                   11570: <tr>
1.197     leot     11571: <td>EXTRACT_CMD</td>
1.200     cirnatda 11572: <td>EXTRACT_CMD_DEFAULT</td>
1.156     leot     11573: </tr>
                   11574: <tr>
1.197     leot     11575: <td>EXTRACT_DIR</td>
1.200     cirnatda 11576: <td>EXTRACT_ELEMENTS</td>
1.156     leot     11577: </tr>
                   11578: <tr>
1.197     leot     11579: <td>EXTRACT_ENV</td>
1.200     cirnatda 11580: <td>EXTRACT_ONLY</td>
1.156     leot     11581: </tr>
                   11582: <tr>
1.197     leot     11583: <td>EXTRACT_OPTS</td>
1.200     cirnatda 11584: <td>EXTRACT_SUFX</td>
1.156     leot     11585: </tr>
                   11586: <tr>
1.197     leot     11587: <td>EXTRACT_USING</td>
1.200     cirnatda 11588: <td>FAIL</td>
1.156     leot     11589: </tr>
                   11590: <tr>
1.197     leot     11591: <td>FAILOVER_FETCH</td>
1.200     cirnatda 11592: <td>FAIL_MSG</td>
1.177     leot     11593: </tr>
                   11594: <tr>
1.197     leot     11595: <td>FAKE_NCURSES</td>
1.200     cirnatda 11596: <td>FAM</td>
1.156     leot     11597: </tr>
                   11598: <tr>
1.197     leot     11599: <td>FAM_ACCEPTED</td>
1.200     cirnatda 11600: <td>FAM_DEFAULT</td>
1.156     leot     11601: </tr>
                   11602: <tr>
1.197     leot     11603: <td>FAM_SERVER</td>
1.200     cirnatda 11604: <td>FCPATH</td>
1.156     leot     11605: </tr>
                   11606: <tr>
1.197     leot     11607: <td>FEATURE_CPPFLAGS</td>
1.200     cirnatda 11608: <td>FEATURE_LDFLAGS</td>
1.156     leot     11609: </tr>
                   11610: <tr>
1.197     leot     11611: <td>FEATURE_LIBS</td>
1.200     cirnatda 11612: <td>FETCH_AFTER_ARGS</td>
1.156     leot     11613: </tr>
                   11614: <tr>
1.197     leot     11615: <td>FETCH_BEFORE_ARGS</td>
1.200     cirnatda 11616: <td>FETCH_CMD</td>
1.156     leot     11617: </tr>
                   11618: <tr>
1.197     leot     11619: <td>FETCH_OUTPUT_ARGS</td>
1.200     cirnatda 11620: <td>FETCH_PROXY</td>
1.156     leot     11621: </tr>
                   11622: <tr>
1.197     leot     11623: <td>FETCH_RESUME_ARGS</td>
1.200     cirnatda 11624: <td>FETCH_TIMEOUT</td>
1.156     leot     11625: </tr>
                   11626: <tr>
1.197     leot     11627: <td>FETCH_USE_IPV4_ONLY</td>
1.200     cirnatda 11628: <td>FETCH_USING</td>
1.189     bacon    11629: </tr>
                   11630: <tr>
1.197     leot     11631: <td>FILES_SUBST</td>
1.200     cirnatda 11632: <td>FILES_SUBST_SED</td>
1.156     leot     11633: </tr>
                   11634: <tr>
1.197     leot     11635: <td>FIX_SYSTEM_HEADERS</td>
1.200     cirnatda 11636: <td>FLUXBOX_USE_GNOME</td>
1.156     leot     11637: </tr>
                   11638: <tr>
1.197     leot     11639: <td>FLUXBOX_USE_KDE</td>
1.200     cirnatda 11640: <td>FLUXBOX_USE_XFT</td>
1.156     leot     11641: </tr>
                   11642: <tr>
1.197     leot     11643: <td>FLUXBOX_USE_XINERAMA</td>
1.180     rillig   11644: <td>FONTS_DIRS</td>
1.161     leot     11645: </tr>
                   11646: <tr>
1.191     bacon    11647: <td>FONTS_VERBOSE</td>
1.180     rillig   11648: <td>FOO_HACKS_MK</td>
1.177     leot     11649: </tr>
                   11650: <tr>
1.191     bacon    11651: <td>FOX_USE_XUNICODE</td>
1.180     rillig   11652: <td>FREEWNN_GROUP</td>
1.156     leot     11653: </tr>
                   11654: <tr>
1.191     bacon    11655: <td>FREEWNN_USER</td>
1.180     rillig   11656: <td>FTP_PKG_URL_DIR</td>
1.156     leot     11657: </tr>
                   11658: <tr>
1.191     bacon    11659: <td>FTP_PKG_URL_HOST</td>
1.180     rillig   11660: <td>GAMEDATAMODE</td>
1.156     leot     11661: </tr>
                   11662: <tr>
1.191     bacon    11663: <td>GAMEDATA_PERMS</td>
1.180     rillig   11664: <td>GAMEDIRMODE</td>
1.156     leot     11665: </tr>
                   11666: <tr>
1.191     bacon    11667: <td>GAMEDIR_PERMS</td>
1.180     rillig   11668: <td>GAMEGRP</td>
1.156     leot     11669: </tr>
                   11670: <tr>
1.191     bacon    11671: <td>GAMEMODE</td>
1.180     rillig   11672: <td>GAMEOWN</td>
1.156     leot     11673: </tr>
                   11674: <tr>
1.191     bacon    11675: <td>GAMES_GROUP</td>
1.180     rillig   11676: <td>GAMES_USER</td>
1.156     leot     11677: </tr>
                   11678: <tr>
1.191     bacon    11679: <td>GCC</td>
1.180     rillig   11680: <td>GCCBASE</td>
1.156     leot     11681: </tr>
                   11682: <tr>
1.191     bacon    11683: <td>GCC_REQD</td>
1.180     rillig   11684: <td>GCC_VERSION_SUFFIX</td>
1.156     leot     11685: </tr>
                   11686: <tr>
1.191     bacon    11687: <td>GEM_BUILD</td>
1.180     rillig   11688: <td>GEM_CLEANBUILD</td>
1.156     leot     11689: </tr>
                   11690: <tr>
1.191     bacon    11691: <td>GEM_CLEANBUILD_EXTENSIONS</td>
1.180     rillig   11692: <td>GEM_DOCDIR</td>
1.156     leot     11693: </tr>
                   11694: <tr>
1.191     bacon    11695: <td>GEM_EXTSDIR</td>
1.180     rillig   11696: <td>GEM_HOME</td>
1.177     leot     11697: </tr>
                   11698: <tr>
1.191     bacon    11699: <td>GEM_KEEPBUILD</td>
1.180     rillig   11700: <td>GEM_LIBDIR</td>
1.156     leot     11701: </tr>
                   11702: <tr>
1.191     bacon    11703: <td>GEM_NAME</td>
1.180     rillig   11704: <td>GEM_PATH</td>
1.156     leot     11705: </tr>
                   11706: <tr>
1.198     leot     11707: <td>GEM_PLUGINSDIR</td>
1.191     bacon    11708: <td>GEM_SPECFILE</td>
1.198     leot     11709: </tr>
                   11710: <tr>
1.180     rillig   11711: <td>GENERATE_PLIST</td>
1.201     cirnatda 11712: <td>GHC</td>
1.156     leot     11713: </tr>
                   11714: <tr>
1.201     cirnatda 11715: <td>GHOSTSCRIPT_REQD</td>
1.180     rillig   11716: <td>GITHUB_PROJECT</td>
1.156     leot     11717: </tr>
                   11718: <tr>
1.201     cirnatda 11719: <td>GITHUB_RELEASE</td>
1.200     cirnatda 11720: <td>GITHUB_SUBMODULES</td>
1.177     leot     11721: </tr>
                   11722: <tr>
1.201     cirnatda 11723: <td>GITHUB_TAG</td>
1.191     bacon    11724: <td>GITHUB_TYPE</td>
1.159     rillig   11725: </tr>
                   11726: <tr>
1.201     cirnatda 11727: <td>GNU</td>
1.191     bacon    11728: <td>GNU_CONFIGURE</td>
1.156     leot     11729: </tr>
                   11730: <tr>
1.201     cirnatda 11731: <td>GNU_CONFIGURE_INFODIR</td>
1.191     bacon    11732: <td>GNU_CONFIGURE_MANDIR</td>
1.156     leot     11733: </tr>
                   11734: <tr>
1.201     cirnatda 11735: <td>GNU_CONFIGURE_QUIET</td>
1.191     bacon    11736: <td>GNU_CONFIGURE_STRICT</td>
1.156     leot     11737: </tr>
                   11738: <tr>
1.201     cirnatda 11739: <td>GODEP_REDIRECTS</td>
1.191     bacon    11740: <td>GO_BUILD_PATTERN</td>
1.156     leot     11741: </tr>
                   11742: <tr>
1.201     cirnatda 11743: <td>GO_DEPS</td>
1.191     bacon    11744: <td>GO_DIST_BASE</td>
1.156     leot     11745: </tr>
                   11746: <tr>
1.201     cirnatda 11747: <td>GO_MODULE_FILES</td>
1.191     bacon    11748: <td>GO_SRCPATH</td>
1.156     leot     11749: </tr>
                   11750: <tr>
1.201     cirnatda 11751: <td>GO_VERSION_DEFAULT</td>
1.191     bacon    11752: <td>GROUP_SPECIFIC_PKGS</td>
1.156     leot     11753: </tr>
                   11754: <tr>
1.201     cirnatda 11755: <td>GRUB_NETWORK_CARDS</td>
1.191     bacon    11756: <td>GRUB_PRESET_COMMAND</td>
1.156     leot     11757: </tr>
                   11758: <tr>
1.201     cirnatda 11759: <td>GRUB_SCAN_ARGS</td>
1.191     bacon    11760: <td>GZIP</td>
1.197     leot     11761: </tr>
                   11762: <tr>
1.201     cirnatda 11763: <td>HASKELL_ENABLE_HADDOCK_DOCUMENTATION</td>
1.197     leot     11764: <td>HASKELL_ENABLE_LIBRARY_PROFILING</td>
1.156     leot     11765: </tr>
                   11766: <tr>
1.201     cirnatda 11767: <td>HASKELL_ENABLE_SHARED_LIBRARY</td>
1.197     leot     11768: <td>HASKELL_OPTIMIZATION_LEVEL</td>
1.156     leot     11769: </tr>
                   11770: <tr>
1.201     cirnatda 11771: <td>HAS_CONFIGURE</td>
1.197     leot     11772: <td>HEADER_TEMPLATES</td>
1.156     leot     11773: </tr>
                   11774: <tr>
1.201     cirnatda 11775: <td>HOMEPAGE</td>
1.191     bacon    11776: <td>HOST_PKGTOOLS_ARGS</td>
1.156     leot     11777: </tr>
                   11778: <tr>
1.201     cirnatda 11779: <td>HOST_SPECIFIC_PKGS</td>
1.191     bacon    11780: <td>HOWL_GROUP</td>
1.156     leot     11781: </tr>
                   11782: <tr>
1.201     cirnatda 11783: <td>HOWL_USER</td>
1.191     bacon    11784: <td>ICCBASE</td>
                   11785: </tr>
                   11786: <tr>
1.201     cirnatda 11787: <td>ICECAST_CHROOTDIR</td>
1.180     rillig   11788: <td>ICON_THEMES</td>
1.156     leot     11789: </tr>
                   11790: <tr>
1.201     cirnatda 11791: <td>IDOBASE</td>
1.180     rillig   11792: <td>IGNORE_CCACHE</td>
1.156     leot     11793: </tr>
                   11794: <tr>
1.201     cirnatda 11795: <td>IGNORE_INFO_DIRS</td>
1.180     rillig   11796: <td>IGNORE_INTERACTIVE_FETCH</td>
1.156     leot     11797: </tr>
                   11798: <tr>
1.201     cirnatda 11799: <td>IMAKE</td>
1.180     rillig   11800: <td>IMAKEOPTS</td>
1.156     leot     11801: </tr>
                   11802: <tr>
1.201     cirnatda 11803: <td>IMAKE_MAKE</td>
1.180     rillig   11804: <td>IMAKE_MANINSTALL</td>
1.156     leot     11805: </tr>
                   11806: <tr>
1.201     cirnatda 11807: <td>IMAP_UW_CCLIENT_MBOX_FMT</td>
1.180     rillig   11808: <td>IMDICTDIR</td>
1.156     leot     11809: </tr>
                   11810: <tr>
1.201     cirnatda 11811: <td>INCOMPAT_CURSES</td>
1.180     rillig   11812: <td>INFO_DIR</td>
1.156     leot     11813: </tr>
                   11814: <tr>
1.201     cirnatda 11815: <td>INFO_FILES</td>
1.180     rillig   11816: <td>INFO_FILES_VERBOSE</td>
1.156     leot     11817: </tr>
                   11818: <tr>
1.201     cirnatda 11819: <td>INFO_MSG</td>
1.180     rillig   11820: <td>INIT_SYSTEM</td>
1.156     leot     11821: </tr>
                   11822: <tr>
1.201     cirnatda 11823: <td>INN_DATA_DIR</td>
1.180     rillig   11824: <td>INN_GROUP</td>
1.172     rillig   11825: </tr>
                   11826: <tr>
1.201     cirnatda 11827: <td>INN_USER</td>
1.180     rillig   11828: <td>INSTALLATION_DIRS</td>
1.156     leot     11829: </tr>
                   11830: <tr>
1.201     cirnatda 11831: <td>INSTALLATION_DIRS_FROM_PLIST</td>
1.180     rillig   11832: <td>INSTALL_ENV</td>
1.156     leot     11833: </tr>
                   11834: <tr>
1.201     cirnatda 11835: <td>INSTALL_SH_OVERRIDE</td>
1.180     rillig   11836: <td>INSTALL_SRC</td>
1.156     leot     11837: </tr>
                   11838: <tr>
1.201     cirnatda 11839: <td>INSTALL_TEMPLATES</td>
1.180     rillig   11840: <td>INSTALL_UNSTRIPPED</td>
1.156     leot     11841: </tr>
                   11842: <tr>
1.201     cirnatda 11843: <td>IRCD_HYBRID_IRC_GROUP</td>
1.180     rillig   11844: <td>IRCD_HYBRID_IRC_USER</td>
1.156     leot     11845: </tr>
                   11846: <tr>
1.201     cirnatda 11847: <td>IRCD_HYBRID_MAXCONN</td>
1.180     rillig   11848: <td>IRCD_HYBRID_NICLEN</td>
1.156     leot     11849: </tr>
                   11850: <tr>
1.201     cirnatda 11851: <td>IRCD_HYBRID_SYSLOG_EVENTS</td>
1.180     rillig   11852: <td>IRCD_HYBRID_SYSLOG_FACILITY</td>
1.156     leot     11853: </tr>
                   11854: <tr>
1.201     cirnatda 11855: <td>IRCD_HYBRID_TOPICLEN</td>
1.180     rillig   11856: <td>IRIX</td>
1.156     leot     11857: </tr>
                   11858: <tr>
1.201     cirnatda 11859: <td>IRRD_USE_PGP</td>
1.180     rillig   11860: <td>JABBERD_GROUP</td>
1.156     leot     11861: </tr>
                   11862: <tr>
1.201     cirnatda 11863: <td>JABBERD_LOGDIR</td>
1.180     rillig   11864: <td>JABBERD_PIDDIR</td>
1.156     leot     11865: </tr>
                   11866: <tr>
1.201     cirnatda 11867: <td>JABBERD_SPOOLDIR</td>
1.180     rillig   11868: <td>JABBERD_USER</td>
1.177     leot     11869: </tr>
                   11870: <tr>
1.201     cirnatda 11871: <td>JAKARTA_HOME</td>
1.180     rillig   11872: <td>JAVA_BINPREFIX</td>
1.156     leot     11873: </tr>
                   11874: <tr>
1.201     cirnatda 11875: <td>JAVA_CLASSPATH</td>
1.180     rillig   11876: <td>JAVA_HOME</td>
1.156     leot     11877: </tr>
                   11878: <tr>
1.201     cirnatda 11879: <td>JAVA_LD_LIBRARY_PATH</td>
1.180     rillig   11880: <td>JAVA_NAME</td>
1.156     leot     11881: </tr>
                   11882: <tr>
1.201     cirnatda 11883: <td>JAVA_UNLIMIT</td>
1.180     rillig   11884: <td>JAVA_WRAPPERS</td>
1.156     leot     11885: </tr>
                   11886: <tr>
1.201     cirnatda 11887: <td>JPEG_ACCEPTED</td>
1.180     rillig   11888: <td>JPEG_DEFAULT</td>
1.156     leot     11889: </tr>
                   11890: <tr>
1.201     cirnatda 11891: <td>KERBEROS</td>
1.180     rillig   11892: <td>KERMIT_SUID_UUCP</td>
1.156     leot     11893: </tr>
                   11894: <tr>
1.201     cirnatda 11895: <td>KJS_USE_PCRE</td>
1.180     rillig   11896: <td>KNEWS_DOMAIN_FILE</td>
1.156     leot     11897: </tr>
                   11898: <tr>
1.201     cirnatda 11899: <td>KNEWS_DOMAIN_NAME</td>
1.180     rillig   11900: <td>KRB5_ACCEPTED</td>
1.177     leot     11901: </tr>
                   11902: <tr>
1.201     cirnatda 11903: <td>KRB5_DEFAULT</td>
1.180     rillig   11904: <td>LANGUAGES</td>
1.156     leot     11905: </tr>
                   11906: <tr>
1.201     cirnatda 11907: <td>LAPACK_LIBS</td>
1.180     rillig   11908: <td>LATEX2HTML_ICONPATH</td>
1.156     leot     11909: </tr>
                   11910: <tr>
1.201     cirnatda 11911: <td>LDCONFIG_ADD_CMD</td>
1.180     rillig   11912: <td>LDCONFIG_REMOVE_CMD</td>
1.156     leot     11913: </tr>
                   11914: <tr>
1.201     cirnatda 11915: <td>LEAFNODE_DATA_DIR</td>
1.180     rillig   11916: <td>LEAFNODE_GROUP</td>
1.156     leot     11917: </tr>
                   11918: <tr>
1.201     cirnatda 11919: <td>LEAFNODE_USER</td>
1.180     rillig   11920: <td>LIBDVDCSS_HOMEPAGE</td>
1.157     leot     11921: </tr>
                   11922: <tr>
1.201     cirnatda 11923: <td>LIBDVDCSS_MASTER_SITES</td>
1.180     rillig   11924: <td>LIBRSVG_TYPE</td>
1.156     leot     11925: </tr>
                   11926: <tr>
1.201     cirnatda 11927: <td>LIBTOOL</td>
1.180     rillig   11928: <td>LIBTOOLIZE_PLIST</td>
1.156     leot     11929: </tr>
                   11930: <tr>
1.201     cirnatda 11931: <td>LIBTOOL_M4_OVERRIDE</td>
1.180     rillig   11932: <td>LIBUSB_TYPE</td>
1.177     leot     11933: </tr>
                   11934: <tr>
1.201     cirnatda 11935: <td>LICENSE</td>
1.180     rillig   11936: <td>LINKER_RPATH_FLAG</td>
1.156     leot     11937: </tr>
                   11938: <tr>
1.201     cirnatda 11939: <td>LINK_RPATH_FLAG</td>
1.191     bacon    11940: <td>LINUX_LOCALES</td>
1.197     leot     11941: </tr>
                   11942: <tr>
1.201     cirnatda 11943: <td>LOCALBASE</td>
1.197     leot     11944: <td>LOCALBASE_LOCKTYPE</td>
1.156     leot     11945: </tr>
                   11946: <tr>
1.201     cirnatda 11947: <td>LOCALPATCHES</td>
1.197     leot     11948: <td>LOVE_DATA</td>
1.156     leot     11949: </tr>
                   11950: <tr>
1.201     cirnatda 11951: <td>LOVE_GAME</td>
1.197     leot     11952: <td>LOVE_VERSION</td>
1.156     leot     11953: </tr>
                   11954: <tr>
1.201     cirnatda 11955: <td>LP64PLATFORMS</td>
1.197     leot     11956: <td>MACHINE_PLATFORM</td>
1.156     leot     11957: </tr>
                   11958: <tr>
1.201     cirnatda 11959: <td>MAILAGENT_DOMAIN</td>
1.197     leot     11960: <td>MAILAGENT_EMAIL</td>
1.156     leot     11961: </tr>
                   11962: <tr>
1.201     cirnatda 11963: <td>MAILAGENT_FQDN</td>
1.197     leot     11964: <td>MAILAGENT_ORGANIZATION</td>
1.156     leot     11965: </tr>
                   11966: <tr>
1.201     cirnatda 11967: <td>MAJORDOMO_HOMEDIR</td>
1.180     rillig   11968: <td>MAKEINFO_ARGS</td>
1.156     leot     11969: </tr>
                   11970: <tr>
1.201     cirnatda 11971: <td>MAKE_DIRS</td>
1.180     rillig   11972: <td>MAKE_DIRS_PERMS</td>
1.156     leot     11973: </tr>
                   11974: <tr>
1.201     cirnatda 11975: <td>MAKE_ENV</td>
1.180     rillig   11976: <td>MAKE_FILE</td>
1.156     leot     11977: </tr>
                   11978: <tr>
1.201     cirnatda 11979: <td>MAKE_FLAGS</td>
1.180     rillig   11980: <td>MAKE_JOBS</td>
1.156     leot     11981: </tr>
                   11982: <tr>
1.201     cirnatda 11983: <td>MAKE_JOBS_SAFE</td>
1.180     rillig   11984: <td>MAKE_PROGRAM</td>
1.156     leot     11985: </tr>
                   11986: <tr>
1.201     cirnatda 11987: <td>MANCOMPRESSED_IF_MANZ</td>
1.188     leot     11988: <td>MANINSTALL</td>
1.189     bacon    11989: </tr>
                   11990: <tr>
1.201     cirnatda 11991: <td>MANZ</td>
1.189     bacon    11992: <td>MASTER_SITES</td>
1.156     leot     11993: </tr>
                   11994: <tr>
1.201     cirnatda 11995: <td>MASTER_SITE_BACKUP</td>
1.189     bacon    11996: <td>MASTER_SITE_LOCAL</td>
1.156     leot     11997: </tr>
                   11998: <tr>
1.201     cirnatda 11999: <td>MASTER_SITE_MOZILLA</td>
1.189     bacon    12000: <td>MASTER_SITE_OVERRIDE</td>
1.156     leot     12001: </tr>
                   12002: <tr>
1.201     cirnatda 12003: <td>MASTER_SITE_PERL_CPAN</td>
1.189     bacon    12004: <td>MASTER_SORT</td>
1.156     leot     12005: </tr>
                   12006: <tr>
1.201     cirnatda 12007: <td>MASTER_SORT_RANDOM</td>
1.189     bacon    12008: <td>MASTER_SORT_REGEX</td>
1.156     leot     12009: </tr>
                   12010: <tr>
1.201     cirnatda 12011: <td>MECAB_CHARSET</td>
1.189     bacon    12012: <td>MEDIATOMB_GROUP</td>
1.156     leot     12013: </tr>
                   12014: <tr>
1.201     cirnatda 12015: <td>MEDIATOMB_USER</td>
1.189     bacon    12016: <td>MIPSPROBASE</td>
1.156     leot     12017: </tr>
                   12018: <tr>
1.201     cirnatda 12019: <td>MIREDO_GROUP</td>
1.189     bacon    12020: <td>MIREDO_USER</td>
1.156     leot     12021: </tr>
                   12022: <tr>
1.201     cirnatda 12023: <td>MISSING_FEATURES</td>
1.189     bacon    12024: <td>MKDIR</td>
1.156     leot     12025: </tr>
                   12026: <tr>
1.201     cirnatda 12027: <td>MLDONKEY_GROUP</td>
1.189     bacon    12028: <td>MLDONKEY_HOME</td>
1.156     leot     12029: </tr>
                   12030: <tr>
1.201     cirnatda 12031: <td>MLDONKEY_USER</td>
1.189     bacon    12032: <td>MONOTONE_GROUP</td>
1.156     leot     12033: </tr>
                   12034: <tr>
1.201     cirnatda 12035: <td>MONOTONE_USER</td>
1.189     bacon    12036: <td>MOTIFBASE</td>
1.156     leot     12037: </tr>
                   12038: <tr>
1.201     cirnatda 12039: <td>MOTIF_TYPE</td>
1.189     bacon    12040: <td>MOTIF_TYPE_DEFAULT</td>
1.156     leot     12041: </tr>
                   12042: <tr>
1.201     cirnatda 12043: <td>MPI_TYPE</td>
1.189     bacon    12044: <td>MSGFMT_STRIP_MSGCTXT</td>
1.156     leot     12045: </tr>
                   12046: <tr>
1.201     cirnatda 12047: <td>MSGFMT_STRIP_MSGID_PLURAL</td>
1.189     bacon    12048: <td>MTOOLS_ENABLE_FLOPPYD</td>
1.197     leot     12049: </tr>
                   12050: <tr>
1.201     cirnatda 12051: <td>MV</td>
1.197     leot     12052: <td>MYSQL_CHARSET</td>
1.156     leot     12053: </tr>
                   12054: <tr>
1.201     cirnatda 12055: <td>MYSQL_DATADIR</td>
1.197     leot     12056: <td>MYSQL_EXTRA_CHARSET</td>
1.156     leot     12057: </tr>
                   12058: <tr>
1.201     cirnatda 12059: <td>MYSQL_GROUP</td>
1.200     cirnatda 12060: <td>MYSQL_USER</td>
1.156     leot     12061: </tr>
                   12062: <tr>
1.197     leot     12063: <td>MYSQL_VERSION</td>
1.200     cirnatda 12064: <td>MYSQL_VERSIONS_ACCEPTED</td>
1.156     leot     12065: </tr>
                   12066: <tr>
1.201     cirnatda 12067: <td>MYSQL_VERSIONS_ALL</td>
1.197     leot     12068: <td>MYSQL_VERSION_DEFAULT</td>
1.195     gutterid 12069: </tr>
                   12070: <tr>
1.201     cirnatda 12071: <td>NAGIOSCMD_GROUP</td>
1.197     leot     12072: <td>NAGIOSDIR</td>
1.156     leot     12073: </tr>
                   12074: <tr>
1.201     cirnatda 12075: <td>NAGIOS_GROUP</td>
1.197     leot     12076: <td>NAGIOS_USER</td>
1.156     leot     12077: </tr>
                   12078: <tr>
1.201     cirnatda 12079: <td>NATIVE_APPEND_ABI</td>
1.197     leot     12080: <td>NATIVE_APPEND_ELF</td>
1.156     leot     12081: </tr>
                   12082: <tr>
1.201     cirnatda 12083: <td>NATIVE_EXEC_FMT</td>
1.197     leot     12084: <td>NATIVE_MACHINE_PLATFORM</td>
1.156     leot     12085: </tr>
                   12086: <tr>
1.201     cirnatda 12087: <td>NATIVE_OBJECT_FMT</td>
1.197     leot     12088: <td>NBPAX_PROGRAM_PREFIX</td>
1.156     leot     12089: </tr>
                   12090: <tr>
1.201     cirnatda 12091: <td>NETBSD_LOGIN_NAME</td>
1.197     leot     12092: <td>NMH_EDITOR</td>
1.156     leot     12093: </tr>
                   12094: <tr>
1.201     cirnatda 12095: <td>NMH_MTA</td>
1.197     leot     12096: <td>NMH_PAGER</td>
1.178     rillig   12097: </tr>
                   12098: <tr>
1.201     cirnatda 12099: <td>NOLOGIN</td>
1.197     leot     12100: <td>NOTE</td>
1.156     leot     12101: </tr>
                   12102: <tr>
1.201     cirnatda 12103: <td>NOT_FOR_PLATFORM</td>
1.197     leot     12104: <td>NOT_PAX_ASLR_SAFE</td>
1.156     leot     12105: </tr>
                   12106: <tr>
1.201     cirnatda 12107: <td>NOT_PAX_MPROTECT_SAFE</td>
1.197     leot     12108: <td>NO_BUILD</td>
1.156     leot     12109: </tr>
                   12110: <tr>
1.201     cirnatda 12111: <td>NO_CHECKSUM</td>
1.197     leot     12112: <td>NO_CONFIGURE</td>
1.156     leot     12113: </tr>
                   12114: <tr>
1.201     cirnatda 12115: <td>NO_SKIP</td>
1.197     leot     12116: <td>NS_PREFERRED</td>
1.156     leot     12117: </tr>
                   12118: <tr>
1.201     cirnatda 12119: <td>NULLMAILER_GROUP</td>
1.197     leot     12120: <td>NULLMAILER_USER</td>
1.156     leot     12121: </tr>
                   12122: <tr>
1.201     cirnatda 12123: <td>OASIS</td>
1.197     leot     12124: <td>OASIS_BUILD_ARGS</td>
1.156     leot     12125: </tr>
                   12126: <tr>
1.201     cirnatda 12127: <td>OBJHOSTNAME</td>
1.197     leot     12128: <td>OBJMACHINE</td>
1.156     leot     12129: </tr>
                   12130: <tr>
1.201     cirnatda 12131: <td>OCAML_FINDLIB_DIRS</td>
1.197     leot     12132: <td>OCAML_FINDLIB_REGISTER</td>
1.156     leot     12133: </tr>
                   12134: <tr>
1.201     cirnatda 12135: <td>OCAML_FINDLIB_REGISTER_VERBOSE</td>
1.197     leot     12136: <td>OCAML_SITELIBDIR</td>
1.156     leot     12137: </tr>
                   12138: <tr>
1.201     cirnatda 12139: <td>OCAML_TOPKG_DOCDIR</td>
1.197     leot     12140: <td>OCAML_USE_DUNE</td>
1.156     leot     12141: </tr>
                   12142: <tr>
1.201     cirnatda 12143: <td>OCAML_USE_FINDLIB</td>
1.197     leot     12144: <td>OCAML_USE_JBUILDER</td>
1.156     leot     12145: </tr>
                   12146: <tr>
1.201     cirnatda 12147: <td>OCAML_USE_OASIS</td>
1.197     leot     12148: <td>OCAML_USE_OASIS_DYNRUN</td>
1.156     leot     12149: </tr>
                   12150: <tr>
1.201     cirnatda 12151: <td>OCAML_USE_OPAM</td>
1.197     leot     12152: <td>OCAML_USE_OPT_COMPILER</td>
1.156     leot     12153: </tr>
                   12154: <tr>
1.201     cirnatda 12155: <td>OCAML_USE_TOPKG</td>
1.197     leot     12156: <td>OMF</td>
1.156     leot     12157: </tr>
                   12158: <tr>
1.201     cirnatda 12159: <td>ONLY_FOR_COMPILER</td>
1.197     leot     12160: <td>ONLY_FOR_PLATFORM</td>
1.156     leot     12161: </tr>
                   12162: <tr>
1.201     cirnatda 12163: <td>OPENSSH_CHROOT</td>
1.197     leot     12164: <td>OPENSSH_GROUP</td>
1.156     leot     12165: </tr>
                   12166: <tr>
1.201     cirnatda 12167: <td>OPENSSH_USER</td>
1.197     leot     12168: <td>OPSYS</td>
1.156     leot     12169: </tr>
                   12170: <tr>
1.201     cirnatda 12171: <td>OPSYS_EMULDIR</td>
1.197     leot     12172: <td>OS</td>
1.156     leot     12173: </tr>
                   12174: <tr>
1.201     cirnatda 12175: <td>OSS_TYPE</td>
1.197     leot     12176: <td>OSX</td>
1.177     leot     12177: </tr>
                   12178: <tr>
1.201     cirnatda 12179: <td>OSX_TOLERATE_SDK_SKEW</td>
1.195     gutterid 12180: <td>OS_VARIANT</td>
1.197     leot     12181: </tr>
                   12182: <tr>
1.201     cirnatda 12183: <td>OS_VERSION</td>
1.197     leot     12184: <td>OTF_FONTS_DIR</td>
1.156     leot     12185: </tr>
                   12186: <tr>
1.201     cirnatda 12187: <td>OVERRIDE_DIRDEPTH</td>
1.197     leot     12188: <td>OVERRIDE_GEMSPEC</td>
1.156     leot     12189: </tr>
                   12190: <tr>
1.201     cirnatda 12191: <td>OVERRIDE_GNU_CONFIG_SCRIPTS</td>
1.191     bacon    12192: <td>OWN_DIRS</td>
1.161     leot     12193: </tr>
                   12194: <tr>
1.201     cirnatda 12195: <td>OWN_DIRS_PERMS</td>
1.191     bacon    12196: <td>P4GROUP</td>
1.156     leot     12197: </tr>
                   12198: <tr>
1.201     cirnatda 12199: <td>P4PORT</td>
1.191     bacon    12200: <td>P4ROOT</td>
1.156     leot     12201: </tr>
                   12202: <tr>
1.201     cirnatda 12203: <td>P4USER</td>
1.191     bacon    12204: <td>PACKAGES</td>
1.156     leot     12205: </tr>
                   12206: <tr>
1.201     cirnatda 12207: <td>PALMOS_DEFAULT_SDK</td>
1.191     bacon    12208: <td>PAMBASE</td>
1.156     leot     12209: </tr>
                   12210: <tr>
1.201     cirnatda 12211: <td>PAM_DEFAULT</td>
1.191     bacon    12212: <td>PAPERSIZE</td>
1.156     leot     12213: </tr>
                   12214: <tr>
1.201     cirnatda 12215: <td>PASSIVE_FETCH</td>
1.191     bacon    12216: <td>PATCHDIR</td>
1.156     leot     12217: </tr>
                   12218: <tr>
1.201     cirnatda 12219: <td>PATCHFILES</td>
1.191     bacon    12220: <td>PATCH_ARGS</td>
1.156     leot     12221: </tr>
                   12222: <tr>
1.201     cirnatda 12223: <td>PATCH_DEBUG</td>
1.191     bacon    12224: <td>PATCH_DIST_ARGS</td>
1.169     rillig   12225: </tr>
                   12226: <tr>
1.201     cirnatda 12227: <td>PATCH_DIST_CAT</td>
1.191     bacon    12228: <td>PATCH_DIST_STRIP</td>
1.156     leot     12229: </tr>
                   12230: <tr>
1.201     cirnatda 12231: <td>PATCH_FUZZ_FACTOR</td>
1.191     bacon    12232: <td>PATCH_STRIP</td>
1.201     cirnatda 12233: </tr>
                   12234: <tr>
1.195     gutterid 12235: <td>PATH</td>
1.201     cirnatda 12236: <td>PCCBASE</td>
1.156     leot     12237: </tr>
                   12238: <tr>
1.195     gutterid 12239: <td>PEAR_CMD</td>
1.201     cirnatda 12240: <td>PEAR_LIB</td>
1.177     leot     12241: </tr>
                   12242: <tr>
1.195     gutterid 12243: <td>PEAR_PACKAGE_XML</td>
1.201     cirnatda 12244: <td>PERL5</td>
1.161     leot     12245: </tr>
                   12246: <tr>
1.195     gutterid 12247: <td>PERL5_CONFIGURE</td>
1.201     cirnatda 12248: <td>PERL5_CONFIGURE_DIRS</td>
1.161     leot     12249: </tr>
                   12250: <tr>
1.195     gutterid 12251: <td>PERL5_LDFLAGS</td>
1.201     cirnatda 12252: <td>PERL5_LICENSE</td>
1.156     leot     12253: </tr>
                   12254: <tr>
1.195     gutterid 12255: <td>PERL5_MODULE_TYPE</td>
1.201     cirnatda 12256: <td>PERL5_PACKLIST</td>
1.156     leot     12257: </tr>
                   12258: <tr>
1.195     gutterid 12259: <td>PERL5_PACKLIST_DIR</td>
1.201     cirnatda 12260: <td>PERL5_PERLBASE</td>
1.156     leot     12261: </tr>
                   12262: <tr>
1.195     gutterid 12263: <td>PERL5_SITEBASE</td>
1.201     cirnatda 12264: <td>PERL5_USE_PACKLIST</td>
1.156     leot     12265: </tr>
                   12266: <tr>
1.195     gutterid 12267: <td>PERL5_VENDORBASE</td>
1.201     cirnatda 12268: <td>PFCTL</td>
1.156     leot     12269: </tr>
                   12270: <tr>
1.195     gutterid 12271: <td>PFVAR_H</td>
1.201     cirnatda 12272: <td>PF_VERSION</td>
1.156     leot     12273: </tr>
                   12274: <tr>
1.195     gutterid 12275: <td>PGGROUP</td>
1.201     cirnatda 12276: <td>PGHOME</td>
1.156     leot     12277: </tr>
                   12278: <tr>
1.195     gutterid 12279: <td>PGPKGSRCDIR</td>
1.201     cirnatda 12280: <td>PGSQL_TYPE</td>
1.156     leot     12281: </tr>
                   12282: <tr>
1.195     gutterid 12283: <td>PGSQL_VERSION</td>
1.201     cirnatda 12284: <td>PGSQL_VERSIONS_ACCEPTED</td>
1.156     leot     12285: </tr>
                   12286: <tr>
1.191     bacon    12287: <td>PGSQL_VERSION_DEFAULT</td>
1.201     cirnatda 12288: <td>PGUSER</td>
1.156     leot     12289: </tr>
                   12290: <tr>
1.191     bacon    12291: <td>PG_LIB_EXT</td>
1.201     cirnatda 12292: <td>PHP</td>
1.156     leot     12293: </tr>
                   12294: <tr>
1.191     bacon    12295: <td>PHPCOMMON_MK</td>
1.201     cirnatda 12296: <td>PHPPKGSRCDIR</td>
1.156     leot     12297: </tr>
                   12298: <tr>
1.191     bacon    12299: <td>PHP_BASE_VERS</td>
1.201     cirnatda 12300: <td>PHP_CHECK_INSTALLED</td>
1.156     leot     12301: </tr>
                   12302: <tr>
1.191     bacon    12303: <td>PHP_EXTENSION_DIR</td>
1.201     cirnatda 12304: <td>PHP_INITIAL_TEENY</td>
1.156     leot     12305: </tr>
                   12306: <tr>
1.191     bacon    12307: <td>PHP_PKG_PREFIX</td>
1.201     cirnatda 12308: <td>PHP_VERSION</td>
1.156     leot     12309: </tr>
                   12310: <tr>
1.191     bacon    12311: <td>PHP_VERSIONS_ACCEPTED</td>
1.201     cirnatda 12312: <td>PHP_VERSIONS_INCOMPATIBLE</td>
1.156     leot     12313: </tr>
                   12314: <tr>
1.191     bacon    12315: <td>PHP_VERSION_DEFAULT</td>
1.201     cirnatda 12316: <td>PHP_VERSION_REQD</td>
1.156     leot     12317: </tr>
                   12318: <tr>
1.191     bacon    12319: <td>PILRC_USE_GTK</td>
1.201     cirnatda 12320: <td>PKGCONFIG_BASE</td>
1.156     leot     12321: </tr>
                   12322: <tr>
1.191     bacon    12323: <td>PKGCONFIG_FILE</td>
1.201     cirnatda 12324: <td>PKGCONFIG_OVERRIDE</td>
1.156     leot     12325: </tr>
                   12326: <tr>
1.191     bacon    12327: <td>PKGCONFIG_OVERRIDE_STAGE</td>
1.201     cirnatda 12328: <td>PKGDIR</td>
1.156     leot     12329: </tr>
                   12330: <tr>
1.191     bacon    12331: <td>PKGGNUDIR</td>
1.201     cirnatda 12332: <td>PKGINFODIR</td>
1.156     leot     12333: </tr>
                   12334: <tr>
1.191     bacon    12335: <td>PKGLOCALEDIR</td>
1.201     cirnatda 12336: <td>PKGMANDIR</td>
1.156     leot     12337: </tr>
                   12338: <tr>
1.191     bacon    12339: <td>PKGNAME</td>
1.201     cirnatda 12340: <td>PKGNAME_REQD</td>
1.156     leot     12341: </tr>
                   12342: <tr>
1.191     bacon    12343: <td>PKGPATH</td>
1.201     cirnatda 12344: <td>PKGREVISION</td>
1.156     leot     12345: </tr>
                   12346: <tr>
1.191     bacon    12347: <td>PKGSRC_BLAS_TYPES</td>
1.201     cirnatda 12348: <td>PKGSRC_CHANGES</td>
1.177     leot     12349: </tr>
                   12350: <tr>
1.191     bacon    12351: <td>PKGSRC_COMPILER</td>
1.201     cirnatda 12352: <td>PKGSRC_KEEP_BIN_PKGS</td>
1.156     leot     12353: </tr>
                   12354: <tr>
1.191     bacon    12355: <td>PKGSRC_LOCKTYPE</td>
1.201     cirnatda 12356: <td>PKGSRC_MAKE_ENV</td>
1.159     rillig   12357: </tr>
                   12358: <tr>
1.191     bacon    12359: <td>PKGSRC_MESSAGE_RECIPIENTS</td>
1.201     cirnatda 12360: <td>PKGSRC_MKPIE</td>
1.156     leot     12361: </tr>
                   12362: <tr>
1.191     bacon    12363: <td>PKGSRC_MKREPRO</td>
1.201     cirnatda 12364: <td>PKGSRC_RUN_TEST</td>
1.156     leot     12365: </tr>
                   12366: <tr>
1.191     bacon    12367: <td>PKGSRC_SETENV</td>
1.201     cirnatda 12368: <td>PKGSRC_SLEEPSECS</td>
1.156     leot     12369: </tr>
                   12370: <tr>
1.191     bacon    12371: <td>PKGSRC_TODO</td>
1.201     cirnatda 12372: <td>PKGSRC_USE_CTF</td>
1.156     leot     12373: </tr>
                   12374: <tr>
1.191     bacon    12375: <td>PKGSRC_USE_FORTIFY</td>
1.201     cirnatda 12376: <td>PKGSRC_USE_RELRO</td>
1.156     leot     12377: </tr>
                   12378: <tr>
1.191     bacon    12379: <td>PKGSRC_USE_SSP</td>
1.201     cirnatda 12380: <td>PKGSRC_USE_STACK_CHECK</td>
1.156     leot     12381: </tr>
                   12382: <tr>
1.191     bacon    12383: <td>PKGTASKS_DATAFILE</td>
1.201     cirnatda 12384: <td>PKGTOOLS_ARGS</td>
1.156     leot     12385: </tr>
                   12386: <tr>
1.191     bacon    12387: <td>PKGTOOLS_ENV</td>
1.201     cirnatda 12388: <td>PKG_ALTERNATIVES</td>
1.156     leot     12389: </tr>
                   12390: <tr>
1.191     bacon    12391: <td>PKG_APACHE</td>
1.201     cirnatda 12392: <td>PKG_APACHE_ACCEPTED</td>
1.156     leot     12393: </tr>
                   12394: <tr>
1.191     bacon    12395: <td>PKG_APACHE_DEFAULT</td>
1.201     cirnatda 12396: <td>PKG_BEST_EXISTS</td>
1.156     leot     12397: </tr>
                   12398: <tr>
1.191     bacon    12399: <td>PKG_BUILD_OPTIONS</td>
1.201     cirnatda 12400: <td>PKG_COMPRESSION</td>
1.156     leot     12401: </tr>
                   12402: <tr>
1.191     bacon    12403: <td>PKG_CONFIG</td>
1.201     cirnatda 12404: <td>PKG_CONFIG_PERMS</td>
1.156     leot     12405: </tr>
                   12406: <tr>
1.191     bacon    12407: <td>PKG_CREATE_USERGROUP</td>
1.201     cirnatda 12408: <td>PKG_DB_TMPDIR</td>
1.156     leot     12409: </tr>
                   12410: <tr>
1.191     bacon    12411: <td>PKG_DEBUG_LEVEL</td>
1.201     cirnatda 12412: <td>PKG_DEFAULT_OPTIONS</td>
1.156     leot     12413: </tr>
                   12414: <tr>
1.191     bacon    12415: <td>PKG_DESTDIR_SUPPORT</td>
1.201     cirnatda 12416: <td>PKG_DEVELOPER</td>
1.156     leot     12417: </tr>
                   12418: <tr>
1.191     bacon    12419: <td>PKG_DISABLED_OPTIONS</td>
1.201     cirnatda 12420: <td>PKG_FATAL_ERRORS</td>
1.156     leot     12421: </tr>
                   12422: <tr>
1.191     bacon    12423: <td>PKG_FC</td>
1.201     cirnatda 12424: <td>PKG_FILELIST_CMD</td>
1.156     leot     12425: </tr>
                   12426: <tr>
1.191     bacon    12427: <td>PKG_GECOS</td>
1.201     cirnatda 12428: <td>PKG_GID</td>
1.156     leot     12429: </tr>
                   12430: <tr>
1.191     bacon    12431: <td>PKG_GROUPS</td>
1.201     cirnatda 12432: <td>PKG_GROUPS_VARS</td>
1.156     leot     12433: </tr>
                   12434: <tr>
1.191     bacon    12435: <td>PKG_HOME</td>
1.201     cirnatda 12436: <td>PKG_INIT_SCRIPTS</td>
1.156     leot     12437: </tr>
                   12438: <tr>
1.191     bacon    12439: <td>PKG_JAVA_HOME</td>
1.201     cirnatda 12440: <td>PKG_JVM</td>
1.156     leot     12441: </tr>
                   12442: <tr>
1.191     bacon    12443: <td>PKG_JVMS_ACCEPTED</td>
1.201     cirnatda 12444: <td>PKG_JVM_DEFAULT</td>
1.156     leot     12445: </tr>
                   12446: <tr>
1.191     bacon    12447: <td>PKG_LEGACY_OPTIONS</td>
1.201     cirnatda 12448: <td>PKG_LIBTOOL</td>
1.156     leot     12449: </tr>
                   12450: <tr>
1.191     bacon    12451: <td>PKG_OPTIONS</td>
1.201     cirnatda 12452: <td>PKG_OPTIONS_DEPRECATED_WARNINGS</td>
1.156     leot     12453: </tr>
                   12454: <tr>
1.191     bacon    12455: <td>PKG_OPTIONS_LEGACY_OPTS</td>
1.201     cirnatda 12456: <td>PKG_OPTIONS_LEGACY_VARS</td>
1.156     leot     12457: </tr>
                   12458: <tr>
1.191     bacon    12459: <td>PKG_OPTIONS_NONEMPTY_SETS</td>
1.201     cirnatda 12460: <td>PKG_OPTIONS_OPTIONAL_GROUPS</td>
1.156     leot     12461: </tr>
                   12462: <tr>
1.191     bacon    12463: <td>PKG_OPTIONS_REQUIRED_GROUPS</td>
1.201     cirnatda 12464: <td>PKG_OPTIONS_VAR</td>
1.156     leot     12465: </tr>
                   12466: <tr>
1.191     bacon    12467: <td>PKG_PHP</td>
1.201     cirnatda 12468: <td>PKG_PHP_MAJOR_VERS</td>
1.156     leot     12469: </tr>
                   12470: <tr>
1.191     bacon    12471: <td>PKG_PHP_VERSION</td>
1.201     cirnatda 12472: <td>PKG_RCD_SCRIPTS</td>
1.156     leot     12473: </tr>
                   12474: <tr>
1.191     bacon    12475: <td>PKG_REFCOUNT_DBDIR</td>
1.201     cirnatda 12476: <td>PKG_REGISTER_SHELLS</td>
1.156     leot     12477: </tr>
                   12478: <tr>
1.191     bacon    12479: <td>PKG_RESUME_TRANSFERS</td>
1.201     cirnatda 12480: <td>PKG_SHELL</td>
1.156     leot     12481: </tr>
                   12482: <tr>
1.191     bacon    12483: <td>PKG_SUGGESTED_OPTIONS</td>
1.201     cirnatda 12484: <td>PKG_SUPPORTED_OPTIONS</td>
1.156     leot     12485: </tr>
                   12486: <tr>
1.191     bacon    12487: <td>PKG_SYSCONFBASE</td>
1.201     cirnatda 12488: <td>PKG_SYSCONFBASEDIR</td>
1.156     leot     12489: </tr>
                   12490: <tr>
1.191     bacon    12491: <td>PKG_SYSCONFDIR</td>
1.201     cirnatda 12492: <td>PKG_SYSCONFDIR_PERMS</td>
1.156     leot     12493: </tr>
                   12494: <tr>
1.191     bacon    12495: <td>PKG_SYSCONFSUBDIR</td>
1.201     cirnatda 12496: <td>PKG_SYSCONFVAR</td>
1.156     leot     12497: </tr>
                   12498: <tr>
1.191     bacon    12499: <td>PKG_TOOLS_BIN</td>
1.201     cirnatda 12500: <td>PKG_UID</td>
1.156     leot     12501: </tr>
                   12502: <tr>
1.191     bacon    12503: <td>PKG_UPDATE_FONTS_DB</td>
1.201     cirnatda 12504: <td>PKG_USERS</td>
1.156     leot     12505: </tr>
                   12506: <tr>
1.191     bacon    12507: <td>PKG_USERS_VARS</td>
1.201     cirnatda 12508: <td>PKG_VERBOSE</td>
1.156     leot     12509: </tr>
                   12510: <tr>
1.201     cirnatda 12511: <td>PLEASE</td>
1.191     bacon    12512: <td>PLIST</td>
1.156     leot     12513: </tr>
                   12514: <tr>
1.180     rillig   12515: <td>PLIST_AWK</td>
1.191     bacon    12516: <td>PLIST_AWK_ENV</td>
1.156     leot     12517: </tr>
                   12518: <tr>
1.180     rillig   12519: <td>PLIST_SRC</td>
1.191     bacon    12520: <td>PLIST_SUBST</td>
1.156     leot     12521: </tr>
                   12522: <tr>
1.180     rillig   12523: <td>PLIST_TYPE</td>
1.191     bacon    12524: <td>PLIST_VARS</td>
1.156     leot     12525: </tr>
                   12526: <tr>
1.180     rillig   12527: <td>POPTOP_USE_MPPE</td>
1.191     bacon    12528: <td>POSSIBLE_GFORTRAN_VERSION</td>
1.156     leot     12529: </tr>
                   12530: <tr>
1.180     rillig   12531: <td>POST_FETCH_HOOK</td>
1.191     bacon    12532: <td>PREFER</td>
1.156     leot     12533: </tr>
                   12534: <tr>
1.180     rillig   12535: <td>PREFER_NATIVE</td>
1.191     bacon    12536: <td>PREFER_NATIVE_PTHREADS</td>
1.156     leot     12537: </tr>
                   12538: <tr>
1.180     rillig   12539: <td>PREFER_PKGSRC</td>
1.191     bacon    12540: <td>PREFIX</td>
1.156     leot     12541: </tr>
                   12542: <tr>
1.180     rillig   12543: <td>PREPEND_PATH</td>
1.191     bacon    12544: <td>PRE_ROOT_CMD</td>
1.156     leot     12545: </tr>
                   12546: <tr>
1.180     rillig   12547: <td>PRIVILEGED_STAGES</td>
1.191     bacon    12548: <td>PS</td>
1.156     leot     12549: </tr>
                   12550: <tr>
1.180     rillig   12551: <td>PTHREAD_AUTO_VARS</td>
1.191     bacon    12552: <td>PTHREAD_CFLAGS</td>
1.156     leot     12553: </tr>
                   12554: <tr>
1.180     rillig   12555: <td>PTHREAD_LDFLAGS</td>
1.191     bacon    12556: <td>PTHREAD_LIBS</td>
1.156     leot     12557: </tr>
                   12558: <tr>
1.180     rillig   12559: <td>PTHREAD_OPTS</td>
1.191     bacon    12560: <td>PTHREAD_TYPE</td>
1.156     leot     12561: </tr>
                   12562: <tr>
1.180     rillig   12563: <td>PVM_SSH</td>
1.191     bacon    12564: <td>PYPKGPREFIX</td>
1.156     leot     12565: </tr>
                   12566: <tr>
1.180     rillig   12567: <td>PYTHON_FOR_BUILD_ONLY</td>
1.191     bacon    12568: <td>PYTHON_SELF_CONFLICT</td>
1.156     leot     12569: </tr>
                   12570: <tr>
1.180     rillig   12571: <td>PYTHON_VERSIONED_DEPENDENCIES</td>
1.191     bacon    12572: <td>PYTHON_VERSIONS_ACCEPTED</td>
1.156     leot     12573: </tr>
                   12574: <tr>
1.180     rillig   12575: <td>PYTHON_VERSIONS_INCOMPATIBLE</td>
1.191     bacon    12576: <td>PYTHON_VERSION_DEFAULT</td>
1.156     leot     12577: </tr>
                   12578: <tr>
1.180     rillig   12579: <td>PYTHON_VERSION_REQD</td>
1.191     bacon    12580: <td>PYVERSSUFFIX</td>
1.156     leot     12581: </tr>
                   12582: <tr>
1.180     rillig   12583: <td>PY_NO_EGG</td>
1.191     bacon    12584: <td>QMAILDIR</td>
1.156     leot     12585: </tr>
                   12586: <tr>
1.180     rillig   12587: <td>QMAIL_ALIAS_USER</td>
1.191     bacon    12588: <td>QMAIL_DAEMON_USER</td>
1.156     leot     12589: </tr>
                   12590: <tr>
1.180     rillig   12591: <td>QMAIL_LOG_USER</td>
1.191     bacon    12592: <td>QMAIL_NOFILES_GROUP</td>
1.156     leot     12593: </tr>
                   12594: <tr>
1.180     rillig   12595: <td>QMAIL_PASSWD_USER</td>
1.191     bacon    12596: <td>QMAIL_QMAIL_GROUP</td>
1.156     leot     12597: </tr>
                   12598: <tr>
1.180     rillig   12599: <td>QMAIL_QUEUE_DIR</td>
1.191     bacon    12600: <td>QMAIL_QUEUE_EXTRA</td>
1.156     leot     12601: </tr>
                   12602: <tr>
1.180     rillig   12603: <td>QMAIL_QUEUE_USER</td>
1.191     bacon    12604: <td>QMAIL_REMOTE_USER</td>
1.156     leot     12605: </tr>
                   12606: <tr>
1.180     rillig   12607: <td>QMAIL_ROOT_USER</td>
1.191     bacon    12608: <td>QMAIL_SEND_USER</td>
1.156     leot     12609: </tr>
                   12610: <tr>
1.180     rillig   12611: <td>QPOPPER_FAC</td>
1.191     bacon    12612: <td>QPOPPER_SPOOL_DIR</td>
1.156     leot     12613: </tr>
                   12614: <tr>
1.180     rillig   12615: <td>QPOPPER_USER</td>
1.191     bacon    12616: <td>RAKE_NAME</td>
1.156     leot     12617: </tr>
                   12618: <tr>
1.180     rillig   12619: <td>RASMOL_DEPTH</td>
1.191     bacon    12620: <td>RCD_SCRIPTS</td>
1.177     leot     12621: </tr>
                   12622: <tr>
1.180     rillig   12623: <td>RCD_SCRIPTS_DIR</td>
1.191     bacon    12624: <td>RCD_SCRIPTS_EXAMPLEDIR</td>
1.159     rillig   12625: </tr>
                   12626: <tr>
1.180     rillig   12627: <td>RCD_SCRIPTS_MODE</td>
1.191     bacon    12628: <td>RCD_SCRIPTS_SHELL</td>
1.156     leot     12629: </tr>
                   12630: <tr>
1.180     rillig   12631: <td>RCD_SCRIPT_SRC</td>
1.200     cirnatda 12632: <td>RDOC</td>
1.197     leot     12633: </tr>
                   12634: <tr>
                   12635: <td>READLINE_DEFAULT</td>
1.200     cirnatda 12636: <td>READLINE_TYPE</td>
1.156     leot     12637: </tr>
                   12638: <tr>
1.197     leot     12639: <td>REAL_ROOT_GROUP</td>
1.200     cirnatda 12640: <td>REAL_ROOT_USER</td>
1.161     leot     12641: </tr>
                   12642: <tr>
1.197     leot     12643: <td>RECURSIVE_MAKE</td>
1.200     cirnatda 12644: <td>RELAY_CTRL_DIR</td>
1.156     leot     12645: </tr>
                   12646: <tr>
1.197     leot     12647: <td>RELRO_SUPPORTED</td>
1.200     cirnatda 12648: <td>REPLACE_AWK</td>
1.156     leot     12649: </tr>
                   12650: <tr>
1.197     leot     12651: <td>REPLACE_BASH</td>
1.200     cirnatda 12652: <td>REPLACE_CSH</td>
1.156     leot     12653: </tr>
                   12654: <tr>
1.197     leot     12655: <td>REPLACE_KSH</td>
1.200     cirnatda 12656: <td>REPLACE_PERL</td>
1.156     leot     12657: </tr>
                   12658: <tr>
1.197     leot     12659: <td>REPLACE_PERL6</td>
1.200     cirnatda 12660: <td>REPLACE_PHP</td>
1.156     leot     12661: </tr>
                   12662: <tr>
1.197     leot     12663: <td>REPLACE_PYTHON</td>
1.200     cirnatda 12664: <td>REPLACE_RUBY</td>
1.156     leot     12665: </tr>
                   12666: <tr>
1.197     leot     12667: <td>REPLACE_RUBY_DIRS</td>
1.200     cirnatda 12668: <td>REPLACE_RUBY_PAT</td>
1.166     leot     12669: </tr>
                   12670: <tr>
1.197     leot     12671: <td>REPLACE_SH</td>
1.200     cirnatda 12672: <td>REPLACE_TEXLUA</td>
1.156     leot     12673: </tr>
                   12674: <tr>
1.197     leot     12675: <td>REQD_DIRS</td>
1.200     cirnatda 12676: <td>REQD_DIRS_PERMS</td>
1.156     leot     12677: </tr>
                   12678: <tr>
1.197     leot     12679: <td>REQD_FILES</td>
1.200     cirnatda 12680: <td>REQD_FILES_MODE</td>
1.156     leot     12681: </tr>
                   12682: <tr>
1.197     leot     12683: <td>REQD_FILES_PERMS</td>
1.200     cirnatda 12684: <td>RESOLV_AUTO_VARS</td>
1.156     leot     12685: </tr>
                   12686: <tr>
1.197     leot     12687: <td>RESOLV_LDFLAGS</td>
1.200     cirnatda 12688: <td>RESOLV_LIBS</td>
1.156     leot     12689: </tr>
                   12690: <tr>
1.197     leot     12691: <td>RM</td>
1.200     cirnatda 12692: <td>ROOT_CMD</td>
1.197     leot     12693: </tr>
                   12694: <tr>
                   12695: <td>ROOT_GROUP</td>
1.192     kim      12696: <td>ROOT_USER</td>
1.156     leot     12697: </tr>
                   12698: <tr>
1.200     cirnatda 12699: <td>RPCGEN</td>
1.192     kim      12700: <td>RPM</td>
1.156     leot     12701: </tr>
                   12702: <tr>
1.200     cirnatda 12703: <td>RPM2PKG_PLIST</td>
1.192     kim      12704: <td>RPM2PKG_PREFIX</td>
1.156     leot     12705: </tr>
                   12706: <tr>
1.200     cirnatda 12707: <td>RPM2PKG_STAGE</td>
1.192     kim      12708: <td>RPM2PKG_STRIP</td>
1.156     leot     12709: </tr>
                   12710: <tr>
1.200     cirnatda 12711: <td>RPM2PKG_SUBPREFIX</td>
1.192     kim      12712: <td>RPMFILES</td>
1.156     leot     12713: </tr>
                   12714: <tr>
1.200     cirnatda 12715: <td>RPMIGNOREPATH</td>
1.192     kim      12716: <td>RPM_DB_PREFIX</td>
1.156     leot     12717: </tr>
                   12718: <tr>
1.200     cirnatda 12719: <td>RSSH_CVS_PATH</td>
1.192     kim      12720: <td>RSSH_RDIST_PATH</td>
1.156     leot     12721: </tr>
                   12722: <tr>
1.200     cirnatda 12723: <td>RSSH_RSYNC_PATH</td>
1.192     kim      12724: <td>RSSH_SCP_PATH</td>
1.156     leot     12725: </tr>
                   12726: <tr>
1.200     cirnatda 12727: <td>RSSH_SFTP_SERVER_PATH</td>
1.192     kim      12728: <td>RUBY</td>
1.156     leot     12729: </tr>
                   12730: <tr>
1.200     cirnatda 12731: <td>RUBYGEM</td>
1.192     kim      12732: <td>RUBYGEM_NAME</td>
1.156     leot     12733: </tr>
                   12734: <tr>
1.200     cirnatda 12735: <td>RUBYGEM_OPTIONS</td>
1.198     leot     12736: <td>RUBYGEM_VERBOSE</td>
                   12737: </tr>
                   12738: <tr>
1.200     cirnatda 12739: <td>RUBY_ABI_VERSION</td>
1.197     leot     12740: <td>RUBY_ARCH</td>
1.156     leot     12741: </tr>
                   12742: <tr>
1.200     cirnatda 12743: <td>RUBY_ARCHINC</td>
1.197     leot     12744: <td>RUBY_ARCHLIB</td>
1.156     leot     12745: </tr>
                   12746: <tr>
1.200     cirnatda 12747: <td>RUBY_BASE</td>
1.197     leot     12748: <td>RUBY_BASERIDIR</td>
1.156     leot     12749: </tr>
                   12750: <tr>
1.200     cirnatda 12751: <td>RUBY_BUILD_DOCUMENT</td>
1.197     leot     12752: <td>RUBY_DLEXT</td>
1.156     leot     12753: </tr>
                   12754: <tr>
1.200     cirnatda 12755: <td>RUBY_DOC</td>
1.197     leot     12756: <td>RUBY_DYNAMIC_DIRS</td>
1.156     leot     12757: </tr>
                   12758: <tr>
1.200     cirnatda 12759: <td>RUBY_EG</td>
1.197     leot     12760: <td>RUBY_ENCODING_ARG</td>
1.156     leot     12761: </tr>
                   12762: <tr>
1.200     cirnatda 12763: <td>RUBY_EXTCONF</td>
1.197     leot     12764: <td>RUBY_EXTCONF_CHECK</td>
1.156     leot     12765: </tr>
                   12766: <tr>
1.200     cirnatda 12767: <td>RUBY_EXTCONF_DEBUG</td>
1.197     leot     12768: <td>RUBY_EXTCONF_MAKEFILE</td>
1.156     leot     12769: </tr>
                   12770: <tr>
1.200     cirnatda 12771: <td>RUBY_GEM_BASE</td>
1.197     leot     12772: <td>RUBY_INC</td>
1.156     leot     12773: </tr>
                   12774: <tr>
1.200     cirnatda 12775: <td>RUBY_LIB</td>
1.197     leot     12776: <td>RUBY_LIB_BASE</td>
1.156     leot     12777: </tr>
                   12778: <tr>
1.200     cirnatda 12779: <td>RUBY_NAME</td>
1.197     leot     12780: <td>RUBY_NOVERSION</td>
1.156     leot     12781: </tr>
                   12782: <tr>
1.200     cirnatda 12783: <td>RUBY_PKGPREFIX</td>
1.197     leot     12784: <td>RUBY_RAILS</td>
1.156     leot     12785: </tr>
                   12786: <tr>
1.200     cirnatda 12787: <td>RUBY_RAILS52_VERSION</td>
1.197     leot     12788: <td>RUBY_RAILS60_VERSION</td>
1.156     leot     12789: </tr>
                   12790: <tr>
1.200     cirnatda 12791: <td>RUBY_RAILS61_VERSION</td>
1.180     rillig   12792: <td>RUBY_RAILS_ACCEPTED</td>
1.174     leot     12793: </tr>
                   12794: <tr>
1.200     cirnatda 12795: <td>RUBY_RAILS_DEFAULT</td>
1.180     rillig   12796: <td>RUBY_RAILS_REQD</td>
1.156     leot     12797: </tr>
                   12798: <tr>
1.200     cirnatda 12799: <td>RUBY_RAILS_STRICT_DEP</td>
1.180     rillig   12800: <td>RUBY_RIDIR</td>
1.156     leot     12801: </tr>
                   12802: <tr>
1.200     cirnatda 12803: <td>RUBY_SETUP</td>
1.180     rillig   12804: <td>RUBY_SHLIB</td>
1.156     leot     12805: </tr>
                   12806: <tr>
1.200     cirnatda 12807: <td>RUBY_SHLIBALIAS</td>
1.180     rillig   12808: <td>RUBY_SHLIBVER</td>
1.156     leot     12809: </tr>
                   12810: <tr>
1.200     cirnatda 12811: <td>RUBY_SIMPLE_INSTALL</td>
1.180     rillig   12812: <td>RUBY_SITEARCHLIB</td>
1.156     leot     12813: </tr>
                   12814: <tr>
1.200     cirnatda 12815: <td>RUBY_SITELIB</td>
1.180     rillig   12816: <td>RUBY_SITELIB_BASE</td>
1.156     leot     12817: </tr>
                   12818: <tr>
1.200     cirnatda 12819: <td>RUBY_SITERIDIR</td>
1.180     rillig   12820: <td>RUBY_SLEXT</td>
1.156     leot     12821: </tr>
                   12822: <tr>
1.200     cirnatda 12823: <td>RUBY_SRCDIR</td>
1.180     rillig   12824: <td>RUBY_STATICLIB</td>
1.156     leot     12825: </tr>
                   12826: <tr>
1.200     cirnatda 12827: <td>RUBY_SUFFIX</td>
1.180     rillig   12828: <td>RUBY_SYSRIDIR</td>
1.156     leot     12829: </tr>
                   12830: <tr>
1.200     cirnatda 12831: <td>RUBY_USE_PTHREAD</td>
1.180     rillig   12832: <td>RUBY_VENDORARCHLIB</td>
1.156     leot     12833: </tr>
                   12834: <tr>
1.200     cirnatda 12835: <td>RUBY_VENDORLIB</td>
1.180     rillig   12836: <td>RUBY_VENDORLIB_BASE</td>
1.156     leot     12837: </tr>
                   12838: <tr>
1.200     cirnatda 12839: <td>RUBY_VER</td>
1.180     rillig   12840: <td>RUBY_VERSION</td>
1.156     leot     12841: </tr>
                   12842: <tr>
1.200     cirnatda 12843: <td>RUBY_VERSIONS_ACCEPTED</td>
1.180     rillig   12844: <td>RUBY_VERSIONS_INCOMPATIBLE</td>
1.156     leot     12845: </tr>
                   12846: <tr>
1.200     cirnatda 12847: <td>RUBY_VERSION_DEFAULT</td>
1.180     rillig   12848: <td>RUBY_VERSION_REQD</td>
1.156     leot     12849: </tr>
                   12850: <tr>
1.200     cirnatda 12851: <td>RUBY_VER_DIR</td>
1.180     rillig   12852: <td>RUN</td>
1.156     leot     12853: </tr>
                   12854: <tr>
1.200     cirnatda 12855: <td>RUN_LDCONFIG</td>
1.180     rillig   12856: <td>SAWFISH_THEMES</td>
1.156     leot     12857: </tr>
                   12858: <tr>
1.200     cirnatda 12859: <td>SCO</td>
1.180     rillig   12860: <td>SCREWS_GROUP</td>
1.156     leot     12861: </tr>
                   12862: <tr>
1.200     cirnatda 12863: <td>SCREWS_USER</td>
1.180     rillig   12864: <td>SCRIPTS_ENV</td>
1.156     leot     12865: </tr>
                   12866: <tr>
1.200     cirnatda 12867: <td>SCROLLKEEPER_DATADIR</td>
1.180     rillig   12868: <td>SCROLLKEEPER_REBUILDDB</td>
1.156     leot     12869: </tr>
                   12870: <tr>
1.200     cirnatda 12871: <td>SCROLLKEEPER_UPDATEDB</td>
1.180     rillig   12872: <td>SDIST_PAWD</td>
1.156     leot     12873: </tr>
                   12874: <tr>
1.200     cirnatda 12875: <td>SERIAL_DEVICES</td>
1.180     rillig   12876: <td>SETGIDGAME</td>
1.156     leot     12877: </tr>
                   12878: <tr>
1.200     cirnatda 12879: <td>SETGID_GAMES_PERMS</td>
1.180     rillig   12880: <td>SETUID_ROOT_PERMS</td>
1.156     leot     12881: </tr>
                   12882: <tr>
1.200     cirnatda 12883: <td>SH</td>
1.180     rillig   12884: <td>SHLIB</td>
1.177     leot     12885: </tr>
                   12886: <tr>
1.180     rillig   12887: <td>SIGN_PACKAGES</td>
1.194     leot     12888: <td>SILC_CLIENT_WITH_PERL</td>
1.156     leot     12889: </tr>
                   12890: <tr>
1.180     rillig   12891: <td>SITE_SPECIFIC_PKGS</td>
1.194     leot     12892: <td>SKIP_DEPENDS</td>
1.156     leot     12893: </tr>
                   12894: <tr>
1.180     rillig   12895: <td>SMF_INSTANCES</td>
1.194     leot     12896: <td>SMF_MANIFEST</td>
1.159     rillig   12897: </tr>
                   12898: <tr>
1.180     rillig   12899: <td>SMF_METHODS</td>
1.194     leot     12900: <td>SMF_METHOD_SHELL</td>
1.156     leot     12901: </tr>
                   12902: <tr>
1.180     rillig   12903: <td>SMF_METHOD_SRC</td>
1.194     leot     12904: <td>SMF_NAME</td>
1.156     leot     12905: </tr>
                   12906: <tr>
1.180     rillig   12907: <td>SMF_PREFIX</td>
1.194     leot     12908: <td>SMF_SRCDIR</td>
1.156     leot     12909: </tr>
                   12910: <tr>
1.180     rillig   12911: <td>SNIPROXY_GROUP</td>
1.194     leot     12912: <td>SNIPROXY_USER</td>
1.156     leot     12913: </tr>
                   12914: <tr>
1.180     rillig   12915: <td>SOURCE_BUFFSIZE</td>
1.194     leot     12916: <td>SPECIAL_PERMS</td>
1.156     leot     12917: </tr>
                   12918: <tr>
1.180     rillig   12919: <td>SPECIFIC_PKGS</td>
1.194     leot     12920: <td>SSH_SUID</td>
1.156     leot     12921: </tr>
                   12922: <tr>
1.180     rillig   12923: <td>SSP_SUPPORTED</td>
1.194     leot     12924: <td>SSYNC_PAWD</td>
1.156     leot     12925: </tr>
                   12926: <tr>
1.180     rillig   12927: <td>STEP_MSG</td>
1.194     leot     12928: <td>STRIP</td>
1.156     leot     12929: </tr>
                   12930: <tr>
1.180     rillig   12931: <td>STRIP_DBG</td>
1.194     leot     12932: <td>STRIP_DEBUG</td>
1.156     leot     12933: </tr>
                   12934: <tr>
1.180     rillig   12935: <td>STRIP_DEBUG_SUPPORTED</td>
1.194     leot     12936: <td>STRIP_FILES_SKIP</td>
1.156     leot     12937: </tr>
                   12938: <tr>
1.180     rillig   12939: <td>SU</td>
1.194     leot     12940: <td>SUBDIR</td>
1.156     leot     12941: </tr>
                   12942: <tr>
1.180     rillig   12943: <td>SUBST</td>
1.194     leot     12944: <td>SUBST_CLASSES</td>
1.174     leot     12945: </tr>
                   12946: <tr>
1.180     rillig   12947: <td>SUBST_FILES</td>
1.194     leot     12948: <td>SUBST_FILTER_CMD</td>
1.156     leot     12949: </tr>
                   12950: <tr>
1.180     rillig   12951: <td>SUBST_MESSAGE</td>
1.194     leot     12952: <td>SUBST_NOOP_OK</td>
1.156     leot     12953: </tr>
                   12954: <tr>
1.180     rillig   12955: <td>SUBST_SED</td>
1.194     leot     12956: <td>SUBST_SHOW_DIFF</td>
1.156     leot     12957: </tr>
                   12958: <tr>
1.180     rillig   12959: <td>SUBST_SKIP_TEXT_CHECK</td>
1.194     leot     12960: <td>SUBST_STAGE</td>
1.156     leot     12961: </tr>
                   12962: <tr>
1.180     rillig   12963: <td>SUBST_VARS</td>
1.194     leot     12964: <td>SUNWSPROBASE</td>
1.156     leot     12965: </tr>
                   12966: <tr>
1.180     rillig   12967: <td>SUSE_PREFER</td>
1.194     leot     12968: <td>SU_CMD</td>
1.177     leot     12969: </tr>
                   12970: <tr>
1.201     cirnatda 12971: <td>SYSCONFBASE</td>
1.189     bacon    12972: <td>TBL</td>
                   12973: </tr>
                   12974: <tr>
1.201     cirnatda 12975: <td>TERMCAP_TYPE</td>
1.189     bacon    12976: <td>TERMINFO_DEFAULT</td>
1.161     leot     12977: </tr>
                   12978: <tr>
1.201     cirnatda 12979: <td>TERMINFO_TYPE</td>
1.189     bacon    12980: <td>TEST</td>
1.159     rillig   12981: </tr>
                   12982: <tr>
1.201     cirnatda 12983: <td>TEST_DEPENDS</td>
1.189     bacon    12984: <td>TEST_DIRS</td>
1.156     leot     12985: </tr>
                   12986: <tr>
1.201     cirnatda 12987: <td>TEST_ENV</td>
1.189     bacon    12988: <td>TEST_ENV_SHELL</td>
1.156     leot     12989: </tr>
                   12990: <tr>
1.201     cirnatda 12991: <td>TEST_MAKE_CMD</td>
1.189     bacon    12992: <td>TEST_MAKE_FLAGS</td>
1.156     leot     12993: </tr>
                   12994: <tr>
1.201     cirnatda 12995: <td>TEST_TARGET</td>
1.189     bacon    12996: <td>TEXLIVE_IGNORE_PATTERNS</td>
1.156     leot     12997: </tr>
                   12998: <tr>
1.201     cirnatda 12999: <td>TEXLIVE_REV</td>
1.189     bacon    13000: <td>TEXLIVE_UNVERSIONED</td>
1.156     leot     13001: </tr>
                   13002: <tr>
1.201     cirnatda 13003: <td>TEXMFSITE</td>
1.189     bacon    13004: <td>TEX_FORMATS</td>
1.156     leot     13005: </tr>
                   13006: <tr>
1.201     cirnatda 13007: <td>TEX_HYPHEN_DAT</td>
1.189     bacon    13008: <td>TEX_HYPHEN_DEF</td>
1.156     leot     13009: </tr>
                   13010: <tr>
1.201     cirnatda 13011: <td>TEX_TEXMF_DIRS</td>
1.189     bacon    13012: <td>THTTPD_LOG_FACILITY</td>
1.156     leot     13013: </tr>
                   13014: <tr>
1.201     cirnatda 13015: <td>TINYDYN_USER</td>
1.195     gutterid 13016: <td>TO</td>
1.156     leot     13017: </tr>
                   13018: <tr>
1.201     cirnatda 13019: <td>TOOLS_ALIASES</td>
1.195     gutterid 13020: <td>TOOLS_ALWAYS_WRAP</td>
1.156     leot     13021: </tr>
                   13022: <tr>
1.201     cirnatda 13023: <td>TOOLS_ARGS</td>
1.195     gutterid 13024: <td>TOOLS_BROKEN</td>
1.156     leot     13025: </tr>
                   13026: <tr>
1.201     cirnatda 13027: <td>TOOLS_CMD</td>
1.195     gutterid 13028: <td>TOOLS_CMDLINE_SED</td>
1.156     leot     13029: </tr>
                   13030: <tr>
1.201     cirnatda 13031: <td>TOOLS_CREATE</td>
1.195     gutterid 13032: <td>TOOLS_DIR</td>
1.156     leot     13033: </tr>
                   13034: <tr>
1.201     cirnatda 13035: <td>TOOLS_FAIL</td>
1.195     gutterid 13036: <td>TOOLS_GNU_MISSING</td>
1.156     leot     13037: </tr>
                   13038: <tr>
1.201     cirnatda 13039: <td>TOOLS_LDCONFIG</td>
1.195     gutterid 13040: <td>TOOLS_NOOP</td>
1.156     leot     13041: </tr>
                   13042: <tr>
1.201     cirnatda 13043: <td>TOOLS_PATH</td>
1.195     gutterid 13044: <td>TOOLS_SCRIPT</td>
1.161     leot     13045: </tr>
                   13046: <tr>
1.201     cirnatda 13047: <td>TOOL_DEPENDS</td>
1.180     rillig   13048: <td>TTF_FONTS_DIR</td>
1.197     leot     13049: </tr>
                   13050: <tr>
1.201     cirnatda 13051: <td>TYPE</td>
1.197     leot     13052: <td>UAC_REQD_EXECS</td>
1.156     leot     13053: </tr>
                   13054: <tr>
1.201     cirnatda 13055: <td>UCSPI_SSL_GROUP</td>
1.197     leot     13056: <td>UCSPI_SSL_USER</td>
1.156     leot     13057: </tr>
                   13058: <tr>
1.201     cirnatda 13059: <td>UNLIMIT_RESOURCES</td>
1.197     leot     13060: <td>UNPRIVILEGED</td>
1.156     leot     13061: </tr>
                   13062: <tr>
1.201     cirnatda 13063: <td>UNPRIVILEGED_GROUP</td>
1.197     leot     13064: <td>UNPRIVILEGED_GROUPS</td>
1.156     leot     13065: </tr>
                   13066: <tr>
1.201     cirnatda 13067: <td>UNPRIVILEGED_USER</td>
1.197     leot     13068: <td>UNWRAP_FILES</td>
1.156     leot     13069: </tr>
                   13070: <tr>
1.201     cirnatda 13071: <td>UNWRAP_PATTERNS</td>
1.197     leot     13072: <td>UPDATE_GEMSPEC</td>
1.156     leot     13073: </tr>
                   13074: <tr>
1.201     cirnatda 13075: <td>UPDATE_TARGET</td>
1.197     leot     13076: <td>URI</td>
1.156     leot     13077: </tr>
                   13078: <tr>
1.201     cirnatda 13079: <td>USERGROUP_PHASE</td>
1.197     leot     13080: <td>USERPPP_GROUP</td>
1.156     leot     13081: </tr>
                   13082: <tr>
1.201     cirnatda 13083: <td>USER_SPECIFIC_PKGS</td>
1.197     leot     13084: <td>USE_ABI_DEPENDS</td>
1.156     leot     13085: </tr>
                   13086: <tr>
1.201     cirnatda 13087: <td>USE_APR</td>
1.197     leot     13088: <td>USE_BSD_MAKEFILE</td>
1.156     leot     13089: </tr>
                   13090: <tr>
1.201     cirnatda 13091: <td>USE_BUILTIN</td>
1.197     leot     13092: <td>USE_CROSS_COMPILE</td>
1.156     leot     13093: </tr>
                   13094: <tr>
1.201     cirnatda 13095: <td>USE_CURSES</td>
1.197     leot     13096: <td>USE_CWRAPPERS</td>
1.156     leot     13097: </tr>
                   13098: <tr>
1.201     cirnatda 13099: <td>USE_DB185</td>
1.197     leot     13100: <td>USE_FEATURES</td>
1.156     leot     13101: </tr>
                   13102: <tr>
1.201     cirnatda 13103: <td>USE_GAMESGROUP</td>
1.197     leot     13104: <td>USE_GCC_RUNTIME</td>
1.156     leot     13105: </tr>
                   13106: <tr>
1.201     cirnatda 13107: <td>USE_IMAKE</td>
1.197     leot     13108: <td>USE_JAVA</td>
1.156     leot     13109: </tr>
                   13110: <tr>
1.201     cirnatda 13111: <td>USE_JAVA2</td>
1.197     leot     13112: <td>USE_LANGUAGES</td>
1.156     leot     13113: </tr>
                   13114: <tr>
1.201     cirnatda 13115: <td>USE_LIBTOOL</td>
1.197     leot     13116: <td>USE_NATIVE_GCC</td>
1.156     leot     13117: </tr>
                   13118: <tr>
1.201     cirnatda 13119: <td>USE_NETBSD_REPO</td>
1.197     leot     13120: <td>USE_PKGSRC_GCC</td>
1.156     leot     13121: </tr>
                   13122: <tr>
1.201     cirnatda 13123: <td>USE_PKGSRC_GCC_RUNTIME</td>
1.197     leot     13124: <td>USE_PKGTASKS</td>
1.156     leot     13125: </tr>
                   13126: <tr>
1.201     cirnatda 13127: <td>USE_PKG_ADMIN_DIGEST</td>
1.197     leot     13128: <td>USE_RUBY_EXTCONF</td>
1.156     leot     13129: </tr>
                   13130: <tr>
1.201     cirnatda 13131: <td>USE_RUBY_INSTALL</td>
1.197     leot     13132: <td>USE_RUBY_SETUP</td>
1.156     leot     13133: </tr>
                   13134: <tr>
1.201     cirnatda 13135: <td>USE_RUBY_SETUP_PKG</td>
1.197     leot     13136: <td>USE_TOOLS</td>
1.156     leot     13137: </tr>
                   13138: <tr>
1.201     cirnatda 13139: <td>UUCP_GROUP</td>
1.197     leot     13140: <td>UUCP_USER</td>
1.156     leot     13141: </tr>
                   13142: <tr>
1.201     cirnatda 13143: <td>VARBASE</td>
1.197     leot     13144: <td>VARNAME</td>
1.156     leot     13145: </tr>
                   13146: <tr>
1.201     cirnatda 13147: <td>VIM_EXTRA_OPTS</td>
1.197     leot     13148: <td>WARNING_MSG</td>
1.156     leot     13149: </tr>
                   13150: <tr>
1.201     cirnatda 13151: <td>WCALC_CGIDIR</td>
1.197     leot     13152: <td>WCALC_CGIPATH</td>
1.156     leot     13153: </tr>
                   13154: <tr>
1.201     cirnatda 13155: <td>WCALC_HTMLDIR</td>
1.197     leot     13156: <td>WCALC_HTMLPATH</td>
1.156     leot     13157: </tr>
                   13158: <tr>
1.201     cirnatda 13159: <td>WDM_MANAGERS</td>
1.197     leot     13160: <td>WRAPPER_CC</td>
1.156     leot     13161: </tr>
                   13162: <tr>
1.201     cirnatda 13163: <td>WRAPPER_REORDER_CMDS</td>
1.197     leot     13164: <td>WRKDIR</td>
1.189     bacon    13165: </tr>
                   13166: <tr>
1.201     cirnatda 13167: <td>WRKDIR_BASENAME</td>
1.197     leot     13168: <td>WRKDIR_LOCKTYPE</td>
1.156     leot     13169: </tr>
                   13170: <tr>
1.201     cirnatda 13171: <td>WRKLOG</td>
1.197     leot     13172: <td>WRKOBJDIR</td>
1.156     leot     13173: </tr>
                   13174: <tr>
1.201     cirnatda 13175: <td>WRKSRC</td>
1.197     leot     13176: <td>X10_PORT</td>
1.156     leot     13177: </tr>
                   13178: <tr>
1.201     cirnatda 13179: <td>X11</td>
1.197     leot     13180: <td>X11BASE</td>
1.156     leot     13181: </tr>
                   13182: <tr>
1.201     cirnatda 13183: <td>X11_PKGSRCDIR</td>
1.197     leot     13184: <td>X11_TYPE</td>
1.156     leot     13185: </tr>
                   13186: <tr>
1.201     cirnatda 13187: <td>X509_CERTIFICATE</td>
1.197     leot     13188: <td>X509_KEY</td>
1.156     leot     13189: </tr>
                   13190: <tr>
1.201     cirnatda 13191: <td>XAW_TYPE</td>
1.197     leot     13192: <td>XLOCK_DEFAULT_MODE</td>
1.156     leot     13193: </tr>
                   13194: <tr>
1.201     cirnatda 13195: <td>XMKMF</td>
1.197     leot     13196: <td>XMKMF_FLAGS</td>
1.159     rillig   13197: </tr>
                   13198: <tr>
1.201     cirnatda 13199: <td>XXX</td>
1.195     gutterid 13200: <td>YES</td>
1.156     leot     13201: </tr>
                   13202: <tr>
1.201     cirnatda 13203: <td>ZSH_STATIC</td>
1.195     gutterid 13204: <td>__stdc__</td>
1.201     cirnatda 13205: </tr>
                   13206: <tr>
1.180     rillig   13207: <td>_vargroups</td>
1.201     cirnatda 13208: <td>accept</td>
1.174     leot     13209: </tr>
                   13210: <tr>
1.180     rillig   13211: <td>acquire-localbase-lock</td>
1.201     cirnatda 13212: <td>acquire-lock</td>
1.156     leot     13213: </tr>
                   13214: <tr>
1.180     rillig   13215: <td>add</td>
1.201     cirnatda 13216: <td>administrator</td>
1.156     leot     13217: </tr>
                   13218: <tr>
1.180     rillig   13219: <td>alloca</td>
1.201     cirnatda 13220: <td>alternatives</td>
1.174     leot     13221: </tr>
                   13222: <tr>
1.180     rillig   13223: <td>aslr</td>
1.201     cirnatda 13224: <td>asprintf</td>
1.156     leot     13225: </tr>
                   13226: <tr>
1.180     rillig   13227: <td>atlas</td>
1.201     cirnatda 13228: <td>autoconf</td>
1.161     leot     13229: </tr>
                   13230: <tr>
1.180     rillig   13231: <td>automake</td>
1.201     cirnatda 13232: <td>autoreconf</td>
1.156     leot     13233: </tr>
                   13234: <tr>
1.180     rillig   13235: <td>awk</td>
1.201     cirnatda 13236: <td>bash</td>
1.156     leot     13237: </tr>
                   13238: <tr>
1.180     rillig   13239: <td>big-endian</td>
1.201     cirnatda 13240: <td>bin-install</td>
1.156     leot     13241: </tr>
                   13242: <tr>
1.180     rillig   13243: <td>bind</td>
1.201     cirnatda 13244: <td>binpkg-list</td>
1.177     leot     13245: </tr>
                   13246: <tr>
1.180     rillig   13247: <td>blas</td>
1.201     cirnatda 13248: <td>bootstrap-depends</td>
1.159     rillig   13249: </tr>
                   13250: <tr>
1.180     rillig   13251: <td>broken</td>
1.201     cirnatda 13252: <td>broken_on_platform</td>
1.156     leot     13253: </tr>
                   13254: <tr>
1.180     rillig   13255: <td>bsd</td>
1.201     cirnatda 13256: <td>bsd.prog.mk</td>
1.174     leot     13257: </tr>
                   13258: <tr>
1.180     rillig   13259: <td>build</td>
1.201     cirnatda 13260: <td>build-env</td>
1.156     leot     13261: </tr>
                   13262: <tr>
1.180     rillig   13263: <td>buildlink-directories</td>
1.201     cirnatda 13264: <td>buildlink-oss-soundcard-h</td>
1.156     leot     13265: </tr>
                   13266: <tr>
1.180     rillig   13267: <td>c</td>
1.201     cirnatda 13268: <td>c++</td>
1.156     leot     13269: </tr>
                   13270: <tr>
1.180     rillig   13271: <td>ccache</td>
1.201     cirnatda 13272: <td>cce</td>
1.156     leot     13273: </tr>
                   13274: <tr>
1.180     rillig   13275: <td>cdefs</td>
1.201     cirnatda 13276: <td>ceil</td>
1.174     leot     13277: </tr>
                   13278: <tr>
1.180     rillig   13279: <td>changes</td>
1.201     cirnatda 13280: <td>changes-entry</td>
1.156     leot     13281: </tr>
                   13282: <tr>
1.180     rillig   13283: <td>changes-entry-noupdate</td>
1.201     cirnatda 13284: <td>check</td>
1.156     leot     13285: </tr>
                   13286: <tr>
1.180     rillig   13287: <td>check-clean</td>
1.201     cirnatda 13288: <td>check-files</td>
1.156     leot     13289: </tr>
                   13290: <tr>
1.180     rillig   13291: <td>check-files-clean</td>
1.201     cirnatda 13292: <td>check-vulnerable</td>
1.156     leot     13293: </tr>
                   13294: <tr>
1.180     rillig   13295: <td>checksum</td>
1.201     cirnatda 13296: <td>checksum-phase</td>
1.156     leot     13297: </tr>
                   13298: <tr>
1.180     rillig   13299: <td>clean</td>
1.201     cirnatda 13300: <td>clean-depends</td>
1.156     leot     13301: </tr>
                   13302: <tr>
1.180     rillig   13303: <td>cleandir</td>
1.201     cirnatda 13304: <td>commit</td>
1.156     leot     13305: </tr>
                   13306: <tr>
1.180     rillig   13307: <td>commit-changes-entry</td>
1.201     cirnatda 13308: <td>compact</td>
1.156     leot     13309: </tr>
                   13310: <tr>
1.180     rillig   13311: <td>compiler</td>
1.201     cirnatda 13312: <td>conf</td>
1.156     leot     13313: </tr>
                   13314: <tr>
1.180     rillig   13315: <td>config.guess</td>
1.201     cirnatda 13316: <td>config.sub</td>
1.156     leot     13317: </tr>
                   13318: <tr>
1.180     rillig   13319: <td>configuration</td>
1.201     cirnatda 13320: <td>configure</td>
1.156     leot     13321: </tr>
                   13322: <tr>
1.180     rillig   13323: <td>configure-env</td>
1.201     cirnatda 13324: <td>configure-help</td>
1.156     leot     13325: </tr>
                   13326: <tr>
1.180     rillig   13327: <td>configure_args</td>
1.201     cirnatda 13328: <td>connect</td>
1.156     leot     13329: </tr>
                   13330: <tr>
1.180     rillig   13331: <td>cos</td>
1.201     cirnatda 13332: <td>cputime</td>
1.174     leot     13333: </tr>
                   13334: <tr>
1.180     rillig   13335: <td>create-usergroup</td>
1.201     cirnatda 13336: <td>csh</td>
1.156     leot     13337: </tr>
                   13338: <tr>
1.180     rillig   13339: <td>ctf</td>
1.201     cirnatda 13340: <td>debug</td>
1.161     leot     13341: </tr>
                   13342: <tr>
1.200     cirnatda 13343: <td>declaration</td>
1.201     cirnatda 13344: <td>declare</td>
1.197     leot     13345: </tr>
                   13346: <tr>
1.200     cirnatda 13347: <td>defined</td>
1.201     cirnatda 13348: <td>depend</td>
1.156     leot     13349: </tr>
                   13350: <tr>
1.200     cirnatda 13351: <td>dependencies</td>
1.201     cirnatda 13352: <td>depends</td>
1.156     leot     13353: </tr>
                   13354: <tr>
1.200     cirnatda 13355: <td>depends-checksum</td>
1.201     cirnatda 13356: <td>depends-fetch</td>
1.156     leot     13357: </tr>
                   13358: <tr>
1.200     cirnatda 13359: <td>deps</td>
1.201     cirnatda 13360: <td>describe</td>
1.156     leot     13361: </tr>
                   13362: <tr>
1.200     cirnatda 13363: <td>destdir</td>
1.201     cirnatda 13364: <td>disable</td>
1.156     leot     13365: </tr>
                   13366: <tr>
1.200     cirnatda 13367: <td>distclean</td>
1.201     cirnatda 13368: <td>distinfo</td>
1.156     leot     13369: </tr>
                   13370: <tr>
1.200     cirnatda 13371: <td>dl</td>
1.201     cirnatda 13372: <td>dlopen</td>
1.162     rillig   13373: </tr>
                   13374: <tr>
1.200     cirnatda 13375: <td>do-build</td>
1.201     cirnatda 13376: <td>do-buildlink</td>
1.156     leot     13377: </tr>
                   13378: <tr>
1.200     cirnatda 13379: <td>do-clean</td>
1.201     cirnatda 13380: <td>do-configure</td>
1.156     leot     13381: </tr>
                   13382: <tr>
1.200     cirnatda 13383: <td>do-configure-post-hook</td>
1.201     cirnatda 13384: <td>do-extract</td>
1.156     leot     13385: </tr>
                   13386: <tr>
1.195     gutterid 13387: <td>do-fetch</td>
1.201     cirnatda 13388: <td>emul</td>
1.174     leot     13389: </tr>
                   13390: <tr>
1.180     rillig   13391: <td>emul-distinfo</td>
1.201     cirnatda 13392: <td>emul-fetch</td>
1.156     leot     13393: </tr>
                   13394: <tr>
1.180     rillig   13395: <td>emulation</td>
1.201     cirnatda 13396: <td>emulator</td>
1.159     rillig   13397: </tr>
                   13398: <tr>
1.180     rillig   13399: <td>enable</td>
1.201     cirnatda 13400: <td>endian</td>
1.156     leot     13401: </tr>
                   13402: <tr>
1.200     cirnatda 13403: <td>enomem</td>
1.201     cirnatda 13404: <td>err</td>
1.197     leot     13405: </tr>
                   13406: <tr>
1.200     cirnatda 13407: <td>errx</td>
1.201     cirnatda 13408: <td>etc</td>
1.156     leot     13409: </tr>
                   13410: <tr>
1.200     cirnatda 13411: <td>exp</td>
1.201     cirnatda 13412: <td>extract-rpm</td>
1.156     leot     13413: </tr>
                   13414: <tr>
1.200     cirnatda 13415: <td>fabs</td>
1.201     cirnatda 13416: <td>feature</td>
1.174     leot     13417: </tr>
                   13418: <tr>
1.200     cirnatda 13419: <td>features</td>
1.201     cirnatda 13420: <td>fetch</td>
1.156     leot     13421: </tr>
                   13422: <tr>
1.200     cirnatda 13423: <td>fetch-list</td>
1.201     cirnatda 13424: <td>follows</td>
1.156     leot     13425: </tr>
                   13426: <tr>
1.200     cirnatda 13427: <td>forbids</td>
1.201     cirnatda 13428: <td>form</td>
1.156     leot     13429: </tr>
                   13430: <tr>
1.200     cirnatda 13431: <td>format</td>
1.201     cirnatda 13432: <td>fortify</td>
1.156     leot     13433: </tr>
                   13434: <tr>
1.195     gutterid 13435: <td>fortify_source</td>
1.201     cirnatda 13436: <td>friend</td>
1.156     leot     13437: </tr>
                   13438: <tr>
1.180     rillig   13439: <td>fts</td>
1.201     cirnatda 13440: <td>fts_close</td>
1.156     leot     13441: </tr>
                   13442: <tr>
1.180     rillig   13443: <td>fts_open</td>
1.201     cirnatda 13444: <td>fts_read</td>
1.156     leot     13445: </tr>
                   13446: <tr>
1.180     rillig   13447: <td>fts_set</td>
1.201     cirnatda 13448: <td>gcc</td>
1.174     leot     13449: </tr>
                   13450: <tr>
1.180     rillig   13451: <td>gethostbyaddr</td>
1.201     cirnatda 13452: <td>gethostbyname</td>
1.156     leot     13453: </tr>
                   13454: <tr>
1.180     rillig   13455: <td>gethostbyname2</td>
1.201     cirnatda 13456: <td>getopt_long</td>
1.156     leot     13457: </tr>
                   13458: <tr>
1.180     rillig   13459: <td>getprogname</td>
1.201     cirnatda 13460: <td>getservbyname</td>
1.174     leot     13461: </tr>
                   13462: <tr>
1.180     rillig   13463: <td>getservbyport</td>
1.201     cirnatda 13464: <td>getservent</td>
1.174     leot     13465: </tr>
                   13466: <tr>
1.180     rillig   13467: <td>gettext</td>
1.201     cirnatda 13468: <td>github</td>
1.156     leot     13469: </tr>
                   13470: <tr>
1.180     rillig   13471: <td>glob</td>
1.201     cirnatda 13472: <td>gnu</td>
1.159     rillig   13473: </tr>
                   13474: <tr>
1.180     rillig   13475: <td>gnu_configure_strict</td>
1.201     cirnatda 13476: <td>go</td>
1.156     leot     13477: </tr>
                   13478: <tr>
1.180     rillig   13479: <td>go-deps</td>
1.201     cirnatda 13480: <td>golang</td>
1.156     leot     13481: </tr>
                   13482: <tr>
1.180     rillig   13483: <td>guess-license</td>
1.201     cirnatda 13484: <td>hashbang</td>
1.156     leot     13485: </tr>
                   13486: <tr>
1.180     rillig   13487: <td>heimdal</td>
1.201     cirnatda 13488: <td>help</td>
1.156     leot     13489: </tr>
                   13490: <tr>
1.200     cirnatda 13491: <td>imake</td>
1.201     cirnatda 13492: <td>increment</td>
1.197     leot     13493: </tr>
                   13494: <tr>
1.200     cirnatda 13495: <td>inet_aton</td>
1.201     cirnatda 13496: <td>interp</td>
1.161     leot     13497: </tr>
                   13498: <tr>
1.200     cirnatda 13499: <td>interpreter</td>
1.201     cirnatda 13500: <td>intl</td>
1.156     leot     13501: </tr>
                   13502: <tr>
1.200     cirnatda 13503: <td>ip4</td>
1.201     cirnatda 13504: <td>ip6</td>
1.156     leot     13505: </tr>
                   13506: <tr>
1.200     cirnatda 13507: <td>ipv4</td>
1.201     cirnatda 13508: <td>ipv6</td>
1.156     leot     13509: </tr>
                   13510: <tr>
1.200     cirnatda 13511: <td>iso</td>
1.201     cirnatda 13512: <td>kerberos</td>
1.189     bacon    13513: </tr>
                   13514: <tr>
1.200     cirnatda 13515: <td>krb</td>
1.201     cirnatda 13516: <td>krb5</td>
1.189     bacon    13517: </tr>
                   13518: <tr>
1.200     cirnatda 13519: <td>ksh</td>
1.201     cirnatda 13520: <td>lapack</td>
1.156     leot     13521: </tr>
                   13522: <tr>
1.200     cirnatda 13523: <td>latex</td>
1.201     cirnatda 13524: <td>libintl_bindtextdomain</td>
1.177     leot     13525: </tr>
                   13526: <tr>
1.200     cirnatda 13527: <td>libintl_gettext</td>
1.201     cirnatda 13528: <td>libintl_textdomain</td>
1.156     leot     13529: </tr>
                   13530: <tr>
1.200     cirnatda 13531: <td>libnbcompat</td>
1.201     cirnatda 13532: <td>libs</td>
1.174     leot     13533: </tr>
                   13534: <tr>
1.200     cirnatda 13535: <td>libtool</td>
1.201     cirnatda 13536: <td>licence</td>
1.159     rillig   13537: </tr>
                   13538: <tr>
1.200     cirnatda 13539: <td>license</td>
1.201     cirnatda 13540: <td>lintl</td>
1.156     leot     13541: </tr>
                   13542: <tr>
1.200     cirnatda 13543: <td>little-endian</td>
1.201     cirnatda 13544: <td>lock</td>
1.156     leot     13545: </tr>
                   13546: <tr>
1.200     cirnatda 13547: <td>locking</td>
1.201     cirnatda 13548: <td>lvalue</td>
1.156     leot     13549: </tr>
                   13550: <tr>
1.200     cirnatda 13551: <td>make</td>
1.201     cirnatda 13552: <td>makesum</td>
1.156     leot     13553: </tr>
                   13554: <tr>
1.195     gutterid 13555: <td>memory</td>
1.201     cirnatda 13556: <td>meta</td>
1.156     leot     13557: </tr>
                   13558: <tr>
1.180     rillig   13559: <td>meta-package</td>
1.201     cirnatda 13560: <td>meta_package</td>
1.156     leot     13561: </tr>
                   13562: <tr>
1.180     rillig   13563: <td>mit-krb5</td>
1.201     cirnatda 13564: <td>mk.conf</td>
1.177     leot     13565: </tr>
                   13566: <tr>
1.180     rillig   13567: <td>mkl</td>
1.201     cirnatda 13568: <td>mount</td>
1.159     rillig   13569: </tr>
                   13570: <tr>
1.180     rillig   13571: <td>mprotect</td>
1.201     cirnatda 13572: <td>mremap</td>
1.156     leot     13573: </tr>
                   13574: <tr>
1.180     rillig   13575: <td>nb</td>
1.201     cirnatda 13576: <td>nbcompat</td>
1.156     leot     13577: </tr>
                   13578: <tr>
1.180     rillig   13579: <td>obstack</td>
1.201     cirnatda 13580: <td>obstack_ptr_grow</td>
1.156     leot     13581: </tr>
                   13582: <tr>
1.180     rillig   13583: <td>occurs</td>
1.201     cirnatda 13584: <td>only</td>
1.161     leot     13585: </tr>
                   13586: <tr>
1.180     rillig   13587: <td>openblas</td>
1.201     cirnatda 13588: <td>options</td>
1.156     leot     13589: </tr>
                   13590: <tr>
1.180     rillig   13591: <td>options.mk</td>
1.201     cirnatda 13592: <td>order</td>
1.156     leot     13593: </tr>
                   13594: <tr>
1.180     rillig   13595: <td>override</td>
1.201     cirnatda 13596: <td>override-intltool</td>
1.156     leot     13597: </tr>
                   13598: <tr>
1.180     rillig   13599: <td>override-message-intltool</td>
1.201     cirnatda 13600: <td>package</td>
1.156     leot     13601: </tr>
                   13602: <tr>
1.180     rillig   13603: <td>parallel</td>
1.201     cirnatda 13604: <td>path</td>
1.156     leot     13605: </tr>
                   13606: <tr>
1.180     rillig   13607: <td>pax</td>
1.201     cirnatda 13608: <td>paxctl</td>
1.156     leot     13609: </tr>
                   13610: <tr>
1.180     rillig   13611: <td>pbulk-index</td>
1.201     cirnatda 13612: <td>pc</td>
1.156     leot     13613: </tr>
                   13614: <tr>
1.180     rillig   13615: <td>perl</td>
1.201     cirnatda 13616: <td>perl5</td>
1.156     leot     13617: </tr>
                   13618: <tr>
1.180     rillig   13619: <td>perms</td>
1.201     cirnatda 13620: <td>php</td>
1.156     leot     13621: </tr>
                   13622: <tr>
1.180     rillig   13623: <td>pkg-build-options</td>
1.201     cirnatda 13624: <td>pkg-config</td>
1.156     leot     13625: </tr>
                   13626: <tr>
1.180     rillig   13627: <td>pkg_build_options</td>
1.201     cirnatda 13628: <td>platform</td>
1.156     leot     13629: </tr>
                   13630: <tr>
1.180     rillig   13631: <td>plist</td>
1.201     cirnatda 13632: <td>post-extract</td>
1.156     leot     13633: </tr>
                   13634: <tr>
1.180     rillig   13635: <td>post-fetch</td>
1.201     cirnatda 13636: <td>post-wrapper</td>
1.156     leot     13637: </tr>
                   13638: <tr>
1.180     rillig   13639: <td>pre-build-checks-hook</td>
1.201     cirnatda 13640: <td>pre-configure</td>
1.174     leot     13641: </tr>
                   13642: <tr>
1.180     rillig   13643: <td>pre-configure-checks-hook</td>
1.201     cirnatda 13644: <td>pre-extract</td>
1.156     leot     13645: </tr>
                   13646: <tr>
1.180     rillig   13647: <td>pre-fetch</td>
1.201     cirnatda 13648: <td>print-go-deps</td>
1.156     leot     13649: </tr>
                   13650: <tr>
1.180     rillig   13651: <td>print-plist</td>
1.201     cirnatda 13652: <td>print-summary-data</td>
1.156     leot     13653: </tr>
                   13654: <tr>
1.180     rillig   13655: <td>privileged-install-hook</td>
1.201     cirnatda 13656: <td>pypi</td>
1.156     leot     13657: </tr>
                   13658: <tr>
1.180     rillig   13659: <td>python</td>
1.201     cirnatda 13660: <td>readme-all</td>
1.156     leot     13661: </tr>
                   13662: <tr>
1.180     rillig   13663: <td>recv</td>
1.201     cirnatda 13664: <td>recvfrom</td>
1.174     leot     13665: </tr>
                   13666: <tr>
1.180     rillig   13667: <td>regcomp</td>
1.201     cirnatda 13668: <td>release-localbase-lock</td>
1.174     leot     13669: </tr>
                   13670: <tr>
1.180     rillig   13671: <td>release-lock</td>
1.201     cirnatda 13672: <td>relro</td>
1.156     leot     13673: </tr>
                   13674: <tr>
1.180     rillig   13675: <td>rename</td>
1.201     cirnatda 13676: <td>reorder</td>
1.156     leot     13677: </tr>
                   13678: <tr>
1.180     rillig   13679: <td>replace</td>
1.201     cirnatda 13680: <td>replace_interpreter</td>
1.156     leot     13681: </tr>
                   13682: <tr>
1.180     rillig   13683: <td>reproducible</td>
1.201     cirnatda 13684: <td>resolv</td>
1.156     leot     13685: </tr>
                   13686: <tr>
1.180     rillig   13687: <td>root</td>
1.201     cirnatda 13688: <td>ruby</td>
1.174     leot     13689: </tr>
                   13690: <tr>
1.180     rillig   13691: <td>send</td>
1.201     cirnatda 13692: <td>sendfile</td>
1.156     leot     13693: </tr>
                   13694: <tr>
1.180     rillig   13695: <td>sendto</td>
1.201     cirnatda 13696: <td>setenv</td>
1.156     leot     13697: </tr>
                   13698: <tr>
1.180     rillig   13699: <td>setgid</td>
1.201     cirnatda 13700: <td>setprogname</td>
1.156     leot     13701: </tr>
                   13702: <tr>
1.180     rillig   13703: <td>setuid</td>
1.201     cirnatda 13704: <td>sh</td>
1.156     leot     13705: </tr>
                   13706: <tr>
1.181     rillig   13707: <td>shebang</td>
1.201     cirnatda 13708: <td>show</td>
1.181     rillig   13709: </tr>
                   13710: <tr>
1.158     brook    13711: <td>show-all</td>
1.201     cirnatda 13712: <td>show-build-defs</td>
1.156     leot     13713: </tr>
                   13714: <tr>
1.158     brook    13715: <td>show-depends</td>
1.201     cirnatda 13716: <td>show-deps</td>
1.156     leot     13717: </tr>
                   13718: <tr>
1.158     brook    13719: <td>show-distfiles</td>
1.201     cirnatda 13720: <td>show-downlevel</td>
1.156     leot     13721: </tr>
                   13722: <tr>
1.158     brook    13723: <td>show-subdir-var</td>
1.201     cirnatda 13724: <td>show-tools</td>
1.156     leot     13725: </tr>
                   13726: <tr>
1.158     brook    13727: <td>show-var</td>
1.201     cirnatda 13728: <td>show-vars</td>
1.156     leot     13729: </tr>
                   13730: <tr>
1.158     brook    13731: <td>snprintf</td>
1.201     cirnatda 13732: <td>socket</td>
1.174     leot     13733: </tr>
                   13734: <tr>
1.170     rillig   13735: <td>ssp</td>
1.201     cirnatda 13736: <td>st_mode</td>
1.156     leot     13737: </tr>
                   13738: <tr>
1.170     rillig   13739: <td>stage-install</td>
1.201     cirnatda 13740: <td>strcasestr</td>
1.156     leot     13741: </tr>
                   13742: <tr>
1.162     rillig   13743: <td>strict</td>
1.201     cirnatda 13744: <td>strip</td>
1.162     rillig   13745: </tr>
                   13746: <tr>
1.174     leot     13747: <td>strndup</td>
1.201     cirnatda 13748: <td>strnlen</td>
1.156     leot     13749: </tr>
                   13750: <tr>
1.174     leot     13751: <td>strsep</td>
1.201     cirnatda 13752: <td>subst</td>
1.174     leot     13753: </tr>
                   13754: <tr>
                   13755: <td>substitutions</td>
1.201     cirnatda 13756: <td>sun</td>
1.177     leot     13757: </tr>
                   13758: <tr>
1.200     cirnatda 13759: <td>sunpro</td>
1.201     cirnatda 13760: <td>sunwspro</td>
1.197     leot     13761: </tr>
                   13762: <tr>
1.161     leot     13763: <td>symlink</td>
1.201     cirnatda 13764: <td>test</td>
1.161     leot     13765: </tr>
                   13766: <tr>
1.174     leot     13767: <td>test-env</td>
1.201     cirnatda 13768: <td>tex</td>
1.156     leot     13769: </tr>
                   13770: <tr>
1.174     leot     13771: <td>texlive</td>
1.201     cirnatda 13772: <td>tmp</td>
1.156     leot     13773: </tr>
                   13774: <tr>
1.174     leot     13775: <td>tool</td>
1.201     cirnatda 13776: <td>tools</td>
1.156     leot     13777: </tr>
                   13778: <tr>
1.174     leot     13779: <td>tools-libtool-m4-override</td>
1.201     cirnatda 13780: <td>type</td>
1.156     leot     13781: </tr>
                   13782: <tr>
1.174     leot     13783: <td>ulimit</td>
1.201     cirnatda 13784: <td>undefined</td>
1.156     leot     13785: </tr>
                   13786: <tr>
1.174     leot     13787: <td>undo-replace</td>
1.201     cirnatda 13788: <td>unlimit</td>
1.156     leot     13789: </tr>
                   13790: <tr>
1.174     leot     13791: <td>unprivileged</td>
1.201     cirnatda 13792: <td>unprivileged-install-hook</td>
1.156     leot     13793: </tr>
                   13794: <tr>
1.174     leot     13795: <td>unstripped</td>
1.201     cirnatda 13796: <td>update</td>
1.156     leot     13797: </tr>
                   13798: <tr>
1.174     leot     13799: <td>upload</td>
1.201     cirnatda 13800: <td>upload-distfiles</td>
1.156     leot     13801: </tr>
                   13802: <tr>
1.157     leot     13803: <td>use_tools</td>
1.201     cirnatda 13804: <td>user</td>
1.156     leot     13805: </tr>
                   13806: <tr>
1.157     leot     13807: <td>utimes</td>
1.201     cirnatda 13808: <td>vasprintf</td>
1.156     leot     13809: </tr>
                   13810: <tr>
1.157     leot     13811: <td>verbose</td>
1.201     cirnatda 13812: <td>vsnprintf</td>
1.156     leot     13813: </tr>
                   13814: <tr>
1.157     leot     13815: <td>warn</td>
1.201     cirnatda 13816: <td>warning</td>
1.156     leot     13817: </tr>
                   13818: <tr>
1.157     leot     13819: <td>warnings</td>
1.201     cirnatda 13820: <td>warnx</td>
1.156     leot     13821: </tr>
                   13822: <tr>
1.174     leot     13823: <td>wattr_off</td>
1.201     cirnatda 13824: <td>wattr_on</td>
1.156     leot     13825: </tr>
                   13826: <tr>
1.174     leot     13827: <td>work</td>
1.201     cirnatda 13828: <td>wrapper</td>
1.156     leot     13829: </tr>
                   13830: <tr>
1.174     leot     13831: <td>wrkdir</td>
1.201     cirnatda 13832: <td> </td>
1.156     leot     13833: </tr>
                   13834: </table>
1.154     rillig   13835: </div>
                   13836: <div class="appendix">
                   13837: <div class="titlepage"><div><div><h1 class="title">
                   13838: <a name="editing"></a>Appendix E. Editing guidelines for the pkgsrc guide</h1></div></div></div>
1.1       dsieger  13839: <div class="toc">
                   13840: <p><b>Table of Contents</b></p>
1.100     leot     13841: <dl class="toc">
1.154     rillig   13842: <dt><span class="sect1"><a href="#targets">E.1. Make targets</a></span></dt>
                   13843: <dt><span class="sect1"><a href="#procedure">E.2. Procedure</a></span></dt>
1.1       dsieger  13844: </dl>
                   13845: </div>
                   13846: <p>This section contains information on editing the pkgsrc
                   13847:        guide itself.</p>
1.41      asau     13848: <div class="sect1">
1.1       dsieger  13849: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   13850: <a name="targets"></a>E.1. Make targets</h2></div></div></div>
1.1       dsieger  13851: <p>The pkgsrc guide's source code is stored in
                   13852:        <code class="filename">pkgsrc/doc/guide/files</code>, and several files
                   13853:        are created from it:</p>
1.41      asau     13854: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      13855: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
                   13856: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
1.174     leot     13857: <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>
                   13858: <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.1       dsieger  13859:        The PDF version of the pkgsrc guide.</p></li>
1.174     leot     13860: <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.1       dsieger  13861:        PostScript version of the pkgsrc guide.</p></li>
                   13862: </ul></div>
                   13863: </div>
1.41      asau     13864: <div class="sect1">
1.1       dsieger  13865: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   13866: <a name="procedure"></a>E.2. Procedure</h2></div></div></div>
1.1       dsieger  13867: <p>The procedure to edit the pkgsrc guide is:</p>
1.23      wiz      13868: <div class="procedure"><ol class="procedure" type="1">
1.190     bacon    13869: <li class="step"><p>Make sure you have checked out the htdocs repository
                   13870:        into a sibling directory of your pkgsrc directory.  You will need
                   13871:        the ability to commit from both pkgsrc and htdocs.</p></li>
1.41      asau     13872: <li class="step"><p>Make sure you have the packages needed to
1.1       dsieger  13873:        regenerate the pkgsrc guide (and other XML-based NetBSD
1.45      obache   13874:        documentation) installed. These are automatically installed when
1.137     leot     13875:        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.41      asau     13876: <li class="step"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.1       dsieger  13877:        right directory. All further steps will take place
                   13878:        here.</p></li>
1.41      asau     13879: <li class="step"><p>Edit the XML file(s) in
1.1       dsieger  13880:        <code class="filename">files/</code>.</p></li>
1.41      asau     13881: <li class="step"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.1       dsieger  13882:        guide for valid XML and to build the final output files. If you
                   13883:        get any errors at this stage, you can just edit the files, as
                   13884:        there are only symbolic links in the working directory, pointing
                   13885:        to the files in <code class="filename">files/</code>.</p></li>
1.41      asau     13886: <li class="step"><p><span class="command"><strong>(cd files &amp;&amp; cvs
1.1       dsieger  13887:        commit)</strong></span></p></li>
1.41      asau     13888: <li class="step"><p>Run <span class="command"><strong>bmake clean &amp;&amp; bmake</strong></span> to
1.1       dsieger  13889:        regenerate the output files with the proper RCS
                   13890:        Ids.</p></li>
1.41      asau     13891: <li class="step">
1.10      hubertf  13892: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.1       dsieger  13893:        commit the files in both <code class="filename">pkgsrc/doc</code> and
                   13894:        <code class="filename">htdocs</code>.</p>
1.41      asau     13895: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  13896: <h3 class="title">Note</h3>
                   13897: <p>If you have added, removed or renamed some chapters,
1.10      hubertf  13898:        you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
                   13899:        <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.1       dsieger  13900:        directory.</p>
                   13901: </div>
                   13902: </li>
                   13903: </ol></div>
                   13904: </div>
                   13905: </div>
                   13906: </div></body>
                   13907: </html>

CVSweb <webmaster@jp.NetBSD.org>