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

1.75      rillig      1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
                      2: <html>
1.1       grant       3: <head>
1.75      rillig      4: <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
                      5: <title>The pkgsrc guide</title>
1.132     spz         6: <link rel="stylesheet" type="text/css" href="/global.css">
1.75      rillig      7: <meta name="generator" content="DocBook XSL Stylesheets VX.X.X">
1.91      rillig      8: <meta name="description" content="pkgsrc is a centralized package management system for Unix-like operating systems. This guide provides information for users and developers of pkgsrc. It covers installation of binary and source packages, creation of binary and source packages and a high-level overview about the infrastructure.">
1.75      rillig      9: </head>
1.148     asau       10: <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book">
1.75      rillig     11: <div class="titlepage">
                     12: <div>
                     13: <div><h1 class="title">
                     14: <a name="the-pkgsrc-guide"></a>The pkgsrc guide</h1></div>
                     15: <div><h2 class="subtitle">Documentation on the NetBSD packages system</h2></div>
                     16: <div><div class="authorgroup">
                     17: <div class="author">
                     18: <h3 class="author">
                     19: <span class="firstname">Alistair</span> <span class="surname">Crooks</span>
                     20: </h3>
1.110     hubertf    21: <div class="affiliation"><div class="address"><p><code class="email">&lt;<a class="email" href="mailto:agc@NetBSD.org">agc@NetBSD.org</a>&gt;</code></p></div></div>
1.75      rillig     22: </div>
                     23: <div class="author">
                     24: <h3 class="author">
                     25: <span class="firstname">Hubert</span> <span class="surname">Feyrer</span>
                     26: </h3>
1.110     hubertf    27: <div class="affiliation"><div class="address"><p><code class="email">&lt;<a class="email" href="mailto:hubertf@NetBSD.org">hubertf@NetBSD.org</a>&gt;</code></p></div></div>
1.75      rillig     28: </div>
                     29: <h3 class="corpauthor">
                     30:         The pkgsrc Developers
                     31:       </h3>
                     32: </div></div>
1.281     leot       33: <div><p class="copyright">Copyright © 1994-2020 The NetBSD Foundation, Inc</p></div>
                     34: <div><p class="pubdate">$NetBSD: pkgsrc.xml,v 1.36 2020/01/03 15:55:24 leot Exp $</p></div>
1.148     asau       35: <div><div class="abstract">
1.75      rillig     36: <p class="title"><b>Abstract</b></p>
                     37: <p>pkgsrc is a centralized package management system for
                     38:        Unix-like operating systems. This guide provides information for
                     39:        users and developers of pkgsrc. It covers installation of binary
                     40:        and source packages, creation of binary and source packages and
                     41:        a high-level overview about the infrastructure.</p>
                     42: </div></div>
                     43: </div>
                     44: <hr>
                     45: </div>
                     46: <div class="toc">
                     47: <p><b>Table of Contents</b></p>
1.210     leot       48: <dl class="toc">
1.75      rillig     49: <dt><span class="chapter"><a href="#introduction">1. What is pkgsrc?</a></span></dt>
                     50: <dd><dl>
                     51: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82      rillig     52: <dd><dl>
                     53: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
                     54: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
                     55: </dl></dd>
1.75      rillig     56: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
                     57: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88      wiz        58: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
1.75      rillig     59: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
                     60: </dl></dd>
                     61: <dt><span class="part"><a href="#users-guide">I. The pkgsrc user's guide</a></span></dt>
                     62: <dd><dl>
1.267     rillig     63: <dt><span class="chapter"><a href="#help-user">2. Getting help</a></span></dt>
                     64: <dt><span class="chapter"><a href="#getting">3. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
1.75      rillig     65: <dd><dl>
1.267     rillig     66: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.75      rillig     67: <dd><dl>
1.267     rillig     68: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
                     69: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.75      rillig     70: </dl></dd>
1.267     rillig     71: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.75      rillig     72: <dd><dl>
1.267     rillig     73: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
                     74: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.75      rillig     75: </dl></dd>
                     76: </dl></dd>
1.267     rillig     77: <dt><span class="chapter"><a href="#platforms">4. Using pkgsrc on systems other than NetBSD</a></span></dt>
1.75      rillig     78: <dd><dl>
1.267     rillig     79: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
                     80: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.75      rillig     81: </dl></dd>
1.267     rillig     82: <dt><span class="chapter"><a href="#using">5. Using pkgsrc</a></span></dt>
1.75      rillig     83: <dd><dl>
1.267     rillig     84: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.75      rillig     85: <dd><dl>
1.267     rillig     86: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
                     87: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
                     88: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.3. Deinstalling packages</a></span></dt>
                     89: <dt><span class="sect2"><a href="#using.pkg_info">5.1.4. Getting information about installed packages</a></span></dt>
                     90: <dt><span class="sect2"><a href="#vulnerabilities">5.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                     91: <dt><span class="sect2"><a href="#pkg_versions">5.1.6. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
                     92: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.7. Other administrative functions</a></span></dt>
1.75      rillig     93: </dl></dd>
1.267     rillig     94: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1.75      rillig     95: <dd><dl>
1.267     rillig     96: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
                     97: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
                     98: <dt><span class="sect2"><a href="#how-to-build-and-install">5.2.3. How to build and install</a></span></dt>
1.75      rillig     99: </dl></dd>
                    100: </dl></dd>
1.267     rillig    101: <dt><span class="chapter"><a href="#configuring">6. Configuring pkgsrc</a></span></dt>
1.75      rillig    102: <dd><dl>
1.267     rillig    103: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
                    104: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
                    105: <dt><span class="sect1"><a href="#variables-affecting-installation">6.3. Variables affecting the installation process</a></span></dt>
                    106: <dt><span class="sect1"><a href="#conf.compiler">6.4. Selecting and configuring the compiler</a></span></dt>
1.88      wiz       107: <dd><dl>
1.267     rillig    108: <dt><span class="sect2"><a href="#selecting-the-compiler">6.4.1. Selecting the compiler</a></span></dt>
                    109: <dt><span class="sect2"><a href="#conf.cflags">6.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                    110: <dt><span class="sect2"><a href="#conf.ldflags">6.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.88      wiz       111: </dl></dd>
1.267     rillig    112: <dt><span class="sect1"><a href="#developer-advanced-settings">6.5. Developer/advanced settings</a></span></dt>
                    113: <dt><span class="sect1"><a href="#selecting-build-options">6.6. Selecting Build Options</a></span></dt>
1.75      rillig    114: </dl></dd>
1.267     rillig    115: <dt><span class="chapter"><a href="#binary">7. Creating binary packages</a></span></dt>
1.75      rillig    116: <dd><dl>
1.267     rillig    117: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
                    118: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">7.2. Settings for creation of binary packages</a></span></dt>
1.106     rillig    119: </dl></dd>
1.267     rillig    120: <dt><span class="chapter"><a href="#bulk">8. Creating binary packages for everything in pkgsrc (bulk
1.106     rillig    121: builds)</a></span></dt>
1.75      rillig    122: <dd><dl>
1.267     rillig    123: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
                    124: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a pbulk-style bulk build</a></span></dt>
                    125: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
                    126: <dt><span class="sect1"><a href="#bulk.req">8.3. Requirements of a full bulk build</a></span></dt>
                    127: <dt><span class="sect1"><a href="#creating-cdroms">8.4. Creating a multiple CD-ROM packages collection</a></span></dt>
                    128: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.4.1. Example of cdpack</a></span></dt></dl></dd>
                    129: </dl></dd>
                    130: <dt><span class="chapter"><a href="#files">9. Directory layout of the installed files</a></span></dt>
                    131: <dd><dl>
                    132: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
                    133: <dt><span class="sect1"><a href="#files.varbase">9.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
                    134: </dl></dd>
                    135: <dt><span class="chapter"><a href="#faq">10. Frequently Asked Questions</a></span></dt>
                    136: <dd><dl>
                    137: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                    138: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
                    139: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
                    140: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
                    141: <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>
                    142: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
                    143: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
                    144: <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>
                    145: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
                    146: <dt><span class="sect1"><a href="#tmac.andoc-missing">10.10. What does <span class="quote">&#8220;<span class="quote">Don't know how to make
1.128     wiz       147: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</a></span></dt>
1.267     rillig    148: <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>
                    149: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' with pkgsrc</a></span></dt>
                    150: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
                    151: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
                    152: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
                    153: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build.  What shall I do?</a></span></dt>
                    154: <dt><span class="sect1"><a href="#faq.rcs-conflicts">10.17. What does <span class="quote">&#8220;<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>&#8221;</span> mean?</a></span></dt>
1.75      rillig    155: </dl></dd>
                    156: </dl></dd>
                    157: <dt><span class="part"><a href="#developers-guide">II. The pkgsrc developer's guide</a></span></dt>
                    158: <dd><dl>
1.267     rillig    159: <dt><span class="chapter"><a href="#help-devel">11. Getting help</a></span></dt>
                    160: <dt><span class="chapter"><a href="#creating">12. Creating a new pkgsrc package from scratch</a></span></dt>
1.91      rillig    161: <dd><dl>
1.267     rillig    162: <dt><span class="sect1"><a href="#creating.common">12.1. Common types of packages</a></span></dt>
1.91      rillig    163: <dd><dl>
1.267     rillig    164: <dt><span class="sect2"><a href="#creating.perl-module">12.1.1. Perl modules</a></span></dt>
                    165: <dt><span class="sect2"><a href="#creating.python-module">12.1.2. Python modules and programs</a></span></dt>
1.275     brook     166: <dt><span class="sect2"><a href="#creating.R-package">12.1.3. R packages</a></span></dt>
                    167: <dt><span class="sect2"><a href="#creating.TeX-package">12.1.4. TeXlive packages</a></span></dt>
1.91      rillig    168: </dl></dd>
1.267     rillig    169: <dt><span class="sect1"><a href="#creating.examples">12.2. Examples</a></span></dt>
                    170: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">12.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
1.106     rillig    171: </dl></dd>
1.267     rillig    172: <dt><span class="chapter"><a href="#components">13. Package components - files, directories and contents</a></span></dt>
1.106     rillig    173: <dd><dl>
1.267     rillig    174: <dt><span class="sect1"><a href="#components.Makefile">13.1. <code class="filename">Makefile</code></a></span></dt>
                    175: <dt><span class="sect1"><a href="#components.distinfo">13.2. <code class="filename">distinfo</code></a></span></dt>
                    176: <dt><span class="sect1"><a href="#components.patches">13.3. <code class="filename">patches/*</code></a></span></dt>
1.106     rillig    177: <dd><dl>
1.267     rillig    178: <dt><span class="sect2"><a href="#components.patch.structure">13.3.1. Structure of a single patch file</a></span></dt>
                    179: <dt><span class="sect2"><a href="#components.patches.caveats">13.3.2. Creating patch files</a></span></dt>
                    180: <dt><span class="sect2"><a href="#components.patches.sources">13.3.3. Sources where the patch files come from</a></span></dt>
                    181: <dt><span class="sect2"><a href="#components.patches.guidelines">13.3.4. Patching guidelines</a></span></dt>
                    182: <dt><span class="sect2"><a href="#components.patches.feedback">13.3.5. Feedback to the author</a></span></dt>
1.106     rillig    183: </dl></dd>
1.267     rillig    184: <dt><span class="sect1"><a href="#other-mandatory-files">13.4. Other mandatory files</a></span></dt>
                    185: <dt><span class="sect1"><a href="#components.optional">13.5. Optional files</a></span></dt>
1.106     rillig    186: <dd><dl>
1.267     rillig    187: <dt><span class="sect2"><a href="#components.optional.bin">13.5.1. Files affecting the binary package</a></span></dt>
                    188: <dt><span class="sect2"><a href="#components.optional.build">13.5.2. Files affecting the build process</a></span></dt>
                    189: <dt><span class="sect2"><a href="#components.optional.none">13.5.3. Files affecting nothing at all</a></span></dt>
1.106     rillig    190: </dl></dd>
1.267     rillig    191: <dt><span class="sect1"><a href="#work-dir">13.6. <code class="filename">work*</code></a></span></dt>
                    192: <dt><span class="sect1"><a href="#files-dir">13.7. <code class="filename">files/*</code></a></span></dt>
1.106     rillig    193: </dl></dd>
1.267     rillig    194: <dt><span class="chapter"><a href="#makefile">14. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.106     rillig    195: <dd><dl>
1.267     rillig    196: <dt><span class="sect1"><a href="#makefile.style">14.1. Caveats</a></span></dt>
                    197: <dt><span class="sect1"><a href="#makefile.variables">14.2. <code class="filename">Makefile</code> variables</a></span></dt>
                    198: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">14.2.1. Naming conventions</a></span></dt></dl></dd>
                    199: <dt><span class="sect1"><a href="#makefile.code">14.3. Code snippets</a></span></dt>
1.106     rillig    200: <dd><dl>
1.267     rillig    201: <dt><span class="sect2"><a href="#adding-to-list">14.3.1. Adding things to a list</a></span></dt>
                    202: <dt><span class="sect2"><a href="#echo-literal">14.3.2. Echoing a string exactly as-is</a></span></dt>
                    203: <dt><span class="sect2"><a href="#cflags-gnu-configure">14.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</a></span></dt>
                    204: <dt><span class="sect2"><a href="#empty-variables">14.3.4. Handling possibly empty variables</a></span></dt>
1.106     rillig    205: </dl></dd>
                    206: </dl></dd>
1.267     rillig    207: <dt><span class="chapter"><a href="#plist">15. PLIST issues</a></span></dt>
1.106     rillig    208: <dd><dl>
1.267     rillig    209: <dt><span class="sect1"><a href="#rcs-id">15.1. RCS ID</a></span></dt>
                    210: <dt><span class="sect1"><a href="#automatic-plist-generation">15.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                    211: <dt><span class="sect1"><a href="#print-PLIST">15.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
                    212: <dt><span class="sect1"><a href="#plist.misc">15.4. Variable substitution in PLIST</a></span></dt>
                    213: <dt><span class="sect1"><a href="#manpage-compression">15.5. Man page compression</a></span></dt>
                    214: <dt><span class="sect1"><a href="#using-PLIST_SRC">15.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
                    215: <dt><span class="sect1"><a href="#platform-specific-plist">15.7. Platform-specific and differing PLISTs</a></span></dt>
                    216: <dt><span class="sect1"><a href="#build-plist">15.8. Build-specific PLISTs</a></span></dt>
                    217: <dt><span class="sect1"><a href="#faq.common-dirs">15.9. Sharing directories between packages</a></span></dt>
1.106     rillig    218: </dl></dd>
1.267     rillig    219: <dt><span class="chapter"><a href="#buildlink">16. Buildlink methodology</a></span></dt>
1.106     rillig    220: <dd><dl>
1.267     rillig    221: <dt><span class="sect1"><a href="#converting-to-buildlink3">16.1. Converting packages to use buildlink3</a></span></dt>
                    222: <dt><span class="sect1"><a href="#creating-buildlink3.mk">16.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106     rillig    223: <dd><dl>
1.267     rillig    224: <dt><span class="sect2"><a href="#anatomy-of-bl3">16.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
                    225: <dt><span class="sect2"><a href="#updating-buildlink-depends">16.2.2. Updating
1.133     wiz       226:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                    227:       and
                    228:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                    229:       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106     rillig    230: </dl></dd>
1.267     rillig    231: <dt><span class="sect1"><a href="#writing-builtin.mk">16.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.106     rillig    232: <dd><dl>
1.267     rillig    233: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">16.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
                    234: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">16.3.2. Global preferences for native or pkgsrc software</a></span></dt>
1.106     rillig    235: </dl></dd>
                    236: </dl></dd>
1.267     rillig    237: <dt><span class="chapter"><a href="#pkginstall">17. The pkginstall framework</a></span></dt>
1.106     rillig    238: <dd><dl>
1.267     rillig    239: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">17.1. Files and directories outside the installation prefix</a></span></dt>
                    240: <dd><dl>
                    241: <dt><span class="sect2"><a href="#dirs-outside-prefix">17.1.1. Directory manipulation</a></span></dt>
                    242: <dt><span class="sect2"><a href="#files-outside-prefix">17.1.2. File manipulation</a></span></dt>
                    243: </dl></dd>
                    244: <dt><span class="sect1"><a href="#conf-files">17.2. Configuration files</a></span></dt>
                    245: <dd><dl>
                    246: <dt><span class="sect2"><a href="#conf-files-sysconfdir">17.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
                    247: <dt><span class="sect2"><a href="#conf-files-configure">17.2.2. Telling the software where configuration files are</a></span></dt>
                    248: <dt><span class="sect2"><a href="#conf-files-patching">17.2.3. Patching installations</a></span></dt>
                    249: <dt><span class="sect2"><a href="#conf-files-disable">17.2.4. Disabling handling of configuration files</a></span></dt>
                    250: </dl></dd>
                    251: <dt><span class="sect1"><a href="#rcd-scripts">17.3. System startup scripts</a></span></dt>
                    252: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">17.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
                    253: <dt><span class="sect1"><a href="#users-and-groups">17.4. System users and groups</a></span></dt>
                    254: <dt><span class="sect1"><a href="#shells">17.5. System shells</a></span></dt>
                    255: <dd><dl><dt><span class="sect2"><a href="#shells-disable">17.5.1. Disabling shell registration</a></span></dt></dl></dd>
                    256: <dt><span class="sect1"><a href="#fonts">17.6. Fonts</a></span></dt>
                    257: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">17.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
                    258: </dl></dd>
                    259: <dt><span class="chapter"><a href="#options">18. Options handling</a></span></dt>
                    260: <dd><dl>
                    261: <dt><span class="sect1"><a href="#global-default-options">18.1. Global default options</a></span></dt>
                    262: <dt><span class="sect1"><a href="#converting-to-options">18.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
                    263: <dt><span class="sect1"><a href="#option-names">18.3. Option Names</a></span></dt>
                    264: <dt><span class="sect1"><a href="#option-build">18.4. Determining the options of dependencies</a></span></dt>
                    265: </dl></dd>
                    266: <dt><span class="chapter"><a href="#build">19. The build process</a></span></dt>
                    267: <dd><dl>
                    268: <dt><span class="sect1"><a href="#build.intro">19.1. Introduction</a></span></dt>
                    269: <dt><span class="sect1"><a href="#build.prefix">19.2. Program location</a></span></dt>
                    270: <dt><span class="sect1"><a href="#build.builddirs">19.3. Directories used during the build process</a></span></dt>
                    271: <dt><span class="sect1"><a href="#build.running">19.4. Running a phase</a></span></dt>
                    272: <dt><span class="sect1"><a href="#build.fetch">19.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                    273: <dd><dl>
                    274: <dt><span class="sect2"><a href="#build.fetch.what">19.5.1. What to fetch and where to get it from</a></span></dt>
                    275: <dt><span class="sect2"><a href="#build.fetch.how">19.5.2. How are the files fetched?</a></span></dt>
                    276: </dl></dd>
                    277: <dt><span class="sect1"><a href="#build.checksum">19.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                    278: <dt><span class="sect1"><a href="#build.extract">19.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                    279: <dt><span class="sect1"><a href="#build.patch">19.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                    280: <dt><span class="sect1"><a href="#build.tools">19.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                    281: <dt><span class="sect1"><a href="#build.wrapper">19.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                    282: <dt><span class="sect1"><a href="#build.configure">19.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                    283: <dt><span class="sect1"><a href="#build.build">19.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                    284: <dt><span class="sect1"><a href="#build.test">19.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                    285: <dt><span class="sect1"><a href="#build.install">19.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                    286: <dt><span class="sect1"><a href="#build.package">19.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
                    287: <dt><span class="sect1"><a href="#build.clean">19.16. Cleaning up</a></span></dt>
                    288: <dt><span class="sect1"><a href="#build.helpful-targets">19.17. Other helpful targets</a></span></dt>
                    289: </dl></dd>
                    290: <dt><span class="chapter"><a href="#tools">20. Tools needed for building or running</a></span></dt>
                    291: <dd><dl>
                    292: <dt><span class="sect1"><a href="#pkgsrc-tools">20.1. Tools for pkgsrc builds</a></span></dt>
                    293: <dt><span class="sect1"><a href="#package-tools">20.2. Tools needed by packages</a></span></dt>
                    294: <dt><span class="sect1"><a href="#platform-tools">20.3. Tools provided by platforms</a></span></dt>
                    295: </dl></dd>
                    296: <dt><span class="chapter"><a href="#fixes">21. Making your package work</a></span></dt>
                    297: <dd><dl>
                    298: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
                    299: <dd><dl>
                    300: <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>
                    301: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
                    302: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
                    303: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
                    304: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
                    305: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
                    306: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
                    307: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
                    308: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
                    309: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
                    310: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                    311: </dl></dd>
                    312: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                    313: <dd><dl>
                    314: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                    315: <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>
                    316: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
                    317: </dl></dd>
                    318: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                    319: <dd><dl>
                    320: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
                    321: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                    322: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
                    323: </dl></dd>
                    324: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
                    325: <dd><dl>
                    326: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
                    327: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
                    328: <dt><span class="sect2"><a href="#perl-scripts">21.4.3. Packages containing perl scripts</a></span></dt>
                    329: <dt><span class="sect2"><a href="#shell-scripts">21.4.4. Packages containing shell scripts</a></span></dt>
                    330: <dt><span class="sect2"><a href="#other-programming-languages">21.4.5. Other programming languages</a></span></dt>
                    331: </dl></dd>
                    332: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                    333: <dd><dl>
                    334: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
                    335: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.287     rillig    336: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
                    337: <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>
                    338: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.267     rillig    339: </dl></dd>
                    340: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                    341: <dd><dl>
                    342: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
                    343: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
                    344: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
                    345: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
                    346: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
                    347: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing perl modules</a></span></dt>
                    348: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
                    349: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
                    350: <dt><span class="sect2"><a href="#gconf-data-files">21.6.9. Packages installing GConf data files</a></span></dt>
                    351: <dt><span class="sect2"><a href="#scrollkeeper-data-files">21.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
                    352: <dt><span class="sect2"><a href="#x11-fonts">21.6.11. Packages installing X11 fonts</a></span></dt>
                    353: <dt><span class="sect2"><a href="#gtk2-modules">21.6.12. Packages installing GTK2 modules</a></span></dt>
                    354: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.13. Packages installing SGML or XML data</a></span></dt>
                    355: <dt><span class="sect2"><a href="#mime-database">21.6.14. Packages installing extensions to the MIME database</a></span></dt>
                    356: <dt><span class="sect2"><a href="#intltool">21.6.15. Packages using intltool</a></span></dt>
                    357: <dt><span class="sect2"><a href="#startup-scripts">21.6.16. Packages installing startup scripts</a></span></dt>
                    358: <dt><span class="sect2"><a href="#tex-packages">21.6.17. Packages installing TeX modules</a></span></dt>
                    359: <dt><span class="sect2"><a href="#emulation-packages">21.6.18. Packages supporting running binaries in
1.87      wiz       360:     emulation</a></span></dt>
1.267     rillig    361: <dt><span class="sect2"><a href="#hicolor-theme">21.6.19. Packages installing hicolor theme icons</a></span></dt>
                    362: <dt><span class="sect2"><a href="#desktop-files">21.6.20. Packages installing desktop files</a></span></dt>
1.77      rillig    363: </dl></dd>
1.267     rillig    364: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.77      rillig    365: </dl></dd>
1.267     rillig    366: <dt><span class="chapter"><a href="#debug">22. Debugging</a></span></dt>
                    367: <dt><span class="chapter"><a href="#submit">23. Submitting and Committing</a></span></dt>
1.77      rillig    368: <dd><dl>
1.267     rillig    369: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
                    370: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                    371: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
                    372: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
                    373: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
                    374: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
                    375: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
                    376: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
                    377: </dl></dd>
                    378: <dt><span class="chapter"><a href="#devfaq">24. Frequently Asked Questions</a></span></dt>
                    379: <dt><span class="chapter"><a href="#gnome">25. GNOME packaging and porting</a></span></dt>
                    380: <dd><dl>
                    381: <dt><span class="sect1"><a href="#meta-packages">25.1. Meta packages</a></span></dt>
                    382: <dt><span class="sect1"><a href="#new-package">25.2. Packaging a GNOME application</a></span></dt>
                    383: <dt><span class="sect1"><a href="#full-update">25.3. Updating GNOME to a newer version</a></span></dt>
                    384: <dt><span class="sect1"><a href="#patching">25.4. Patching guidelines</a></span></dt>
1.85      jmmv      385: </dl></dd>
1.75      rillig    386: </dl></dd>
                    387: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
                    388: <dd><dl>
1.267     rillig    389: <dt><span class="chapter"><a href="#infr.design">26. Design of the pkgsrc infrastructure</a></span></dt>
1.75      rillig    390: <dd><dl>
1.267     rillig    391: <dt><span class="sect1"><a href="#infr.vardef">26.1. The meaning of variable definitions</a></span></dt>
                    392: <dt><span class="sect1"><a href="#infr.vardef.problems">26.2. Avoiding problems before they arise</a></span></dt>
                    393: <dt><span class="sect1"><a href="#infr.var">26.3. Variable evaluation</a></span></dt>
1.81      rillig    394: <dd><dl>
1.267     rillig    395: <dt><span class="sect2"><a href="#infr.var.load">26.3.1. At load time</a></span></dt>
                    396: <dt><span class="sect2"><a href="#infr.var.run">26.3.2. At runtime</a></span></dt>
1.81      rillig    397: </dl></dd>
1.267     rillig    398: <dt><span class="sect1"><a href="#infr.varspec">26.4. How can variables be specified?</a></span></dt>
                    399: <dt><span class="sect1"><a href="#infr.design.intf">26.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig    400: <dd><dl>
1.267     rillig    401: <dt><span class="sect2"><a href="#infr.design.intf.proc">26.5.1. Procedures with parameters</a></span></dt>
                    402: <dt><span class="sect2"><a href="#infr.design.intf.action">26.5.2. Actions taken on behalf of parameters</a></span></dt>
1.75      rillig    403: </dl></dd>
1.267     rillig    404: <dt><span class="sect1"><a href="#infr.order">26.6. The order in which files are loaded</a></span></dt>
1.75      rillig    405: <dd><dl>
1.267     rillig    406: <dt><span class="sect2"><a href="#infr.order.prefs">26.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
                    407: <dt><span class="sect2"><a href="#infr.order.pkg">26.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.75      rillig    408: </dl></dd>
                    409: </dl></dd>
1.267     rillig    410: <dt><span class="chapter"><a href="#regression">27. Regression tests</a></span></dt>
1.75      rillig    411: <dd><dl>
1.267     rillig    412: <dt><span class="sect1"><a href="#regression.run">27.1. Running the regression tests</a></span></dt>
                    413: <dt><span class="sect1"><a href="#regression.new">27.2. Adding a new regression test</a></span></dt>
1.75      rillig    414: <dd><dl>
1.267     rillig    415: <dt><span class="sect2"><a href="#regression.fun.override">27.2.1. Overridable functions</a></span></dt>
                    416: <dt><span class="sect2"><a href="#regression.fun.helper">27.2.2. Helper functions</a></span></dt>
1.75      rillig    417: </dl></dd>
                    418: </dl></dd>
1.267     rillig    419: <dt><span class="chapter"><a href="#porting">28. Porting pkgsrc</a></span></dt>
                    420: <dd><dl><dt><span class="sect1"><a href="#porting.opsys">28.1. Porting pkgsrc to a new operating system</a></span></dt></dl></dd>
1.75      rillig    421: </dl></dd>
                    422: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
                    423: <dd><dl>
                    424: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
                    425: <dd><dl>
                    426: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
                    427: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
                    428: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.287     rillig    429: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with pkglint</a></span></dt>
1.75      rillig    430: </dl></dd>
                    431: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
                    432: </dl></dd>
                    433: <dt><span class="appendix"><a href="#logs">B. Build logs</a></span></dt>
                    434: <dd><dl>
                    435: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
                    436: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
                    437: </dl></dd>
1.76      rillig    438: <dt><span class="appendix"><a href="#ftp-layout">C. Directory layout of the pkgsrc FTP server</a></span></dt>
                    439: <dd><dl>
1.128     wiz       440: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
                    441: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
                    442: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
                    443: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
                    444: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
1.261     leot      445: <code class="filename">stable</code>,
1.128     wiz       446: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76      rillig    447: source packages</a></span></dt>
                    448: </dl></dd>
1.267     rillig    449: <dt><span class="appendix"><a href="#help-topics">D. Help topics</a></span></dt>
                    450: <dt><span class="appendix"><a href="#editing">E. Editing guidelines for the pkgsrc guide</a></span></dt>
1.75      rillig    451: <dd><dl>
1.267     rillig    452: <dt><span class="sect1"><a href="#targets">E.1. Make targets</a></span></dt>
                    453: <dt><span class="sect1"><a href="#procedure">E.2. Procedure</a></span></dt>
1.75      rillig    454: </dl></dd>
                    455: </dl>
                    456: </div>
1.82      rillig    457: <div class="list-of-tables">
                    458: <p><b>List of Tables</b></p>
                    459: <dl>
                    460: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
                    461: </dt>
1.267     rillig    462: <dt>13.1. <a href="#patch-examples">Patching examples</a>
1.85      jmmv      463: </dt>
1.267     rillig    464: <dt>25.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.85      jmmv      465: </dt>
1.82      rillig    466: </dl>
                    467: </div>
1.148     asau      468: <div class="chapter">
                    469: <div class="titlepage"><div><div><h1 class="title">
                    470: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h1></div></div></div>
1.75      rillig    471: <div class="toc">
                    472: <p><b>Table of Contents</b></p>
1.210     leot      473: <dl class="toc">
1.75      rillig    474: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
1.82      rillig    475: <dd><dl>
                    476: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
                    477: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
                    478: </dl></dd>
1.75      rillig    479: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
                    480: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
1.88      wiz       481: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
1.75      rillig    482: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
                    483: </dl>
                    484: </div>
1.148     asau      485: <div class="sect1">
1.75      rillig    486: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    487: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
1.82      rillig    488: <p>There is a lot of software freely available for Unix-based
                    489: systems, which is usually available in form of the source code. Before
                    490: such software can be used, it needs to be configured to the local
                    491: system, compiled and installed, and this is exactly what The NetBSD
                    492: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
                    493: to handle binary packages, so that not every user has to build the
                    494: packages for himself, which is a time-costly task.</p>
1.75      rillig    495: <p>pkgsrc currently contains several thousand packages,
                    496:       including:</p>
1.148     asau      497: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.250     leot      498: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache24/README.html" target="_top"><code class="filename">www/apache24</code></a> - The Apache
1.75      rillig    499:          web server</p></li>
1.250     leot      500: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a> - The Firefox
1.75      rillig    501:          web browser</p></li>
1.250     leot      502: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome/README.html" target="_top"><code class="filename">meta-pkgs/gnome</code></a> - The GNOME
1.75      rillig    503:          Desktop Environment</p></li>
1.250     leot      504: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde4/README.html" target="_top"><code class="filename">meta-pkgs/kde4</code></a> - The K
1.75      rillig    505:          Desktop Environment</p></li>
                    506: </ul></div>
1.219     rillig    507: <p>&#8230; just to name a few.</p>
1.75      rillig    508: <p>pkgsrc has built-in support for handling varying dependencies,
                    509:       such as pthreads and X11, and extended features such as IPv6 support on
                    510:       a range of platforms.</p>
1.148     asau      511: <div class="sect2">
1.82      rillig    512: <div class="titlepage"><div><div><h3 class="title">
                    513: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
                    514: <p>
                    515: pkgsrc provides the following key features:
                    516: </p>
1.148     asau      517: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz       518: <li class="listitem"><p>Easy building of software from source as well as the creation
1.82      rillig    519:   and installation of binary packages. The source and latest
                    520:   patches are retrieved from a master or mirror download site, checksum
                    521:   verified, then built on your system. Support for binary-only
                    522:   distributions is available for both native platforms and NetBSD
                    523:   emulated platforms.</p></li>
1.128     wiz       524: <li class="listitem"><p>All packages are installed in a consistent directory tree,
1.82      rillig    525:   including binaries, libraries, man pages and other
                    526:   documentation.</p></li>
1.214     sevan     527: <li class="listitem"><p>Tracking of package dependencies automatically, including when
                    528:   performing updates, to ensure required packages are installed. The
                    529:   configuration files of various packages are handled automatically during
                    530:   updates, so local changes are preserved.</p></li>
1.128     wiz       531: <li class="listitem"><p>Like NetBSD, pkgsrc is designed with portability in mind and
1.82      rillig    532:   consists of highly portable code. This allows the greatest speed of
1.132     spz       533:   development when porting to a new platform. This portability also
1.82      rillig    534:   ensures that pkgsrc is <span class="emphasis"><em>consistent across all
                    535:   platforms</em></span>.</p></li>
1.128     wiz       536: <li class="listitem"><p>The installation prefix, acceptable software licenses,
1.82      rillig    537:   international encryption requirements and build-time options for a
                    538:   large number of packages are all set in a simple, central
                    539:   configuration file.</p></li>
1.128     wiz       540: <li class="listitem"><p>The entire source (not including the distribution files) is
1.82      rillig    541:   freely available under a BSD license, so you may extend and adapt
                    542:   pkgsrc to your needs. Support for local packages and patches is
                    543:   available right out of the box, so you can configure it specifically
                    544:   for your environment.</p></li>
                    545: </ul></div>
1.91      rillig    546: <p>The following principles are basic to pkgsrc:</p>
1.148     asau      547: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz       548: <li class="listitem"><p><span class="quote">&#8220;<span class="quote">It should only work if it's right.</span>&#8221;</span>
1.126     jakllsch  549: &mdash; That means, if a package contains bugs, it's better to find
1.91      rillig    550: them and to complain about them rather than to just install the package
                    551: and hope that it works. There are numerous checks in pkgsrc that try to
1.290     gutterid  552: find such bugs: static analysis tools (<a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>), build-time checks (portability
1.91      rillig    553: of shell scripts), and post-installation checks (installed files,
                    554: references to shared libraries, script interpreters).</p></li>
1.128     wiz       555: <li class="listitem"><p><span class="quote">&#8220;<span class="quote">If it works, it should work everywhere</span>&#8221;</span>
1.126     jakllsch  556: &mdash; Like NetBSD has been ported to many hardware architectures,
1.91      rillig    557: pkgsrc has been ported to many operating systems. Care is taken that
                    558: packages behave the same on all platforms.</p></li>
                    559: </ul></div>
1.82      rillig    560: </div>
1.148     asau      561: <div class="sect2">
1.82      rillig    562: <div class="titlepage"><div><div><h3 class="title">
                    563: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
                    564: <p>pkgsrc consists of both a source distribution and a binary
                    565: distribution for these operating systems. After retrieving the required
                    566: source or binaries, you can be up and running with pkgsrc in just
                    567: minutes!</p>
1.75      rillig    568: <p>pkgsrc was derived from FreeBSD's ports system, and
                    569:       initially developed for NetBSD only. Since then, pkgsrc has
                    570:       grown a lot, and now supports the following platforms:</p>
1.82      rillig    571: <div class="table">
                    572: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.216     tnn       573: <div class="table-contents"><table class="table" summary="Platforms supported by pkgsrc" border="1">
1.82      rillig    574: <colgroup>
                    575: <col>
                    576: <col>
1.202     sevan     577: <col>
1.82      rillig    578: </colgroup>
                    579: <thead><tr>
                    580: <th>Platform</th>
                    581: <th>Date Support Added</th>
1.202     sevan     582: <th>Notes</th>
1.82      rillig    583: </tr></thead>
                    584: <tbody>
                    585: <tr>
1.289     leot      586: <td><a class="ulink" href="https://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.82      rillig    587: <td align="center">Aug 1997</td>
1.202     sevan     588: <td class="auto-generated"> </td>
1.82      rillig    589: </tr>
                    590: <tr>
1.110     hubertf   591: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.82      rillig    592: <td align="center">Mar 1999</td>
1.264     sevan     593: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Solaris" target="_top">README.Solaris</a></td>
1.82      rillig    594: </tr>
                    595: <tr>
1.289     leot      596: <td><a class="ulink" href="https://www.kernel.org/" target="_top">Linux</a></td>
1.82      rillig    597: <td align="center">Jun 1999</td>
1.264     sevan     598: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Linux" target="_top">README.Linux</a></td>
1.82      rillig    599: </tr>
                    600: <tr>
                    601: <td>
1.230     sevan     602:           <a class="ulink" href="https://developer.apple.com/macos/" target="_top">Darwin / Mac OS X / OS X / macOS</a>
1.82      rillig    603:         </td>
                    604: <td align="center">Oct 2001</td>
1.264     sevan     605: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.MacOSX" target="_top">README.MacOSX</a></td>
1.82      rillig    606: </tr>
                    607: <tr>
1.289     leot      608: <td><a class="ulink" href="https://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.82      rillig    609: <td align="center">Nov 2002</td>
1.264     sevan     610: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.FreeBSD" target="_top">README.FreeBSD</a></td>
1.82      rillig    611: </tr>
                    612: <tr>
1.289     leot      613: <td><a class="ulink" href="https://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.82      rillig    614: <td align="center">Nov 2002</td>
1.264     sevan     615: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.OpenBSD" target="_top">README.OpenBSD</a></td>
1.82      rillig    616: </tr>
                    617: <tr>
1.289     leot      618: <td><a class="ulink" href="https://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.82      rillig    619: <td align="center">Dec 2002</td>
1.202     sevan     620: <td>
1.264     sevan     621:        <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.IRIX" target="_top">README.IRIX</a>
                    622:        <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.IRIX5.3" target="_top">README.IRIX5.3</a>
1.202     sevan     623:        </td>
1.82      rillig    624: </tr>
                    625: <tr>
                    626: <td>BSD/OS</td>
                    627: <td align="center">Dec 2003</td>
1.202     sevan     628: <td class="auto-generated"> </td>
1.82      rillig    629: </tr>
                    630: <tr>
1.289     leot      631: <td><a class="ulink" href="https://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.82      rillig    632: <td align="center">Dec 2003</td>
1.264     sevan     633: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.AIX" target="_top">README.AIX</a></td>
1.82      rillig    634: </tr>
                    635: <tr>
                    636: <td>
1.289     leot      637:           <a class="ulink" href="https://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.82      rillig    638:           (Microsoft Windows Services for Unix)
                    639:         </td>
                    640: <td align="center">Mar 2004</td>
1.264     sevan     641: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Interix" target="_top">README.Interix</a></td>
1.82      rillig    642: </tr>
                    643: <tr>
1.289     leot      644: <td><a class="ulink" href="https://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.82      rillig    645: <td align="center">Oct 2004</td>
1.202     sevan     646: <td class="auto-generated"> </td>
1.82      rillig    647: </tr>
                    648: <tr>
1.110     hubertf   649: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.82      rillig    650: <td align="center">Nov 2004</td>
1.264     sevan     651: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.OSF1" target="_top">README.OSF1</a></td>
1.82      rillig    652: </tr>
1.98      wiz       653: <tr>
1.289     leot      654: <td><a class="ulink" href="https://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.98      wiz       655: <td align="center">Apr 2007</td>
1.264     sevan     656: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.HPUX" target="_top">README.HPUX</a></td>
1.98      wiz       657: </tr>
1.128     wiz       658: <tr>
1.289     leot      659: <td><a class="ulink" href="https://www.haiku-os.org/" target="_top">Haiku</a></td>
1.128     wiz       660: <td align="center">Sep 2010</td>
1.264     sevan     661: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Haiku" target="_top">README.Haiku</a></td>
1.128     wiz       662: </tr>
1.151     obache    663: <tr>
1.289     leot      664: <td><a class="ulink" href="https://www.mirbsd.org/" target="_top">MirBSD</a></td>
1.163     bsiegert  665: <td align="center">Jan 2011</td>
1.202     sevan     666: <td class="auto-generated"> </td>
1.151     obache    667: </tr>
                    668: <tr>
1.289     leot      669: <td><a class="ulink" href="https://www.minix3.org/" target="_top">Minix3</a></td>
1.151     obache    670: <td align="center">Nov 2011</td>
1.264     sevan     671: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Minix3" target="_top">README.Minix3</a></td>
1.151     obache    672: </tr>
                    673: <tr>
1.289     leot      674: <td><a class="ulink" href="https://cygwin.com/" target="_top">Cygwin</a></td>
1.151     obache    675: <td align="center">Mar 2013</td>
1.264     sevan     676: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Cygwin" target="_top">README.Cygwin</a></td>
1.151     obache    677: </tr>
1.166     jnemeth   678: <tr>
1.289     leot      679: <td><a class="ulink" href="https://www.debian.org/ports/kfreebsd-gnu/" target="_top">GNU/kFreeBSD</a></td>
1.166     jnemeth   680: <td align="center">Jul 2013</td>
1.264     sevan     681: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.GNUkFreeBSD" target="_top">README.GNUkFreeBSD</a></td>
1.166     jnemeth   682: </tr>
1.214     sevan     683: <tr>
1.289     leot      684: <td><a class="ulink" href="https://www.bitrig.org/" target="_top">Bitrig</a></td>
1.214     sevan     685: <td align="center">Jun 2014</td>
1.264     sevan     686: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Bitrig" target="_top">README.Bitrig</a></td>
1.214     sevan     687: </tr>
1.82      rillig    688: </tbody>
1.91      rillig    689: </table></div>
1.82      rillig    690: </div>
1.91      rillig    691: <br class="table-break">
1.82      rillig    692: </div>
1.75      rillig    693: </div>
1.148     asau      694: <div class="sect1">
1.75      rillig    695: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    696: <a name="overview"></a>1.2. Overview</h2></div></div></div>
                    697: <p>This document is divided into three parts. The first,
1.110     hubertf   698:        <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.75      rillig    699:        describes how one can use one of the packages in the Package
                    700:        Collection, either by installing a precompiled binary package,
1.93      rillig    701:        or by building one's own copy using the NetBSD package system.
1.110     hubertf   702:        The second part, <a class="link" href="#developers-guide" title="Part II. The pkgsrc developer's guide">The pkgsrc developer's guide</a>, explains how to prepare a
1.75      rillig    703:        package so it can be easily built by other NetBSD users without
                    704:        knowing about the package's building details. The third part,
1.110     hubertf   705:        <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.75      rillig    706:        is intended for those who want to understand how pkgsrc is
                    707:        implemented.</p>
                    708: <p>This document is available in various formats:
1.110     hubertf   709:        <span class="simplelist"><a class="ulink" href="index.html" target="_top">HTML</a>, <a class="ulink" href="pkgsrc.pdf" target="_top">PDF</a>, <a class="ulink" href="pkgsrc.ps" target="_top">PS</a>, <a class="ulink" href="pkgsrc.txt" target="_top">TXT</a></span>.</p>
1.75      rillig    710: </div>
1.148     asau      711: <div class="sect1">
1.75      rillig    712: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    713: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
1.128     wiz       714: <p>There has been a lot of talk about <span class="quote">&#8220;<span class="quote">ports</span>&#8221;</span>,
                    715:       <span class="quote">&#8220;<span class="quote">packages</span>&#8221;</span>, etc. so far. Here is a description of all the
1.75      rillig    716:       terminology used within this document.</p>
1.148     asau      717: <div class="variablelist"><dl class="variablelist">
1.75      rillig    718: <dt><span class="term">Package</span></dt>
                    719: <dd><p>A set of files and building instructions
                    720:            that describe what's necessary
                    721:            to build a certain piece of software using
                    722:             pkgsrc. Packages are traditionally stored under
1.236     wiz       723:            <code class="filename">/usr/pkgsrc</code>,
                    724:            but may be stored in any location,
                    725:            referred to as <code class="varname">PKGSRCDIR</code>.</p></dd>
1.75      rillig    726: <dt><span class="term">The NetBSD package system</span></dt>
1.128     wiz       727: <dd><p>This is the former name of <span class="quote">&#8220;<span class="quote">pkgsrc</span>&#8221;</span>.  It
1.87      wiz       728:          is part of the NetBSD operating system and can be bootstrapped
                    729:          to run on non-NetBSD operating systems as well.  It handles
                    730:          building (compiling), installing, and removing of
                    731:          packages.</p></dd>
1.75      rillig    732: <dt><span class="term">Distfile</span></dt>
                    733: <dd><p>This term describes the file or files that are
                    734:            provided by the author of the piece of software to
                    735:            distribute his work. All the changes necessary to build on
                    736:            NetBSD are reflected in the corresponding package. Usually
                    737:            the distfile is in the form of a compressed tar-archive,
                    738:            but other types are possible, too. Distfiles are usually
                    739:            stored below
1.76      rillig    740:            <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
1.75      rillig    741: <dt><span class="term">Port</span></dt>
                    742: <dd><p>This is the term used by FreeBSD and OpenBSD people
                    743:            for what we call a package.
1.128     wiz       744:            In NetBSD terminology, <span class="quote">&#8220;<span class="quote">port</span>&#8221;</span> refers to a different
1.75      rillig    745:            architecture.</p></dd>
                    746: <dt><span class="term">Precompiled/binary package</span></dt>
                    747: <dd>
                    748: <p>A set of binaries built with pkgsrc from a distfile
1.76      rillig    749:            and stuffed together in a single <code class="filename">.tgz</code>
1.75      rillig    750:            file so it can be installed on machines of the same
                    751:            machine architecture without the need to
                    752:            recompile. Packages are usually generated in
1.76      rillig    753:            <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.132     spz       754:            an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.128     wiz       755: <p>Sometimes, this is referred to by the term <span class="quote">&#8220;<span class="quote">package</span>&#8221;</span> too,
1.75      rillig    756:            especially in the context of precompiled packages.</p>
                    757: </dd>
                    758: <dt><span class="term">Program</span></dt>
1.88      wiz       759: <dd><p>The piece of software to be installed which will be
                    760:          constructed from all the files in the distfile by the
                    761:          actions defined in the corresponding package.</p></dd>
1.75      rillig    762: </dl></div>
1.148     asau      763: <div class="sect2">
1.75      rillig    764: <div class="titlepage"><div><div><h3 class="title">
1.88      wiz       765: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.148     asau      766: <div class="variablelist"><dl class="variablelist">
1.75      rillig    767: <dt><span class="term">pkgsrc users</span></dt>
                    768: <dd>
                    769: <p>The
                    770:        pkgsrc users are people who use the packages provided by pkgsrc.
                    771:        Typically they are system administrators. The people using the
1.128     wiz       772:        software that is inside the packages (maybe called <span class="quote">&#8220;<span class="quote">end
                    773:        users</span>&#8221;</span>) are not covered by the pkgsrc guide.</p>
1.75      rillig    774: <p>There are two kinds of pkgsrc users: Some only want to
                    775:        install pre-built binary packages. Others build the pkgsrc
                    776:        packages from source, either for installing them directly or for
1.110     hubertf   777:        building binary packages themselves. For pkgsrc users <a class="xref" href="#users-guide" title="Part I. The pkgsrc user's guide">Part I, &#8220;The pkgsrc user's guide&#8221;</a> should provide all necessary
1.75      rillig    778:        documentation.</p>
                    779: </dd>
                    780: <dt><span class="term">package maintainers</span></dt>
                    781: <dd><p>A
1.110     hubertf   782:        package maintainer creates packages as described in <a class="xref" href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, &#8220;The pkgsrc developer's guide&#8221;</a>.</p></dd>
1.75      rillig    783: <dt><span class="term">infrastructure developers</span></dt>
                    784: <dd><p>These people are involved in all those files
1.76      rillig    785:        that live in the <code class="filename">mk/</code> directory and below.
1.110     hubertf   786:        Only these people should need to read through <a class="xref" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">Part III, &#8220;The pkgsrc infrastructure internals&#8221;</a>, though others might be curious,
1.75      rillig    787:        too.</p></dd>
                    788: </dl></div>
                    789: </div>
                    790: </div>
1.148     asau      791: <div class="sect1">
1.75      rillig    792: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    793: <a name="typography"></a>1.4. Typography</h2></div></div></div>
                    794: <p>When giving examples for commands, shell prompts are used to
                    795:       show if the command should/can be issued as root, or if
1.128     wiz       796:       <span class="quote">&#8220;<span class="quote">normal</span>&#8221;</span> user privileges are sufficient. We use a
1.226     sevan     797:       <code class="prompt">#</code> for root's shell prompt, a <code class="prompt">%</code> for users'
                    798:       shell prompt, assuming they use the C-shell or tcsh and a <code class="prompt">$</code> for
                    799:       bourne shell and derivatives.</p>
1.75      rillig    800: </div>
                    801: </div>
1.148     asau      802: <div class="part">
1.75      rillig    803: <div class="titlepage"><div><div><h1 class="title">
                    804: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
                    805: <div class="toc">
                    806: <p><b>Table of Contents</b></p>
1.210     leot      807: <dl class="toc">
1.267     rillig    808: <dt><span class="chapter"><a href="#help-user">2. Getting help</a></span></dt>
                    809: <dt><span class="chapter"><a href="#getting">3. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
1.75      rillig    810: <dd><dl>
1.267     rillig    811: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.75      rillig    812: <dd><dl>
1.267     rillig    813: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
                    814: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.75      rillig    815: </dl></dd>
1.267     rillig    816: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.75      rillig    817: <dd><dl>
1.267     rillig    818: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
                    819: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.75      rillig    820: </dl></dd>
                    821: </dl></dd>
1.267     rillig    822: <dt><span class="chapter"><a href="#platforms">4. Using pkgsrc on systems other than NetBSD</a></span></dt>
1.75      rillig    823: <dd><dl>
1.267     rillig    824: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
                    825: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.75      rillig    826: </dl></dd>
1.267     rillig    827: <dt><span class="chapter"><a href="#using">5. Using pkgsrc</a></span></dt>
1.75      rillig    828: <dd><dl>
1.267     rillig    829: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.75      rillig    830: <dd><dl>
1.267     rillig    831: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
                    832: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
                    833: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.3. Deinstalling packages</a></span></dt>
                    834: <dt><span class="sect2"><a href="#using.pkg_info">5.1.4. Getting information about installed packages</a></span></dt>
                    835: <dt><span class="sect2"><a href="#vulnerabilities">5.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                    836: <dt><span class="sect2"><a href="#pkg_versions">5.1.6. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
                    837: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.7. Other administrative functions</a></span></dt>
1.75      rillig    838: </dl></dd>
1.267     rillig    839: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1.75      rillig    840: <dd><dl>
1.267     rillig    841: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
                    842: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
                    843: <dt><span class="sect2"><a href="#how-to-build-and-install">5.2.3. How to build and install</a></span></dt>
1.75      rillig    844: </dl></dd>
                    845: </dl></dd>
1.267     rillig    846: <dt><span class="chapter"><a href="#configuring">6. Configuring pkgsrc</a></span></dt>
1.75      rillig    847: <dd><dl>
1.267     rillig    848: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
                    849: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
                    850: <dt><span class="sect1"><a href="#variables-affecting-installation">6.3. Variables affecting the installation process</a></span></dt>
                    851: <dt><span class="sect1"><a href="#conf.compiler">6.4. Selecting and configuring the compiler</a></span></dt>
1.88      wiz       852: <dd><dl>
1.267     rillig    853: <dt><span class="sect2"><a href="#selecting-the-compiler">6.4.1. Selecting the compiler</a></span></dt>
                    854: <dt><span class="sect2"><a href="#conf.cflags">6.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                    855: <dt><span class="sect2"><a href="#conf.ldflags">6.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.88      wiz       856: </dl></dd>
1.267     rillig    857: <dt><span class="sect1"><a href="#developer-advanced-settings">6.5. Developer/advanced settings</a></span></dt>
                    858: <dt><span class="sect1"><a href="#selecting-build-options">6.6. Selecting Build Options</a></span></dt>
1.75      rillig    859: </dl></dd>
1.267     rillig    860: <dt><span class="chapter"><a href="#binary">7. Creating binary packages</a></span></dt>
1.75      rillig    861: <dd><dl>
1.267     rillig    862: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
                    863: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">7.2. Settings for creation of binary packages</a></span></dt>
1.106     rillig    864: </dl></dd>
1.267     rillig    865: <dt><span class="chapter"><a href="#bulk">8. Creating binary packages for everything in pkgsrc (bulk
1.106     rillig    866: builds)</a></span></dt>
1.75      rillig    867: <dd><dl>
1.267     rillig    868: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
                    869: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a pbulk-style bulk build</a></span></dt>
                    870: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
                    871: <dt><span class="sect1"><a href="#bulk.req">8.3. Requirements of a full bulk build</a></span></dt>
                    872: <dt><span class="sect1"><a href="#creating-cdroms">8.4. Creating a multiple CD-ROM packages collection</a></span></dt>
                    873: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.4.1. Example of cdpack</a></span></dt></dl></dd>
                    874: </dl></dd>
                    875: <dt><span class="chapter"><a href="#files">9. Directory layout of the installed files</a></span></dt>
                    876: <dd><dl>
                    877: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
                    878: <dt><span class="sect1"><a href="#files.varbase">9.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
                    879: </dl></dd>
                    880: <dt><span class="chapter"><a href="#faq">10. Frequently Asked Questions</a></span></dt>
                    881: <dd><dl>
                    882: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                    883: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
                    884: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
                    885: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
                    886: <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>
                    887: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
                    888: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
                    889: <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>
                    890: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
                    891: <dt><span class="sect1"><a href="#tmac.andoc-missing">10.10. What does <span class="quote">&#8220;<span class="quote">Don't know how to make
1.128     wiz       892: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</a></span></dt>
1.267     rillig    893: <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>
                    894: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' with pkgsrc</a></span></dt>
                    895: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
                    896: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
                    897: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
                    898: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build.  What shall I do?</a></span></dt>
                    899: <dt><span class="sect1"><a href="#faq.rcs-conflicts">10.17. What does <span class="quote">&#8220;<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>&#8221;</span> mean?</a></span></dt>
1.75      rillig    900: </dl></dd>
                    901: </dl>
                    902: </div>
1.148     asau      903: <div class="chapter">
1.75      rillig    904: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig    905: <a name="help-user"></a>Chapter 2. Getting help</h2></div></div></div>
                    906: <p>
                    907:        To get help when using pkgsrc, the definitive source is this
                    908:        document, the pkgsrc guide. If you don't find anything here,
                    909:        there are alternatives:
                    910: </p>
                    911: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                    912: <li class="listitem">
                    913: <p>
                    914:        The built-in pkgsrc help, which is available after bootstrapping
                    915:        pkgsrc. Run <span class="command"><strong>bmake help topic=&#8230;</strong></span> to get
                    916:        help for any topic, such as a variable name like
                    917:        <code class="varname">BUILD_DEFS</code>, a make target like
                    918:        <span class="command"><strong>do-build</strong></span>, a missing C or C++ function like
                    919:        <span class="command"><strong>strcasecmp</strong></span> or any other topic.</p>
                    920: <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>
                    921: </li>
                    922: <li class="listitem"><p>
1.278     rillig    923:        To see the value of a single variable, run <span class="command"><strong>bmake
                    924:        show-var VARNAME=<em class="replaceable"><code>X</code></em></strong></span>.
                    925: </p></li>
                    926: <li class="listitem"><p>
                    927:        To see the values of the most common variables, run
                    928:        <span class="command"><strong>bmake show-all</strong></span>. These variables are grouped by
                    929:        topic. To see the variables for a single topic, run
                    930:        <span class="command"><strong>bmake
                    931:        show-all-<em class="replaceable"><code>topic</code></em></strong></span>, for example
                    932:        <span class="command"><strong>bmake show-all-fetch</strong></span>.
                    933: </p></li>
                    934: <li class="listitem"><p>
1.267     rillig    935:        The pkgsrc-users mailing list, to which
                    936:        <a class="ulink" href="https://www.NetBSD.org/mailinglists/#pkgsrc-users" target="_top">you
                    937:        can subscribe</a> and then <a class="ulink" href="mailto:pkgsrc-users@NetBSD.org" target="_top">ask your
                    938:        questions</a>.</p></li>
                    939: <li class="listitem"><p>The #pkgsrc IRC channel, which is accessible
                    940:        <a class="ulink" href="https://webchat.freenode.net/" target="_top">via a web browser</a>
                    941:        or by using a specialized chat program such as
                    942:        <a class="ulink" href="http://xchat.org/" target="_top">XChat</a>.
                    943:        Pick any user name and join the channel #pkgsrc.</p></li>
                    944: </ul></div>
                    945: </div>
                    946: <div class="chapter">
                    947: <div class="titlepage"><div><div><h2 class="title">
                    948: <a name="getting"></a>Chapter 3. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
1.75      rillig    949: <div class="toc">
                    950: <p><b>Table of Contents</b></p>
1.210     leot      951: <dl class="toc">
1.267     rillig    952: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.75      rillig    953: <dd><dl>
1.267     rillig    954: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
                    955: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.75      rillig    956: </dl></dd>
1.267     rillig    957: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.75      rillig    958: <dd><dl>
1.267     rillig    959: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
                    960: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.75      rillig    961: </dl></dd>
                    962: </dl>
                    963: </div>
1.91      rillig    964: <p>Before you download and extract the files, you need to decide
                    965: where you want to extract them. When using pkgsrc as root user, pkgsrc
                    966: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
                    967: free to install the sources and binary packages wherever you want in
                    968: your filesystem, provided that the pathname does not contain white-space
                    969: or other characters that are interpreted specially by the shell and some
                    970: other programs. A safe bet is to use only letters, digits, underscores
                    971: and dashes.</p>
1.148     asau      972: <div class="sect1">
1.75      rillig    973: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig    974: <a name="getting-first"></a>3.1. Getting pkgsrc for the first time</h2></div></div></div>
1.75      rillig    975: <p>Before you download any pkgsrc files, you should decide
                    976:        whether you want the <span class="emphasis"><em>current</em></span> branch or the
                    977:        <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
                    978:        quarterly basis from the current branch and only gets modified
                    979:        for security updates. The names of the stable branches are built
                    980:        from the year and the quarter, for example
1.289     leot      981:        <code class="literal">2020Q1</code>.</p>
1.75      rillig    982: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
1.128     wiz       983:        want to download pkgsrc. You can get it as a tar file or via CVS.
                    984:        Both ways are described here.</p>
1.157     asau      985: <p>Note that tar archive contains CVS working copy.
                    986:        Thus you can switch to using CVS at any later time.</p>
1.148     asau      987: <div class="sect2">
1.75      rillig    988: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig    989: <a name="getting-via-tar"></a>3.1.1. As tar archive</h3></div></div></div>
1.75      rillig    990: <p>The primary download location for all pkgsrc files is
1.264     sevan     991:        <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/" target="_top">https://cdn.NetBSD.org/pub/pkgsrc/</a> or
1.157     asau      992:        <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>
                    993:        (it points to the same location).
                    994:        There are a number of subdirectories for different purposes,
                    995:        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>
                    996: <p>The tar archive for the current branch is in the directory
1.264     sevan     997:        <code class="filename">current</code> and is called <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.
1.230     sevan     998:        It is autogenerated weekly.</p>
1.157     asau      999: <p>To save download time we provide bzip2- and
                   1000:        xz-compressed archives which are published at
1.264     sevan    1001:        <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.bz2" target="_top"><code class="filename">pkgsrc.tar.bz2</code></a>
1.157     asau     1002:        and
1.264     sevan    1003:        <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.xz" target="_top"><code class="filename">pkgsrc.tar.xz</code></a>
1.157     asau     1004:        respectively.
                   1005:        </p>
                   1006: <p>You can fetch the same files using FTP.</p>
1.289     leot     1007: <p>The tar file for the stable branch 2020Q1 is in the
                   1008:        directory <code class="filename">pkgsrc-2020Q1</code> and is also called <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/pkgsrc-2020Q1/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.</p>
1.249     leot     1009: <p>To download the latest pkgsrc stable tarball, run:</p>
1.112     weinem   1010: <pre class="screen">
1.289     leot     1011: <code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2020Q1/pkgsrc.tar.gz</code></strong></pre>
1.188     snj      1012: <p>If you prefer, you can also fetch it using "wget", "curl",
1.157     asau     1013:        or your web browser.</p>
1.112     weinem   1014: <p>Then, extract it with:</p>
1.188     snj      1015: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf pkgsrc.tar.gz -C /usr</code></strong></pre>
1.112     weinem   1016: <p>This will create the directory <code class="filename">pkgsrc/</code>
                   1017:        in <code class="filename">/usr/</code> and all the package source will be 
                   1018:        stored under <code class="filename">/usr/pkgsrc/</code>.</p>
                   1019: <p>To download pkgsrc-current, run:</p>
                   1020: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz</code></strong></pre>
1.75      rillig   1021: </div>
1.148     asau     1022: <div class="sect2">
1.75      rillig   1023: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1024: <a name="getting-via-cvs"></a>3.1.2. Via anonymous CVS</h3></div></div></div>
1.128     wiz      1025: <p>To fetch a specific pkgsrc stable branch, run:</p>
1.289     leot     1026: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr &amp;&amp; cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -r pkgsrc-2020Q1 -P pkgsrc</code></strong>
1.128     wiz      1027: </pre>
                   1028: <p>This will create the directory <code class="filename">pkgsrc/</code> 
                   1029:        in your <code class="filename">/usr/</code> directory and all the package source 
                   1030:        will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
                   1031: <p>To fetch the pkgsrc current branch, run:</p>
1.146     wiz      1032: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr &amp;&amp; cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.1       grant    1033: </pre>
1.289     leot     1034: <p>Refer to the <a class="ulink" href="https://www.NetBSD.org/mirrors/#anoncvs" target="_top">list of available mirrors</a> to choose a faster CVS mirror, if needed.</p>
1.128     wiz      1035: <p>If you get error messages from <code class="literal">rsh</code>, you need to set CVS_RSH variable. E.g.:</p>
1.146     wiz      1036: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr &amp;&amp; env CVS_RSH=ssh cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.128     wiz      1037: </pre>
                   1038: <p>Refer to documentation on your command shell how to set CVS_RSH=ssh permanently.
                   1039:        For Bourne shells, you can set it in your <code class="filename">.profile</code>
                   1040:        or better globally in <code class="filename">/etc/profile</code>:</p>
                   1041: <pre class="programlisting">
                   1042: # set CVS remote shell command
                   1043: CVS_RSH=ssh
                   1044: export CVS_RSH
                   1045: </pre>
                   1046: <p>By default, CVS doesn't do things like most people would expect it to do.
                   1047:        But there is a way to convince CVS, by creating a file called <code class="filename">.cvsrc</code>
                   1048:        in your home directory and saving the following lines to it.
                   1049:        This file will save you lots of headache and some bug reports, so we strongly recommend it.
                   1050:        You can find an explanation of this file in the CVS documentation.</p>
1.101     rillig   1051: <pre class="programlisting">
                   1052: # recommended CVS configuration file from the pkgsrc guide
1.268     sevan    1053: cvs -q
1.101     rillig   1054: checkout -P
1.103     wiz      1055: update -dP
                   1056: diff -upN
1.101     rillig   1057: rdiff -u
1.128     wiz      1058: release -d
1.101     rillig   1059: </pre>
1.75      rillig   1060: </div>
                   1061: </div>
1.148     asau     1062: <div class="sect1">
1.75      rillig   1063: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1064: <a name="uptodate"></a>3.2. Keeping pkgsrc up-to-date</h2></div></div></div>
1.75      rillig   1065: <p>The preferred way to keep pkgsrc up-to-date is via CVS
                   1066:        (which also works if you have first installed it via a tar
                   1067:        file). It saves bandwidth and hard disk activity, compared to
                   1068:        downloading the tar file again.</p>
1.148     asau     1069: <div class="sect2">
1.75      rillig   1070: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1071: <a name="uptodate-tar"></a>3.2.1. Via tar files</h3></div></div></div>
1.148     asau     1072: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   1073: <h3 class="title">Warning</h3>
1.77      rillig   1074: <p>When updating from a tar file, you first need to
                   1075:        completely remove the old pkgsrc directory. Otherwise those
                   1076:        files that have been removed from pkgsrc in the mean time will
                   1077:        not be removed on your local disk, resulting in inconsistencies.
                   1078:        When removing the old files, any changes that you have done to
                   1079:        the pkgsrc files will be lost after updating. Therefore updating
                   1080:        via CVS is strongly recommended.</p>
1.75      rillig   1081: </div>
1.82      rillig   1082: <p>Note that by default the distfiles and the binary packages
                   1083:        are saved in the pkgsrc tree, so don't forget to rescue them
1.188     snj      1084:        before updating. You can also configure pkgsrc to store distfiles
                   1085:         and packages in directories outside the pkgsrc tree by setting the
1.82      rillig   1086:        <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.267     rillig   1087:        variables. See <a class="xref" href="#configuring" title="Chapter 6. Configuring pkgsrc">Chapter 6, <i>Configuring pkgsrc</i></a> for the details.</p>
1.75      rillig   1088: <p>To update pkgsrc from a tar file, download the tar file as
                   1089:        explained above. Then, make sure that you have not made any
                   1090:        changes to the files in the pkgsrc directory. Remove the pkgsrc
                   1091:        directory and extract the new tar file. Done.</p>
                   1092: </div>
1.148     asau     1093: <div class="sect2">
1.75      rillig   1094: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1095: <a name="uptodate-cvs"></a>3.2.2. Via CVS</h3></div></div></div>
1.132     spz      1096: <p>To update pkgsrc via CVS, change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
                   1097: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc &amp;&amp; cvs update -dP</code></strong>
                   1098: </pre>
                   1099: <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>
                   1100: <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>
                   1101: </pre>
1.148     asau     1102: <div class="sect3">
1.75      rillig   1103: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   1104: <a name="uptodate-cvs-switch"></a>3.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1.75      rillig   1105: <p>When updating pkgsrc, the CVS program keeps track of the
                   1106:        branch you selected. But if you, for whatever reason, want to
                   1107:        switch from the stable branch to the current one, you can do it
1.128     wiz      1108:        by adding the option <span class="quote">&#8220;<span class="quote">-A</span>&#8221;</span> after the
                   1109:        <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> keyword. To switch from the current branch
1.75      rillig   1110:        back to the stable branch, add the
1.289     leot     1111:        <span class="quote">&#8220;<span class="quote">-rpkgsrc-2020Q1</span>&#8221;</span> option.</p>
1.75      rillig   1112: </div>
1.148     asau     1113: <div class="sect3">
1.75      rillig   1114: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   1115: <a name="uptodate-cvs-changes"></a>3.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1.75      rillig   1116: <p>When you update pkgsrc, the CVS program will only touch
                   1117:        those files that are registered in the CVS repository. That
                   1118:        means that any packages that you created on your own will stay
                   1119:        unmodified. If you change files that are managed by CVS, later
                   1120:        updates will try to merge your changes with those that have been
                   1121:        done by others. See the CVS manual, chapter
1.128     wiz      1122:        <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> for details.</p>
1.75      rillig   1123: </div>
                   1124: </div>
                   1125: </div>
                   1126: </div>
1.148     asau     1127: <div class="chapter">
1.75      rillig   1128: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   1129: <a name="platforms"></a>Chapter 4. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1.75      rillig   1130: <div class="toc">
                   1131: <p><b>Table of Contents</b></p>
1.210     leot     1132: <dl class="toc">
1.267     rillig   1133: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
                   1134: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.75      rillig   1135: </dl>
                   1136: </div>
1.148     asau     1137: <div class="sect1">
1.75      rillig   1138: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1139: <a name="binarydist"></a>4.1. Binary distribution</h2></div></div></div>
                   1140: <p>See <a class="xref" href="#using-pkg" title="5.1. Using binary packages">Section 5.1, &#8220;Using binary packages&#8221;</a>.</p>
1.82      rillig   1141: </div>
1.148     asau     1142: <div class="sect1">
1.82      rillig   1143: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1144: <a name="bootstrapping-pkgsrc"></a>4.2. Bootstrapping pkgsrc</h2></div></div></div>
1.149     asau     1145: <p>pkgsrc can be bootstrapped for use in two different modes:
                   1146:     privileged and unprivileged one. In unprivileged mode in contrast
1.150     asau     1147:     to privileged one all programs are installed under one particular user
1.149     asau     1148:     and cannot utilise privileged operations (packages don't create
                   1149:     special users and all special file permissions like setuid are ignored).
                   1150:     </p>
1.82      rillig   1151: <p>Installing the bootstrap kit from source should be as simple as:</p>
1.75      rillig   1152: <pre class="screen">
1.167     asau     1153: <code class="prompt">#</code> <strong class="userinput"><code>env CVS_RSH=ssh cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.75      rillig   1154: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
1.87      wiz      1155: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
                   1156:     </pre>
1.149     asau     1157: <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>
                   1158: <p>By default, in privileged mode pkgsrc uses
                   1159:     <code class="filename">/usr/pkg</code> for <span class="emphasis"><em>prefix</em></span>
                   1160:     where programs will be installed in,
1.230     sevan    1161:     and <code class="filename">/usr/pkg/pkgdb</code> for the package database
1.149     asau     1162:     directory where pkgsrc will do its internal bookkeeping,
                   1163:     <code class="filename">/var</code> is used as <span class="emphasis"><em>varbase</em></span>,
                   1164:     where packages install their persistent data.
                   1165:     In unprivileged mode pkgsrc uses
                   1166:     <code class="filename">~/pkg</code> for <span class="emphasis"><em>prefix</em></span>,
1.230     sevan    1167:     <code class="filename">~/pkg/pkgdb</code> for the package database,
1.149     asau     1168:     and <code class="filename">~/pkg/var</code> for <span class="emphasis"><em>varbase</em></span>.
                   1169:     </p>
                   1170: <p>You can change default layout using command-line arguments.
                   1171:     Run <span class="quote">&#8220;<span class="quote">./bootstrap --help</span>&#8221;</span> to get details.
                   1172:     </p>
1.148     asau     1173: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   1174: <h3 class="title">Note</h3>
1.110     hubertf  1175: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
                   1176:       Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
                   1177:       For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.128     wiz      1178:       instead of <span class="quote">&#8220;<span class="quote">make</span>&#8221;</span>.</p>
1.75      rillig   1179: </div>
1.149     asau     1180: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1181: <h3 class="title">Note</h3>
                   1182: <p>It is possible to bootstrap multiple instances of pkgsrc
                   1183:       using non-intersecting directories. Use <span class="command"><strong>bmake</strong></span>
                   1184:       corresponding to the installation you're working with to build
                   1185:       and install packages.
                   1186:       </p>
                   1187: </div>
1.75      rillig   1188: </div>
                   1189: </div>
1.148     asau     1190: <div class="chapter">
1.75      rillig   1191: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   1192: <a name="using"></a>Chapter 5. Using pkgsrc</h2></div></div></div>
1.75      rillig   1193: <div class="toc">
                   1194: <p><b>Table of Contents</b></p>
1.210     leot     1195: <dl class="toc">
1.267     rillig   1196: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.75      rillig   1197: <dd><dl>
1.267     rillig   1198: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
                   1199: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
                   1200: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.3. Deinstalling packages</a></span></dt>
                   1201: <dt><span class="sect2"><a href="#using.pkg_info">5.1.4. Getting information about installed packages</a></span></dt>
                   1202: <dt><span class="sect2"><a href="#vulnerabilities">5.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                   1203: <dt><span class="sect2"><a href="#pkg_versions">5.1.6. Finding if newer versions of your installed packages are in pkgsrc</a></span></dt>
                   1204: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.7. Other administrative functions</a></span></dt>
                   1205: </dl></dd>
                   1206: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
                   1207: <dd><dl>
                   1208: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
                   1209: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
                   1210: <dt><span class="sect2"><a href="#how-to-build-and-install">5.2.3. How to build and install</a></span></dt>
1.75      rillig   1211: </dl></dd>
                   1212: </dl>
                   1213: </div>
                   1214: <p>Basically, there are two ways of using pkgsrc. The first
1.88      wiz      1215: is to only install the package tools and to use binary packages
1.128     wiz      1216: that someone else has prepared. This is the <span class="quote">&#8220;<span class="quote">pkg</span>&#8221;</span>
                   1217: in pkgsrc. The second way is to install the <span class="quote">&#8220;<span class="quote">src</span>&#8221;</span>
1.88      wiz      1218: of pkgsrc, too. Then you are able to build your own packages,
                   1219: and you can still use binary packages from someone else.</p>
1.148     asau     1220: <div class="sect1">
1.75      rillig   1221: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1222: <a name="using-pkg"></a>5.1. Using binary packages</h2></div></div></div>
1.264     sevan    1223: <p>On the <a class="ulink" href="https://cdn.NetBSD.org/" target="_top">cdn.NetBSD.org</a>
                   1224:   site and mirrors, there are collections of binary packages,
1.109     rillig   1225:   ready to be installed. These binary packages have been built using the
                   1226:   default settings for the directories, that is:</p>
1.148     asau     1227: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1228: <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>
                   1229: <li class="listitem"><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
                   1230: <li class="listitem"><p><code class="filename">/var</code> for <code class="varname">VARBASE</code>, where those files are installed that may change after installation.</p></li>
1.109     rillig   1231: </ul></div>
                   1232: <p>If you cannot use these directories for whatever reasons (maybe
                   1233:   because you're not root), you cannot use these binary packages, but
1.267     rillig   1234:   have to build the packages yourself, which is explained in <a class="xref" href="#bootstrapping-pkgsrc" title="4.2. Bootstrapping pkgsrc">Section 4.2, &#8220;Bootstrapping pkgsrc&#8221;</a>.</p>
1.148     asau     1235: <div class="sect2">
1.75      rillig   1236: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1237: <a name="finding-binary-packages"></a>5.1.1. Finding binary packages</h3></div></div></div>
1.105     weinem   1238: <p>To install binary packages, you first need to know from where
                   1239:     to get them. The first place where you should look is on the main
1.264     sevan    1240:     pkgsrc FTP server in the directory <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/packages/" target="_top"><code class="filename">/pub/pkgsrc/packages</code></a>.</p>
1.105     weinem   1241: <p>This directory contains binary packages for multiple
                   1242:     platforms. First, select your operating system. (Ignore the
                   1243:     directories with version numbers attached to it, they just exist for
                   1244:     legacy reasons.) Then, select your hardware architecture, and in the
1.128     wiz      1245:     third step, the OS version and the <span class="quote">&#8220;<span class="quote">version</span>&#8221;</span> of pkgsrc.</p>
1.109     rillig   1246: <p>In this directory, you often find a file called
                   1247:     <code class="filename">bootstrap.tar.gz</code> which contains the package
                   1248:     management tools. If the file is missing, it is likely that your
                   1249:     operating system already provides those tools. Download the file and
                   1250:     extract it in the <code class="filename">/</code> directory. It will create
                   1251:     the directories <code class="filename">/usr/pkg</code> (containing the tools
1.230     sevan    1252:     for managing binary packages and the database of installed packages).</p>
1.75      rillig   1253: </div>
1.148     asau     1254: <div class="sect2">
1.75      rillig   1255: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1256: <a name="installing-binary-packages"></a>5.1.2. Installing binary packages</h3></div></div></div>
1.109     rillig   1257: <p>In the directory from the last section, there is a
1.196     wiz      1258:     subdirectory called <code class="filename">All/</code>, which contains all the
1.109     rillig   1259:     binary packages that are available for the platform, excluding those
                   1260:     that may not be distributed via FTP or CDROM (depending on which
1.128     wiz      1261:     medium you are using).</p>
1.109     rillig   1262: <p>To install packages directly from an FTP or HTTP server, run
                   1263:     the following commands in a Bourne-compatible shell (be sure to
1.110     hubertf  1264:     <span class="command"><strong>su</strong></span> to root first):</p>
1.109     rillig   1265: <pre class="screen">
                   1266: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:$PATH"</code></strong>
1.289     leot     1267: <code class="prompt">#</code> <strong class="userinput"><code>PKG_PATH="https://cdn.NetBSD.org/pub/pkgsrc/packages"</code></strong>
1.284     rillig   1268: <code class="prompt">#</code> <strong class="userinput"><code>PKG_PATH="$PKG_PATH/<em class="replaceable"><code>OPSYS</code></em>/<em class="replaceable"><code>ARCH</code></em>/<em class="replaceable"><code>VERSIONS</code></em>/All/"</code></strong>
1.109     rillig   1269: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
                   1270: </pre>
                   1271: <p>Instead of URLs, you can also use local paths, for example if
                   1272:     you are installing from a set of CDROMs, DVDs or an NFS-mounted
                   1273:     repository. If you want to install packages from multiple sources,
                   1274:     you can separate them by a semicolon in
                   1275:     <code class="varname">PKG_PATH</code>.</p>
                   1276: <p>After these preparations, installing a package is very
                   1277:     easy:</p>
                   1278: <pre class="screen">
1.230     sevan    1279: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add libreoffice</code></strong>
                   1280: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add ap24-php71-*</code></strong>
1.109     rillig   1281: </pre>
1.75      rillig   1282: <p>Note that any prerequisite packages needed to run the
1.88      wiz      1283:     package in question will be installed, too, assuming they are
                   1284:     present where you install from.</p>
1.128     wiz      1285: <p>Adding packages might install vulnerable packages.
                   1286:     Thus you should run <span class="command"><strong>pkg_admin audit</strong></span>
                   1287:     regularly, especially after installing new packages, and verify
                   1288:     that the vulnerabilities are acceptable for your configuration.</p>
1.75      rillig   1289: <p>After you've installed packages, be sure to have
1.88      wiz      1290:     <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
                   1291:     <code class="varname">PATH</code> so you can actually start the just
                   1292:     installed program.</p>
1.75      rillig   1293: </div>
1.148     asau     1294: <div class="sect2">
1.75      rillig   1295: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1296: <a name="using.pkg_delete"></a>5.1.3. Deinstalling packages</h3></div></div></div>
1.82      rillig   1297: <p>To deinstall a package, it does not matter whether it was
1.88      wiz      1298:     installed from source code or from a binary package. The
1.110     hubertf  1299:     <span class="command"><strong>pkg_delete</strong></span> command does not know it anyway.
                   1300:     To delete a package, you can just run <span class="command"><strong>pkg_delete
1.88      wiz      1301:     <em class="replaceable"><code>package-name</code></em></strong></span>. The package
                   1302:     name can be given with or without version number. Wildcards can
                   1303:     also be used to deinstall a set of packages, for example
                   1304:     <code class="literal">*emacs*</code>. Be sure to include them in quotes,
                   1305:     so that the shell does not expand them before
                   1306:     <code class="literal">pkg_delete</code> sees them.</p>
1.82      rillig   1307: <p>The <code class="option">-r</code> option is very powerful: it
1.88      wiz      1308:     removes all the packages that require the package in question
                   1309:     and then removes the package itself. For example:
1.82      rillig   1310: 
1.88      wiz      1311:     </p>
1.82      rillig   1312: <pre class="screen">
1.88      wiz      1313: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
                   1314:     </pre>
1.82      rillig   1315: <p>
                   1316: 
1.88      wiz      1317:     will remove jpeg and all the packages that used it; this allows
                   1318:     upgrading the jpeg package.</p>
1.82      rillig   1319: </div>
1.148     asau     1320: <div class="sect2">
1.82      rillig   1321: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1322: <a name="using.pkg_info"></a>5.1.4. Getting information about installed packages</h3></div></div></div>
1.110     hubertf  1323: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.88      wiz      1324:     installed packages or binary package files.</p>
1.82      rillig   1325: </div>
1.148     asau     1326: <div class="sect2">
1.82      rillig   1327: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1328: <a name="vulnerabilities"></a>5.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1.82      rillig   1329: <p>
1.279     leot     1330:       The pkgsrc Security Team and Packages Groups maintain a list of
1.88      wiz      1331:       known security vulnerabilities to packages which are (or have been)
                   1332:       included in pkgsrc.  The list is available from the NetBSD
1.289     leot     1333:       FTP site at <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>.
1.88      wiz      1334:     </p>
1.82      rillig   1335: <p>
1.125     wiz      1336:       Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.88      wiz      1337:       this list can be downloaded
                   1338:       automatically, and a security audit of all packages installed on a system
                   1339:       can take place.
                   1340:     </p>
1.82      rillig   1341: <p>
1.125     wiz      1342:       There are two components to auditing.  The first
                   1343:       step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
                   1344:       is for downloading
1.88      wiz      1345:       the list of vulnerabilities from the NetBSD FTP site.  The second
1.125     wiz      1346:       step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.88      wiz      1347:       installed packages are vulnerable.  If a package is vulnerable, you
                   1348:       will see output similar to the following:
                   1349:     </p>
1.82      rillig   1350: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
1.289     leot     1351:     https://www.samba.org/samba/whatsnew/macroexploit.html</pre>
1.82      rillig   1352: <p>
1.125     wiz      1353:       You may wish to have the
1.289     leot     1354:       <a class="ulink" href="https://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.125     wiz      1355:       file downloaded daily so that
                   1356:       it remains current.  This may be done by adding an appropriate entry
1.289     leot     1357:       to the root users <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?crontab+5.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">crontab</span>(5)</span></a> entry.  For example the entry
1.125     wiz      1358:       </p>
                   1359: <pre class="screen">
1.233     sevan    1360: # Download vulnerabilities file
1.230     sevan    1361: 0 3 * * * /usr/pkg/sbin/pkg_admin fetch-pkg-vulnerabilities &gt;/dev/null 2&gt;&amp;1
1.233     sevan    1362: # Audit the installed packages and email results to root
                   1363: 9 3 * * * /usr/pkg/sbin/pkg_admin audit |mail -s "Installed package audit result" \
                   1364:            root &gt;/dev/null 2&gt;&amp;1
1.125     wiz      1365:       </pre>
                   1366: <p>
1.230     sevan    1367:       will update the vulnerability list every day at 3AM, followed by an audit
                   1368:       at 3:09AM. The result of the audit are then emailed to root.
1.125     wiz      1369: 
1.230     sevan    1370:       On NetBSD this may be accomplished instead by adding the following
                   1371:       line to <code class="filename">/etc/daily.conf</code>:
                   1372:       </p>
                   1373: <pre class="screen">
                   1374: fetch_pkg_vulnerabilities=YES
                   1375:       </pre>
                   1376: <p>
                   1377:       to fetch the vulnerability list from the daily security script. The system
                   1378:       is set to audit the packages by default but can be set explicitly, if
1.235     yyamano  1379:       desired (not required), by adding the following line to
1.230     sevan    1380: <code class="filename">/etc/security.conf</code>:
1.125     wiz      1381:       </p>
                   1382: <pre class="screen">
1.230     sevan    1383: check_pkg_vulnerabilities=YES
1.125     wiz      1384:       </pre>
                   1385: <p>
1.289     leot     1386:       see <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?daily.conf+5.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">daily.conf</span>(5)</span></a> and <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?security.conf+5.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">security.conf</span>(5)</span></a> for more details.
1.88      wiz      1387:     </p>
1.82      rillig   1388: </div>
1.148     asau     1389: <div class="sect2">
1.82      rillig   1390: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1391: <a name="pkg_versions"></a>5.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
1.82      rillig   1392: <p>
1.250     leot     1393:       Install <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/lintpkgsrc/README.html" target="_top"><code class="filename">pkgtools/lintpkgsrc</code></a> and run
1.128     wiz      1394:       <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">&#8220;<span class="quote">-i</span>&#8221;</span>
1.88      wiz      1395:       argument to check if your packages are up-to-date, e.g.
                   1396:     </p>
                   1397: <pre class="screen">
                   1398: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
1.82      rillig   1399: ...
1.88      wiz      1400: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
                   1401:     </pre>
1.110     hubertf  1402: <p>You can then use <span class="command"><strong>make update</strong></span> to update the
1.88      wiz      1403:     package on your system and rebuild any dependencies.
                   1404:     </p>
1.82      rillig   1405: </div>
1.148     asau     1406: <div class="sect2">
1.82      rillig   1407: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1408: <a name="using.pkg_admin"></a>5.1.7. Other administrative functions</h3></div></div></div>
1.110     hubertf  1409: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.88      wiz      1410:     administrative functions on the package system.</p>
1.82      rillig   1411: </div>
1.75      rillig   1412: </div>
1.148     asau     1413: <div class="sect1">
1.75      rillig   1414: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1415: <a name="building-packages-from-source"></a>5.2. Building packages from source</h2></div></div></div>
1.88      wiz      1416: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
                   1417:   directory now contains a set of packages, organized into
                   1418:   categories. You can browse the online index of packages, or run
1.110     hubertf  1419:   <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.88      wiz      1420:   directory to build local <code class="filename">README.html</code> files for
1.250     leot     1421:   all packages, viewable with any web browser such as <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/lynx/README.html" target="_top"><code class="filename">www/lynx</code></a> or <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a>.</p>
1.88      wiz      1422: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
                   1423:   is <code class="filename">/usr/pkg</code>. If you wish to change this, you
                   1424:   should do so by setting <code class="varname">LOCALBASE</code> in
1.110     hubertf  1425:   <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.88      wiz      1426:   different <code class="varname">LOCALBASE</code> definitions on the same
                   1427:   system (inside a chroot is an exception). </p>
                   1428: <p>The rest of this chapter assumes that the package is already
1.110     hubertf  1429:   in pkgsrc. If it is not, see <a class="xref" href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, &#8220;The pkgsrc developer's guide&#8221;</a> for
1.88      wiz      1430:   instructions how to create your own packages.</p>
1.148     asau     1431: <div class="sect2">
1.75      rillig   1432: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1433: <a name="requirements"></a>5.2.1. Requirements</h3></div></div></div>
1.82      rillig   1434: <p>To build packages from source, you need a working C
1.88      wiz      1435:     compiler. On NetBSD, you need to install the
1.128     wiz      1436:     <span class="quote">&#8220;<span class="quote">comp</span>&#8221;</span> and the <span class="quote">&#8220;<span class="quote">text</span>&#8221;</span> distribution
1.88      wiz      1437:     sets. If you want to build X11-related packages, the
1.128     wiz      1438:     <span class="quote">&#8220;<span class="quote">xbase</span>&#8221;</span> and <span class="quote">&#8220;<span class="quote">xcomp</span>&#8221;</span> distribution
1.88      wiz      1439:     sets are required, too.</p>
1.75      rillig   1440: </div>
1.148     asau     1441: <div class="sect2">
1.75      rillig   1442: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1443: <a name="fetching-distfiles"></a>5.2.2. Fetching distfiles</h3></div></div></div>
1.75      rillig   1444: <p>The first step for building a package is downloading the
1.88      wiz      1445:     distfiles (i.e. the unmodified source). If they have not yet been
                   1446:     downloaded, pkgsrc will fetch them automatically.</p>
                   1447: <p>If you have all files that you need in the
                   1448:     <code class="filename">distfiles</code> directory,
                   1449:     you don't need to connect. If the distfiles are on CD-ROM, you can
                   1450:     mount the CD-ROM on <code class="filename">/cdrom</code> and add:
                   1451:     </p>
1.82      rillig   1452: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
                   1453: <p>
1.110     hubertf  1454:     to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.91      rillig   1455: <p>By default a list of distribution sites will be randomly
                   1456:     intermixed to prevent huge load on servers which holding popular
                   1457:     packages (for example, SourceForge.net mirrors). Thus, every
                   1458:     time when you need to fetch yet another distfile all the mirrors
                   1459:     will be tried in new (random) order. You can turn this feature
                   1460:     off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
                   1461:     <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
1.88      wiz      1462: <p>You can overwrite some of the major distribution sites to
                   1463:     fit to sites that are close to your own.  By setting one or two
                   1464:     variables you can modify the order in which the master sites are
                   1465:     accessed.  <code class="varname">MASTER_SORT</code> contains a whitespace
                   1466:     delimited list of domain suffixes.
                   1467:     <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
                   1468:     contains a whitespace delimited list of regular expressions.  It
                   1469:     has higher priority than <code class="varname">MASTER_SORT</code>.  Have a
                   1470:     look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
                   1471:     some examples.  This may save some of your bandwidth and
                   1472:     time.</p>
1.75      rillig   1473: <p>You can change these settings either in your shell's environment, or,
1.88      wiz      1474:     if you want to keep the settings, by editing the
1.110     hubertf  1475:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.88      wiz      1476:     and adding the definitions there.</p>
1.82      rillig   1477: <p>
1.88      wiz      1478:       If a package depends on many other packages (such as
1.250     leot     1479:       <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde4/README.html" target="_top"><code class="filename">meta-pkgs/kde4</code></a>), the build process may
1.88      wiz      1480:       alternate between periods of
                   1481:       downloading source, and compiling. To ensure you have all the source
                   1482:       downloaded initially you can run the command:
                   1483:       </p>
1.82      rillig   1484: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
                   1485: <p>
1.88      wiz      1486:       which will output and run a set of shell commands to fetch the
                   1487:       necessary files into the <code class="filename">distfiles</code> directory.  You can
                   1488:       also choose to download the files manually.
                   1489:     </p>
1.75      rillig   1490: </div>
1.148     asau     1491: <div class="sect2">
1.75      rillig   1492: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1493: <a name="how-to-build-and-install"></a>5.2.3. How to build and install</h3></div></div></div>
1.82      rillig   1494: <p>
1.88      wiz      1495:       Once the software has downloaded, any patches will be applied, then it
                   1496:       will be compiled for you. This may take some time depending on your
                   1497:       computer, and how many other packages the software depends on and their
                   1498:       compile time.
                   1499:     </p>
1.148     asau     1500: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   1501: <h3 class="title">Note</h3>
                   1502: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.110     hubertf  1503:     use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.128     wiz      1504:     <span class="quote">&#8220;<span class="quote">make</span>&#8221;</span> in the examples in this guide.</p>
1.75      rillig   1505: </div>
1.87      wiz      1506: <p>For example, type</p>
1.88      wiz      1507: <pre class="screen">
                   1508: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
                   1509: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   1510:     </pre>
1.75      rillig   1511: <p>at the shell prompt to build the various components of the
1.88      wiz      1512:     package.</p>
1.82      rillig   1513: <p>The next stage is to actually install the newly compiled
1.88      wiz      1514:     program onto your system. Do this by entering:
1.82      rillig   1515: 
1.88      wiz      1516:     </p>
1.82      rillig   1517: <pre class="screen">
1.88      wiz      1518: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
                   1519:     </pre>
1.82      rillig   1520: <p>
                   1521: 
1.88      wiz      1522:     while you are still in the directory for whatever package you
                   1523:     are installing.</p>
1.82      rillig   1524: <p>Installing the package on your system may require you to
1.88      wiz      1525:     be root.  However, pkgsrc has a
                   1526:     <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
                   1527:     to only become root for the actual installation step.</p>
1.82      rillig   1528: <p>That's it, the software should now be installed and setup for use.
1.88      wiz      1529:     You can now enter:
1.82      rillig   1530: 
1.88      wiz      1531:     </p>
1.82      rillig   1532: <pre class="screen">
1.88      wiz      1533: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
                   1534:     </pre>
1.82      rillig   1535: <p>
                   1536: 
1.88      wiz      1537:     to remove the compiled files in the work directory, as you shouldn't need
                   1538:     them any more. If other packages were also added to your system
                   1539:     (dependencies) to allow your program to compile, you can tidy these up
                   1540:     also with the command:</p>
1.82      rillig   1541: <pre class="screen">
1.88      wiz      1542: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
                   1543:     </pre>
1.75      rillig   1544: <p>Taking the figlet utility as an example, we can install it on our
1.110     hubertf  1545:     system by building as shown in <a class="xref" href="#logs" title="Appendix B. Build logs">Appendix B, <i>Build logs</i></a>.</p>
1.88      wiz      1546: <p>The program is installed under the default root of the
                   1547:     packages tree - <code class="filename">/usr/pkg</code>. Should this not
                   1548:     conform to your tastes, set the <code class="varname">LOCALBASE</code>
                   1549:     variable in your environment, and it will use that value as the
                   1550:     root of your packages tree. So, to use
                   1551:     <code class="filename">/usr/local</code>, set
                   1552:     <code class="varname">LOCALBASE=/usr/local</code> in your environment.
                   1553:     Please note that you should use a directory which is dedicated to
                   1554:     packages and not shared with other programs (i.e., do not try and
                   1555:     use <code class="varname">LOCALBASE=/usr</code>).  Also, you should not try
                   1556:     to add any of your own files or directories (such as
                   1557:     <code class="filename">src/</code>, <code class="filename">obj/</code>, or
                   1558:     <code class="filename">pkgsrc/</code>) below the
                   1559:     <code class="varname">LOCALBASE</code> tree.  This is to prevent possible
                   1560:     conflicts between programs and other files installed by the
                   1561:     package system and whatever else may have been installed
                   1562:     there.</p>
1.110     hubertf  1563: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.88      wiz      1564:     alter some configuration options at build time.  Have a look at
                   1565:     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
                   1566:     of what will be set there by default.  Environment variables such
                   1567:     as <code class="varname">LOCALBASE</code> can be set in
1.110     hubertf  1568:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.88      wiz      1569:     set them each time you want to use pkgsrc.</p>
1.128     wiz      1570: <p>Occasionally, people want to <span class="quote">&#8220;<span class="quote">look under the
                   1571:     covers</span>&#8221;</span> to see what is going on when a package is building
1.88      wiz      1572:     or being installed. This may be for debugging purposes, or out of
                   1573:     simple curiosity. A number of utility values have been added to
                   1574:     help with this.</p>
1.128     wiz      1575: <div class="orderedlist"><ol class="orderedlist" type="1">
                   1576: <li class="listitem">
1.289     leot     1577: <p>If you invoke the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> command with
1.88      wiz      1578:        <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
                   1579:        information will be displayed. For example,</p>
1.75      rillig   1580: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
1.88      wiz      1581: <p>will show all the commands that are invoked, up to and
1.128     wiz      1582:        including the <span class="quote">&#8220;<span class="quote">patch</span>&#8221;</span> stage.</p>
1.75      rillig   1583: </li>
1.128     wiz      1584: <li class="listitem">
1.289     leot     1585: <p>If you want to know the value of a certain <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88      wiz      1586:        definition, then the <code class="varname">VARNAME</code> definition
                   1587:        should be used, in conjunction with the show-var
1.289     leot     1588:        target. e.g. to show the expansion of the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.88      wiz      1589:        variable <code class="varname">LOCALBASE</code>:</p>
                   1590: <pre class="screen">
                   1591: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
1.75      rillig   1592: /usr/pkg
                   1593: <code class="prompt">%</code>
1.88      wiz      1594:        </pre>
1.75      rillig   1595: </li>
                   1596: </ol></div>
                   1597: <p>If you want to install a binary package that you've either
1.88      wiz      1598:     created yourself (see next section), that you put into
                   1599:     pkgsrc/packages manually or that is located on a remote FTP
                   1600:     server, you can use the "bin-install" target. This target will
1.289     leot     1601:     install a binary package - if available - via <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>,
1.110     hubertf  1602:     else do a <span class="command"><strong>make package</strong></span>.  The list of remote FTP
1.88      wiz      1603:     sites searched is kept in the variable
                   1604:     <code class="varname">BINPKG_SITES</code>, which defaults to
1.289     leot     1605:     ftp.NetBSD.org. Any flags that should be added to <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>
1.88      wiz      1606:     can be put into <code class="varname">BIN_INSTALL_FLAGS</code>.  See
                   1607:     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
                   1608:     details.</p>
                   1609: <p>A final word of warning: If you set up a system that has a
                   1610:     non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
                   1611:     set that before any packages are installed, as you cannot use
                   1612:     several directories for the same purpose. Doing so will result in
                   1613:     pkgsrc not being able to properly detect your installed packages,
                   1614:     and fail miserably. Note also that precompiled binary packages are
                   1615:     usually built with the default <code class="varname">LOCALBASE</code> of
                   1616:     <code class="filename">/usr/pkg</code>, and that you should
                   1617:     <span class="emphasis"><em>not</em></span> install any if you use a non-standard
                   1618:     <code class="varname">LOCALBASE</code>.</p>
1.75      rillig   1619: </div>
                   1620: </div>
                   1621: </div>
1.148     asau     1622: <div class="chapter">
1.75      rillig   1623: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   1624: <a name="configuring"></a>Chapter 6. Configuring pkgsrc</h2></div></div></div>
1.75      rillig   1625: <div class="toc">
                   1626: <p><b>Table of Contents</b></p>
1.210     leot     1627: <dl class="toc">
1.267     rillig   1628: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
                   1629: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
                   1630: <dt><span class="sect1"><a href="#variables-affecting-installation">6.3. Variables affecting the installation process</a></span></dt>
                   1631: <dt><span class="sect1"><a href="#conf.compiler">6.4. Selecting and configuring the compiler</a></span></dt>
                   1632: <dd><dl>
                   1633: <dt><span class="sect2"><a href="#selecting-the-compiler">6.4.1. Selecting the compiler</a></span></dt>
                   1634: <dt><span class="sect2"><a href="#conf.cflags">6.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                   1635: <dt><span class="sect2"><a href="#conf.ldflags">6.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.88      wiz      1636: </dl></dd>
1.267     rillig   1637: <dt><span class="sect1"><a href="#developer-advanced-settings">6.5. Developer/advanced settings</a></span></dt>
                   1638: <dt><span class="sect1"><a href="#selecting-build-options">6.6. Selecting Build Options</a></span></dt>
1.75      rillig   1639: </dl>
                   1640: </div>
1.104     rillig   1641: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.89      rillig   1642: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
                   1643: that file depends on the installation. On NetBSD, when you use
1.289     leot     1644: <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> from the base system, it is in the directory
1.89      rillig   1645: <code class="filename">/etc/</code>. In all other cases the default location is
                   1646: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
                   1647: bootstrap program to install the binary packages.</p>
                   1648: <p>The format of the configuration file is that of the usual
                   1649: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
                   1650: is done by setting variables in this file. Note that you can define all
                   1651: kinds of variables, and no special error checking (for example for
1.223     rillig   1652: spelling mistakes) takes place.</p>
1.148     asau     1653: <div class="sect1">
1.75      rillig   1654: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1655: <a name="general-configuration"></a>6.1. General configuration</h2></div></div></div>
1.223     rillig   1656: <p>The following variables apply to all
1.89      rillig   1657:     pkgsrc packages. A complete list of the variables that can be
                   1658:     configured by the user is available in
                   1659:     <code class="filename">mk/defaults/mk.conf</code>, together with some
                   1660:     comments that describe each variable's intent.</p>
1.148     asau     1661: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1662: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.75      rillig   1663:            packages will be installed. The default is
1.76      rillig   1664:            <code class="filename">/usr/pkg</code>. Do not mix binary packages
1.75      rillig   1665:            with different <code class="varname">LOCALBASE</code>s!</p></li>
1.128     wiz      1666: <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
                   1667:            <span class="quote">&#8220;<span class="quote">cross</span>&#8221;</span> category packages will be
1.75      rillig   1668:            installed. The default is
1.76      rillig   1669:            <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.128     wiz      1670: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.75      rillig   1671:            X11 is installed on the system. The default is
1.194     bsiegert 1672:            <code class="filename">/usr/X11R7</code>.</p></li>
1.128     wiz      1673: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.75      rillig   1674:            downloaded copies of the original source distributions used
                   1675:            for building pkgsrc packages. The default is
1.76      rillig   1676:            <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.128     wiz      1677: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.97      rillig   1678:            database about installed packages is stored.  The default is
1.230     sevan    1679:            <code class="filename">/usr/pkg/pkgdb</code>.</p></li>
1.128     wiz      1680: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.75      rillig   1681:            If set, override the packages'
                   1682:            <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.128     wiz      1683: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.75      rillig   1684:            Backup location(s) for distribution files and patch files
                   1685:            if not found locally or in
1.76      rillig   1686:            <code class="filename">${MASTER_SITES}</code> or
                   1687:            <code class="filename">${PATCH_SITES}</code> respectively.
1.230     sevan    1688:            The defaults is
                   1689:            <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.128     wiz      1690: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.93      rillig   1691:            List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
                   1692:            <em class="replaceable"><code>arch</code></em> are replaced with OS
1.128     wiz      1693:            release (<span class="quote">&#8220;<span class="quote">2.0</span>&#8221;</span>, etc.) and architecture
                   1694:            (<span class="quote">&#8220;<span class="quote">mipsel</span>&#8221;</span>, etc.).</p></li>
                   1695: <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.125     wiz      1696:            List of acceptable licenses. License names are case-sensitive.
                   1697:            Whenever you try to build a package whose license is not in this
                   1698:            list, you will get an error message. If the license condition is
                   1699:            simple enough, the error message will include specific
                   1700:            instructions on how to change this variable.</p></li>
1.75      rillig   1701: </ul></div>
                   1702: </div>
1.148     asau     1703: <div class="sect1">
1.75      rillig   1704: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1705: <a name="variables-affecting-build"></a>6.2. Variables affecting the build process</h2></div></div></div>
1.219     rillig   1706: <p>
1.75      rillig   1707:       </p>
1.148     asau     1708: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1709: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.75      rillig   1710:            directory for the binary packages. The default is
1.76      rillig   1711:            <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.128     wiz      1712: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.75      rillig   1713:            The top level directory where, if defined, the separate
                   1714:            working directories will get created, and symbolically
1.76      rillig   1715:            linked to from <code class="filename">${WRKDIR}</code> (see below).
1.75      rillig   1716:            This is useful for building packages on several
1.76      rillig   1717:            architectures, then <code class="filename">${PKGSRCDIR}</code>
                   1718:            can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
1.75      rillig   1719:            is local to every architecture. (It should be noted that
                   1720:            <code class="varname">PKGSRCDIR</code> should not be set by the user
1.126     jakllsch 1721:            &mdash; it is an internal definition which refers to the
1.75      rillig   1722:            root of the pkgsrc tree. It is possible to have many
                   1723:            pkgsrc tree instances.)</p></li>
1.128     wiz      1724: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.75      rillig   1725:            Directory for local patches that aren't part of pkgsrc.
1.267     rillig   1726:            See <a class="xref" href="#components.patches" title="13.3. patches/*">Section 13.3, &#8220;<code class="filename">patches/*</code>&#8221;</a> for more
1.93      rillig   1727:            information.</p></li>
1.128     wiz      1728: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.110     hubertf  1729:            the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.75      rillig   1730:            BSD-style Makefile. If this is not set,
                   1731:            <code class="varname">MAKECONF</code> is set to
1.76      rillig   1732:            <code class="filename">/dev/null</code> to avoid picking up
                   1733:            settings used by builds in <code class="filename">/usr/src</code>.</p></li>
1.75      rillig   1734: </ul></div>
                   1735: </div>
1.148     asau     1736: <div class="sect1">
1.75      rillig   1737: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1738: <a name="variables-affecting-installation"></a>6.3. Variables affecting the installation process</h2></div></div></div>
1.256     maya     1739: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><code class="varname">PKGSRC_KEEP_BIN_PKGSRC</code>:
                   1740:                 By default, binary packages of built packages are
1.263     leot     1741:                 preserved in <code class="filename">${PACKAGES}/All</code>. Setting
1.256     maya     1742:                this variable to "no" prevents this.</p></li></ul></div>
1.217     jnemeth  1743: <p>Packages have to support installation into a
1.103     wiz      1744:     subdirectory of <code class="varname">WRKDIR</code>. This allows a package
                   1745:     to be built, before the actual filesystem is touched. DESTDIR
                   1746:     support exists in two variations:</p>
1.148     asau     1747: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1748: <li class="listitem"><p>Basic DESTDIR support means that the package
1.131     wiz      1749:       installation and packaging is still run as root.</p></li>
                   1750: <li class="listitem"><p>Full DESTDIR support can run the complete
                   1751:       build, installation and packaging as normal user. Root
                   1752:       privileges are only needed to add packages.</p></li>
                   1753: </ul></div>
1.103     wiz      1754: <p>With basic DESTDIR support, <strong class="userinput"><code>make
                   1755:     clean</code></strong> needs to be run as root.</p>
1.118     imil     1756: <p>Considering the <code class="filename">foo/bar</code> package,
                   1757:     DESTDIR full support can be tested using the following commands
                   1758: 
                   1759: </p>
                   1760: <pre class="programlisting">
                   1761: <code class="prompt">$</code> id
                   1762: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
                   1763: <code class="prompt">$</code> mkdir $HOME/packages
                   1764: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
                   1765: </pre>
                   1766: <p>
                   1767: 
                   1768:     Verify <code class="varname">DESTDIR</code> full support, no root privileges
                   1769:     should be needed
                   1770: 
                   1771: </p>
                   1772: <pre class="programlisting">
1.174     asau     1773: <code class="prompt">$</code> make stage-install
1.118     imil     1774: </pre>
                   1775: <p>
                   1776: 
                   1777:     Create a package without root privileges
                   1778: 
                   1779: </p>
                   1780: <pre class="programlisting">
1.174     asau     1781: <code class="prompt">$</code> make PACKAGES=$HOME/packages package
1.118     imil     1782: </pre>
                   1783: <p>
                   1784: 
                   1785:     For the following command, you must be able to gain root
1.289     leot     1786:     privileges using <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?su+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a>
1.118     imil     1787: 
                   1788: </p>
                   1789: <pre class="programlisting">
1.174     asau     1790: <code class="prompt">$</code> make PACKAGES=$HOME/packages install
1.118     imil     1791: </pre>
                   1792: <p>
                   1793: 
                   1794:     Then, as a simple user
                   1795: 
                   1796: </p>
                   1797: <pre class="programlisting">
                   1798: <code class="prompt">$</code> make clean
                   1799: </pre>
                   1800: <p>
                   1801: 
                   1802:     </p>
1.103     wiz      1803: </div>
1.148     asau     1804: <div class="sect1">
1.103     wiz      1805: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1806: <a name="conf.compiler"></a>6.4. Selecting and configuring the compiler</h2></div></div></div>
1.148     asau     1807: <div class="sect2">
1.78      rillig   1808: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1809: <a name="selecting-the-compiler"></a>6.4.1. Selecting the compiler</h3></div></div></div>
1.89      rillig   1810: <p>By default, pkgsrc will use GCC to build packages.  This may be
                   1811:     overridden by setting the following variables in /etc/mk.conf:</p>
1.148     asau     1812: <div class="variablelist"><dl class="variablelist">
1.89      rillig   1813: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
                   1814: <dd>
                   1815: <p>This is a list of values specifying the chain of
                   1816:          compilers to invoke when building packages.  Valid values
                   1817:          are:</p>
1.148     asau     1818: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.174     asau     1819: <li class="listitem"><p><code class="varname">ccc</code>:
                   1820:            Compaq C Compilers (Tru64)</p></li>
                   1821: <li class="listitem"><p><code class="varname">ccache</code>:
                   1822:            compiler cache (chainable)</p></li>
                   1823: <li class="listitem"><p><code class="varname">clang</code>:
                   1824:            Clang C and Objective-C compiler</p></li>
1.128     wiz      1825: <li class="listitem"><p><code class="varname">distcc</code>:
1.89      rillig   1826:            distributed C/C++ (chainable)</p></li>
1.174     asau     1827: <li class="listitem"><p><code class="varname">f2c</code>:
                   1828:            Fortran 77 to C compiler (chainable)</p></li>
                   1829: <li class="listitem"><p><code class="varname">icc</code>:
                   1830:            Intel C++ Compiler (Linux)</p></li>
                   1831: <li class="listitem"><p><code class="varname">ido</code>:
                   1832:            SGI IRIS Development Option cc (IRIX 5)</p></li>
1.128     wiz      1833: <li class="listitem"><p><code class="varname">gcc</code>:
1.89      rillig   1834:            GNU C/C++ Compiler</p></li>
1.174     asau     1835: <li class="listitem"><p><code class="varname">hp</code>:
                   1836:            HP-UX C/aC++ compilers</p></li>
1.128     wiz      1837: <li class="listitem"><p><code class="varname">mipspro</code>:
1.89      rillig   1838:            Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.174     asau     1839: <li class="listitem"><p><code class="varname">mipspro-ucode</code>:
1.89      rillig   1840:            Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.128     wiz      1841: <li class="listitem"><p><code class="varname">sunpro</code>:
1.89      rillig   1842:            Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
1.174     asau     1843: <li class="listitem"><p><code class="varname">xlc</code>:
1.230     sevan    1844:            IBM's XL C/C++ compiler suite</p></li>
1.89      rillig   1845: </ul></div>
                   1846: <p>The default is
1.128     wiz      1847:          <span class="quote">&#8220;<span class="quote"><code class="varname">gcc</code></span>&#8221;</span>.  You can use
1.89      rillig   1848:          <code class="varname">ccache</code> and/or
                   1849:          <code class="varname">distcc</code> with an appropriate
                   1850:          <code class="varname">PKGSRC_COMPILER</code> setting,
1.128     wiz      1851:          e.g. <span class="quote">&#8220;<span class="quote"><code class="varname">ccache gcc</code></span>&#8221;</span>.  This
1.94      dmcmahil 1852:          variable should always be terminated with a value for
                   1853:          a real compiler.  Note that only one real compiler
1.128     wiz      1854:          should be listed (e.g. <span class="quote">&#8220;<span class="quote"><code class="varname">sunpro gcc</code></span>&#8221;</span>
1.94      dmcmahil 1855:          is not allowed).</p>
1.89      rillig   1856: </dd>
                   1857: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
                   1858: <dd><p>This specifies the minimum version of GCC to use
                   1859:          when building packages.  If the system GCC doesn't
                   1860:          satisfy this requirement, then pkgsrc will build and
                   1861:          install one of the GCC packages to use instead.</p></dd>
1.266     leot     1862: <dt><span class="term"><code class="varname">PYTHON_VERSION_DEFAULT</code>:</span></dt>
1.225     maya     1863: <dd><p>Specifies which version of python to use when several
                   1864:          options are available.</p></dd>
                   1865: <dt><span class="term"><code class="varname">PKGSRC_FORTRAN</code>:</span></dt>
1.291     gutterid 1866: <dd><p>Specifies the Fortran compiler to use.
                   1867:          The default is <code class="varname">gfortran</code>.</p></dd>
1.225     maya     1868: <dt><span class="term"><code class="varname">GFORTRAN_VERSION</code>:</span></dt>
                   1869: <dd><p>If <code class="varname">PKGSRC_FORTRAN</code><code class="literal">=</code>
                   1870:          <code class="varname">gfortran</code> is used, this option specifies which
                   1871:          version to use.</p></dd>
1.89      rillig   1872: </dl></div>
                   1873: </div>
1.148     asau     1874: <div class="sect2">
1.89      rillig   1875: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1876: <a name="conf.cflags"></a>6.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</h3></div></div></div>
1.78      rillig   1877: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
                   1878:        please make sure to use the <code class="literal">+=</code> operator
                   1879:        instead of the <code class="literal">=</code> operator:</p>
                   1880: <pre class="programlisting">
1.100     rillig   1881: CFLAGS+=        -your -flags
1.78      rillig   1882: </pre>
                   1883: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.128     wiz      1884:        <span class="quote">&#8220;<span class="quote">+</span>&#8221;</span>) may lead to problems with packages that
1.117     jnemeth  1885:        need to add their own flags.  You may want to take a look
1.250     leot     1886:        at the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/README.html" target="_top"><code class="filename">devel/cpuflags</code></a>
1.128     wiz      1887:        package if you're interested in optimization specifically
                   1888:        for the current CPU. </p>
1.78      rillig   1889: </div>
1.148     asau     1890: <div class="sect2">
1.88      wiz      1891: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   1892: <a name="conf.ldflags"></a>6.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</h3></div></div></div>
1.88      wiz      1893: <p>If you want to pass flags to the linker, both in the configure
                   1894: step and the build step, you can do this in two ways.  Either set
                   1895: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>.  The difference
                   1896: between the two is that <code class="varname">LIBS</code> will be appended to
                   1897: the command line, while <code class="varname">LDFLAGS</code> come earlier.
                   1898: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
                   1899: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
                   1900: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>.  As with
                   1901: <code class="varname">CFLAGS</code>, if you do not wish to override these
                   1902: settings, use the <code class="literal">+=</code> operator:</p>
                   1903: <pre class="programlisting">
1.100     rillig   1904: LDFLAGS+=        -your -linkerflags
1.88      wiz      1905: </pre>
                   1906: </div>
1.78      rillig   1907: </div>
1.148     asau     1908: <div class="sect1">
1.78      rillig   1909: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1910: <a name="developer-advanced-settings"></a>6.5. Developer/advanced settings</h2></div></div></div>
1.194     bsiegert 1911: <p>
1.75      rillig   1912:       </p>
1.148     asau     1913: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      1914: <li class="listitem">
1.75      rillig   1915: <p><code class="varname">PKG_DEVELOPER</code>:
                   1916:            Run some sanity checks that package developers want:
                   1917:            </p>
1.148     asau     1918: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.128     wiz      1919: <li class="listitem"><p>make sure patches apply with zero
1.88      wiz      1920:              fuzz</p></li>
1.128     wiz      1921: <li class="listitem"><p>run check-shlibs to see that all
1.88      wiz      1922:              binaries will find their shared libs.</p></li>
1.75      rillig   1923: </ul></div>
                   1924: <p>
1.87      wiz      1925:        </p>
1.75      rillig   1926: </li>
1.128     wiz      1927: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.88      wiz      1928:        of debugging output which is displayed whilst making and
                   1929:        installing the package.  The default value for this is 0,
                   1930:        which will not display the commands as they are executed
                   1931:        (normal, default, quiet operation); the value 1 will display
                   1932:        all shell commands before their invocation, and the value 2
                   1933:        will display both the shell commands before their invocation,
1.223     rillig   1934:        as well as their actual execution progress with <span class="command"><strong>set
                   1935:        -x</strong></span>.</p></li>
1.75      rillig   1936: </ul></div>
                   1937: <p>
                   1938:     </p>
                   1939: </div>
1.148     asau     1940: <div class="sect1">
1.75      rillig   1941: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   1942: <a name="selecting-build-options"></a>6.6. Selecting Build Options</h2></div></div></div>
1.88      wiz      1943: <p>Some packages have build time options, usually to select
                   1944:     between different dependencies, enable optional support for big
                   1945:     dependencies or enable experimental features.</p>
1.75      rillig   1946: <p>To see which options, if any, a package supports, and which
1.110     hubertf  1947:     options are mutually exclusive, run <span class="command"><strong>make
1.88      wiz      1948:     show-options</strong></span>, for example:</p>
1.75      rillig   1949: <pre class="programlisting">
                   1950:     The following options are supported by this package:
                   1951:         ssl      Enable SSL support.
                   1952:     Exactly one of the following gecko options is required:
                   1953:         firefox  Use firefox as gecko rendering engine.
                   1954:         mozilla  Use mozilla as gecko rendering engine.
                   1955:     At most one of the following database options may be selected:
                   1956:         mysql    Enable support for MySQL database.
                   1957:         pgsql    Enable support for PostgreSQL database.
1.1       grant    1958: 
1.75      rillig   1959:     These options are enabled by default: firefox
                   1960:     These options are currently enabled: mozilla ssl
1.1       grant    1961: </pre>
1.75      rillig   1962: <p>The following variables can be defined in
1.110     hubertf  1963:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.88      wiz      1964:     enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
                   1965:     which can be used to select or disable options for all packages
                   1966:     that support them, and
                   1967:     <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
                   1968:     which can be used to select or disable options specifically for
                   1969:     package <em class="replaceable"><code>pkgbase</code></em>.  Options listed in
1.128     wiz      1970:     these variables are selected, options preceded by <span class="quote">&#8220;<span class="quote">-</span>&#8221;</span>
1.88      wiz      1971:     are disabled. A few examples:</p>
1.75      rillig   1972: <pre class="screen">
1.110     hubertf  1973: <code class="prompt">$</code> <span class="command"><strong>grep "PKG.*OPTION" <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a></strong></span>
1.75      rillig   1974: PKG_DEFAULT_OPTIONS=    -arts -dvdread -esound
                   1975: PKG_OPTIONS.kdebase=    debug -sasl
                   1976: PKG_OPTIONS.apache=     suexec </pre>
1.111     rillig   1977: <p>It is important to note that options that were specifically
1.120     snj      1978:     suggested by the package maintainer must be explicitly removed if
1.111     rillig   1979:     you do not wish to include the option.  If you are unsure you can view
                   1980:     the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.88      wiz      1981: <p>The following settings are consulted in the order given, and
                   1982:     the last setting that selects or disables an option is
                   1983:     used:</p>
1.128     wiz      1984: <div class="orderedlist"><ol class="orderedlist" type="1">
                   1985: <li class="listitem"><p>the default options as suggested by the package
1.88      wiz      1986:       maintainer</p></li>
1.128     wiz      1987: <li class="listitem"><p>the options implied by the settings of legacy
1.88      wiz      1988:       variables (see below)</p></li>
1.128     wiz      1989: <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
                   1990: <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
1.75      rillig   1991: </ol></div>
                   1992: <p>For groups of mutually exclusive options, the last option
1.88      wiz      1993:     selected is used, all others are automatically disabled.  If an
                   1994:     option of the group is explicitly disabled, the previously
                   1995:     selected option, if any, is used.  It is an error if no option
                   1996:     from a required group of options is selected, and building the
                   1997:     package will fail.</p>
                   1998: <p>Before the options framework was introduced, build options
                   1999:     were selected by setting a variable (often named
                   2000:     <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.110     hubertf  2001:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option.  To ease
1.88      wiz      2002:     transition to the options framework for the user, these legacy
                   2003:     variables are converted to the appropriate options setting
                   2004:     (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
                   2005:     automatically.  A warning is issued to prompt the user to update
1.110     hubertf  2006:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.88      wiz      2007:     directly.  Support for the legacy variables will be removed
                   2008:     eventually.</p>
1.75      rillig   2009: </div>
                   2010: </div>
1.148     asau     2011: <div class="chapter">
1.75      rillig   2012: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   2013: <a name="binary"></a>Chapter 7. Creating binary packages</h2></div></div></div>
1.75      rillig   2014: <div class="toc">
                   2015: <p><b>Table of Contents</b></p>
1.210     leot     2016: <dl class="toc">
1.267     rillig   2017: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
                   2018: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">7.2. Settings for creation of binary packages</a></span></dt>
1.75      rillig   2019: </dl>
                   2020: </div>
1.148     asau     2021: <div class="sect1">
1.75      rillig   2022: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2023: <a name="building-a-single-binary-package"></a>7.1. Building a single binary package</h2></div></div></div>
1.87      wiz      2024: <p>Once you have built and installed a package, you can create
                   2025:     a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.289     leot     2026:     another system with <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. This saves having to build
1.87      wiz      2027:     the same package on a group of hosts and wasting CPU time. It also
                   2028:     provides a simple means for others to install your package, should
                   2029:     you distribute it.</p>
                   2030: <p>To create a binary package, change into the appropriate
1.110     hubertf  2031:     directory in pkgsrc, and run <span class="command"><strong>make
1.87      wiz      2032:     package</strong></span>:</p>
                   2033: <pre class="screen">
1.223     rillig   2034: <code class="prompt">$</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
                   2035: <code class="prompt">$</code> <strong class="userinput"><code>make package</code></strong>
                   2036: </pre>
1.87      wiz      2037: <p>This will build and install your package (if not already done),
                   2038:     and then build a binary package from what was installed. You can
1.110     hubertf  2039:     then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.87      wiz      2040:     it. Binary packages are created by default in
                   2041:     <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.110     hubertf  2042:     gzipped tar file. See <a class="xref" href="#logs.package" title="B.2. Packaging figlet">Section B.2, &#8220;Packaging figlet&#8221;</a> for a
1.250     leot     2043:     continuation of the above <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/misc/figlet/README.html" target="_top"><code class="filename">misc/figlet</code></a> example.</p>
1.267     rillig   2044: <p>See <a class="xref" href="#submit" title="Chapter 23. Submitting and Committing">Chapter 23, <i>Submitting and Committing</i></a> for information on how to submit
1.87      wiz      2045:     such a binary package.</p>
1.75      rillig   2046: </div>
1.148     asau     2047: <div class="sect1">
1.75      rillig   2048: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2049: <a name="settings-for-creationg-of-binary-packages"></a>7.2. Settings for creation of binary packages</h2></div></div></div>
                   2050: <p>See <a class="xref" href="#build.helpful-targets" title="19.17. Other helpful targets">Section 19.17, &#8220;Other helpful targets&#8221;</a>.</p>
1.106     rillig   2051: </div>
                   2052: </div>
1.148     asau     2053: <div class="chapter">
1.106     rillig   2054: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   2055: <a name="bulk"></a>Chapter 8. Creating binary packages for everything in pkgsrc (bulk
1.106     rillig   2056: builds)</h2></div></div></div>
                   2057: <div class="toc">
                   2058: <p><b>Table of Contents</b></p>
1.210     leot     2059: <dl class="toc">
1.267     rillig   2060: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
                   2061: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a pbulk-style bulk build</a></span></dt>
                   2062: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
                   2063: <dt><span class="sect1"><a href="#bulk.req">8.3. Requirements of a full bulk build</a></span></dt>
                   2064: <dt><span class="sect1"><a href="#creating-cdroms">8.4. Creating a multiple CD-ROM packages collection</a></span></dt>
                   2065: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.4.1. Example of cdpack</a></span></dt></dl></dd>
1.106     rillig   2066: </dl>
                   2067: </div>
1.290     gutterid 2068: <p>For a number of reasons, you may want to build binary packages
                   2069: for a large selected set of packages in pkgsrc, or even for all pkgsrc packages.
1.180     wiz      2070: For instance, when you have multiple machines that should run the same software,
                   2071: it is wasted time if they all build their packages themselves from source.
                   2072: Or you may want to build a list of packages you want and check them before
1.290     gutterid 2073: deploying onto production systems.
1.180     wiz      2074: There is a way of getting a set of binary packages:
1.290     gutterid 2075: the bulk build system, or pbulk ("p" stands for "parallel").
1.223     rillig   2076: This chapter describes how to set it up.</p>
1.148     asau     2077: <div class="sect1">
1.106     rillig   2078: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2079: <a name="bulk.pre"></a>8.1. Preparations</h2></div></div></div>
1.180     wiz      2080: <p>First of all, you have to decide whether you build all packages
                   2081: or a limited set of them. Full bulk builds usually consume a lot more resources,
                   2082: both space and time, than builds for some practical sets of packages.
1.290     gutterid 2083: A number of particularly heavy packages exist that are not actually
                   2084: interesting to a wide audience. (The approximate resource consumption for a
                   2085: 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>.)
                   2086: For limited bulk builds you need to make a list of packages you want to build.
1.223     rillig   2087: Note that all their dependencies will be built, so you don't need to track them manually.
1.180     wiz      2088: </p>
                   2089: <p>During bulk builds various packages are installed and deinstalled
                   2090: in <code class="filename">/usr/pkg</code> (or whatever <code class="filename">LOCALBASE</code> is),
                   2091: so make sure that you don't need any package during the builds.
1.223     rillig   2092: Essentially, you should provide a fresh system, either a chroot environment
1.180     wiz      2093: or something even more restrictive, depending on what the operating system provides,
                   2094: or dedicate the whole physical machine.
                   2095: As a useful side effect this makes sure that bulk builds cannot
                   2096: break anything in your system. There have been numerous cases where
1.106     rillig   2097: certain packages tried to install files outside the
                   2098: <code class="filename">LOCALBASE</code> or wanted to edit some files in
1.180     wiz      2099: <code class="filename">/etc</code>.
                   2100: </p>
1.106     rillig   2101: </div>
1.148     asau     2102: <div class="sect1">
1.106     rillig   2103: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2104: <a name="bulk.pbulk"></a>8.2. Running a pbulk-style bulk build</h2></div></div></div>
1.116     rillig   2105: <p>Running a pbulk-style bulk build works roughly as follows:</p>
1.148     asau     2106: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2107: <li class="listitem"><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
                   2108: <li class="listitem"><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
1.116     rillig   2109: </ul></div>
1.148     asau     2110: <div class="sect2">
1.116     rillig   2111: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   2112: <a name="bulk.pbulk.conf"></a>8.2.1. Configuration</h3></div></div></div>
1.223     rillig   2113: <p>To simplify configuration, we provide the helper script <code class="filename">mk/pbulk/pbulk.sh</code>.</p>
1.178     asau     2114: <p>In order to use it, prepare a clear system (real one, chroot environment, jail, zone, virtual machine).
                   2115: Configure network access to fetch distribution files.
1.223     rillig   2116: Create a user with name "pbulk".</p>
1.178     asau     2117: <p>Fetch and extract pkgsrc. Use a command like one of these:</p>
                   2118: <pre class="screen">
1.264     sevan    2119: <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>
                   2120: <code class="prompt">#</code> <strong class="userinput"><code>(cd /usr &amp;&amp; fetch -o - https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz | tar -zxf-)</code></strong>
1.181     wiz      2121: <code class="prompt">#</code> <strong class="userinput"><code>(cd /usr &amp;&amp; cvs -Q -z3 -d anoncvs@anoncvs.NetBSD.org:/cvsroot get -P pkgsrc)</code></strong>
1.178     asau     2122: </pre>
                   2123: <p>Or any other way that fits (e.g., curl, wget).</p>
                   2124: <p>Deploy and configure pbulk tools, e.g.:</p>
                   2125: <pre class="screen">
1.230     sevan    2126: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -n # use native make, no bootstrap kit needed (for use on NetBSD)</code></strong>
1.178     asau     2127: <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>
                   2128: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -nlc mk.conf.frag # native, apply settings, configure for limited build</code></strong>
                   2129: </pre>
                   2130: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2131: <h3 class="title">Note</h3>
                   2132: <p><code class="filename">mk.conf.frag</code> is a fragment of
                   2133: <code class="filename">mk.conf</code> that contains settings you want to
                   2134: apply to packages you build. For instance,</p>
                   2135: <pre class="programlisting">
1.223     rillig   2136: PKG_DEVELOPER=          yes     # perform more checks
                   2137: X11_TYPE=               modular # use pkgsrc X11
                   2138: SKIP_LICENSE_CHECK=     yes     # accept all licences (useful
                   2139:                                 # when building all packages)
1.178     asau     2140: </pre>
                   2141: </div>
                   2142: <p>If configured for limited list, replace the list in <code class="filename">/usr/pbulk/etc/pbulk.list</code>
1.223     rillig   2143: with your list of packages, one per line without empty lines or comments. E.g.:</p>
1.178     asau     2144: <pre class="programlisting">
                   2145: www/firefox
                   2146: mail/thunderbird
                   2147: misc/libreoffice4
                   2148: </pre>
1.179     asau     2149: <p>At this point you can also review configuration in <code class="filename">/usr/pbulk/etc</code>
                   2150: and make final amendments, if wanted.</p>
1.178     asau     2151: <p>Start it:</p>
                   2152: <pre class="screen">
                   2153: <code class="prompt">#</code> <strong class="userinput"><code>/usr/pbulk/bin/bulkbuild</code></strong>
                   2154: </pre>
                   2155: <p>After it finishes, you'll have <code class="filename">/mnt</code> filled with distribution files, binary packages, and reports,
                   2156: plain text summary in <code class="filename">/mnt/bulklog/meta/report.txt</code>
                   2157: </p>
                   2158: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2159: <h3 class="title">Note</h3>
                   2160: <p>The <code class="filename">pbulk.sh</code> script does not cover all possible use cases.
                   2161: While being ready to run, it serves as a good starting point to understand and build more complex setups.
                   2162: The script is kept small enough for better understanding.</p>
                   2163: </div>
                   2164: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2165: <h3 class="title">Note</h3>
                   2166: <p>The <code class="filename">pbulk.sh</code> script supports running
                   2167: unprivileged bulk build and helps configuring distributed bulk builds.</p>
                   2168: </div>
1.106     rillig   2169: </div>
                   2170: </div>
1.148     asau     2171: <div class="sect1">
1.106     rillig   2172: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2173: <a name="bulk.req"></a>8.3. Requirements of a full bulk build</h2></div></div></div>
1.180     wiz      2174: <p>A complete bulk build requires lots of disk space. Some of the
                   2175: disk space can be read-only, some other must be writable. Some can be on
                   2176: remote filesystems (such as NFS) and some should be local. Some can be
                   2177: temporary filesystems, others must survive a sudden reboot.</p>
                   2178: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   2179: <li class="listitem"><p>40 GB for the distfiles (read-write, remote, temporary)</p></li>
                   2180: <li class="listitem"><p>30 GB for the binary packages (read-write, remote, permanent)</p></li>
                   2181: <li class="listitem"><p>1 GB for the pkgsrc tree (read-only, remote, permanent)</p></li>
                   2182: <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary)</p></li>
                   2183: <li class="listitem"><p>10 GB for the log files (read-write, remote, permanent)</p></li>
                   2184: <li class="listitem"><p>5 GB for temporary files (read-write, local, temporary)</p></li>
                   2185: </ul></div>
                   2186: </div>
                   2187: <div class="sect1">
                   2188: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2189: <a name="creating-cdroms"></a>8.4. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.87      wiz      2190: <p>After your pkgsrc bulk-build has completed, you may wish to
                   2191:     create a CD-ROM set of the resulting binary packages to assist
                   2192:     in installing packages on other machines.  The
1.250     leot     2193:     <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/cdpack/README.html" target="_top"><code class="filename">pkgtools/cdpack</code></a> package provides
1.87      wiz      2194:     a simple tool for creating the ISO 9660 images.
1.110     hubertf  2195:     <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.87      wiz      2196:     way that keeps all the dependencies for a given package on the same
                   2197:     CD as that package.</p>
1.148     asau     2198: <div class="sect2">
1.75      rillig   2199: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   2200: <a name="cdpack-example"></a>8.4.1. Example of cdpack</h3></div></div></div>
1.87      wiz      2201: <p>Complete documentation for cdpack is found in the cdpack(1)
                   2202:       man page. The following short example assumes that the binary
                   2203:       packages are left in
                   2204:       <code class="filename">/usr/pkgsrc/packages/All</code> and that
                   2205:       sufficient disk space exists in <code class="filename">/u2</code> to
                   2206:       hold the ISO 9660 images.</p>
                   2207: <pre class="screen">
                   2208: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
1.75      rillig   2209: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
1.87      wiz      2210: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
                   2211:       </pre>
                   2212: <p>If you wish to include a common set of files
                   2213:       (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
                   2214:       etc.) on each CD in the collection, then you need to create a
1.290     gutterid 2215:       directory which contains these files, e.g.:</p>
1.87      wiz      2216: <pre class="screen">
                   2217: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
1.75      rillig   2218: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" &gt; /tmp/common/README</code></strong>
                   2219: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" &gt; /tmp/common/COPYING</code></strong>
                   2220: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
                   2221: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" &gt; /tmp/common/bin/myscript</code></strong>
                   2222: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" &gt;&gt; /tmp/common/bin/myscript</code></strong>
1.87      wiz      2223: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
                   2224:       </pre>
1.75      rillig   2225: <p>Now create the images:</p>
                   2226: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cdpack -x /tmp/common /usr/pkgsrc/packages/All /u2/images</code></strong></pre>
1.76      rillig   2227: <p>Each image will contain <code class="filename">README</code>,
1.87      wiz      2228:       <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
                   2229:       in their root directories.</p>
1.75      rillig   2230: </div>
                   2231: </div>
                   2232: </div>
1.148     asau     2233: <div class="chapter">
1.75      rillig   2234: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   2235: <a name="files"></a>Chapter 9. Directory layout of the installed files</h2></div></div></div>
1.90      rillig   2236: <div class="toc">
                   2237: <p><b>Table of Contents</b></p>
1.210     leot     2238: <dl class="toc">
1.267     rillig   2239: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
                   2240: <dt><span class="sect1"><a href="#files.varbase">9.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.90      rillig   2241: </dl>
                   2242: </div>
                   2243: <p>The files that are installed by pkgsrc are organized in a way that
                   2244: is similar to what you find in the <code class="filename">/usr</code> directory
                   2245: of the base system. But some details are different. This is because
                   2246: pkgsrc initially came from FreeBSD and had adopted its file system
                   2247: hierarchy. Later it was largely influenced by NetBSD. But no matter
                   2248: which operating system you are using pkgsrc with, you can expect the
                   2249: same layout for pkgsrc.</p>
1.91      rillig   2250: <p>There are mainly four root directories for pkgsrc, which are all
                   2251: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
                   2252: When pkgsrc has been installed as root, the default locations
                   2253: are:</p>
                   2254: <pre class="programlisting">
1.100     rillig   2255: LOCALBASE=              /usr/pkg
                   2256: PKG_SYSCONFBASE=        /usr/pkg/etc
                   2257: VARBASE=                /var
1.231     sevan    2258: PKG_DBDIR=              /usr/pkg/pkgdb
1.91      rillig   2259: </pre>
                   2260: <p>In unprivileged mode (when pkgsrc has been installed as any other
                   2261: user), the default locations are:</p>
                   2262: <pre class="programlisting">
1.100     rillig   2263: LOCALBASE=              ${HOME}/pkg
                   2264: PKG_SYSCONFBASE=        ${HOME}/pkg/etc
                   2265: VARBASE=                ${HOME}/pkg/var
1.231     sevan    2266: PKG_DBDIR=              ${HOME}/pkg/pkgdb
1.91      rillig   2267: </pre>
                   2268: <p>What these four directories are for, and what they look like is
                   2269: explained below.</p>
1.148     asau     2270: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2271: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.90      rillig   2272: <code class="filename">/usr</code> directory in the base system. It is the
1.128     wiz      2273: <span class="quote">&#8220;<span class="quote">main</span>&#8221;</span> directory where the files are installed and contains
1.90      rillig   2274: the well-known subdirectories like <code class="filename">bin</code>,
                   2275: <code class="filename">include</code>, <code class="filename">lib</code>,
                   2276: <code class="filename">share</code> and
                   2277: <code class="filename">sbin</code>.</p></li>
1.128     wiz      2278: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.90      rillig   2279: <code class="filename">/var</code> in the base system. Some programs (especially
                   2280: games, network daemons) need write access to it during normal
                   2281: operation.</p></li>
1.128     wiz      2282: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.90      rillig   2283: <code class="filename">/etc</code> in the base system. It contains configuration
1.110     hubertf  2284: files of the packages, as well as pkgsrc's <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.90      rillig   2285: itself.</p></li>
                   2286: </ul></div>
1.148     asau     2287: <div class="sect1">
1.90      rillig   2288: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2289: <a name="files.localbase"></a>9.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.93      rillig   2290: </h2></div></div></div>
1.90      rillig   2291: <p>The following directories exist in a typical pkgsrc installation
1.91      rillig   2292: in <code class="filename">${LOCALBASE}</code>.</p>
1.148     asau     2293: <div class="variablelist"><dl class="variablelist">
1.90      rillig   2294: <dt><span class="term"><code class="filename">bin</code></span></dt>
                   2295: <dd><p>Contains executable programs that are intended to be
                   2296: directly used by the end user.</p></dd>
                   2297: <dt><span class="term"><code class="filename">emul</code></span></dt>
                   2298: <dd><p>Contains files for the emulation layers of various other
                   2299: operating systems, especially for
                   2300: NetBSD.</p></dd>
                   2301: <dt><span class="term"><code class="filename">etc</code> (the usual location of
                   2302: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
                   2303: <dd><p>Contains
                   2304: the configuration files.</p></dd>
                   2305: <dt><span class="term"><code class="filename">include</code></span></dt>
                   2306: <dd><p>Contains headers for the C and C++ programming
                   2307: languages.</p></dd>
                   2308: <dt><span class="term"><code class="filename">info</code></span></dt>
                   2309: <dd><p>Contains GNU info files of various
                   2310: packages.</p></dd>
                   2311: <dt><span class="term"><code class="filename">lib</code></span></dt>
                   2312: <dd><p>Contains shared and static
                   2313: libraries.</p></dd>
                   2314: <dt><span class="term"><code class="filename">libdata</code></span></dt>
                   2315: <dd><p>Contains data files that don't change after
                   2316: installation. Other data files belong into
                   2317: <code class="filename">${VARBASE}</code>.</p></dd>
                   2318: <dt><span class="term"><code class="filename">libexec</code></span></dt>
                   2319: <dd><p>Contains programs that are not intended to be used by
                   2320: end users, such as helper programs or network
                   2321: daemons.</p></dd>
                   2322: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
                   2323: <dd><p>Contains programs that are intended to be executed as
                   2324: CGI scripts by a web server.</p></dd>
                   2325: <dt><span class="term"><code class="filename">man</code> (the usual value of
                   2326: <code class="filename">${PKGMANDIR}</code>)</span></dt>
                   2327: <dd><p>Contains brief
                   2328: documentation in form of manual pages.</p></dd>
                   2329: <dt><span class="term"><code class="filename">sbin</code></span></dt>
                   2330: <dd><p>Contains programs that are intended to be used only by
                   2331: the super-user.</p></dd>
                   2332: <dt><span class="term"><code class="filename">share</code></span></dt>
                   2333: <dd><p>Contains platform-independent data files that don't
                   2334: change after installation.</p></dd>
                   2335: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
                   2336: <dd><p>Contains documentation files provided by the
                   2337: packages.</p></dd>
                   2338: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
                   2339: <dd><p>Contains example files provided by the packages. Among
                   2340: others, the original configuration files are saved here and copied to
                   2341: <code class="filename">${PKG_SYSCONFDIR}</code> during
                   2342: installation.</p></dd>
                   2343: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
                   2344: <dd><p>Contains the original files for rc.d
                   2345: scripts.</p></dd>
                   2346: <dt><span class="term"><code class="filename">var</code> (the usual location of
                   2347: <code class="filename">${VARBASE}</code>)</span></dt>
                   2348: <dd><p>Contains files
                   2349: that may be modified after
                   2350: installation.</p></dd>
                   2351: </dl></div>
                   2352: </div>
1.148     asau     2353: <div class="sect1">
1.90      rillig   2354: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2355: <a name="files.varbase"></a>9.2. File system layout in <code class="literal">${VARBASE}</code>
1.93      rillig   2356: </h2></div></div></div>
1.148     asau     2357: <div class="variablelist"><dl class="variablelist">
1.90      rillig   2358: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
                   2359: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
                   2360: <dd><p>Contains
                   2361: information about the currently installed
                   2362: packages.</p></dd>
                   2363: <dt><span class="term"><code class="filename">games</code></span></dt>
                   2364: <dd><p>Contains highscore
                   2365: files.</p></dd>
                   2366: <dt><span class="term"><code class="filename">log</code></span></dt>
                   2367: <dd><p>Contains log files.</p></dd>
                   2368: <dt><span class="term"><code class="filename">run</code></span></dt>
                   2369: <dd><p>Contains informational files about daemons that are
                   2370: currently running.</p></dd>
                   2371: </dl></div>
                   2372: </div>
                   2373: </div>
1.148     asau     2374: <div class="chapter">
1.90      rillig   2375: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   2376: <a name="faq"></a>Chapter 10. Frequently Asked Questions</h2></div></div></div>
1.75      rillig   2377: <div class="toc">
                   2378: <p><b>Table of Contents</b></p>
1.210     leot     2379: <dl class="toc">
1.267     rillig   2380: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                   2381: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
                   2382: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
                   2383: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
                   2384: <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>
                   2385: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
                   2386: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
                   2387: <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>
                   2388: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
                   2389: <dt><span class="sect1"><a href="#tmac.andoc-missing">10.10. What does <span class="quote">&#8220;<span class="quote">Don't know how to make
1.128     wiz      2390: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</a></span></dt>
1.267     rillig   2391: <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>
                   2392: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' with pkgsrc</a></span></dt>
                   2393: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
                   2394: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
                   2395: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
                   2396: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build.  What shall I do?</a></span></dt>
                   2397: <dt><span class="sect1"><a href="#faq.rcs-conflicts">10.17. What does <span class="quote">&#8220;<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>&#8221;</span> mean?</a></span></dt>
1.75      rillig   2398: </dl>
                   2399: </div>
                   2400: <p>This section contains hints, tips &amp; tricks on special things in
                   2401: pkgsrc that we didn't find a better place for in the previous chapters, and
                   2402: it contains items for both pkgsrc users and developers.</p>
1.148     asau     2403: <div class="sect1">
1.75      rillig   2404: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2405: <a name="mailing-list-pointers"></a>10.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.75      rillig   2406: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.148     asau     2407: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2408: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-users" target="_top">pkgsrc-users</a>:
1.78      rillig   2409:          This is a general purpose list for most issues regarding
                   2410:          pkgsrc, regardless of platform, e.g. soliciting user help
                   2411:          for pkgsrc configuration, unexpected build failures, using
                   2412:          particular packages, upgrading pkgsrc installations,
                   2413:          questions regarding the pkgsrc release branches, etc.  General announcements or
                   2414:          proposals for changes that impact the pkgsrc user community,
                   2415:          e.g. major infrastructure changes, new features, package
                   2416:          removals, etc., may also be posted.</p></li>
1.289     leot     2417: <li class="listitem"><p><a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#pkgsrc-bulk" target="_top">pkgsrc-bulk</a>:
1.75      rillig   2418:          A list where the results of pkgsrc bulk builds are sent and
                   2419:          discussed.</p></li>
1.289     leot     2420: <li class="listitem"><p><a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#pkgsrc-changes" target="_top">pkgsrc-changes</a>:
1.75      rillig   2421:          This list is for those who are interested in getting a
                   2422:          commit message for every change committed to pkgsrc. It is
                   2423:          also available in digest form, meaning one daily message
                   2424:          containing all commit messages for changes to the package
                   2425:          source tree in that 24 hour period.</p></li>
                   2426: </ul></div>
                   2427: <p>To subscribe, do:</p>
                   2428: <pre class="programlisting">
1.100     rillig   2429: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
1.75      rillig   2430: </pre>
                   2431: <p>Archives for all these mailing lists are available from
1.289     leot     2432: <a class="ulink" href="https://mail-index.NetBSD.org/" target="_top">https://mail-index.NetBSD.org/</a>.</p>
1.75      rillig   2433: </div>
1.148     asau     2434: <div class="sect1">
1.75      rillig   2435: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2436: <a name="faq-pkgtools"></a>10.2. Utilities for package management (pkgtools)</h2></div></div></div>
1.80      rillig   2437: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
1.75      rillig   2438: a number of useful utilities for both users and developers of pkgsrc.  This
1.233     sevan    2439: section attempts only to make the reader aware of some of the utilities and when
1.75      rillig   2440: they might be useful, and not to duplicate the documentation that comes
                   2441: with each package.</p>
                   2442: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.250     leot     2443: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/x11-links/README.html" target="_top"><code class="filename">pkgtools/x11-links</code></a>:
1.75      rillig   2444:       Symlinks for use by buildlink.</p></li></ul></div>
                   2445: <p>OS tool augmentation (automatically installed when needed):</p>
1.148     asau     2446: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.250     leot     2447: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/digest/README.html" target="_top"><code class="filename">pkgtools/digest</code></a>:
1.233     sevan    2448:       Calculates various kinds of checksums (including SHA3).</p></li>
1.250     leot     2449: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libnbcompat/README.html" target="_top"><code class="filename">pkgtools/libnbcompat</code></a>:
1.75      rillig   2450:       Compatibility library for pkgsrc tools.</p></li>
1.250     leot     2451: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/mtree/README.html" target="_top"><code class="filename">pkgtools/mtree</code></a>: Installed on
1.87      wiz      2452:       non-BSD systems due to lack of native mtree.</p></li>
1.250     leot     2453: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a>:
1.75      rillig   2454:       Up-to-date replacement for
1.76      rillig   2455:       <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
1.75      rillig   2456:       systems where pkg_install is not present.</p></li>
                   2457: </ul></div>
                   2458: <p>Utilities used by pkgsrc (not automatically installed):</p>
1.148     asau     2459: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.250     leot     2460: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_tarup/README.html" target="_top"><code class="filename">pkgtools/pkg_tarup</code></a>:
1.75      rillig   2461:       Create a binary package from an
1.110     hubertf  2462:       already-installed package.  Used by <span class="command"><strong>make replace</strong></span> to
1.75      rillig   2463:       save the old package.</p></li>
1.250     leot     2464: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/dfdisk/README.html" target="_top"><code class="filename">pkgtools/dfdisk</code></a>:
1.75      rillig   2465:       Adds extra functionality to pkgsrc, allowing it to fetch distfiles
                   2466:       from multiple locations. It currently supports the following
                   2467:       methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.250     leot     2468: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/README.html" target="_top"><code class="filename">devel/cpuflags</code></a>: Determine
1.117     jnemeth  2469:       the best compiler flags to optimise code for your current
1.128     wiz      2470:       CPU and compiler. </p></li>
1.75      rillig   2471: </ul></div>
                   2472: <p>Utilities for keeping track of installed packages, being up to date,
                   2473: etc:</p>
1.148     asau     2474: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.250     leot     2475: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgin/README.html" target="_top"><code class="filename">pkgtools/pkgin</code></a>: A package
1.173     wiz      2476:     update tool similar to apt(1). Download, install, and upgrade
                   2477:     binary packages easily.</p></li>
1.250     leot     2478: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_chk/README.html" target="_top"><code class="filename">pkgtools/pkg_chk</code></a>: Reports on
1.75      rillig   2479:       packages whose installed versions do not match the latest pkgsrc
                   2480:       entries.</p></li>
1.250     leot     2481: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdep/README.html" target="_top"><code class="filename">pkgtools/pkgdep</code></a>: Makes
1.75      rillig   2482:       dependency graphs of packages, to aid in choosing a strategy for
                   2483:       updating.</p></li>
1.250     leot     2484: <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
                   2485:       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>
                   2486: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>: The
1.112     weinem   2487:       pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.250     leot     2488: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/lintpkgsrc/README.html" target="_top"><code class="filename">pkgtools/lintpkgsrc</code></a>: The lintpkgsrc(1) program
1.75      rillig   2489:       does various checks on the complete pkgsrc system.</p></li>
1.250     leot     2490: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgsurvey/README.html" target="_top"><code class="filename">pkgtools/pkgsurvey</code></a>: Report what
1.75      rillig   2491:       packages you have installed.</p></li>
                   2492: </ul></div>
                   2493: <p>Utilities for people maintaining or creating individual packages:</p>
1.148     asau     2494: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.250     leot     2495: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a>: Automate
1.75      rillig   2496:       making and maintaining patches for a package (includes pkgdiff,
                   2497:       pkgvi, mkpatches, etc.).</p></li>
1.250     leot     2498: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a>: Aids in
1.75      rillig   2499:       converting to pkgsrc.</p></li>
                   2500: </ul></div>
                   2501: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
                   2502: utilities)</p>
1.148     asau     2503: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.250     leot     2504: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_comp/README.html" target="_top"><code class="filename">pkgtools/pkg_comp</code></a>: Build
1.75      rillig   2505:       packages in a chrooted area.</p></li>
1.250     leot     2506: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libkver/README.html" target="_top"><code class="filename">pkgtools/libkver</code></a>: Spoof
1.75      rillig   2507:       kernel version for chrooted cross builds.</p></li>
                   2508: </ul></div>
                   2509: </div>
1.148     asau     2510: <div class="sect1">
1.75      rillig   2511: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2512: <a name="non-root-pkgsrc"></a>10.3. How to use pkgsrc as non-root</h2></div></div></div>
1.219     rillig   2513: <p>To install packages from source as a non-root user, download
1.267     rillig   2514: pkgsrc as described in <a class="xref" href="#getting" title="Chapter 3. Where to get pkgsrc and how to keep it up-to-date">Chapter 3, <i>Where to get pkgsrc and how to keep it up-to-date</i></a>, cd into that
1.219     rillig   2515: directory and run the command <span class="command"><strong>./bootstrap/bootstrap
                   2516: --unprivileged</strong></span>.</p>
                   2517: <p>This will install the binary part of pkgsrc to
                   2518: <code class="filename">~/pkg</code> and put the pkgsrc configuration <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
                   2519: into <code class="filename">~/pkg/etc</code>.</p>
                   2520: <p>For more details, see <code class="filename">mk/unprivileged.mk</code>.</p>
1.75      rillig   2521: </div>
1.148     asau     2522: <div class="sect1">
1.75      rillig   2523: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2524: <a name="resume-transfers"></a>10.4. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.75      rillig   2525: <p>By default, resuming transfers in pkgsrc is disabled, but you can
                   2526: enable this feature by adding the option
                   2527: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.110     hubertf  2528: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  If, during a fetch step, an incomplete
1.75      rillig   2529: distfile is found, pkgsrc will try to resume it.</p>
                   2530: <p>You can also
1.168     wiz      2531: use a different program than the platform default program by changing the
1.117     jnemeth  2532: <code class="varname">FETCH_USING</code> variable.  You can specify the program by
                   2533: using of ftp, fetch, wget or curl.  Alternatively, fetching can be disabled
                   2534: by using the value manual.  A value of custom disables the system defaults
                   2535: and dependency tracking for the fetch program.  In that case you have to
                   2536: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
                   2537: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
                   2538: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.75      rillig   2539: <p>For example, if you want to use
1.117     jnemeth  2540: <code class="filename">wget</code> to download, you'll have to use something
1.75      rillig   2541: like:</p>
                   2542: <pre class="programlisting">
1.223     rillig   2543: FETCH_USING=    wget
1.1       grant    2544: </pre>
1.75      rillig   2545: </div>
1.148     asau     2546: <div class="sect1">
1.75      rillig   2547: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2548: <a name="x.org-from-pkgsrc"></a>10.5. How can I install/use modular X.org from pkgsrc?</h2></div></div></div>
1.103     wiz      2549: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.76      rillig   2550: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
1.75      rillig   2551: you will have to add the following line into
1.110     hubertf  2552: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.75      rillig   2553: <pre class="programlisting">
1.103     wiz      2554: X11_TYPE=modular
1.1       grant    2555: </pre>
1.75      rillig   2556: </div>
1.148     asau     2557: <div class="sect1">
1.75      rillig   2558: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2559: <a name="fetch-behind-firewall"></a>10.6. How to fetch files from behind a firewall</h2></div></div></div>
1.75      rillig   2560: <p>If you are sitting behind a firewall which does not allow direct
                   2561: connections to Internet hosts (i.e. non-NAT), you may specify the
                   2562: relevant proxy hosts.  This is done using an environment variable in the
                   2563: form of a URL, e.g. in Amdahl, the machine
1.128     wiz      2564: <span class="quote">&#8220;<span class="quote">orpheus.amdahl.com</span>&#8221;</span> is one of the firewalls, and it uses
1.75      rillig   2565: port 80 as the proxy port number.  So the proxy environment variables
                   2566: are:</p>
                   2567: <pre class="programlisting">
1.100     rillig   2568: ftp_proxy=ftp://orpheus.amdahl.com:80/
                   2569: http_proxy=http://orpheus.amdahl.com:80/
1.1       grant    2570: </pre>
1.75      rillig   2571: </div>
1.148     asau     2572: <div class="sect1">
1.75      rillig   2573: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2574: <a name="fetch-https"></a>10.7. How to fetch files from HTTPS sites</h2></div></div></div>
1.173     wiz      2575: <p>Some fetch tools are not prepared to support HTTPS by default
                   2576: (for example, the one in NetBSD 6.0), or the one installed by the
                   2577: pkgsrc bootstrap (to avoid an openssl dependency that low in the
                   2578: dependency graph).</p>
                   2579: <p>Usually you won't notice, because distribution files are
                   2580: mirrored weekly to <span class="quote">&#8220;<span class="quote">ftp.NetBSD.org</span>&#8221;</span>, but that might not
                   2581: be often enough if you are following pkgsrc-current. In that case, set
                   2582: <code class="varname">FETCH_USING</code> in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file to
                   2583: <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
                   2584: with HTTPS support by default. Of course, these tools need to be
                   2585: installed before you can use them this way.</p>
                   2586: </div>
                   2587: <div class="sect1">
                   2588: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2589: <a name="passive-ftp"></a>10.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</h2></div></div></div>
1.75      rillig   2590: <p>This depends on which utility is used to retrieve distfiles.  From
1.76      rillig   2591: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
1.75      rillig   2592: the first available command from the following list:</p>
1.148     asau     2593: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      2594: <li class="listitem"><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
                   2595: <li class="listitem"><p><code class="filename">/usr/bin/ftp</code></p></li>
1.75      rillig   2596: </ul></div>
                   2597: <p>On a default NetBSD installation, this will be
1.76      rillig   2598: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
1.75      rillig   2599: connections first, and falls back to active connections if the server
                   2600: refuses to do passive.  For the other tools, add the following to your
1.110     hubertf  2601: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.75      rillig   2602: <code class="varname">PASSIVE_FETCH=1</code>.</p>
                   2603: <p>Having that option present will prevent
1.76      rillig   2604: <code class="filename">/usr/bin/ftp</code> from falling back to active
1.75      rillig   2605: transfers.</p>
                   2606: </div>
1.148     asau     2607: <div class="sect1">
1.75      rillig   2608: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2609: <a name="fetching-all-distfiles"></a>10.9. How to fetch all distfiles at once</h2></div></div></div>
1.88      wiz      2610: <p>You would like to download all the distfiles in a single batch
1.110     hubertf  2611: from work or university, where you can't run a <span class="command"><strong>make
1.132     spz      2612: fetch</strong></span>.  There is an archive of distfiles on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/" target="_top">ftp.NetBSD.org</a>,
1.75      rillig   2613: but downloading the entire directory may not be appropriate.</p>
1.110     hubertf  2614: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.76      rillig   2615: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
1.75      rillig   2616: resulting list to your machine at work/school and use it there.  If you
1.289     leot     2617: don't have a NetBSD-compatible <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?ftp+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">ftp</span>(1)</span></a> (like tnftp) at work, don't
1.75      rillig   2618: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
                   2619: URL:</p>
                   2620: <p>At home:</p>
                   2621: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   2622: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles &gt;/tmp/fetch.sh</code></strong>
                   2623: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
                   2624: <p>At work:</p>
                   2625: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
1.76      rillig   2626: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
1.75      rillig   2627: home.</p>
                   2628: <p>If you have a machine running NetBSD, and you want to get
1.88      wiz      2629: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
                   2630: machine architecture), you can do so by using the above-mentioned
1.110     hubertf  2631: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.88      wiz      2632: directly by running:</p>
1.75      rillig   2633: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
                   2634: <p>If you even decide to ignore
                   2635: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
                   2636: by running:</p>
                   2637: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
                   2638: </div>
1.148     asau     2639: <div class="sect1">
1.75      rillig   2640: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2641: <a name="tmac.andoc-missing"></a>10.10. What does <span class="quote">&#8220;<span class="quote">Don't know how to make
1.128     wiz      2642: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</h2></div></div></div>
1.250     leot     2643: <p>When compiling the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a>
1.75      rillig   2644: package, you get the error from make that it doesn't know how to make
1.76      rillig   2645: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.128     wiz      2646: you don't have installed the <span class="quote">&#8220;<span class="quote">text</span>&#8221;</span> set (nroff, ...) from
1.75      rillig   2647: the NetBSD base distribution on your machine.  It is recommended to do
                   2648: that to format man pages.</p>
1.250     leot     2649: <p>In the case of the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a> package, you
1.75      rillig   2650: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.110     hubertf  2651: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75      rillig   2652: </div>
1.148     asau     2653: <div class="sect1">
1.75      rillig   2654: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2655: <a name="bsd.own.mk-missing"></a>10.11. What does <span class="quote">&#8220;<span class="quote">Could not find bsd.own.mk</span>&#8221;</span> mean?</h2></div></div></div>
1.87      wiz      2656: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
1.75      rillig   2657: when you installed your NetBSD machine.  Please get and install it, by
1.76      rillig   2658: extracting it in <code class="filename">/</code>:</p>
1.75      rillig   2659: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
                   2660: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
1.76      rillig   2661: <p><code class="filename">comp.tgz</code> is part of every NetBSD release.  Get
1.110     hubertf  2662: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.75      rillig   2663: -r</strong></span>).</p>
                   2664: </div>
1.148     asau     2665: <div class="sect1">
1.75      rillig   2666: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2667: <a name="using-sudo-with-pkgsrc"></a>10.12. Using 'sudo' with pkgsrc</h2></div></div></div>
1.75      rillig   2668: <p>When installing packages as non-root user and using the just-in-time
1.289     leot     2669: <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?su+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a> feature of pkgsrc, it can become annoying to type in the root
1.75      rillig   2670: password for each required package installed.  To avoid this, the sudo
                   2671: package can be used, which does password caching over a limited time.  To
                   2672: use it, install sudo (either as binary package or from
1.250     leot     2673: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/sudo/README.html" target="_top"><code class="filename">security/sudo</code></a>) and then put the
1.110     hubertf  2674: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.98      wiz      2675: <span class="emphasis"><em>after</em></span> the definition of the
                   2676: <code class="varname">LOCALBASE</code> variable:</p>
1.75      rillig   2677: <pre class="programlisting">
1.100     rillig   2678: .if exists(${LOCALBASE}/bin/sudo)
                   2679: SU_CMD=        ${LOCALBASE}/bin/sudo /bin/sh -c
                   2680: .endif
1.1       grant    2681: </pre>
1.75      rillig   2682: </div>
1.148     asau     2683: <div class="sect1">
1.75      rillig   2684: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2685: <a name="faq.conf"></a>10.13. How do I change the location of configuration files?</h2></div></div></div>
1.75      rillig   2686: <p>As the system administrator, you can choose where configuration files
                   2687: are installed.  The default settings make all these files go into
1.76      rillig   2688: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
1.75      rillig   2689: be suboptimal depending on your expectations (e.g., a read-only,
                   2690: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
                   2691: configuration of the provided packages).</p>
                   2692: <p>In order to change the defaults, you can modify the
                   2693: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.110     hubertf  2694: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.76      rillig   2695: directory; some common examples include <code class="filename">/etc</code> or
                   2696: <code class="filename">/etc/pkg</code>.</p>
1.75      rillig   2697: <p>Furthermore, you can change this value on a per-package basis by
                   2698: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
                   2699: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
                   2700: package you would like to modify, that is, the contents of
                   2701: <code class="varname">PKGBASE</code>.</p>
                   2702: <p>Note that after changing these settings, you must rebuild and
                   2703: reinstall any affected packages.</p>
                   2704: </div>
1.148     asau     2705: <div class="sect1">
1.75      rillig   2706: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2707: <a name="audit-packages"></a>10.14. Automated security checks</h2></div></div></div>
1.75      rillig   2708: <p>Please be aware that there can often be bugs in third-party software,
                   2709: and some of these bugs can leave a machine vulnerable to exploitation by
                   2710: attackers.  In an effort to lessen the exposure, the NetBSD packages team
                   2711: maintains a database of known-exploits to packages which have at one time
                   2712: been included in pkgsrc.  The database can be downloaded automatically, and
                   2713: a security audit of all packages installed on a system can take place.  To
1.114     jmcneill 2714: do this, refer to the following two tools (installed as part of the
1.250     leot     2715: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a> package):</p>
1.128     wiz      2716: <div class="orderedlist"><ol class="orderedlist" type="1">
                   2717: <li class="listitem">
1.122     reed     2718: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.75      rillig   2719:     download a list of the security vulnerabilities information.  This list
1.132     spz      2720:     is kept up to date by the pkgsrc security team, and is distributed
                   2721:     from the NetBSD ftp server:</p>
1.292   ! leot     2722: <p><a class="ulink" href="https://ftp.NetBSD.org/pub/NetBSD/packages/vulns/pkg-vulnerabilities" target="_top">https://ftp.NetBSD.org/pub/NetBSD/packages/vulns/pkg-vulnerabilities</a></p>
1.75      rillig   2723: </li>
1.128     wiz      2724: <li class="listitem"><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
                   2725:     current machine, checking each known vulnerability.  If a
1.75      rillig   2726:     vulnerable package is installed, it will be shown by output to stdout,
                   2727:     including a description of the type of vulnerability, and a URL
                   2728:     containing more information.</p></li>
                   2729: </ol></div>
1.233     sevan    2730: <p>Use of these tools is strongly recommended!
1.267     rillig   2731: See <a class="xref" href="#vulnerabilities" title="5.1.5. Checking for security vulnerabilities in installed packages">Section 5.1.5, &#8220;Checking for security vulnerabilities in installed packages&#8221;</a> for instructions on how to automate checking and
1.233     sevan    2732: reporting.</p>
                   2733: <p>If this database is installed, pkgsrc builds will use it to
                   2734: perform a security check before building any package.</p>
1.75      rillig   2735: </div>
1.148     asau     2736: <div class="sect1">
1.75      rillig   2737: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2738: <a name="ufaq-cflags"></a>10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</h2></div></div></div>
1.75      rillig   2739: <p>When you add your own preferences to the
                   2740:        <code class="varname">CFLAGS</code> variable in your
1.110     hubertf  2741:        <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.76      rillig   2742:        environment variables to the <code class="filename">./configure</code>
1.289     leot     2743:        scripts and to <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>. Some package authors ignore the
1.75      rillig   2744:        <code class="varname">CFLAGS</code> from the environment variable by
1.76      rillig   2745:        overriding them in the <code class="filename">Makefile</code>s of their
1.75      rillig   2746:        package.</p>
                   2747: <p>Currently there is no solution to this problem. If you
                   2748:        really need the package to use your <code class="varname">CFLAGS</code>
1.110     hubertf  2749:        you should run <span class="command"><strong>make patch</strong></span> in the package
1.76      rillig   2750:        directory and then inspect any <code class="filename">Makefile</code> and
                   2751:        <code class="filename">Makefile.in</code> for whether they define
1.75      rillig   2752:        <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.128     wiz      2753:        these lines. But be aware that some <span class="quote">&#8220;<span class="quote">smart</span>&#8221;</span>
1.75      rillig   2754:        programmers write so bad code that it only works for the
                   2755:        specific combination of <code class="varname">CFLAGS</code> they have
                   2756:        chosen.</p>
1.287     rillig   2757: <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>
                   2758: <pre class="programlisting">
                   2759: CPPFLAGS+=              -Dpkgsrc___CPPFLAGS
                   2760: CFLAGS+=                -Dpkgsrc___CFLAGS
                   2761: CXXFLAGS+=              -Dpkgsrc___CXXFLAGS
                   2762: </pre>
                   2763: <p>Then run <span class="command"><strong>bmake show-all-configure show-all-build</strong></span>
                   2764: to see whether the above flags are passed to the actual build
                   2765: commands in general.</p>
                   2766: <p>To find out whether the flags are passed to individual compiler
                   2767: commands, have a look at the file <code class="filename">work/.work.log</code>. In
                   2768: most cases, the flags from the original command lines (the lines starting
                   2769: with <code class="literal">[*]</code>) are passed unmodified to the actual compiler
                   2770: (the lines starting with <code class="literal">&lt;.&gt;</code>). If the flag is
                   2771: missing from the actual compiler command, it must have been removed by
                   2772: the <a class="link" href="#build.wrapper" title="19.10. The wrapper phase">pkgsrc compiler wrappers</a>.</p>
1.75      rillig   2773: </div>
1.148     asau     2774: <div class="sect1">
1.80      rillig   2775: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2776: <a name="ufaq-fail"></a>10.16. A package does not build.  What shall I do?</h2></div></div></div>
1.128     wiz      2777: <div class="procedure"><ol class="procedure" type="1">
1.148     asau     2778: <li class="step"><p>Make sure that your copy of pkgsrc is consistent. A
1.80      rillig   2779:        case that occurs often is that people only update pkgsrc in
                   2780:        parts, because of performance reasons. Since pkgsrc is one large
                   2781:        system, not a collection of many small systems, there are
                   2782:        sometimes changes that only work when the whole pkgsrc tree is
                   2783:        updated.</p></li>
1.148     asau     2784: <li class="step"><p>Make sure that you don't have any CVS conflicts.
1.128     wiz      2785:        Search for <span class="quote">&#8220;<span class="quote">&lt;&lt;&lt;&lt;&lt;&lt;</span>&#8221;</span> or
                   2786:        <span class="quote">&#8220;<span class="quote">&gt;&gt;&gt;&gt;&gt;&gt;</span>&#8221;</span> in all your pkgsrc
1.80      rillig   2787:        files.</p></li>
1.148     asau     2788: <li class="step"><p>Make sure that you don't have old copies of the packages
1.110     hubertf  2789:        extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.80      rillig   2790:        verify this.</p></li>
1.218     rillig   2791: <li class="step"><p>If you are a package developer who wants to invest
1.267     rillig   2792:        some work, have a look at <a class="xref" href="#fixes" title="Chapter 21. Making your package work">Chapter 21, <i>Making your package work</i></a>.</p></li>
1.148     asau     2793: <li class="step"><p>If the problem still exists, write a mail to the
1.80      rillig   2794:        <code class="literal">pkgsrc-users</code> mailing list.</p></li>
                   2795: </ol></div>
                   2796: </div>
1.148     asau     2797: <div class="sect1">
1.88      wiz      2798: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   2799: <a name="faq.rcs-conflicts"></a>10.17. What does <span class="quote">&#8220;<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>&#8221;</span> mean?</h2></div></div></div>
1.89      rillig   2800: <p>You have modified a file from pkgsrc, and someone else has
                   2801: modified that same file afterwards in the CVS repository. Both changes
                   2802: are in the same region of the file, so when you updated pkgsrc, the
                   2803: <code class="literal">cvs</code> command marked the conflicting changes in the
                   2804: file. Because of these markers, the file is no longer a valid
                   2805: <code class="filename">Makefile</code>.</p>
                   2806: <p>Have a look at that file, and if you don't need your local changes
1.110     hubertf  2807: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.89      rillig   2808: -dP</strong></span> in that directory to download the current version.</p>
                   2809: </div>
1.75      rillig   2810: </div>
                   2811: </div>
1.148     asau     2812: <div class="part">
1.75      rillig   2813: <div class="titlepage"><div><div><h1 class="title">
                   2814: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.148     asau     2815: <div class="partintro">
1.77      rillig   2816: <div></div>
                   2817: <p>This part of the book deals with creating and
1.128     wiz      2818:        modifying packages. It starts with a <span class="quote">&#8220;<span class="quote">HOWTO</span>&#8221;</span>-like
1.77      rillig   2819:        guide on creating a new package. The remaining chapters are more
                   2820:        like a reference manual for pkgsrc.</p>
1.75      rillig   2821: <div class="toc">
                   2822: <p><b>Table of Contents</b></p>
1.210     leot     2823: <dl class="toc">
1.267     rillig   2824: <dt><span class="chapter"><a href="#help-devel">11. Getting help</a></span></dt>
                   2825: <dt><span class="chapter"><a href="#creating">12. Creating a new pkgsrc package from scratch</a></span></dt>
1.91      rillig   2826: <dd><dl>
1.267     rillig   2827: <dt><span class="sect1"><a href="#creating.common">12.1. Common types of packages</a></span></dt>
1.91      rillig   2828: <dd><dl>
1.267     rillig   2829: <dt><span class="sect2"><a href="#creating.perl-module">12.1.1. Perl modules</a></span></dt>
                   2830: <dt><span class="sect2"><a href="#creating.python-module">12.1.2. Python modules and programs</a></span></dt>
1.275     brook    2831: <dt><span class="sect2"><a href="#creating.R-package">12.1.3. R packages</a></span></dt>
                   2832: <dt><span class="sect2"><a href="#creating.TeX-package">12.1.4. TeXlive packages</a></span></dt>
1.91      rillig   2833: </dl></dd>
1.267     rillig   2834: <dt><span class="sect1"><a href="#creating.examples">12.2. Examples</a></span></dt>
                   2835: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">12.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
1.106     rillig   2836: </dl></dd>
1.267     rillig   2837: <dt><span class="chapter"><a href="#components">13. Package components - files, directories and contents</a></span></dt>
1.106     rillig   2838: <dd><dl>
1.267     rillig   2839: <dt><span class="sect1"><a href="#components.Makefile">13.1. <code class="filename">Makefile</code></a></span></dt>
                   2840: <dt><span class="sect1"><a href="#components.distinfo">13.2. <code class="filename">distinfo</code></a></span></dt>
                   2841: <dt><span class="sect1"><a href="#components.patches">13.3. <code class="filename">patches/*</code></a></span></dt>
1.106     rillig   2842: <dd><dl>
1.267     rillig   2843: <dt><span class="sect2"><a href="#components.patch.structure">13.3.1. Structure of a single patch file</a></span></dt>
                   2844: <dt><span class="sect2"><a href="#components.patches.caveats">13.3.2. Creating patch files</a></span></dt>
                   2845: <dt><span class="sect2"><a href="#components.patches.sources">13.3.3. Sources where the patch files come from</a></span></dt>
                   2846: <dt><span class="sect2"><a href="#components.patches.guidelines">13.3.4. Patching guidelines</a></span></dt>
                   2847: <dt><span class="sect2"><a href="#components.patches.feedback">13.3.5. Feedback to the author</a></span></dt>
1.106     rillig   2848: </dl></dd>
1.267     rillig   2849: <dt><span class="sect1"><a href="#other-mandatory-files">13.4. Other mandatory files</a></span></dt>
                   2850: <dt><span class="sect1"><a href="#components.optional">13.5. Optional files</a></span></dt>
1.106     rillig   2851: <dd><dl>
1.267     rillig   2852: <dt><span class="sect2"><a href="#components.optional.bin">13.5.1. Files affecting the binary package</a></span></dt>
                   2853: <dt><span class="sect2"><a href="#components.optional.build">13.5.2. Files affecting the build process</a></span></dt>
                   2854: <dt><span class="sect2"><a href="#components.optional.none">13.5.3. Files affecting nothing at all</a></span></dt>
1.106     rillig   2855: </dl></dd>
1.267     rillig   2856: <dt><span class="sect1"><a href="#work-dir">13.6. <code class="filename">work*</code></a></span></dt>
                   2857: <dt><span class="sect1"><a href="#files-dir">13.7. <code class="filename">files/*</code></a></span></dt>
1.106     rillig   2858: </dl></dd>
1.267     rillig   2859: <dt><span class="chapter"><a href="#makefile">14. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.106     rillig   2860: <dd><dl>
1.267     rillig   2861: <dt><span class="sect1"><a href="#makefile.style">14.1. Caveats</a></span></dt>
                   2862: <dt><span class="sect1"><a href="#makefile.variables">14.2. <code class="filename">Makefile</code> variables</a></span></dt>
                   2863: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">14.2.1. Naming conventions</a></span></dt></dl></dd>
                   2864: <dt><span class="sect1"><a href="#makefile.code">14.3. Code snippets</a></span></dt>
1.106     rillig   2865: <dd><dl>
1.267     rillig   2866: <dt><span class="sect2"><a href="#adding-to-list">14.3.1. Adding things to a list</a></span></dt>
                   2867: <dt><span class="sect2"><a href="#echo-literal">14.3.2. Echoing a string exactly as-is</a></span></dt>
                   2868: <dt><span class="sect2"><a href="#cflags-gnu-configure">14.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</a></span></dt>
                   2869: <dt><span class="sect2"><a href="#empty-variables">14.3.4. Handling possibly empty variables</a></span></dt>
1.106     rillig   2870: </dl></dd>
                   2871: </dl></dd>
1.267     rillig   2872: <dt><span class="chapter"><a href="#plist">15. PLIST issues</a></span></dt>
1.106     rillig   2873: <dd><dl>
1.267     rillig   2874: <dt><span class="sect1"><a href="#rcs-id">15.1. RCS ID</a></span></dt>
                   2875: <dt><span class="sect1"><a href="#automatic-plist-generation">15.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                   2876: <dt><span class="sect1"><a href="#print-PLIST">15.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
                   2877: <dt><span class="sect1"><a href="#plist.misc">15.4. Variable substitution in PLIST</a></span></dt>
                   2878: <dt><span class="sect1"><a href="#manpage-compression">15.5. Man page compression</a></span></dt>
                   2879: <dt><span class="sect1"><a href="#using-PLIST_SRC">15.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
                   2880: <dt><span class="sect1"><a href="#platform-specific-plist">15.7. Platform-specific and differing PLISTs</a></span></dt>
                   2881: <dt><span class="sect1"><a href="#build-plist">15.8. Build-specific PLISTs</a></span></dt>
                   2882: <dt><span class="sect1"><a href="#faq.common-dirs">15.9. Sharing directories between packages</a></span></dt>
1.106     rillig   2883: </dl></dd>
1.267     rillig   2884: <dt><span class="chapter"><a href="#buildlink">16. Buildlink methodology</a></span></dt>
1.106     rillig   2885: <dd><dl>
1.267     rillig   2886: <dt><span class="sect1"><a href="#converting-to-buildlink3">16.1. Converting packages to use buildlink3</a></span></dt>
                   2887: <dt><span class="sect1"><a href="#creating-buildlink3.mk">16.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106     rillig   2888: <dd><dl>
1.267     rillig   2889: <dt><span class="sect2"><a href="#anatomy-of-bl3">16.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
                   2890: <dt><span class="sect2"><a href="#updating-buildlink-depends">16.2.2. Updating
1.133     wiz      2891:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   2892:       and
                   2893:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   2894:       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.106     rillig   2895: </dl></dd>
1.267     rillig   2896: <dt><span class="sect1"><a href="#writing-builtin.mk">16.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.106     rillig   2897: <dd><dl>
1.267     rillig   2898: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">16.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
                   2899: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">16.3.2. Global preferences for native or pkgsrc software</a></span></dt>
1.106     rillig   2900: </dl></dd>
                   2901: </dl></dd>
1.267     rillig   2902: <dt><span class="chapter"><a href="#pkginstall">17. The pkginstall framework</a></span></dt>
1.106     rillig   2903: <dd><dl>
1.267     rillig   2904: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">17.1. Files and directories outside the installation prefix</a></span></dt>
                   2905: <dd><dl>
                   2906: <dt><span class="sect2"><a href="#dirs-outside-prefix">17.1.1. Directory manipulation</a></span></dt>
                   2907: <dt><span class="sect2"><a href="#files-outside-prefix">17.1.2. File manipulation</a></span></dt>
                   2908: </dl></dd>
                   2909: <dt><span class="sect1"><a href="#conf-files">17.2. Configuration files</a></span></dt>
                   2910: <dd><dl>
                   2911: <dt><span class="sect2"><a href="#conf-files-sysconfdir">17.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
                   2912: <dt><span class="sect2"><a href="#conf-files-configure">17.2.2. Telling the software where configuration files are</a></span></dt>
                   2913: <dt><span class="sect2"><a href="#conf-files-patching">17.2.3. Patching installations</a></span></dt>
                   2914: <dt><span class="sect2"><a href="#conf-files-disable">17.2.4. Disabling handling of configuration files</a></span></dt>
                   2915: </dl></dd>
                   2916: <dt><span class="sect1"><a href="#rcd-scripts">17.3. System startup scripts</a></span></dt>
                   2917: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">17.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
                   2918: <dt><span class="sect1"><a href="#users-and-groups">17.4. System users and groups</a></span></dt>
                   2919: <dt><span class="sect1"><a href="#shells">17.5. System shells</a></span></dt>
                   2920: <dd><dl><dt><span class="sect2"><a href="#shells-disable">17.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   2921: <dt><span class="sect1"><a href="#fonts">17.6. Fonts</a></span></dt>
                   2922: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">17.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
                   2923: </dl></dd>
                   2924: <dt><span class="chapter"><a href="#options">18. Options handling</a></span></dt>
                   2925: <dd><dl>
                   2926: <dt><span class="sect1"><a href="#global-default-options">18.1. Global default options</a></span></dt>
                   2927: <dt><span class="sect1"><a href="#converting-to-options">18.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
                   2928: <dt><span class="sect1"><a href="#option-names">18.3. Option Names</a></span></dt>
                   2929: <dt><span class="sect1"><a href="#option-build">18.4. Determining the options of dependencies</a></span></dt>
                   2930: </dl></dd>
                   2931: <dt><span class="chapter"><a href="#build">19. The build process</a></span></dt>
                   2932: <dd><dl>
                   2933: <dt><span class="sect1"><a href="#build.intro">19.1. Introduction</a></span></dt>
                   2934: <dt><span class="sect1"><a href="#build.prefix">19.2. Program location</a></span></dt>
                   2935: <dt><span class="sect1"><a href="#build.builddirs">19.3. Directories used during the build process</a></span></dt>
                   2936: <dt><span class="sect1"><a href="#build.running">19.4. Running a phase</a></span></dt>
                   2937: <dt><span class="sect1"><a href="#build.fetch">19.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                   2938: <dd><dl>
                   2939: <dt><span class="sect2"><a href="#build.fetch.what">19.5.1. What to fetch and where to get it from</a></span></dt>
                   2940: <dt><span class="sect2"><a href="#build.fetch.how">19.5.2. How are the files fetched?</a></span></dt>
                   2941: </dl></dd>
                   2942: <dt><span class="sect1"><a href="#build.checksum">19.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                   2943: <dt><span class="sect1"><a href="#build.extract">19.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                   2944: <dt><span class="sect1"><a href="#build.patch">19.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                   2945: <dt><span class="sect1"><a href="#build.tools">19.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                   2946: <dt><span class="sect1"><a href="#build.wrapper">19.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                   2947: <dt><span class="sect1"><a href="#build.configure">19.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   2948: <dt><span class="sect1"><a href="#build.build">19.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   2949: <dt><span class="sect1"><a href="#build.test">19.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                   2950: <dt><span class="sect1"><a href="#build.install">19.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   2951: <dt><span class="sect1"><a href="#build.package">19.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
                   2952: <dt><span class="sect1"><a href="#build.clean">19.16. Cleaning up</a></span></dt>
                   2953: <dt><span class="sect1"><a href="#build.helpful-targets">19.17. Other helpful targets</a></span></dt>
                   2954: </dl></dd>
                   2955: <dt><span class="chapter"><a href="#tools">20. Tools needed for building or running</a></span></dt>
                   2956: <dd><dl>
                   2957: <dt><span class="sect1"><a href="#pkgsrc-tools">20.1. Tools for pkgsrc builds</a></span></dt>
                   2958: <dt><span class="sect1"><a href="#package-tools">20.2. Tools needed by packages</a></span></dt>
                   2959: <dt><span class="sect1"><a href="#platform-tools">20.3. Tools provided by platforms</a></span></dt>
                   2960: </dl></dd>
                   2961: <dt><span class="chapter"><a href="#fixes">21. Making your package work</a></span></dt>
                   2962: <dd><dl>
                   2963: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
                   2964: <dd><dl>
                   2965: <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>
                   2966: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
                   2967: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
                   2968: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
                   2969: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
                   2970: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
                   2971: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
                   2972: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
                   2973: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
                   2974: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
                   2975: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                   2976: </dl></dd>
                   2977: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                   2978: <dd><dl>
                   2979: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   2980: <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>
                   2981: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
                   2982: </dl></dd>
                   2983: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   2984: <dd><dl>
                   2985: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
                   2986: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   2987: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
                   2988: </dl></dd>
                   2989: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
                   2990: <dd><dl>
                   2991: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
                   2992: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
                   2993: <dt><span class="sect2"><a href="#perl-scripts">21.4.3. Packages containing perl scripts</a></span></dt>
                   2994: <dt><span class="sect2"><a href="#shell-scripts">21.4.4. Packages containing shell scripts</a></span></dt>
                   2995: <dt><span class="sect2"><a href="#other-programming-languages">21.4.5. Other programming languages</a></span></dt>
                   2996: </dl></dd>
                   2997: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   2998: <dd><dl>
                   2999: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   3000: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.287     rillig   3001: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
                   3002: <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>
                   3003: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.267     rillig   3004: </dl></dd>
                   3005: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   3006: <dd><dl>
                   3007: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
                   3008: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
                   3009: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
                   3010: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
                   3011: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
                   3012: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing perl modules</a></span></dt>
                   3013: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
                   3014: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
                   3015: <dt><span class="sect2"><a href="#gconf-data-files">21.6.9. Packages installing GConf data files</a></span></dt>
                   3016: <dt><span class="sect2"><a href="#scrollkeeper-data-files">21.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
                   3017: <dt><span class="sect2"><a href="#x11-fonts">21.6.11. Packages installing X11 fonts</a></span></dt>
                   3018: <dt><span class="sect2"><a href="#gtk2-modules">21.6.12. Packages installing GTK2 modules</a></span></dt>
                   3019: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.13. Packages installing SGML or XML data</a></span></dt>
                   3020: <dt><span class="sect2"><a href="#mime-database">21.6.14. Packages installing extensions to the MIME database</a></span></dt>
                   3021: <dt><span class="sect2"><a href="#intltool">21.6.15. Packages using intltool</a></span></dt>
                   3022: <dt><span class="sect2"><a href="#startup-scripts">21.6.16. Packages installing startup scripts</a></span></dt>
                   3023: <dt><span class="sect2"><a href="#tex-packages">21.6.17. Packages installing TeX modules</a></span></dt>
                   3024: <dt><span class="sect2"><a href="#emulation-packages">21.6.18. Packages supporting running binaries in
1.87      wiz      3025:     emulation</a></span></dt>
1.267     rillig   3026: <dt><span class="sect2"><a href="#hicolor-theme">21.6.19. Packages installing hicolor theme icons</a></span></dt>
                   3027: <dt><span class="sect2"><a href="#desktop-files">21.6.20. Packages installing desktop files</a></span></dt>
1.77      rillig   3028: </dl></dd>
1.267     rillig   3029: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.77      rillig   3030: </dl></dd>
1.267     rillig   3031: <dt><span class="chapter"><a href="#debug">22. Debugging</a></span></dt>
                   3032: <dt><span class="chapter"><a href="#submit">23. Submitting and Committing</a></span></dt>
1.77      rillig   3033: <dd><dl>
1.267     rillig   3034: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
                   3035: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   3036: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
                   3037: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
                   3038: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
                   3039: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
                   3040: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
                   3041: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
                   3042: </dl></dd>
                   3043: <dt><span class="chapter"><a href="#devfaq">24. Frequently Asked Questions</a></span></dt>
                   3044: <dt><span class="chapter"><a href="#gnome">25. GNOME packaging and porting</a></span></dt>
                   3045: <dd><dl>
                   3046: <dt><span class="sect1"><a href="#meta-packages">25.1. Meta packages</a></span></dt>
                   3047: <dt><span class="sect1"><a href="#new-package">25.2. Packaging a GNOME application</a></span></dt>
                   3048: <dt><span class="sect1"><a href="#full-update">25.3. Updating GNOME to a newer version</a></span></dt>
                   3049: <dt><span class="sect1"><a href="#patching">25.4. Patching guidelines</a></span></dt>
1.85      jmmv     3050: </dl></dd>
1.75      rillig   3051: </dl>
                   3052: </div>
1.77      rillig   3053: </div>
1.148     asau     3054: <div class="chapter">
1.77      rillig   3055: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   3056: <a name="help-devel"></a>Chapter 11. Getting help</h2></div></div></div>
                   3057: <p>
                   3058:        To get help when developing pkgsrc, the definitive source is this
                   3059:        document, the pkgsrc guide. If you don't find anything here,
                   3060:        there are alternatives:
                   3061: </p>
                   3062: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   3063: <li class="listitem">
                   3064: <p>
                   3065:        The built-in pkgsrc help, which is available after bootstrapping
                   3066:        pkgsrc. Run <span class="command"><strong>bmake help topic=&#8230;</strong></span> to get
                   3067:        help for any topic, such as a variable name like
                   3068:        <code class="varname">BUILD_DEFS</code>, a make target like
                   3069:        <span class="command"><strong>do-build</strong></span>, a missing C or C++ function like
                   3070:        <span class="command"><strong>strcasecmp</strong></span> or any other topic.</p>
                   3071: <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>
                   3072: </li>
                   3073: <li class="listitem"><p>
1.278     rillig   3074:        To see the value of a single variable, run <span class="command"><strong>bmake
                   3075:        show-var VARNAME=<em class="replaceable"><code>X</code></em></strong></span>.
                   3076: </p></li>
                   3077: <li class="listitem"><p>
                   3078:        To see the values of the most common variables, run
                   3079:        <span class="command"><strong>bmake show-all</strong></span>. These variables are grouped by
                   3080:        topic. To see the variables for a single topic, run
                   3081:        <span class="command"><strong>bmake
                   3082:        show-all-<em class="replaceable"><code>topic</code></em></strong></span>, for example
                   3083:        <span class="command"><strong>bmake show-all-fetch</strong></span>.
                   3084: </p></li>
                   3085: <li class="listitem"><p>
1.267     rillig   3086:        The tech-pkg mailing list, to which
                   3087:        <a class="ulink" href="https://www.NetBSD.org/mailinglists/#tech-pkg" target="_top">you
                   3088:        can subscribe</a> and then <a class="ulink" href="mailto:tech-pkg@NetBSD.org" target="_top">ask your
                   3089:        questions</a>.</p></li>
                   3090: <li class="listitem"><p>The #pkgsrc IRC channel, which is accessible
                   3091:        <a class="ulink" href="https://webchat.freenode.net/" target="_top">via a web browser</a>
                   3092:        or by using a specialized chat program such as
                   3093:        <a class="ulink" href="http://xchat.org/" target="_top">XChat</a>.
                   3094:        Pick any user name and join the channel #pkgsrc.</p></li>
                   3095: </ul></div>
                   3096: </div>
                   3097: <div class="chapter">
                   3098: <div class="titlepage"><div><div><h2 class="title">
                   3099: <a name="creating"></a>Chapter 12. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.91      rillig   3100: <div class="toc">
                   3101: <p><b>Table of Contents</b></p>
1.210     leot     3102: <dl class="toc">
1.267     rillig   3103: <dt><span class="sect1"><a href="#creating.common">12.1. Common types of packages</a></span></dt>
1.91      rillig   3104: <dd><dl>
1.267     rillig   3105: <dt><span class="sect2"><a href="#creating.perl-module">12.1.1. Perl modules</a></span></dt>
                   3106: <dt><span class="sect2"><a href="#creating.python-module">12.1.2. Python modules and programs</a></span></dt>
1.275     brook    3107: <dt><span class="sect2"><a href="#creating.R-package">12.1.3. R packages</a></span></dt>
                   3108: <dt><span class="sect2"><a href="#creating.TeX-package">12.1.4. TeXlive packages</a></span></dt>
1.91      rillig   3109: </dl></dd>
1.267     rillig   3110: <dt><span class="sect1"><a href="#creating.examples">12.2. Examples</a></span></dt>
                   3111: <dd><dl><dt><span class="sect2"><a href="#creating.nvu">12.2.1. How the www/nvu package came into pkgsrc</a></span></dt></dl></dd>
1.91      rillig   3112: </dl>
                   3113: </div>
1.77      rillig   3114: <p>When you find a package that is not yet in pkgsrc, you
1.91      rillig   3115: most likely have a URL from where you can download the source
                   3116: code. Starting with this URL, creating a package involves only a
                   3117: few steps.</p>
1.128     wiz      3118: <div class="procedure"><ol class="procedure" type="1">
1.250     leot     3119: <li class="step"><p>First, install the packages <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a> and <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>.</p></li>
1.148     asau     3120: <li class="step"><p>Then, choose one of the top-level directories as the
1.91      rillig   3121: category in which you want to place your package. You can also create a
                   3122: directory of your own (maybe called <code class="filename">local</code>). In that
                   3123: category directory, create another directory for your package and change
                   3124: into it.</p></li>
1.148     asau     3125: <li class="step"><p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
1.91      rillig   3126: you for a URL. Enter the URL of the distribution file (in most cases a
                   3127: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
                   3128: of your package are created automatically. The distribution file is
                   3129: extracted automatically to fill in some details in the
                   3130: <code class="filename">Makefile</code> that would otherwise have to be done
                   3131: manually.</p></li>
1.148     asau     3132: <li class="step">
1.91      rillig   3133: <p>Examine the extracted files to determine the dependencies of
                   3134: your package. Ideally, this is mentioned in some
                   3135: <code class="filename">README</code> file, but things may differ. For each of
                   3136: these dependencies, look where it exists in pkgsrc, and if there is a
                   3137: file called <code class="filename">buildlink3.mk</code> in that directory, add a
                   3138: line to your package <code class="filename">Makefile</code> which includes that
                   3139: file just before the last line. If the
1.132     spz      3140: <code class="filename">buildlink3.mk</code> file does not exist, it must be
1.276     leot     3141: created first. The <code class="filename">buildlink3.mk</code> file makes sure
                   3142: that the package's include files and libraries are provided.</p>
1.132     spz      3143: <p>If you just need binaries from a package, add a
1.91      rillig   3144: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
                   3145: version of the dependency and where it can be found in pkgsrc. This line
                   3146: should be placed in the third paragraph. If the dependency is only
                   3147: needed for building the package, but not when using it, use
1.269     leot     3148: <code class="varname">TOOL_DEPENDS</code> or <code class="varname">BUILD_DEPENDS</code>
                   3149: instead of <code class="varname">DEPENDS</code>.
                   3150: The difference between <code class="varname">TOOL_DEPENDS</code> and
                   3151: <code class="varname">BUILD_DEPENDS</code> occurs when cross-compiling:
                   3152: <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
                   3153: packages, i.e. packages for the architecture where the package
                   3154: is built;
                   3155: <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
                   3156: packages, i.e. packages for the architecture for which the package
1.290     gutterid 3157: is built. There is also <code class="varname">TEST_DEPENDS</code>, which is used
                   3158: to specify a dependency used only for testing the resulting package
                   3159: built, using the upstream project's included test suite.
1.91      rillig   3160: Your package may then look like this:</p>
1.77      rillig   3161: <pre class="programlisting">
1.100     rillig   3162: [...]
1.77      rillig   3163: 
1.269     leot     3164: TOOL_DEPENDS+=  libxslt-[0-9]*:../../textproc/libxslt
1.100     rillig   3165: DEPENDS+=       screen-[0-9]*:../../misc/screen
                   3166: DEPENDS+=       screen&gt;=4.0:../../misc/screen
1.77      rillig   3167: 
1.100     rillig   3168: [...]
1.77      rillig   3169: 
1.100     rillig   3170: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
                   3171: .include "../../devel/glib2/buildlink3.mk"
                   3172: .include "../../mk/bsd.pkg.mk"
1.77      rillig   3173: </pre>
                   3174: </li>
1.148     asau     3175: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
1.128     wiz      3176: to be done to make your package a <span class="quote">&#8220;<span class="quote">good</span>&#8221;</span> one. If you don't
1.110     hubertf  3177: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
                   3178: --explain</strong></span> or <span class="command"><strong>pkglint
1.91      rillig   3179: -e</strong></span>, which outputs additional
                   3180: explanations.</p></li>
1.148     asau     3181: <li class="step"><p>In many cases the package is not yet ready to build. You can
1.267     rillig   3182: find instructions for the most common cases in the next section, <a class="xref" href="#creating.common" title="12.1. Common types of packages">Section 12.1, &#8220;Common types of packages&#8221;</a>. After you have followed the instructions
1.91      rillig   3183: over there, you can hopefully continue here.</p></li>
1.148     asau     3184: <li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
1.91      rillig   3185: directory from the extracted files. Besides these files, a lot of cache
                   3186: files and other system information has been saved in the working
                   3187: directory, which may become wrong after you edited the
                   3188: <code class="filename">Makefile</code>.</p></li>
1.148     asau     3189: <li class="step"><p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
1.267     rillig   3190: 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></li>
1.148     asau     3191: <li class="step"><p>When the package builds fine, the next step is to install
1.110     hubertf  3192: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
1.91      rillig   3193: everything works.</p></li>
1.148     asau     3194: <li class="step"><p>Up to now, the file <code class="filename">PLIST</code>, which
1.91      rillig   3195: contains a list of the files that are installed by the package, is
1.110     hubertf  3196: nearly empty. Run <span class="command"><strong>bmake print-PLIST
1.91      rillig   3197: &gt;PLIST</strong></span> to generate a probably correct list. Check
                   3198: the file using your preferred text editor to see if the list of
                   3199: files looks plausible.</p></li>
1.148     asau     3200: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
1.91      rillig   3201: <code class="filename">PLIST</code> contains garbage or not.</p></li>
1.148     asau     3202: <li class="step"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
1.91      rillig   3203: has been registered in the database of installed files, but with an
1.110     hubertf  3204: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
                   3205: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
1.91      rillig   3206: registered with the list of files from
                   3207: <code class="filename">PLIST</code>.</p></li>
1.148     asau     3208: <li class="step"><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
1.91      rillig   3209: package from the set of installed files.</p></li>
1.77      rillig   3210: </ol></div>
1.148     asau     3211: <div class="sect1">
1.91      rillig   3212: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   3213: <a name="creating.common"></a>12.1. Common types of packages</h2></div></div></div>
1.148     asau     3214: <div class="sect2">
1.91      rillig   3215: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   3216: <a name="creating.perl-module"></a>12.1.1. Perl modules</h3></div></div></div>
1.91      rillig   3217: <p>Simple Perl modules are handled automatically by
1.110     hubertf  3218: <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
1.91      rillig   3219: </div>
1.148     asau     3220: <div class="sect2">
1.91      rillig   3221: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   3222: <a name="creating.python-module"></a>12.1.2. Python modules and programs</h3></div></div></div>
1.118     imil     3223: <p>Python modules and programs packages are easily created using a
                   3224: set of predefined variables.</p>
                   3225: <p>
1.171     wiz      3226: If some Python versions are not supported by the software, set the
                   3227: <code class="varname">PYTHON_VERSIONS_INCOMPATIBLE</code> variable to the Python versions
                   3228: that are not supported, e.g.
1.118     imil     3229: </p>
                   3230: <pre class="programlisting">
1.203     sevan    3231: PYTHON_VERSIONS_INCOMPATIBLE=       27
1.118     imil     3232: </pre>
                   3233: <p>
1.213     wiz      3234: If the packaged software is a Python module, include one of
                   3235: <code class="filename">../../lang/python/egg.mk</code>,
                   3236: <code class="filename">../../lang/python/distutils.mk</code>, or
                   3237: <code class="filename">../../lang/python/extension.mk</code>.</p>
                   3238: <p>Most Python packages use either <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span> or
                   3239: easy-setup/setuptools (<span class="quote">&#8220;<span class="quote">eggs</span>&#8221;</span>).
1.290     gutterid 3240: If the packaged software is using setuptools, you only need
1.213     wiz      3241: to include <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>&#8221;</span>.
                   3242: Otherwise, if the software uses <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span>, include 
1.290     gutterid 3243: <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/distutils.mk</code></span>&#8221;</span>,
1.213     wiz      3244: so pkgsrc will use this framework.
1.290     gutterid 3245: <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span> uses a script called <code class="filename">setup.py</code>;
1.213     wiz      3246: if the <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span> driver is not called
                   3247: <code class="filename">setup.py</code>, set the <code class="varname">PYSETUP</code> variable
                   3248: to the name of the script.</p>
                   3249: <p>Either way, the package directory should be called
1.128     wiz      3250: <span class="quote">&#8220;<span class="quote">py-software</span>&#8221;</span> and <code class="varname">PKGNAME</code> should be set to
                   3251: <span class="quote">&#8220;<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>&#8221;</span>, e.g.
1.118     imil     3252: </p>
                   3253: <pre class="programlisting">
                   3254: DISTNAME=   foopymodule-1.2.10
                   3255: PKGNAME=    ${PYPKGPREFIX}-${DISTNAME}
                   3256: </pre>
1.171     wiz      3257: <p>If it is an application, include
                   3258: <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>&#8221;</span>.
                   3259: In order to correctly set the path to the Python interpreter, use the
1.118     imil     3260: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
1.142     wiz      3261: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
1.171     wiz      3262: For example:
1.118     imil     3263: </p>
                   3264: <pre class="programlisting">
1.142     wiz      3265: REPLACE_PYTHON=   *.py
1.118     imil     3266: </pre>
1.171     wiz      3267: <p>Some Python modules have separate distributions for Python-2.x
                   3268: and Python-3.x support. In pkgsrc this is handled by the
                   3269: <code class="filename">versioned_dependencies.mk</code> file. Set
                   3270: <code class="varname">PYTHON_VERSIONED_DEPENDENCIES</code> to the list of
                   3271: packages that should be depended upon and include
                   3272: <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/versioned_dependencies.mk</code></span>&#8221;</span>,
                   3273: then the pkgsrc infrastructure will depend on the appropriate package
                   3274: version. For example:
                   3275: </p>
                   3276: <pre class="programlisting">
1.248     wiz      3277: PYTHON_VERSIONED_DEPENDENCIES=dialog
1.171     wiz      3278: </pre>
                   3279: <p>
                   3280: Look inside <code class="filename">versioned_dependencies.mk</code> for a list
                   3281: of supported packages.</p>
1.118     imil     3282: </div>
1.275     brook    3283: <div class="sect2">
                   3284: <div class="titlepage"><div><div><h3 class="title">
                   3285: <a name="creating.R-package"></a>12.1.3. R packages</h3></div></div></div>
                   3286: <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>
                   3287: are handled automatically by <span class="command"><strong>R2pkg</strong></span>, which is
                   3288: 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>.
                   3289: Individual packages (and optionally their dependencies) may be created
                   3290: and updated.  R packages generally follow the same form, and most of
                   3291: the relevant information needed is contained in a
                   3292: <code class="filename">DESCRIPTION</code> file as part of each R package on
                   3293: <a class="ulink" href="https://cran.r-project.org/web/packages/available_packages_by_name.html" target="_top">CRAN</a>.
                   3294: Consequently, <span class="command"><strong>R2pkg</strong></span> downloads that information and
                   3295: creates or updates a package in the canonical form.  The resulting
                   3296: package should be reviewed for correctness.</p>
                   3297: </div>
                   3298: <div class="sect2">
                   3299: <div class="titlepage"><div><div><h3 class="title">
                   3300: <a name="creating.TeX-package"></a>12.1.4. TeXlive packages</h3></div></div></div>
                   3301: <p>TeXlive packages from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> are handled automatically by
                   3302: <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>
                   3303: <p>If the TeXlive package name is not known, it may be useful to
                   3304: search <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>.  A
                   3305: <span class="quote">&#8220;<span class="quote">Contained in</span>&#8221;</span> field on the package page typically
                   3306: 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
                   3307: archive</a>.</p>
                   3308: <p>If the TeXlive package name is known, download the files from
                   3309: the <a class="ulink" href="https://www.ctan.org/tex-archive/systems/texlive/tlnet/archive" target="_top">TeXlive
                   3310: archive</a>.  For package <code class="filename">foo</code>, you will need
                   3311: to download <code class="filename">foo.tar.xz</code>.  Most TeXlive packages
                   3312: also have associated documentation packages, so download
                   3313: <code class="filename">foo.doc.tar.xz</code> at the same time.  These files
                   3314: should be placed in the appropriate category directory, which is often
                   3315: but not always <code class="filename">print</code>.  Then run the following
                   3316: command in the category directory.</p>
                   3317: <pre class="programlisting">
                   3318: texlive2pkg foo.tar.xz foo.doc.tar.xz
                   3319: </pre>
                   3320: <p>This will create two packages, <code class="filename">tex-foo</code> and
                   3321: <code class="filename">tex-foo-doc</code>.  Be sure to check that both packages
                   3322: are correct.</p>
                   3323: <p>Finally, <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>
                   3324: currently does not include version information in package filenames
                   3325: and changes their contents periodically when updates occur.
                   3326: Consequently, pkgsrc avoids downloading distfiles directly from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> and instead relies on the
                   3327: pkgsrc archives.  For each new or updated TeXlive package, e.g., the
                   3328: main one and the corresponding documentation, upload the distfiles
                   3329: with the following command in each package directory.</p>
                   3330: <pre class="programlisting">
                   3331: make upload-distfiles
                   3332: </pre>
                   3333: </div>
1.91      rillig   3334: </div>
1.148     asau     3335: <div class="sect1">
1.91      rillig   3336: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   3337: <a name="creating.examples"></a>12.2. Examples</h2></div></div></div>
1.148     asau     3338: <div class="sect2">
1.91      rillig   3339: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   3340: <a name="creating.nvu"></a>12.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
1.148     asau     3341: <div class="sect3">
1.91      rillig   3342: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   3343: <a name="creating.nvu.init"></a>12.2.1.1. The initial package</h4></div></div></div>
1.91      rillig   3344: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
1.128     wiz      3345: that the <span class="quote">&#8220;<span class="quote">nvu</span>&#8221;</span> package has not yet been imported into
1.91      rillig   3346: pkgsrc. As the description says it has to do with the web, the obvious
1.128     wiz      3347: choice for the category is <span class="quote">&#8220;<span class="quote">www</span>&#8221;</span>.</p>
1.91      rillig   3348: <pre class="programlisting">
1.100     rillig   3349: <code class="prompt">$</code> mkdir www/nvu
                   3350: <code class="prompt">$</code> cd www/nvu
1.91      rillig   3351: </pre>
                   3352: <p>The web site says that the sources are available as a tar file, so
1.110     hubertf  3353: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
1.91      rillig   3354: <pre class="programlisting">
1.100     rillig   3355: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
1.91      rillig   3356: </pre>
                   3357: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
                   3358: below the <code class="varname">DISTNAME</code> line, as the package name should
1.128     wiz      3359: not have the word <span class="quote">&#8220;<span class="quote">sources</span>&#8221;</span> in it. I also filled in the
1.91      rillig   3360: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
                   3361: <code class="varname">COMMENT</code> fields. Then the package
                   3362: <code class="filename">Makefile</code> looked like that:</p>
                   3363: <pre class="programlisting">
1.233     sevan    3364: # $NetBSD $
1.100     rillig   3365: #
1.91      rillig   3366: 
1.100     rillig   3367: DISTNAME=       nvu-1.0-sources
                   3368: PKGNAME=        nvu-1.0
                   3369: CATEGORIES=     www
                   3370: MASTER_SITES=   http://cvs.nvu.com/download/
                   3371: EXTRACT_SUFX=   .tar.bz2
                   3372: 
                   3373: MAINTAINER=     rillig@NetBSD.org
                   3374: HOMEPAGE=       http://cvs.nvu.com/
                   3375: COMMENT=        Web Authoring System
1.91      rillig   3376: 
1.100     rillig   3377: # url2pkg-marker (please do not remove this line.)
                   3378: .include "../../mk/bsd.pkg.mk"
1.91      rillig   3379: </pre>
1.237     wiz      3380: <p>On the first line of output above, an artificial space has been added between NetBSD and $,
1.233     sevan    3381: this is a workaround to prevent CVS expanding to the filename of the
                   3382: guide.</p>
1.91      rillig   3383: <p>Then, I quit the editor and watched pkgsrc downloading a large
                   3384: source archive:</p>
                   3385: <pre class="programlisting">
1.100     rillig   3386: url2pkg&gt; Running "make makesum" ...
                   3387: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   3388: =&gt; Fetching nvu-1.0-sources.tar.bz2
                   3389: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
                   3390: 100% |*************************************| 28992 KB  150.77 KB/s00:00 ETA
                   3391: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
                   3392: url2pkg&gt; Running "make extract" ...
                   3393: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   3394: =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   3395: =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   3396: work.bacc -&gt; /tmp/roland/pkgsrc/www/nvu/work.bacc
                   3397: ===&gt; Installing dependencies for nvu-1.0
                   3398: ===&gt; Overriding tools for nvu-1.0
                   3399: ===&gt; Extracting for nvu-1.0
                   3400: url2pkg&gt; Adjusting the Makefile.
1.91      rillig   3401: 
1.100     rillig   3402: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
1.91      rillig   3403: 
1.100     rillig   3404: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
1.91      rillig   3405: </pre>
                   3406: </div>
1.148     asau     3407: <div class="sect3">
1.91      rillig   3408: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   3409: <a name="creating.nvu.problems"></a>12.2.1.2. Fixing all kinds of problems to make the package work</h4></div></div></div>
1.91      rillig   3410: <p>Now that the package has been extracted, let's see what's inside
                   3411: it. The package has a <code class="filename">README.txt</code>, but that only
                   3412: says something about mozilla, so it's probably useless for seeing what
                   3413: dependencies this package has. But since there is a GNU configure script
                   3414: in the package, let's hope that it will complain about everything it
                   3415: needs.</p>
                   3416: <pre class="programlisting">
1.100     rillig   3417: <code class="prompt">$</code> bmake
                   3418: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   3419: =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   3420: =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   3421: ===&gt; Patching for nvu-1.0
                   3422: ===&gt; Creating toolchain wrappers for nvu-1.0
                   3423: ===&gt; Configuring for nvu-1.0
                   3424: [...]
                   3425: configure: error: Perl 5.004 or higher is required.
                   3426: [...]
                   3427: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
                   3428: [...]
1.91      rillig   3429: </pre>
                   3430: <p>That worked quite well. So I opened the package Makefile in my
                   3431: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
1.128     wiz      3432: just appended <span class="quote">&#8220;<span class="quote">perl</span>&#8221;</span> to it. Since the dependencies of the
1.91      rillig   3433: package have changed now, and since a perl wrapper is automatically
1.128     wiz      3434: installed in the <span class="quote">&#8220;<span class="quote">tools</span>&#8221;</span> phase, I need to build the package
1.91      rillig   3435: from scratch.</p>
                   3436: <pre class="programlisting">
1.100     rillig   3437: <code class="prompt">$</code> bmake clean
                   3438: ===&gt; Cleaning for nvu-1.0
                   3439: <code class="prompt">$</code> bmake
                   3440: [...]
                   3441: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
                   3442: GNU Make.  You will not be able to build Mozilla without GNU Make.
                   3443: [...]
1.91      rillig   3444: </pre>
1.128     wiz      3445: <p>So I added <span class="quote">&#8220;<span class="quote">gmake</span>&#8221;</span> to the
1.91      rillig   3446: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
                   3447: <pre class="programlisting">
1.100     rillig   3448: [...]
                   3449: checking for GTK - version &gt;= 1.2.0... no
                   3450: *** Could not run GTK test program, checking why...
                   3451: [...]
1.91      rillig   3452: </pre>
                   3453: <p>Now to the other dependencies. The first question is: Where is the
                   3454: GTK package hidden in pkgsrc?</p>
                   3455: <pre class="programlisting">
1.100     rillig   3456: <code class="prompt">$</code> echo ../../*/gtk*
                   3457: [many packages ...]
                   3458: <code class="prompt">$</code> echo ../../*/gtk
                   3459: ../../x11/gtk
                   3460: <code class="prompt">$</code> echo ../../*/gtk2
                   3461: ../../x11/gtk2
                   3462: <code class="prompt">$</code> echo ../../*/gtk2/bui*
                   3463: ../../x11/gtk2/buildlink3.mk
1.91      rillig   3464: </pre>
                   3465: <p>The first try was definitely too broad. The second one had exactly
                   3466: one result, which is very good. But there is one pitfall with GNOME
                   3467: packages. Before GNOME 2 had been released, there were already many
                   3468: GNOME 1 packages in pkgsrc. To be able to continue to use these
                   3469: packages, the GNOME 2 packages were imported as separate packages, and
1.128     wiz      3470: their names usually have a <span class="quote">&#8220;<span class="quote">2</span>&#8221;</span> appended. So I checked
1.91      rillig   3471: whether this was the case here, and indeed it was.</p>
                   3472: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
                   3473: file, adding the dependency is very easy. I just inserted an
                   3474: <code class="literal">.include</code> line before the last line of the package
                   3475: <code class="filename">Makefile</code>, so that it now looks like this:</p>
                   3476: <pre class="programlisting">
1.100     rillig   3477: [...]
                   3478: .include "../../x11/gtk2/buildlink3.mk"
                   3479: .include "../../mk/bsd.pkg.mk
1.91      rillig   3480: </pre>
1.110     hubertf  3481: <p>After another <span class="command"><strong>bmake clean &amp;&amp; bmake</strong></span>, the answer
1.91      rillig   3482: was:</p>
                   3483: <pre class="programlisting">
1.100     rillig   3484: [...]
                   3485: checking for gtk-config... /home/roland/pkg/bin/gtk-config
                   3486: checking for GTK - version &gt;= 1.2.0... no
                   3487: *** Could not run GTK test program, checking why...
                   3488: *** The test program failed to compile or link. See the file config.log for the
                   3489: *** exact error that occured. This usually means GTK was incorrectly installed
                   3490: *** or that you have moved GTK since it was installed. In the latter case, you
                   3491: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
                   3492: configure: error: Test for GTK failed.
                   3493: [...]
1.91      rillig   3494: </pre>
1.128     wiz      3495: <p>In this particular case, the assumption that <span class="quote">&#8220;<span class="quote">every package
                   3496: prefers GNOME 2</span>&#8221;</span> had been wrong. The first of the lines above
1.91      rillig   3497: told me that this package really wanted to have the GNOME 1 version of
                   3498: GTK. If the package had looked for GTK2, it would have looked for
1.110     hubertf  3499: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
1.91      rillig   3500: So I changed the <code class="literal">x11/gtk2</code> to
                   3501: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
                   3502: and tried again.</p>
                   3503: <pre class="programlisting">
1.100     rillig   3504: [...]
1.166     jnemeth  3505: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\"  [...]
1.100     rillig   3506: In file included from xpidl.c:42:
                   3507: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
                   3508: In file included from xpidl.c:42:
                   3509: xpidl.h:132: error: parse error before "IDL_ns"
                   3510: [...]
1.91      rillig   3511: </pre>
                   3512: <p>The package still does not find all of its dependencies. Now the
                   3513: question is: Which package provides the
                   3514: <code class="filename">libIDL/IDL.h</code> header file?</p>
                   3515: <pre class="programlisting">
1.100     rillig   3516: <code class="prompt">$</code> echo ../../*/*idl*
                   3517: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
                   3518: <code class="prompt">$</code> echo ../../*/*IDL*
                   3519: ../../net/libIDL
1.91      rillig   3520: </pre>
                   3521: <p>Let's take the one from the second try. So I included the
                   3522: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
                   3523: again. But the error didn't change. After digging through some of the
                   3524: code, I concluded that the build process of the package was broken and
                   3525: couldn't have ever worked, but since the Mozilla source tree is quite
                   3526: large, I didn't want to fix it. So I added the following to the package
                   3527: <code class="filename">Makefile</code> and tried again:</p>
                   3528: <pre class="programlisting">
1.100     rillig   3529: CPPFLAGS+=              -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
1.252     leot     3530: BUILDLINK_TRANSFORM+=   l:IDL:IDL-2
1.91      rillig   3531: </pre>
                   3532: <p>The latter line is needed because the package expects the library
                   3533: <code class="filename">libIDL.so</code>, but only
                   3534: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
                   3535: wrapper to rewrite that on the fly.</p>
                   3536: <p>The next problem was related to a recent change of the FreeType
1.250     leot     3537: 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>
1.91      rillig   3538: which patch files were relevant for this issue and copied them to the
                   3539: <code class="filename">patches</code> directory. Then I retried, fixed the
                   3540: patches so that they applied cleanly and retried again. This time,
                   3541: everything worked.</p>
                   3542: </div>
1.148     asau     3543: <div class="sect3">
1.91      rillig   3544: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   3545: <a name="creating.nvu.inst"></a>12.2.1.3. Installing the package</h4></div></div></div>
1.91      rillig   3546: <pre class="programlisting">
1.100     rillig   3547: <code class="prompt">$</code> bmake CHECK_FILES=no install
                   3548: [...]
                   3549: <code class="prompt">$</code> bmake print-PLIST &gt;PLIST
                   3550: <code class="prompt">$</code> bmake deinstall
                   3551: <code class="prompt">$</code> bmake install
1.91      rillig   3552: </pre>
                   3553: </div>
                   3554: </div>
                   3555: </div>
1.77      rillig   3556: </div>
1.148     asau     3557: <div class="chapter">
1.75      rillig   3558: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   3559: <a name="components"></a>Chapter 13. Package components - files, directories and contents</h2></div></div></div>
1.75      rillig   3560: <div class="toc">
                   3561: <p><b>Table of Contents</b></p>
1.210     leot     3562: <dl class="toc">
1.267     rillig   3563: <dt><span class="sect1"><a href="#components.Makefile">13.1. <code class="filename">Makefile</code></a></span></dt>
                   3564: <dt><span class="sect1"><a href="#components.distinfo">13.2. <code class="filename">distinfo</code></a></span></dt>
                   3565: <dt><span class="sect1"><a href="#components.patches">13.3. <code class="filename">patches/*</code></a></span></dt>
                   3566: <dd><dl>
                   3567: <dt><span class="sect2"><a href="#components.patch.structure">13.3.1. Structure of a single patch file</a></span></dt>
                   3568: <dt><span class="sect2"><a href="#components.patches.caveats">13.3.2. Creating patch files</a></span></dt>
                   3569: <dt><span class="sect2"><a href="#components.patches.sources">13.3.3. Sources where the patch files come from</a></span></dt>
                   3570: <dt><span class="sect2"><a href="#components.patches.guidelines">13.3.4. Patching guidelines</a></span></dt>
                   3571: <dt><span class="sect2"><a href="#components.patches.feedback">13.3.5. Feedback to the author</a></span></dt>
                   3572: </dl></dd>
                   3573: <dt><span class="sect1"><a href="#other-mandatory-files">13.4. Other mandatory files</a></span></dt>
                   3574: <dt><span class="sect1"><a href="#components.optional">13.5. Optional files</a></span></dt>
                   3575: <dd><dl>
                   3576: <dt><span class="sect2"><a href="#components.optional.bin">13.5.1. Files affecting the binary package</a></span></dt>
                   3577: <dt><span class="sect2"><a href="#components.optional.build">13.5.2. Files affecting the build process</a></span></dt>
                   3578: <dt><span class="sect2"><a href="#components.optional.none">13.5.3. Files affecting nothing at all</a></span></dt>
1.78      rillig   3579: </dl></dd>
1.267     rillig   3580: <dt><span class="sect1"><a href="#work-dir">13.6. <code class="filename">work*</code></a></span></dt>
                   3581: <dt><span class="sect1"><a href="#files-dir">13.7. <code class="filename">files/*</code></a></span></dt>
1.75      rillig   3582: </dl>
                   3583: </div>
1.87      wiz      3584: <p>Whenever you're preparing a package, there are a number of
                   3585: files involved which are described in the following
                   3586: sections.</p>
1.148     asau     3587: <div class="sect1">
1.75      rillig   3588: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   3589: <a name="components.Makefile"></a>13.1. <code class="filename">Makefile</code>
1.93      rillig   3590: </h2></div></div></div>
1.75      rillig   3591: <p>Building, installation and creation of a binary package are all
1.87      wiz      3592:   controlled by the package's <code class="filename">Makefile</code>.
                   3593:   The <code class="filename">Makefile</code> describes various things about
                   3594:   a package, for example from where to get it, how to configure,
                   3595:   build, and install it.</p>
1.76      rillig   3596: <p>A package <code class="filename">Makefile</code> contains several
1.87      wiz      3597:   sections that describe the package.</p>
1.75      rillig   3598: <p>In the first section there are the following variables, which
1.87      wiz      3599:   should appear exactly in the order given here.  The order and
                   3600:   grouping of the variables is mostly historical and has no further
                   3601:   meaning.</p>
1.148     asau     3602: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      3603: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
1.87      wiz      3604:     distribution file to be downloaded from the package's
                   3605:     website.</p></li>
1.128     wiz      3606: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
1.174     asau     3607:     package, as used by pkgsrc. You need to provide it if
1.87      wiz      3608:     <code class="varname">DISTNAME</code> (which is the default) is not a good
1.174     asau     3609:     name for the package in pkgsrc or <code class="varname">DISTNAME</code> is not
                   3610:     provided (no distribution file is required).  Usually it is the pkgsrc
1.87      wiz      3611:     directory name together with the version number. It must match the
                   3612:     regular expression
                   3613:     <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
                   3614:     starts with a letter or digit, and contains only letters, digits,
                   3615:     dashes, underscores, dots and plus signs.</p></li>
1.128     wiz      3616: <li class="listitem">
1.75      rillig   3617: <p><code class="varname">CATEGORIES</code> is a list of categories
1.87      wiz      3618:     which the package fits in. You can choose any of the top-level
                   3619:     directories of pkgsrc for it.</p>
1.75      rillig   3620: <p>Currently the following values are available for
1.87      wiz      3621:     <code class="varname">CATEGORIES</code>. If more than
                   3622:     one is used, they need to be separated by spaces:</p>
1.75      rillig   3623: <pre class="programlisting">
1.100     rillig   3624: archivers     cross         geography     meta-pkgs     security
                   3625: audio         databases     graphics      misc          shells
                   3626: benchmarks    devel         ham           multimedia    sysutils
                   3627: biology       editors       inputmethod   net           textproc
                   3628: cad           emulators     lang          news          time
                   3629: chat          finance       mail          parallel      wm
                   3630: comms         fonts         math          pkgtools      www
                   3631: converters    games         mbone         print         x11
                   3632: </pre>
1.75      rillig   3633: </li>
1.128     wiz      3634: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
1.87      wiz      3635:     <code class="varname">DYNAMIC_MASTER_SITES</code>,
                   3636:     <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
                   3637:     and <code class="varname">DISTFILES</code> are discussed in detail in
1.267     rillig   3638:     <a class="xref" href="#build.fetch" title="19.5. The fetch phase">Section 19.5, &#8220;The <span class="emphasis"><em>fetch</em></span> phase&#8221;</a>.</p></li>
1.75      rillig   3639: </ul></div>
                   3640: <p>The second section contains information about separately
1.87      wiz      3641:   downloaded patches, if any.
                   3642:   </p>
1.148     asau     3643: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.190     wiz      3644: <li class="listitem"><p><code class="varname">PATCHFILES</code>:
1.87      wiz      3645:     Name(s) of additional files that contain distribution patches.
                   3646:     There is no default. pkgsrc will look for them at
                   3647:     <code class="varname">PATCH_SITES</code>.
                   3648:     They will automatically be uncompressed before patching if
                   3649:     the names end with <code class="filename">.gz</code> or
                   3650:     <code class="filename">.Z</code>.</p></li>
1.128     wiz      3651: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
1.87      wiz      3652:     Primary location(s) for distribution patch files (see
1.190     wiz      3653:     <code class="varname">PATCHFILES</code> above) if not found locally.</p></li>
                   3654: <li class="listitem"><p><code class="varname">PATCH_DIST_STRIP</code>:
1.289     leot     3655:     an argument to <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?patch+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> that sets the pathname strip count to
1.190     wiz      3656:     help find the correct files to patch. It defaults to
                   3657:     <span class="command"><strong>-p0</strong></span>.</p></li>
1.75      rillig   3658: </ul></div>
                   3659: <p>The third section contains the following variables.
1.87      wiz      3660:   </p>
1.148     asau     3661: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      3662: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email
1.114     jmcneill 3663:     address of the person who feels responsible for this package,
                   3664:     and who is most likely to look at problems or questions regarding
1.289     leot     3665:     this package which have been reported with <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a>.
1.114     jmcneill 3666:     Other developers may contact the <code class="varname">MAINTAINER</code>
                   3667:     before making changes to the package, but are not required to
                   3668:     do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
                   3669:     to yourself. If you really can't maintain the package for future
                   3670:     updates, set it to
1.110     hubertf  3671:     <code class="email">&lt;<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>&gt;</code>.</p></li>
1.128     wiz      3672: <li class="listitem"><p><code class="varname">OWNER</code> should be used instead
1.114     jmcneill 3673:     of <code class="varname">MAINTAINER</code> when you do not want other
                   3674:     developers to update or change the package without contacting
                   3675:     you first. A package Makefile should contain one of
                   3676:     <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
                   3677:     not both.  </p></li>
1.128     wiz      3678: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
1.87      wiz      3679:     find more information about the package.</p></li>
1.128     wiz      3680: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
1.87      wiz      3681:     description of the package (should not include the package
                   3682:     name).</p></li>
1.234     leot     3683: <li class="listitem"><p><code class="varname">LICENSE</code> indicates the license(s)
1.267     rillig   3684:     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>
1.75      rillig   3685: </ul></div>
                   3686: <p>Other variables that affect the build:
1.87      wiz      3687:   </p>
1.148     asau     3688: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.75      rillig   3689: <p><code class="varname">WRKSRC</code>: The directory where the
1.87      wiz      3690:       interesting distribution files of the package are found. The
                   3691:       default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
                   3692:       works for most packages.</p>
1.75      rillig   3693: <p>If a package doesn't create a subdirectory for itself
1.87      wiz      3694:       (most GNU software does, for instance), but extracts itself in
                   3695:       the current directory, you should set
                   3696:       <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
                   3697: <p>If a package doesn't create a subdirectory with the
                   3698:       name of <code class="varname">DISTNAME</code> but some different name,
                   3699:       set <code class="varname">WRKSRC</code> to point to the proper name in
                   3700:       <code class="filename">${WRKDIR}</code>, for example
                   3701:       <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.250     leot     3702:       <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>
1.75      rillig   3703: <p>The name of the working directory created by pkgsrc is
1.87      wiz      3704:       taken from the <code class="varname">WRKDIR_BASENAME</code>
                   3705:       variable. By default, its value is
                   3706:       <code class="filename">work</code>. If you want to use the same
                   3707:       pkgsrc tree for building different kinds of binary packages,
                   3708:       you can change the variable according to your needs. Two
                   3709:       other variables handle common cases of setting
                   3710:       <code class="varname">WRKDIR_BASENAME</code> individually. If
                   3711:       <code class="varname">OBJHOSTNAME</code> is defined in
1.110     hubertf  3712:       <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
1.87      wiz      3713:       the host's name is attached to the directory name. If
                   3714:       <code class="varname">OBJMACHINE</code> is defined, the platform name
                   3715:       is attached, which might look like
                   3716:       <code class="filename">work.i386</code> or
                   3717:       <code class="filename">work.sparc</code>.</p>
1.75      rillig   3718: </li></ul></div>
                   3719: <p>Please pay attention to the following gotchas:</p>
1.148     asau     3720: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      3721: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
1.88      wiz      3722:       installed in compressed form by the package.  For packages using
                   3723:       BSD-style makefiles which honor MANZ, there is
                   3724:       <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
1.128     wiz      3725: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
                   3726:       <span class="quote">&#8220;<span class="quote">${PREFIX}</span>&#8221;</span> in all files (see patches,
1.88      wiz      3727:       below).</p></li>
1.267     rillig   3728: <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>
1.75      rillig   3729: </ul></div>
                   3730: </div>
1.148     asau     3731: <div class="sect1">
1.75      rillig   3732: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   3733: <a name="components.distinfo"></a>13.2. <code class="filename">distinfo</code>
1.93      rillig   3734: </h2></div></div></div>
1.76      rillig   3735: <p>The <code class="filename">distinfo</code> file contains the message
1.87      wiz      3736:   digest, or checksum, of each distfile needed for the package. This
                   3737:   ensures that the distfiles retrieved from the Internet have not been
                   3738:   corrupted during transfer or altered by a malign force to introduce
1.219     rillig   3739:   a security hole. To provide maximum security, all distfiles are
                   3740:   protected using three different message digest algorithms (SHA1,
                   3741:   RMD160, SHA512), as well as the file size.</p>
1.76      rillig   3742: <p>The <code class="filename">distinfo</code> file also contains the
1.87      wiz      3743:   checksums for all the patches found in the
1.267     rillig   3744:   <code class="filename">patches</code> directory (see <a class="xref" href="#components.patches" title="13.3. patches/*">Section 13.3, &#8220;<code class="filename">patches/*</code>&#8221;</a>). These checksums ensure that patches
1.258     leot     3745:   are only applied intentionally and that they don't accidentally change,
                   3746:   e.g. when merging different changes together. They also make sure that
                   3747:   new patches are actually added to CVS and old ones are removed.
                   3748:   Too see whether the patches and the <code class="filename">distinfo</code> file
                   3749:   match, run <span class="command"><strong>pkglint</strong></span> after changing the patches.</p>
1.76      rillig   3750: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.219     rillig   3751:   <span class="command"><strong>make distinfo</strong></span> command.</p>
1.75      rillig   3752: <p>Some packages have different sets of distfiles depending on
1.250     leot     3753:   the platform, for example <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/openjdk7/README.html" target="_top"><code class="filename">lang/openjdk7</code></a>. These are kept in the same
1.87      wiz      3754:   <code class="filename">distinfo</code> file and care should be taken when
                   3755:   upgrading such a package to ensure distfile information is not
                   3756:   lost.</p>
1.75      rillig   3757: </div>
1.148     asau     3758: <div class="sect1">
1.75      rillig   3759: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   3760: <a name="components.patches"></a>13.3. <code class="filename">patches/*</code>
1.219     rillig   3761: </h2></div></div></div>
                   3762: <p>Some packages don't work out-of-the box on the various
                   3763:   platforms that are supported by pkgsrc. These packages need
                   3764:   to be patched to make them work. The patch files can be
1.93      rillig   3765:   found in the <code class="filename">patches/</code> directory.</p>
                   3766: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
                   3767:   applied to the files in <code class="varname">WRKSRC</code> directory after
1.219     rillig   3768:   extracting them, in alphabetic order.</p>
1.148     asau     3769: <div class="sect2">
1.93      rillig   3770: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   3771: <a name="components.patch.structure"></a>13.3.1. Structure of a single patch file</h3></div></div></div>
1.76      rillig   3772: <p>The <code class="filename">patch-*</code> files should be in
1.110     hubertf  3773:   <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
1.93      rillig   3774:   problems. (To force patches to apply with fuzz you can set
                   3775:   <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
1.94      dmcmahil 3776:   should contain only changes for a single file, and no file should be
1.93      rillig   3777:   patched by more than one patch file. This helps to keep future
                   3778:   modifications simple.</p>
                   3779: <p>Each patch file is structured as follows: In the first line,
                   3780:   there is the RCS Id of the patch itself. The second line should be
                   3781:   empty for aesthetic reasons. After that, there should be a comment for
                   3782:   each change that the patch does. There are a number of standard
                   3783:   cases:</p>
1.148     asau     3784: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      3785: <li class="listitem"><p>Patches for commonly known vulnerabilities should
1.93      rillig   3786:   mention the vulnerability ID (CAN, CVE).</p></li>
1.128     wiz      3787: <li class="listitem"><p>Patches that change source code should mention the
1.93      rillig   3788:   platform and other environment (for example, the compiler) that the
                   3789:   patch is needed for.</p></li>
                   3790: </ul></div>
1.219     rillig   3791: <p>The patch should be commented so that any
1.93      rillig   3792:   developer who knows the code of the application can make some use of
                   3793:   the patch. Special care should be taken for the upstream developers,
                   3794:   since we generally want that they accept our patches, so we have less
                   3795:   work in the future.</p>
                   3796: </div>
1.148     asau     3797: <div class="sect2">
1.93      rillig   3798: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   3799: <a name="components.patches.caveats"></a>13.3.2. Creating patch files</h3></div></div></div>
1.93      rillig   3800: <p>One important thing to mention is to pay attention that no RCS
                   3801:   IDs get stored in the patch files, as these will cause problems when
1.87      wiz      3802:   later checked into the NetBSD CVS tree. Use the
1.250     leot     3803:   <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
1.93      rillig   3804:   problems.</p>
1.87      wiz      3805: <p>For even more automation, we recommend using
1.110     hubertf  3806:   <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.87      wiz      3807:   whole set of patches. You just have to backup files before you
                   3808:   edit them to <code class="filename">filename.orig</code>, e.g. with
1.110     hubertf  3809:   <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
                   3810:   using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
1.87      wiz      3811:   you upgrade a package this way, you can easily compare the new
                   3812:   set of patches with the previously existing one with
1.130     wiz      3813:   <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
                   3814:   are replaced by new files, so carefully check if you want to take all
                   3815:   the changes.</p>
1.87      wiz      3816: <p>When you have finished a package, remember to generate
1.110     hubertf  3817:   the checksums for the patch files by using the <span class="command"><strong>make
1.267     rillig   3818:   makepatchsum</strong></span> command, see <a class="xref" href="#components.distinfo" title="13.2. distinfo">Section 13.2, &#8220;<code class="filename">distinfo</code>&#8221;</a>.</p>
1.87      wiz      3819: <p>When adding a patch that corrects a problem in the
                   3820:   distfile (rather than e.g. enforcing pkgsrc's view of where
                   3821:   man pages should go), send the patch as a bug report to the
                   3822:   maintainer.  This benefits non-pkgsrc users of the package,
                   3823:   and usually makes it possible to remove the patch in future
                   3824:   version.</p>
1.101     rillig   3825: <p>The file names of the patch files are usually of the form
1.130     wiz      3826:   <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
                   3827:   Many packages still use the previous convention
                   3828:   <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
                   3829:   but new patches should be of the form containing the filename.
1.250     leot     3830:   <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
1.130     wiz      3831:   automatically.</p>
1.93      rillig   3832: </div>
1.148     asau     3833: <div class="sect2">
1.93      rillig   3834: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   3835: <a name="components.patches.sources"></a>13.3.3. Sources where the patch files come from</h3></div></div></div>
1.87      wiz      3836: <p>If you want to share patches between multiple packages
                   3837:   in pkgsrc, e.g. because they use the same distfiles, set
                   3838:   <code class="varname">PATCHDIR</code> to the path where the patch files
                   3839:   can be found, e.g.:</p>
                   3840: <pre class="programlisting">
1.274     rillig   3841: PATCHDIR=       ../../editors/xemacs/patches
1.93      rillig   3842: </pre>
1.75      rillig   3843: <p>Patch files that are distributed by the author or other
1.87      wiz      3844:     maintainers can be listed in
                   3845:     <code class="varname">PATCHFILES</code>.</p>
                   3846: <p>If it is desired to store any patches that should not be
                   3847:     committed into pkgsrc, they can be kept outside the pkgsrc
                   3848:     tree in the <code class="filename">$LOCALPATCHES</code> directory. The
                   3849:     directory tree there is expected to have the same
1.128     wiz      3850:     <span class="quote">&#8220;<span class="quote">category/package</span>&#8221;</span> structure as pkgsrc, and
1.87      wiz      3851:     patches are expected to be stored inside these dirs (also
                   3852:     known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
                   3853:     example, if you want to keep a private patch for
                   3854:     <code class="filename">pkgsrc/graphics/png</code>, keep it in
                   3855:     <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
                   3856:     files in the named directory are expected to be patch files,
                   3857:     and <span class="emphasis"><em>they are applied after pkgsrc patches are
                   3858:     applied</em></span>.</p>
1.93      rillig   3859: </div>
1.148     asau     3860: <div class="sect2">
1.85      jmmv     3861: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   3862: <a name="components.patches.guidelines"></a>13.3.4. Patching guidelines</h3></div></div></div>
1.85      jmmv     3863: <p>When fixing a portability issue in the code do not use
                   3864:       preprocessor magic to check for the current operating system nor
                   3865:       platform.  Doing so hurts portability to other platforms because
                   3866:       the OS-specific details are not abstracted appropriately.</p>
                   3867: <p>The general rule to follow is: instead of checking for the
                   3868:       operating system the application is being built on, check for the
                   3869:       specific <span class="emphasis"><em>features</em></span> you need.  For example,
                   3870:       instead of assuming that kqueue is available under NetBSD and
                   3871:       using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.126     jakllsch 3872:       kqueue support, add a check that detects kqueue itself &mdash;
1.85      jmmv     3873:       yes, this generally involves patching the
1.110     hubertf  3874:       <span class="command"><strong>configure</strong></span> script.  There is absolutely nothing
1.85      jmmv     3875:       that prevents some OSes from adopting interfaces from other OSes
                   3876:       (e.g. Linux implementing kqueue), something that the above checks
                   3877:       cannot take into account.</p>
                   3878: <p>Of course, checking for features generally involves more
                   3879:       work on the developer's side, but the resulting changes are
1.87      wiz      3880:       cleaner and there are chances they will work on many other
1.85      jmmv     3881:       platforms.  Not to mention that there are higher chances of being
                   3882:       later integrated into the mainstream sources.  Remember:
                   3883:       <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
                   3884: <p>Some typical examples:</p>
                   3885: <div class="table">
1.267     rillig   3886: <a name="patch-examples"></a><p class="title"><b>Table 13.1. Patching examples</b></p>
1.216     tnn      3887: <div class="table-contents"><table class="table" summary="Patching examples" border="1">
1.85      jmmv     3888: <colgroup>
                   3889: <col>
                   3890: <col>
                   3891: <col>
                   3892: </colgroup>
                   3893: <thead><tr>
                   3894: <th>Where</th>
                   3895: <th>Incorrect</th>
                   3896: <th>Correct</th>
                   3897: </tr></thead>
                   3898: <tbody>
                   3899: <tr>
                   3900: <td>configure script</td>
                   3901: <td>
1.100     rillig   3902: <pre class="programlisting">
                   3903: case ${target_os} in
                   3904: netbsd*) have_kvm=yes ;;
                   3905: *)       have_kvm=no  ;;
                   3906: esac
                   3907: </pre>
1.85      jmmv     3908:              </td>
                   3909: <td>
1.100     rillig   3910: <pre class="programlisting">
                   3911: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
                   3912: </pre>
1.85      jmmv     3913:              </td>
                   3914: </tr>
                   3915: <tr>
                   3916: <td>C source file</td>
                   3917: <td>
1.100     rillig   3918: <pre class="programlisting">
                   3919: #if defined(__NetBSD__)
                   3920: #  include &lt;sys/event.h&gt;
                   3921: #endif
                   3922: </pre>
1.85      jmmv     3923:              </td>
                   3924: <td>
1.100     rillig   3925: <pre class="programlisting">
                   3926: #if defined(HAVE_SYS_EVENT_H)
                   3927: #  include &lt;sys/event.h&gt;
                   3928: #endif
                   3929: </pre>
1.85      jmmv     3930:              </td>
                   3931: </tr>
                   3932: <tr>
                   3933: <td>C source file</td>
                   3934: <td>
1.100     rillig   3935: <pre class="programlisting">
                   3936: int
                   3937: monitor_file(...)
                   3938: {
                   3939: #if defined(__NetBSD__)
                   3940:         int fd = kqueue();
                   3941:         ...
                   3942: #else
                   3943:         ...
                   3944: #endif
                   3945: }
                   3946: </pre>
1.85      jmmv     3947:              </td>
                   3948: <td>
1.100     rillig   3949: <pre class="programlisting">
                   3950: int
                   3951: monitor_file(...)
                   3952: {
                   3953: #if defined(HAVE_KQUEUE)
                   3954:         int fd = kqueue();
                   3955:         ...
                   3956: #else
1.223     rillig   3957:         ...
1.100     rillig   3958: #endif
                   3959: }
                   3960: </pre>
1.85      jmmv     3961:              </td>
                   3962: </tr>
                   3963: </tbody>
1.91      rillig   3964: </table></div>
1.85      jmmv     3965: </div>
1.254     maya     3966: <br class="table-break">
1.85      jmmv     3967: </div>
1.148     asau     3968: <div class="sect2">
1.85      jmmv     3969: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   3970: <a name="components.patches.feedback"></a>13.3.5. Feedback to the author</h3></div></div></div>
1.85      jmmv     3971: <p>Always, always, <span class="strong"><strong>always</strong></span>
                   3972:       feed back any <span class="emphasis"><em>portability fixes</em></span> or
                   3973:       improvements you do to a package to the mainstream developers.
                   3974:       This is the only way to get their attention on portability issues
                   3975:       and to ensure that future versions can be built out-of-the box on
                   3976:       NetBSD.  Furthermore, any user that gets newer distfiles will get
                   3977:       the fixes straight from the packaged code.</p>
1.93      rillig   3978: <p>This generally involves cleaning up the patches
                   3979:       (because sometimes the patches that are
1.147     wiz      3980:       added to pkgsrc are quick hacks), filing bug reports in the
1.85      jmmv     3981:       appropriate trackers for the projects and working with the
                   3982:       mainstream authors to accept your changes.  It is
                   3983:       <span class="emphasis"><em>extremely important</em></span> that you do it so that
                   3984:       the packages in pkgsrc are kept simple and thus further changes
                   3985:       can be done without much hassle.</p>
1.130     wiz      3986: <p>When you have done this, please add a URL to the upstream
                   3987:       bug report to the patch comment.</p>
1.85      jmmv     3988: <p>Support the idea of free software!</p>
                   3989: </div>
1.75      rillig   3990: </div>
1.148     asau     3991: <div class="sect1">
1.75      rillig   3992: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   3993: <a name="other-mandatory-files"></a>13.4. Other mandatory files</h2></div></div></div>
1.148     asau     3994: <div class="variablelist"><dl class="variablelist">
1.76      rillig   3995: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
1.75      rillig   3996: <dd><p>A multi-line description of the piece of software.  This should include
1.87      wiz      3997:          any credits where they are due.  Please bear in mind that others do not
                   3998:          share your sense of humour (or spelling idiosyncrasies), and that others
                   3999:          will read everything that you write here.</p></dd>
1.76      rillig   4000: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
1.87      wiz      4001: <dd><p>This file governs the files that are installed on your
                   4002:          system: all the binaries, manual pages, etc. There are other
                   4003:          directives which may be entered in this file, to control the
                   4004:          creation and deletion of directories, and the location of
1.267     rillig   4005:          inserted files.  See <a class="xref" href="#plist" title="Chapter 15. PLIST issues">Chapter 15, <i>PLIST issues</i></a> for more
1.87      wiz      4006:          information.</p></dd>
1.75      rillig   4007: </dl></div>
                   4008: </div>
1.148     asau     4009: <div class="sect1">
1.75      rillig   4010: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   4011: <a name="components.optional"></a>13.5. Optional files</h2></div></div></div>
1.148     asau     4012: <div class="sect2">
1.78      rillig   4013: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   4014: <a name="components.optional.bin"></a>13.5.1. Files affecting the binary package</h3></div></div></div>
1.148     asau     4015: <div class="variablelist"><dl class="variablelist">
1.76      rillig   4016: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.135     wiz      4017: <dd>
1.289     leot     4018: <p>This shell script is invoked twice by <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>.
1.87      wiz      4019:            First time after package extraction and before files are
                   4020:            moved in place, the second time after the files to install
                   4021:            are moved in place. This can be used to do any custom
                   4022:            procedures not possible with @exec commands in
1.289     leot     4023:            <code class="filename">PLIST</code>. See <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> and
                   4024:            <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information.  See also <a class="xref" href="#files-and-dirs-outside-prefix" title="17.1. Files and directories outside the installation prefix">Section 17.1, &#8220;Files and directories outside the installation prefix&#8221;</a>.
1.135     wiz      4025:            Please note that you can modify variables in it easily by using
                   4026:            <code class="varname">FILES_SUBST</code> in the package's
                   4027:            <code class="filename">Makefile</code>:</p>
                   4028: <pre class="programlisting">
                   4029: FILES_SUBST+=  SOMEVAR="somevalue"
                   4030: </pre>
                   4031: <p>replaces "@SOMEVAR@" with <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span> in the
                   4032:            <code class="filename">INSTALL</code>.  By default, substitution is
                   4033:            performed for <code class="varname">PREFIX</code>,
                   4034:            <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
                   4035:            <code class="varname">VARBASE</code>, and a few others, type
                   4036:            <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
                   4037:            complete list.</p>
                   4038: </dd>
1.76      rillig   4039: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
1.75      rillig   4040: <dd><p>This script is executed before and after any files are removed.  It is
1.87      wiz      4041:            this script's responsibility to clean up any additional messy details
                   4042:            around the package's installation, since all pkg_delete knows is how to
                   4043:            delete the files created in the original distribution.
1.289     leot     4044:            See <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
                   4045:            and <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information.
1.135     wiz      4046:            The same methods to replace variables can be used as for
                   4047:            the <code class="filename">INSTALL</code> file.</p></dd>
1.76      rillig   4048: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
1.75      rillig   4049: <dd>
                   4050: <p>This file is displayed after installation of the package.
1.87      wiz      4051:            Useful for things like legal notices on almost-free
                   4052:            software and hints for updating config files after
                   4053:            installing modules for apache, PHP etc.
                   4054:            Please note that you can modify variables in it easily by using
                   4055:            <code class="varname">MESSAGE_SUBST</code> in the package's
                   4056:            <code class="filename">Makefile</code>:</p>
1.75      rillig   4057: <pre class="programlisting">
1.100     rillig   4058: MESSAGE_SUBST+=  SOMEVAR="somevalue"
                   4059: </pre>
1.128     wiz      4060: <p>replaces "${SOMEVAR}" with <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span> in
1.87      wiz      4061:            <code class="filename">MESSAGE</code>.  By default, substitution is
                   4062:            performed for <code class="varname">PKGNAME</code>,
                   4063:            <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
1.209     sevan    4064:            <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
1.87      wiz      4065:            <code class="varname">PKG_SYSCONFDIR</code>,
                   4066:            <code class="varname">ROOT_GROUP</code>, and
1.117     jnemeth  4067:            <code class="varname">ROOT_USER</code>.</p>
1.87      wiz      4068: <p>You can display a different or additional files by
                   4069:            setting the <code class="varname">MESSAGE_SRC</code> variable.  Its
                   4070:            default is <code class="filename">MESSAGE</code>, if the file
                   4071:            exists.</p>
1.75      rillig   4072: </dd>
1.78      rillig   4073: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
1.174     asau     4074: <dd>
                   4075: <p>This file is used by the alternatives framework.
                   4076:            It creates, configures, and destroys generic wrappers used to
                   4077:            run programs with similar interfaces.
                   4078:            See pkg_alternatives(8) from pkgtools/pkg_alternatives
                   4079:             for more information.</p>
                   4080: <p>Each line of the file contains two filenames, first
                   4081:            the wrapper and then the alternative provided by the package.
                   4082:            Both paths are relative to <code class="varname">PREFIX</code>.</p>
                   4083: </dd>
1.78      rillig   4084: </dl></div>
                   4085: </div>
1.148     asau     4086: <div class="sect2">
1.78      rillig   4087: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   4088: <a name="components.optional.build"></a>13.5.2. Files affecting the build process</h3></div></div></div>
1.148     asau     4089: <div class="variablelist"><dl class="variablelist">
1.78      rillig   4090: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
                   4091: <dd><p>This file contains arbitrary things that could
                   4092:        also go into a <code class="filename">Makefile</code>, but its purpose is
                   4093:        to be used by more than one package. This file should only be
                   4094:        used when the packages that will use the file are known in
                   4095:        advance. For other purposes it is often better to write a
                   4096:        <code class="filename">*.mk</code> file and give it a good name that
                   4097:        describes what it does.</p></dd>
                   4098: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
                   4099: <dd><p>This file contains the dependency information
1.267     rillig   4100:        for the buildlink3 framework (see <a class="xref" href="#buildlink" title="Chapter 16. Buildlink methodology">Chapter 16, <i>Buildlink methodology</i></a>).</p></dd>
1.78      rillig   4101: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
                   4102: <dd><p>This file contains workarounds for compiler bugs
                   4103:        and similar things. It is included automatically by the pkgsrc
                   4104:        infrastructure, so you don't need an extra
                   4105:        <code class="literal">.include</code> line for
                   4106:        it.</p></dd>
                   4107: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
                   4108: <dd><p>This file contains the code for the
1.267     rillig   4109:        package-specific options (see <a class="xref" href="#options" title="Chapter 18. Options handling">Chapter 18, <i>Options handling</i></a>) that can be
1.78      rillig   4110:        selected by the user. If a package has only one or two options,
                   4111:        it is equally acceptable to put the code directly into the
                   4112:        <code class="filename">Makefile</code>.</p></dd>
                   4113: </dl></div>
                   4114: </div>
1.148     asau     4115: <div class="sect2">
1.78      rillig   4116: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   4117: <a name="components.optional.none"></a>13.5.3. Files affecting nothing at all</h3></div></div></div>
1.148     asau     4118: <div class="variablelist"><dl class="variablelist">
1.78      rillig   4119: <dt><span class="term"><code class="filename">README*</code></span></dt>
                   4120: <dd><p>These files do not take place in the creation of
                   4121:        a package and thus are purely informative to the package
                   4122:        developer.</p></dd>
                   4123: <dt><span class="term"><code class="filename">TODO</code></span></dt>
                   4124: <dd><p>This file contains things that need to be done
                   4125:        to make the package even
                   4126:        better.</p></dd>
1.75      rillig   4127: </dl></div>
                   4128: </div>
1.78      rillig   4129: </div>
1.148     asau     4130: <div class="sect1">
1.75      rillig   4131: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   4132: <a name="work-dir"></a>13.6. <code class="filename">work*</code>
1.93      rillig   4133: </h2></div></div></div>
1.110     hubertf  4134: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
1.87      wiz      4135:     unpacked into the directory denoted by
                   4136:     <code class="varname">WRKDIR</code>. It can be removed by running
1.110     hubertf  4137:     <span class="command"><strong>make clean</strong></span>. Besides the sources, this
1.87      wiz      4138:     directory is also used to keep various timestamp files.
                   4139:     The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
                   4140:     The default is <code class="filename">${.CURDIR}/work</code>
                   4141:     or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
                   4142:     if <code class="varname">OBJMACHINE</code> is set.</p>
1.75      rillig   4143: </div>
1.148     asau     4144: <div class="sect1">
1.75      rillig   4145: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   4146: <a name="files-dir"></a>13.7. <code class="filename">files/*</code>
1.93      rillig   4147: </h2></div></div></div>
1.287     rillig   4148: <p>If you have any files that you wish to be placed in the package
                   4149:     prior to configuration or building, you can place these files here
                   4150:     and use a <span class="command"><strong>${CP}</strong></span> command in the
                   4151:     <span class="quote">&#8220;<span class="quote">post-extract</span>&#8221;</span> target to achieve this.</p>
1.87      wiz      4152: <p>If you want to share files in this way with other
                   4153:     packages, set the <code class="varname">FILESDIR</code> variable to point
                   4154:     to the other package's <code class="filename">files</code> directory,
                   4155:     e.g.:</p>
                   4156: <pre class="programlisting">
1.274     rillig   4157: FILESDIR=       ../../editors/xemacs/files
1.100     rillig   4158: </pre>
1.75      rillig   4159: </div>
                   4160: </div>
1.148     asau     4161: <div class="chapter">
1.75      rillig   4162: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   4163: <a name="makefile"></a>Chapter 14. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.75      rillig   4164: <div class="toc">
                   4165: <p><b>Table of Contents</b></p>
1.210     leot     4166: <dl class="toc">
1.267     rillig   4167: <dt><span class="sect1"><a href="#makefile.style">14.1. Caveats</a></span></dt>
                   4168: <dt><span class="sect1"><a href="#makefile.variables">14.2. <code class="filename">Makefile</code> variables</a></span></dt>
                   4169: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">14.2.1. Naming conventions</a></span></dt></dl></dd>
                   4170: <dt><span class="sect1"><a href="#makefile.code">14.3. Code snippets</a></span></dt>
                   4171: <dd><dl>
                   4172: <dt><span class="sect2"><a href="#adding-to-list">14.3.1. Adding things to a list</a></span></dt>
                   4173: <dt><span class="sect2"><a href="#echo-literal">14.3.2. Echoing a string exactly as-is</a></span></dt>
                   4174: <dt><span class="sect2"><a href="#cflags-gnu-configure">14.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</a></span></dt>
                   4175: <dt><span class="sect2"><a href="#empty-variables">14.3.4. Handling possibly empty variables</a></span></dt>
1.75      rillig   4176: </dl></dd>
                   4177: </dl>
                   4178: </div>
1.76      rillig   4179: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
1.75      rillig   4180:   each of which forms a well-defined part of the pkgsrc system. Using
1.289     leot     4181:   the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> system as a programming language for a big system
1.75      rillig   4182:   like pkgsrc requires some discipline to keep the code correct and
                   4183:   understandable.</p>
1.76      rillig   4184: <p>The basic ingredients for <code class="filename">Makefile</code>
1.267     rillig   4185:   programming are variables and shell
1.75      rillig   4186:   commands. Among these shell commands may even be more complex ones
1.289     leot     4187:   like <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?awk+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">awk</span>(1)</span></a> programs. To make sure that every shell command runs
1.75      rillig   4188:   as intended it is necessary to quote all variables correctly when they
                   4189:   are used.</p>
1.267     rillig   4190: <p>This chapter describes some patterns that appear quite often in
1.76      rillig   4191:   <code class="filename">Makefile</code>s, including the pitfalls that come along
1.75      rillig   4192:   with them.</p>
1.148     asau     4193: <div class="sect1">
1.75      rillig   4194: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   4195: <a name="makefile.style"></a>14.1. Caveats</h2></div></div></div>
1.148     asau     4196: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.97      rillig   4197: <p>When you are creating a file as a
                   4198:     target of a rule, always write the data to a temporary file first
                   4199:     and finally rename that file. Otherwise there might occur an error
                   4200:     in the middle of generating the file, and when the user runs
1.289     leot     4201:     <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> for the second time, the file exists and will not be
1.97      rillig   4202:     regenerated properly. Example:</p>
                   4203: <pre class="programlisting">
1.100     rillig   4204: wrong:
                   4205:         @echo "line 1" &gt; ${.TARGET}
                   4206:         @echo "line 2" &gt;&gt; ${.TARGET}
                   4207:         @false
                   4208: 
                   4209: correct:
                   4210:         @echo "line 1" &gt; ${.TARGET}.tmp
                   4211:         @echo "line 2" &gt;&gt; ${.TARGET}.tmp
                   4212:         @false
                   4213:         @mv ${.TARGET}.tmp ${.TARGET}
1.97      rillig   4214: </pre>
1.110     hubertf  4215: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
1.97      rillig   4216:     <code class="filename">wrong</code> will exist, although there was an error
1.110     hubertf  4217:     message in the first run. On the other hand, running <span class="command"><strong>make
1.97      rillig   4218:     correct</strong></span> gives an error message twice, as expected.</p>
1.289     leot     4219: <p>You might remember that <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> sometimes removes
1.97      rillig   4220:     <code class="literal">${.TARGET}</code> in case of error, but this only
                   4221:     happens when it is interrupted, for example by pressing
1.267     rillig   4222:     <code class="literal">Ctrl+C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.289     leot     4223:     when one of the commands fails (like <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?false+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">false</span>(1)</span></a> above).</p>
1.97      rillig   4224: </li></ul></div>
                   4225: </div>
1.148     asau     4226: <div class="sect1">
1.97      rillig   4227: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   4228: <a name="makefile.variables"></a>14.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.76      rillig   4229: <p><code class="filename">Makefile</code> variables contain strings that
1.267     rillig   4230:     can be processed using the five operators <code class="code">=</code>,
                   4231:     <code class="code">+=</code>, <code class="code">?=</code>, <code class="code">:=</code> and
1.289     leot     4232:     <code class="code">!=</code>, which are described in the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man
1.75      rillig   4233:     page.</p>
                   4234: <p>When a variable's value is parsed from a
1.267     rillig   4235:     <code class="filename">Makefile</code>, the hash character <code class="code">#</code> and
                   4236:     the backslash character <code class="code">\</code> are handled specially. If a
                   4237:     backslash is the last character in a line, that backslash is removed
                   4238:     from the line and the line continues with the next line of the file.</p>
                   4239: <p>The <code class="code">#</code> character starts a comment that reaches
                   4240:     until the end of the line. To get an actual <code class="code">#</code> character,
                   4241:     such as in a URL, write <code class="code">\#</code> instead.</p>
1.219     rillig   4242: <p>The evaluation of variables either happens immediately or lazy.
1.267     rillig   4243:     It happens immediately when the variable occurs on the right-hand
                   4244:     side of the <code class="code">:=</code> or the <code class="code">!=</code> operator, in a
1.219     rillig   4245:     <code class="varname">.if</code> condition or a <code class="varname">.for</code> loop.
                   4246:     In the other cases, it is evaluated lazily.</p>
1.75      rillig   4247: <p>Some of the modifiers split the string into words and then
1.267     rillig   4248:     operate on the words, others operate on the string as a whole. When a
                   4249:     string is split into words, double quotes and single quotes are
1.289     leot     4250:     interpreted as delimiters, just like in <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?sh+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">sh</span>(1)</span></a>.</p>
1.148     asau     4251: <div class="sect2">
1.75      rillig   4252: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   4253: <a name="makefile.variables.names"></a>14.2.1. Naming conventions</h3></div></div></div>
1.148     asau     4254: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      4255: <li class="listitem"><p>All variable names starting with an underscore
1.75      rillig   4256:        are reserved for use by the pkgsrc infrastructure. They shall
1.267     rillig   4257:        not be used by packages.</p></li>
1.128     wiz      4258: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
1.75      rillig   4259:        lowercase variable names for the iteration
                   4260:        variables.</p></li>
1.267     rillig   4261: <li class="listitem"><p>All list variables should have a plural name,
                   4262:        such as <code class="varname">PKG_OPTIONS</code> or
1.75      rillig   4263:        <code class="varname">DISTFILES</code>.</p></li>
                   4264: </ul></div>
                   4265: </div>
                   4266: </div>
1.148     asau     4267: <div class="sect1">
1.75      rillig   4268: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   4269: <a name="makefile.code"></a>14.3. Code snippets</h2></div></div></div>
1.148     asau     4270: <div class="sect2">
1.75      rillig   4271: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   4272: <a name="adding-to-list"></a>14.3.1. Adding things to a list</h3></div></div></div>
1.220     wiz      4273: <p>When adding a string that possibly contains whitespace or quotes to
                   4274: a list (example 1), it must be quoted using the <code class="code">:Q</code>
                   4275: modifier.</p>
                   4276: <p>When adding another list to a list (example 2), it must not be
                   4277: quoted, since its elements are already quoted.</p>
1.75      rillig   4278: <pre class="programlisting">
1.220     wiz      4279: STRING=         foo * bar `date`
                   4280: LIST=           # empty
                   4281: ANOTHER_LIST=   a=b c=d
                   4282: 
                   4283: LIST+=          ${STRING:Q}       # 1
                   4284: LIST+=          ${ANOTHER_LIST}   # 2
                   4285: </pre>
1.75      rillig   4286: </div>
1.148     asau     4287: <div class="sect2">
1.75      rillig   4288: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   4289: <a name="echo-literal"></a>14.3.2. Echoing a string exactly as-is</h3></div></div></div>
1.220     wiz      4290: <p>Echoing a string containing special characters needs special
                   4291: work.</p>
1.75      rillig   4292: <pre class="programlisting">
1.100     rillig   4293: STRING=         foo bar &lt;    &gt; * `date` $$HOME ' "
1.219     rillig   4294: EXAMPLE_ENV=    string=${STRING:Q} x=multiple\ quoted\ words
1.1       grant    4295: 
1.100     rillig   4296: all:
                   4297:         echo ${STRING}                  # 1
1.219     rillig   4298:         echo ${STRING:Q}                # 2
                   4299:         printf '%s\n' ${STRING:Q}''     # 3
1.220     wiz      4300:         env ${EXAMPLE_ENV} sh -c 'echo "$$string"; echo "$$x"'   # 4
1.1       grant    4301: </pre>
1.220     wiz      4302: <p>Example 1 leads to a syntax error in the shell, as the characters
                   4303: are just copied.</p>
                   4304: <p>Example 2 quotes the string so that the shell interprets it
                   4305: correctly. But the echo command may additionally interpret strings with a
                   4306: leading dash or those containing backslashes.</p>
1.289     leot     4307: <p>Example 3 can handle arbitrary strings, since <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?printf+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">printf</span>(1)</span></a> only
1.252     leot     4308: interprets the format string, but not the next argument. The trailing
                   4309: single quotes handle the case when the string is empty. In that case, the
                   4310: :Q modifier would result in an empty string too, which would then be
1.289     leot     4311: skipped by the shell. For <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?printf+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">printf</span>(1)</span></a> this doesn't make a difference,
1.252     leot     4312: but other programs may care.</p>
1.220     wiz      4313: <p>In example 4, the <code class="varname">EXAMPLE_ENV</code> does not
                   4314: need to be quoted because the quoting has already been done
                   4315: when adding elements to the list.</p>
1.75      rillig   4316: </div>
1.148     asau     4317: <div class="sect2">
1.75      rillig   4318: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   4319: <a name="cflags-gnu-configure"></a>14.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</h3></div></div></div>
1.220     wiz      4320: <p>When passing <code class="varname">CFLAGS</code> or similar variables to a
                   4321: GNU-style configure script (especially those that call other configure
                   4322: scripts), it must not have leading or trailing whitespace, since
                   4323: otherwise the configure script gets confused. To trim leading and
                   4324: trailing whitespace, use the <code class="code">:M</code> modifier, as in the
                   4325: following example:</p>
1.75      rillig   4326: <pre class="programlisting">
1.100     rillig   4327: CPPFLAGS=               # empty
1.220     wiz      4328: CPPFLAGS+=              -Wundef -DPREFIX=\"${PREFIX}\"
1.100     rillig   4329: CPPFLAGS+=              ${MY_CPPFLAGS}
                   4330: 
                   4331: CONFIGURE_ARGS+=        CPPFLAGS=${CPPFLAGS:M*:Q}
                   4332: 
                   4333: all:
                   4334:         echo x${CPPFLAGS:Q}x            # leading and trailing whitespace
1.220     wiz      4335:         echo x${CONFIGURE_ARGS:Q}x      # properly trimmed
1.1       grant    4336: </pre>
1.220     wiz      4337: <p>In this example, <code class="varname">CPPFLAGS</code> has both leading and
                   4338: trailing whitespace because the <code class="code">+=</code> operator always adds a
                   4339: space.</p>
                   4340: </div>
                   4341: <div class="sect2">
                   4342: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   4343: <a name="empty-variables"></a>14.3.4. Handling possibly empty variables</h3></div></div></div>
1.220     wiz      4344: <p>When a possibly empty variable is used in a shell program, it may
                   4345: lead to a syntax error.</p>
                   4346: <pre class="programlisting">
                   4347: EGFILES=        # empty
                   4348: 
                   4349: install-examples:   # produces a syntax error in the shell
                   4350:         for egfile in ${EGFILES}; do            \
                   4351:                 echo "Installing $$egfile";     \
                   4352:         done
                   4353: </pre>
                   4354: <p>The shell only sees the text <code class="code">for egfile in ; do</code>, since
1.289     leot     4355: <code class="code">${EGFILES}</code> is replaced with an empty string by <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>.
1.220     wiz      4356: To fix this syntax error, use one of the snippets below.</p>
                   4357: <pre class="programlisting">
                   4358: EMPTY=          # empty
                   4359: 
                   4360: install-examples:
                   4361:         for egfile in ${EGFILES} ""; do         \
                   4362:                 [ -n "$$egfile" ] || continue;  \
                   4363:                 echo "Installing $$egfile";     \
1.100     rillig   4364:         done
1.220     wiz      4365: </pre>
                   4366: <p>In this case, an empty string is appended to the iteration list (to
                   4367: prevent the syntax error) and filtered out later.</p>
                   4368: <pre class="programlisting">
                   4369: EGFILES=        # empty
1.100     rillig   4370: 
1.220     wiz      4371: install-examples:
                   4372: .for egfile in ${EGFILES}
                   4373:         echo "Installing ${egfile}"
1.100     rillig   4374: .endfor
1.1       grant    4375: </pre>
1.267     rillig   4376: <p>If one of the filenames contains special characters, it should be
                   4377: enclosed in single or double quotes.</p>
1.220     wiz      4378: <p>To have a shell command test whether a make variable is empty, use
                   4379: the following code: <code class="code">${TEST} -z ${POSSIBLY_EMPTY:Q}""</code>.</p>
1.75      rillig   4380: </div>
                   4381: </div>
                   4382: </div>
1.148     asau     4383: <div class="chapter">
1.75      rillig   4384: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   4385: <a name="plist"></a>Chapter 15. PLIST issues</h2></div></div></div>
1.75      rillig   4386: <div class="toc">
                   4387: <p><b>Table of Contents</b></p>
1.210     leot     4388: <dl class="toc">
1.267     rillig   4389: <dt><span class="sect1"><a href="#rcs-id">15.1. RCS ID</a></span></dt>
                   4390: <dt><span class="sect1"><a href="#automatic-plist-generation">15.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                   4391: <dt><span class="sect1"><a href="#print-PLIST">15.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span></a></span></dt>
                   4392: <dt><span class="sect1"><a href="#plist.misc">15.4. Variable substitution in PLIST</a></span></dt>
                   4393: <dt><span class="sect1"><a href="#manpage-compression">15.5. Man page compression</a></span></dt>
                   4394: <dt><span class="sect1"><a href="#using-PLIST_SRC">15.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
                   4395: <dt><span class="sect1"><a href="#platform-specific-plist">15.7. Platform-specific and differing PLISTs</a></span></dt>
                   4396: <dt><span class="sect1"><a href="#build-plist">15.8. Build-specific PLISTs</a></span></dt>
                   4397: <dt><span class="sect1"><a href="#faq.common-dirs">15.9. Sharing directories between packages</a></span></dt>
1.75      rillig   4398: </dl>
                   4399: </div>
1.87      wiz      4400: <p>The <code class="filename">PLIST</code> file contains a package's
1.128     wiz      4401:   <span class="quote">&#8220;<span class="quote">packing list</span>&#8221;</span>, i.e. a list of files that belong to
1.87      wiz      4402:   the package (relative to the <code class="filename">${PREFIX}</code>
                   4403:   directory it's been installed in) plus some additional statements
1.289     leot     4404:   - see the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> man page for a full list.
1.87      wiz      4405:   This chapter addresses some issues that need attention when
                   4406:   dealing with the <code class="filename">PLIST</code> file (or files, see
                   4407:   below!).</p>
1.148     asau     4408: <div class="sect1">
1.75      rillig   4409: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   4410: <a name="rcs-id"></a>15.1. RCS ID</h2></div></div></div>
1.87      wiz      4411: <p>Be sure to add a RCS ID line as the first thing in any
                   4412:     <code class="filename">PLIST</code> file you write:</p>
1.75      rillig   4413: <pre class="programlisting">
1.233     sevan    4414: @comment $NetBSD $
1.222     sevan    4415: </pre>
1.235     yyamano  4416: <p>An artificial space has been added between NetBSD and $, this is a
1.233     sevan    4417: workaround here to prevent CVS expanding to the filename of the guide. When
1.238     leot     4418: adding the RCS ID the space should be omitted.</p>
1.75      rillig   4419: </div>
1.148     asau     4420: <div class="sect1">
1.75      rillig   4421: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   4422: <a name="automatic-plist-generation"></a>15.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.110     hubertf  4423: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
1.87      wiz      4424:     to output a PLIST that matches any new files since the package
1.267     rillig   4425:     was extracted.  See <a class="xref" href="#build.helpful-targets" title="19.17. Other helpful targets">Section 19.17, &#8220;Other helpful targets&#8221;</a> for
1.87      wiz      4426:     more information on this target.</p>
1.75      rillig   4427: </div>
1.148     asau     4428: <div class="sect1">
1.75      rillig   4429: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   4430: <a name="print-PLIST"></a>15.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
1.93      rillig   4431: </h2></div></div></div>
1.87      wiz      4432: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
                   4433:     of AWK patterns and actions that are used to filter the output of
                   4434:     print-PLIST.  You can <span class="emphasis"><em>append</em></span> any chunk of AWK
                   4435:     scripting you like to it, but be careful with quoting.</p>
                   4436: <p>For example, to get all files inside the
                   4437:     <code class="filename">libdata/foo</code> directory removed from the
                   4438:     resulting PLIST:</p>
                   4439: <pre class="programlisting">
1.100     rillig   4440: PRINT_PLIST_AWK+=       /^libdata\/foo/ { next; }
1.222     sevan    4441: </pre>
1.75      rillig   4442: </div>
1.148     asau     4443: <div class="sect1">
1.75      rillig   4444: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   4445: <a name="plist.misc"></a>15.4. Variable substitution in PLIST</h2></div></div></div>
1.87      wiz      4446: <p>A number of variables are substituted automatically in
                   4447:     PLISTs when a package is installed on a system. This includes the
                   4448:     following variables:</p>
1.148     asau     4449: <div class="variablelist"><dl class="variablelist">
1.75      rillig   4450: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
                   4451: <dd>
                   4452: <p>Some packages like emacs and perl embed information
1.87      wiz      4453:          about which architecture they were built on into the
                   4454:          pathnames where they install their files. To handle this
                   4455:          case, PLIST will be preprocessed before actually used, and
                   4456:          the symbol
1.128     wiz      4457:          <span class="quote">&#8220;<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>&#8221;</span> will be
1.110     hubertf  4458:          replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
1.87      wiz      4459:          same is done if the string
                   4460:          <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
                   4461:          PLIST somewhere - use this on packages that have GNU
                   4462:          autoconf-created configure scripts.</p>
1.148     asau     4463: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   4464: <h3 class="title">Legacy note</h3>
                   4465: <p>There used to be a symbol
1.128     wiz      4466:            <span class="quote">&#8220;<span class="quote"><code class="varname">$ARCH</code></span>&#8221;</span> that
1.110     hubertf  4467:            was replaced by the output of <span class="command"><strong>uname
1.87      wiz      4468:            -m</strong></span>, but that's no longer supported and has
                   4469:            been removed.</p>
1.75      rillig   4470: </div>
                   4471: </dd>
                   4472: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
                   4473: <dd>
                   4474: <p>Some packages want to embed the OS name and version
1.87      wiz      4475:          into some paths.  To do this, use these variables in the
                   4476:          <code class="filename">PLIST</code>:
                   4477:          </p>
1.148     asau     4478: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      4479: <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>
                   4480: <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>
                   4481: <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>
1.75      rillig   4482: </ul></div>
                   4483: </dd>
                   4484: </dl></div>
1.199     tnn      4485: <p>For a list of values which are replaced by
                   4486:     default, the output of <span class="command"><strong>make help topic=PLIST_SUBST</strong></span> as
                   4487: well as searching the <code class="filename">pkgsrc/mk</code> directory with <span class="command"><strong>grep</strong></span> for
                   4488: <code class="varname">PLIST_SUBST</code> should help.</p>
1.87      wiz      4489: <p>If you want to change other variables not listed above, you
                   4490:     can add variables and their expansions to this variable in the
1.267     rillig   4491:     following way, similar to <code class="varname">MESSAGE_SUBST</code> (see <a class="xref" href="#components.optional" title="13.5. Optional files">Section 13.5, &#8220;Optional files&#8221;</a>):</p>
1.75      rillig   4492: <pre class="programlisting">
1.100     rillig   4493: PLIST_SUBST+=   SOMEVAR="somevalue"
1.222     sevan    4494: </pre>
1.128     wiz      4495: <p>This replaces all occurrences of <span class="quote">&#8220;<span class="quote">${SOMEVAR}</span>&#8221;</span>
1.87      wiz      4496:     in the <code class="filename">PLIST</code> with
1.128     wiz      4497:     <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span>.</p>
1.120     snj      4498: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
1.119     mishka   4499:     the common case of conditionally including some
                   4500:     <code class="filename">PLIST</code> entries. It can be done by adding
                   4501:     <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
1.120     snj      4502:     setting the corresponding <code class="varname">PLIST.foo</code> variable
                   4503:     to <code class="literal">yes</code> if the entry should be included.
1.128     wiz      4504:     This will substitute <span class="quote">&#8220;<span class="quote"><code class="varname">${PLIST.foo}</code></span>&#8221;</span>
1.119     mishka   4505:     in the <code class="filename">PLIST</code> with either
1.128     wiz      4506:     <span class="quote">&#8220;<span class="quote"><code class="literal">""</code></span>&#8221;</span> or
                   4507:     <span class="quote">&#8220;<span class="quote"><code class="literal">"@comment "</code></span>&#8221;</span>.
1.119     mishka   4508:     For example, in <code class="filename">Makefile</code>:</p>
                   4509: <pre class="programlisting">
1.223     rillig   4510: PLIST_VARS+=    foo
1.119     mishka   4511: .if <em class="replaceable"><code>condition</code></em>
1.223     rillig   4512: PLIST.foo=      yes
1.119     mishka   4513: .else
1.222     sevan    4514: </pre>
1.119     mishka   4515: <p>And then in <code class="filename">PLIST</code>:</p>
                   4516: <pre class="programlisting">
1.233     sevan    4517: @comment $NetBSD $
1.119     mishka   4518: bin/bar
                   4519: man/man1/bar.1
                   4520: ${PLIST.foo}bin/foo
                   4521: ${PLIST.foo}man/man1/foo.1
                   4522: ${PLIST.foo}share/bar/foo.data
1.222     sevan    4523: </pre>
1.235     yyamano  4524: <p>An artificial space has been added between NetBSD and $, this is a
1.233     sevan    4525: workaround here to prevent CVS expanding to the filename of the guide. When
                   4526: adding the RCS ID the space should be ommited.</p>
1.75      rillig   4527: </div>
1.148     asau     4528: <div class="sect1">
1.75      rillig   4529: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   4530: <a name="manpage-compression"></a>15.5. Man page compression</h2></div></div></div>
1.75      rillig   4531: <p>Man pages should be installed in compressed form if
1.87      wiz      4532:     <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
                   4533:     and uncompressed otherwise. To handle this in the
1.128     wiz      4534:     <code class="filename">PLIST</code> file, the suffix <span class="quote">&#8220;<span class="quote">.gz</span>&#8221;</span> is
1.87      wiz      4535:     appended/removed automatically for man pages according to
                   4536:     <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
                   4537:     or not, see above for details. This modification of the
                   4538:     <code class="filename">PLIST</code> file is done on a copy of it, not
                   4539:     <code class="filename">PLIST</code> itself.</p>
1.75      rillig   4540: </div>
1.148     asau     4541: <div class="sect1">
1.75      rillig   4542: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   4543: <a name="using-PLIST_SRC"></a>15.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
1.93      rillig   4544: </h2></div></div></div>
1.76      rillig   4545: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
1.87      wiz      4546:     in generating the binary package, set the variable
                   4547:     <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.289     leot     4548:     The files are later concatenated using <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?cat+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">cat</span>(1)</span></a>, and the order of things is
1.87      wiz      4549:     important. The default for <code class="varname">PLIST_SRC</code> is
                   4550:     <code class="filename">${PKGDIR}/PLIST</code>.</p>
1.75      rillig   4551: </div>
1.148     asau     4552: <div class="sect1">
1.75      rillig   4553: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   4554: <a name="platform-specific-plist"></a>15.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.75      rillig   4555: <p>Some packages decide to install a different set of files based on
1.87      wiz      4556:     the operating system being used. These differences can be
                   4557:     automatically handled by using the following files:</p>
1.148     asau     4558: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      4559: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
                   4560: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
                   4561: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
                   4562: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
                   4563: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
1.75      rillig   4564: </ul></div>
                   4565: </div>
1.148     asau     4566: <div class="sect1">
1.75      rillig   4567: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   4568: <a name="build-plist"></a>15.8. Build-specific PLISTs</h2></div></div></div>
1.197     wiz      4569: <p>Some packages decide to generate hard-to-guess file names
                   4570:     during installation that are hard to wire down.</p>
                   4571: <p>In such cases, you can set the
                   4572:     <code class="varname">GENERATE_PLIST</code> variable to shell code
                   4573:     terminated (with a semicolon) that will output PLIST entries which
                   4574:     will be appended to the PLIST</p>
                   4575: <p>You can find one example in editors/xemacs:</p>
                   4576: <pre class="programlisting">
1.222     sevan    4577: GENERATE_PLIST+=        ${ECHO} bin/${DISTNAME}-`${WRKSRC}/src/xemacs -sd`.dmp ;
                   4578: </pre>
1.197     wiz      4579: <p>which will append something like
                   4580:     <code class="filename">bin/xemacs-21.4.23-54e8ea71.dmp</code> to the
                   4581:     <code class="filename">PLIST</code>.
                   4582:     </p>
                   4583: </div>
                   4584: <div class="sect1">
                   4585: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   4586: <a name="faq.common-dirs"></a>15.9. Sharing directories between packages</h2></div></div></div>
1.128     wiz      4587: <p>A <span class="quote">&#8220;<span class="quote">shared directory</span>&#8221;</span> is a directory where
1.87      wiz      4588:     multiple (and unrelated) packages install files.  These
1.125     wiz      4589:     directories were problematic because you had to add special
                   4590:     tricks in the PLIST to conditionally remove them, or have some
1.87      wiz      4591:     centralized package handle them.</p>
1.125     wiz      4592: <p>In pkgsrc, it is now easy: Each package should create
                   4593:     directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
                   4594:     will remove any directories left empty after uninstalling a
                   4595:     package.</p>
                   4596: <p>If a package needs an empty directory to work, create
                   4597:     the directory during installation as usual, and also add an
                   4598:     entry to the PLIST:
1.222     sevan    4599: 
                   4600: </p>
1.87      wiz      4601: <pre class="programlisting">
1.125     wiz      4602: @pkgdir path/to/empty/directory
1.222     sevan    4603: </pre>
1.125     wiz      4604: <p>
1.222     sevan    4605: 
1.197     wiz      4606:     or take a look at <code class="varname">MAKE_DIRS</code> and
                   4607:     <code class="varname">OWN_DIRS</code>.
1.125     wiz      4608:     </p>
1.75      rillig   4609: </div>
                   4610: </div>
1.148     asau     4611: <div class="chapter">
1.75      rillig   4612: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   4613: <a name="buildlink"></a>Chapter 16. Buildlink methodology</h2></div></div></div>
1.75      rillig   4614: <div class="toc">
                   4615: <p><b>Table of Contents</b></p>
1.210     leot     4616: <dl class="toc">
1.267     rillig   4617: <dt><span class="sect1"><a href="#converting-to-buildlink3">16.1. Converting packages to use buildlink3</a></span></dt>
                   4618: <dt><span class="sect1"><a href="#creating-buildlink3.mk">16.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.75      rillig   4619: <dd><dl>
1.267     rillig   4620: <dt><span class="sect2"><a href="#anatomy-of-bl3">16.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
                   4621: <dt><span class="sect2"><a href="#updating-buildlink-depends">16.2.2. Updating
1.133     wiz      4622:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   4623:       and
                   4624:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   4625:       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.75      rillig   4626: </dl></dd>
1.267     rillig   4627: <dt><span class="sect1"><a href="#writing-builtin.mk">16.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.75      rillig   4628: <dd><dl>
1.267     rillig   4629: <dt><span class="sect2"><a href="#anatomy-of-builtin.mk">16.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</a></span></dt>
                   4630: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">16.3.2. Global preferences for native or pkgsrc software</a></span></dt>
1.75      rillig   4631: </dl></dd>
                   4632: </dl>
                   4633: </div>
                   4634: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
1.87      wiz      4635:   are seen by a package's configure and build processes.  This is implemented
                   4636:   in a two step process:</p>
1.128     wiz      4637: <div class="orderedlist"><ol class="orderedlist" type="1">
                   4638: <li class="listitem"><p>Symlink headers and libraries for dependencies into
1.87      wiz      4639:       <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
                   4640:       of <code class="varname">WRKDIR</code>.</p></li>
1.128     wiz      4641: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
1.87      wiz      4642:       tools that translate <code class="option">-I${LOCALBASE}/include</code> and
                   4643:       <code class="option">-L${LOCALBASE}/lib</code> into references to
                   4644:       <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
                   4645:       native compiler on some operating systems look like GCC, so that
                   4646:       packages that expect GCC won't require modifications to build with
                   4647:       those native compilers.</p></li>
1.75      rillig   4648: </ol></div>
                   4649: <p>This normalizes the environment in which a package is built so that the
1.87      wiz      4650:   package may be built consistently despite what other software may be
                   4651:   installed. Please note that the normal system header and library paths,
                   4652:   e.g. <code class="filename">/usr/include</code>,
                   4653:   <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
                   4654:   designed to insulate the package build from non-system-supplied
                   4655:   software.</p>
1.148     asau     4656: <div class="sect1">
1.75      rillig   4657: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   4658: <a name="converting-to-buildlink3"></a>16.1. Converting packages to use buildlink3</h2></div></div></div>
1.75      rillig   4659: <p>The process of converting packages to use the buildlink3
1.128     wiz      4660:     framework (<span class="quote">&#8220;<span class="quote">bl3ifying</span>&#8221;</span>) is fairly straightforward.
1.87      wiz      4661:     The things to keep in mind are:</p>
1.128     wiz      4662: <div class="orderedlist"><ol class="orderedlist" type="1">
                   4663: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
1.87      wiz      4664:        instead of the actual toolchain.  Some packages are tricky,
                   4665:        and the only way to know for sure is the check
                   4666:        <code class="filename">${WRKDIR}/.work.log</code> to see if the
                   4667:        wrappers are being invoked.</p></li>
1.128     wiz      4668: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
1.87      wiz      4669:        the package Makefile, e.g. Java VMs, standalone shells,
                   4670:        etc., because the code to symlink files into
                   4671:        <code class="filename">${BUILDLINK_DIR}</code> looks for files
1.128     wiz      4672:        relative to <span class="quote">&#8220;<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>&#8221;</span>.
1.87      wiz      4673:        </p></li>
1.128     wiz      4674: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
1.87      wiz      4675:        <code class="filename">buildlink3.mk</code> files that you list in a
                   4676:        package's Makefile are added as dependencies for that package.
                   4677:        </p></li>
1.75      rillig   4678: </ol></div>
1.87      wiz      4679: <p>If a dependency on a particular package is required for its libraries and
                   4680:     headers, then we replace:</p>
1.75      rillig   4681: <pre class="programlisting">
1.100     rillig   4682: DEPENDS+=       foo&gt;=1.1.0:../../category/foo
                   4683: </pre>
1.75      rillig   4684: <p>with</p>
                   4685: <pre class="programlisting">
1.100     rillig   4686: .include "../../category/foo/buildlink3.mk"
                   4687: </pre>
1.75      rillig   4688: <p>The buildlink3.mk files usually define the required dependencies.
                   4689:     If you need a newer version of the dependency when using buildlink3.mk
1.87      wiz      4690:     files, then you can define it in your Makefile; for example:</p>
1.75      rillig   4691: <pre class="programlisting">
1.100     rillig   4692: BUILDLINK_API_DEPENDS.foo+=   foo&gt;=1.1.0
                   4693: .include "../../category/foo/buildlink3.mk"
                   4694: </pre>
1.76      rillig   4695: <p>There are several <code class="filename">buildlink3.mk</code>
1.87      wiz      4696:     files in <code class="filename">pkgsrc/mk</code>
                   4697:     that handle special package issues:</p>
1.148     asau     4698: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      4699: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
1.87      wiz      4700:        the native or a pkgsrc Berkeley DB implementation based on
                   4701:        the values of <code class="varname">BDB_ACCEPTED</code> and
                   4702:        <code class="varname">BDB_DEFAULT</code>.</p></li>
1.128     wiz      4703: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
1.87      wiz      4704:        comes with neither Curses nor NCurses, this will take care
1.250     leot     4705:        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>
1.128     wiz      4706: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
1.87      wiz      4707:        of <code class="varname">KRB5_ACCEPTED</code> to choose between
                   4708:        adding a dependency on Heimdal or MIT-krb5 for packages that
                   4709:        require a Kerberos 5 implementation.</p></li>
1.128     wiz      4710: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
1.88      wiz      4711:        system-provided Motif installation or adds a dependency on
1.250     leot     4712:        <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
1.128     wiz      4713:        <code class="varname">MOTIF_TYPE</code> to <span class="quote">&#8220;<span class="quote">dt</span>&#8221;</span>,
1.239     leot     4714:        <span class="quote">&#8220;<span class="quote">lesstif</span>&#8221;</span> or <span class="quote">&#8220;<span class="quote">motif</span>&#8221;</span>
                   4715:        to choose which Motif version will be used.</p></li>
1.161     ryoon    4716: <li class="listitem"><p><code class="filename">readline.buildlink3.mk</code> checks for a
1.162     wiz      4717:        system-provided GNU readline or editline (libedit) installation,
1.250     leot     4718:        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>,
                   4719:        <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
1.161     ryoon    4720:        <code class="varname">READLINE_DEFAULT</code> to choose readline implementation.
                   4721:        If your package really needs GNU readline library, its Makefile
                   4722:        should include <code class="filename">devel/readline/buildlink3.mk</code>
                   4723:        instead of <code class="filename">readline.buildlink3.mk</code>.</p></li>
1.128     wiz      4724: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
1.87      wiz      4725:        variables that may be used by packages that use the
                   4726:        Open Sound System (OSS) API.</p></li>
1.128     wiz      4727: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
1.142     wiz      4728:        any of the Postgres versions in the variable
                   4729:        <code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
                   4730:        the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
1.87      wiz      4731:        the file for more information.</p></li>
1.128     wiz      4732: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
1.87      wiz      4733:        <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.250     leot     4734:        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>
1.128     wiz      4735: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
1.87      wiz      4736:        <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
                   4737:        library.</p></li>
1.75      rillig   4738: </ul></div>
1.76      rillig   4739: <p>The comments in those <code class="filename">buildlink3.mk</code>
1.87      wiz      4740:     files provide a more complete
                   4741:     description of how to use them properly.</p>
1.75      rillig   4742: </div>
1.148     asau     4743: <div class="sect1">
1.75      rillig   4744: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   4745: <a name="creating-buildlink3.mk"></a>16.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.107     rillig   4746: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
1.87      wiz      4747:     included by Makefiles to indicate the need to compile and link
                   4748:     against header files and libraries provided by the package.  A
                   4749:     <code class="filename">buildlink3.mk</code> file should always provide
                   4750:     enough information to add the correct type of dependency
                   4751:     relationship and include any other
                   4752:     <code class="filename">buildlink3.mk</code> files that it needs to find
                   4753:     headers and libraries that it needs in turn.</p>
                   4754: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.250     leot     4755:     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>
1.87      wiz      4756:     package is highly recommended.  For most packages, the following
                   4757:     command will generate a good starting point for
                   4758:     <code class="filename">buildlink3.mk</code> files:</p>
                   4759: <pre class="screen">
                   4760: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
                   4761: <code class="prompt">%</code> createbuildlink &gt;buildlink3.mk</code></strong>
                   4762:     </pre>
1.148     asau     4763: <div class="sect2">
1.75      rillig   4764: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   4765: <a name="anatomy-of-bl3"></a>16.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.75      rillig   4766: <p>The following real-life example
1.87      wiz      4767:       <code class="filename">buildlink3.mk</code> is taken
                   4768:       from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
1.75      rillig   4769: <pre class="programlisting">
1.120     snj      4770: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
1.1       grant    4771: 
1.223     rillig   4772: BUILDLINK_TREE+=        tiff
1.1       grant    4773: 
1.120     snj      4774: .if !defined(TIFF_BUILDLINK3_MK)
                   4775: TIFF_BUILDLINK3_MK:=
1.87      wiz      4776: 
1.223     rillig   4777: BUILDLINK_API_DEPENDS.tiff+=    tiff&gt;=3.6.1
                   4778: BUILDLINK_ABI_DEPENDS.tiff+=    tiff&gt;=3.7.2nb1
                   4779: BUILDLINK_PKGSRCDIR.tiff?=      ../../graphics/tiff
1.87      wiz      4780: 
1.100     rillig   4781: .include "../../devel/zlib/buildlink3.mk"
                   4782: .include "../../graphics/jpeg/buildlink3.mk"
1.120     snj      4783: .endif # TIFF_BUILDLINK3_MK
1.87      wiz      4784: 
1.223     rillig   4785: BUILDLINK_TREE+=        -tiff
1.100     rillig   4786: </pre>
1.87      wiz      4787: <p>The header and footer manipulate
1.120     snj      4788:       <code class="varname">BUILDLINK_TREE</code>, which is common across all
1.87      wiz      4789:       <code class="filename">buildlink3.mk</code> files and is used to track
1.120     snj      4790:       the dependency tree.</p>
                   4791: <p>The main section is protected from multiple inclusion
1.87      wiz      4792:       and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
                   4793:       added.  Several important variables are set in the section:</p>
1.148     asau     4794: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      4795: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.87      wiz      4796:          is the actual dependency recorded in the installed
                   4797:          package; this should always be set using
1.110     hubertf  4798:          <span class="command"><strong>+=</strong></span> to ensure that
1.87      wiz      4799:          we're appending to any pre-existing list of values.  This
                   4800:          variable should be set to the first version of the
1.133     wiz      4801:          package that had an backwards-incompatible API change.
1.87      wiz      4802:          </p></li>
1.128     wiz      4803: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
1.87      wiz      4804:          is the location of the <em class="replaceable"><code>pkg</code></em>
                   4805:          pkgsrc directory.</p></li>
1.128     wiz      4806: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.87      wiz      4807:          (not shown above) controls whether we use
                   4808:          <code class="varname">BUILD_DEPENDS</code> or
                   4809:          <code class="varname">DEPENDS</code> to add the dependency on
                   4810:          <em class="replaceable"><code>pkg</code></em>.  The build dependency is
                   4811:          selected by setting
                   4812:          <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.128     wiz      4813:          to <span class="quote">&#8220;<span class="quote">build</span>&#8221;</span>.  By default, the full dependency is
1.87      wiz      4814:          used.</p></li>
1.128     wiz      4815: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   4816:            and
                   4817:            <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
                   4818:            (not shown above) are lists of subdirectories of
1.76      rillig   4819:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75      rillig   4820:            to add to the header and library search paths.  These
1.128     wiz      4821:            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>
1.87      wiz      4822:          respectively.</p></li>
1.128     wiz      4823: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   4824:            (not shown above) is the list of preprocessor flags to add
                   4825:            to <code class="varname">CPPFLAGS</code>, which are passed on to the
1.128     wiz      4826:            configure and build phases.  The <span class="quote">&#8220;<span class="quote">-I</span>&#8221;</span> option
1.75      rillig   4827:            should be avoided and instead be handled using
                   4828:            <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
1.87      wiz      4829:          above.</p></li>
1.75      rillig   4830: </ul></div>
1.87      wiz      4831: <p>The following variables are all optionally defined within
                   4832:       this second section (protected against multiple inclusion) and
                   4833:       control which package files are symlinked into
                   4834:       <code class="filename">${BUILDLINK_DIR}</code> and how their names are
                   4835:       transformed during the symlinking:</p>
1.148     asau     4836: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      4837: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   4838:            (not shown above) is a shell glob pattern relative to
1.76      rillig   4839:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.75      rillig   4840:            to be symlinked into
1.76      rillig   4841:            <code class="filename">${BUILDLINK_DIR}</code>,
1.87      wiz      4842:          e.g. <code class="filename">include/*.h</code>.</p></li>
1.128     wiz      4843: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
1.87      wiz      4844:            (not shown above) is a shell pipeline that
                   4845:            outputs to stdout a list of files relative to
                   4846:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
                   4847:            The resulting files are to be symlinked
                   4848:            into <code class="filename">${BUILDLINK_DIR}</code>.  By default,
                   4849:            this takes the <code class="filename">+CONTENTS</code> of a
                   4850:            <em class="replaceable"><code>pkg</code></em> and filters it through
                   4851:            <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
1.128     wiz      4852: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   4853:            (not shown above) is a filter command that filters
1.76      rillig   4854:            <code class="filename">+CONTENTS</code> input into a list of files
1.75      rillig   4855:            relative to
1.76      rillig   4856:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.194     bsiegert 4857:            on stdout.  By default,
1.75      rillig   4858:            <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.76      rillig   4859:            outputs the contents of the <code class="filename">include</code>
                   4860:            and <code class="filename">lib</code> directories in the package
1.194     bsiegert 4861:            <code class="filename">+CONTENTS</code>.</p></li>
1.128     wiz      4862: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
1.75      rillig   4863:            (not shown above) is a list of sed arguments used to
                   4864:            transform the name of the source filename into a
1.110     hubertf  4865:            destination filename, e.g. <span class="command"><strong>-e
1.87      wiz      4866:            "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
1.75      rillig   4867: </ul></div>
1.120     snj      4868: <p>This section can additionally include any
1.87      wiz      4869:       <code class="filename">buildlink3.mk</code> needed for
                   4870:       <em class="replaceable"><code>pkg</code></em>'s library dependencies.
                   4871:       Including these <code class="filename">buildlink3.mk</code> files
                   4872:       means that the headers and libraries for these
                   4873:       dependencies are also symlinked into
                   4874:       <code class="filename">${BUILDLINK_DIR}</code>
                   4875:       whenever the <em class="replaceable"><code>pkg</code></em>
                   4876:       <code class="filename">buildlink3.mk</code>
1.120     snj      4877:       file is included. Dependencies are only added for directly
                   4878:       include <code class="filename">buildlink3.mk</code> files.</p>
1.153     wiz      4879: <p>When providing a <code class="filename">buildlink3.mk</code> and
                   4880:       including other <code class="filename">buildlink3.mk</code> files in it,
1.156     wiz      4881:       please only add necessary ones, i.e., those whose libraries or
1.153     wiz      4882:       header files are automatically exposed when the package is
                   4883:       use.</p>
                   4884: <p>In particular, if only an executable
                   4885:       (<code class="filename">bin/foo</code>) is linked against a library, that
                   4886:       library does not need to be propagated in the
                   4887:       <code class="filename">buildlink3.mk</code> file.</p>
                   4888: <p>The following steps should help you decide if a
                   4889:       <code class="filename">buildlink3.mk</code> file needs to be included:
                   4890:       </p>
                   4891: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   4892: <li class="listitem"><p>Look at the installed header files: What
                   4893:        headers do they include? The packages providing these files
                   4894:        must be buildlinked.</p></li>
1.155     wiz      4895: <li class="listitem"><p>Run <code class="filename">ldd</code> on all installed
                   4896:        libraries and look against what other libraries they link.
                   4897:        Some of the packages providing these probably need to be
                   4898:        buildlinked; however, it's not automatic, since e.g. GTK on
                   4899:        some systems pulls in the X libraries, so they will show up in
                   4900:        the <code class="filename">ldd</code> output, while on others (like OS
1.156     wiz      4901:        X) it won't. <code class="filename">ldd</code> output can thus only be
1.155     wiz      4902:        used as a hint.</p></li>
1.153     wiz      4903: </ul></div>
                   4904: <p>
                   4905:       </p>
1.75      rillig   4906: </div>
1.148     asau     4907: <div class="sect2">
1.75      rillig   4908: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   4909: <a name="updating-buildlink-depends"></a>16.2.2. Updating
1.87      wiz      4910:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.133     wiz      4911:       and
                   4912:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   4913:       in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
                   4914: <p>These two variables differ in that one describes source
                   4915:       compatibility (API) and the other binary compatibility (ABI).
                   4916:       The difference is that a change in the API breaks compilation of
                   4917:       programs while changes in the ABI stop compiled programs from
                   4918:       running.</p>
                   4919: <p>Changes to the
1.134     wiz      4920:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.133     wiz      4921:       variable in a <code class="filename">buildlink3.mk</code> file happen
                   4922:       very rarely. One possible reason is that all packages depending
                   4923:       on this already need a newer version. In case it is bumped see
                   4924:       the description below.</p>
                   4925: <p>The most common example of an ABI change is that the major
                   4926:       version of a shared library is increased. In this case,
                   4927:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   4928:       should be adjusted to require at least the new package version.
                   4929:       Then the packages that depend on this package need their
                   4930:       <code class="varname">PKGREVISION</code>s increased and, if they have
                   4931:       <code class="filename">buildlink3.mk</code> files, their
                   4932:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   4933:       adjusted, too. This is needed so pkgsrc will require the correct
                   4934:       package dependency and not settle for an older one when building
                   4935:       the source.</p>
1.267     rillig   4936: <p>See <a class="xref" href="#dependencies" title="21.1.5. Handling dependencies">Section 21.1.5, &#8220;Handling dependencies&#8221;</a> for
1.133     wiz      4937:       more information about dependencies on other packages,
                   4938:       including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
1.87      wiz      4939:       <code class="varname">ABI_DEPENDS</code> definitions.</p>
                   4940: <p>Please take careful consideration before adjusting
                   4941:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   4942:       or
                   4943:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   4944:       as we don't want to cause unneeded package deletions and
                   4945:       rebuilds.  In many cases, new versions of packages work just
                   4946:       fine with older dependencies.</p>
                   4947: <p>Also it is not needed to set
1.133     wiz      4948:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   4949:       when it is identical to
1.87      wiz      4950:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.        </p>
1.75      rillig   4951: </div>
                   4952: </div>
1.148     asau     4953: <div class="sect1">
1.75      rillig   4954: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   4955: <a name="writing-builtin.mk"></a>16.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.87      wiz      4956: <p>Some packages in pkgsrc install headers and libraries that
1.75      rillig   4957:       coincide with headers and libraries present in the base system.
1.76      rillig   4958:       Aside from a <code class="filename">buildlink3.mk</code> file, these
                   4959:       packages should also include a <code class="filename">builtin.mk</code>
1.75      rillig   4960:       file that includes the necessary checks to decide whether using
                   4961:       the built-in software or the pkgsrc software is
1.87      wiz      4962:     appropriate.</p>
                   4963: <p>The only requirements of a builtin.mk file for
                   4964:     <em class="replaceable"><code>pkg</code></em> are:</p>
1.128     wiz      4965: <div class="orderedlist"><ol class="orderedlist" type="1">
                   4966: <li class="listitem"><p>It should set
1.87      wiz      4967:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128     wiz      4968:        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>
1.87      wiz      4969:        after it is included.</p></li>
1.128     wiz      4970: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
1.87      wiz      4971:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   4972:        which is already set before the
                   4973:        <code class="filename">builtin.mk</code> file is included.</p></li>
1.128     wiz      4974: <li class="listitem"><p>It should be written to allow multiple inclusion.  This
1.87      wiz      4975:        is <span class="emphasis"><em>very</em></span> important and takes careful
                   4976:        attention to <code class="filename">Makefile</code> coding.</p></li>
1.75      rillig   4977: </ol></div>
1.148     asau     4978: <div class="sect2">
1.75      rillig   4979: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   4980: <a name="anatomy-of-builtin.mk"></a>16.3.1. Anatomy of a <code class="filename">builtin.mk</code> file</h3></div></div></div>
1.75      rillig   4981: <p>The following is the recommended template for builtin.mk
1.87      wiz      4982:       files:</p>
1.75      rillig   4983: <pre class="programlisting">
1.100     rillig   4984: .if !defined(IS_BUILTIN.foo)
                   4985: #
                   4986: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
                   4987: # genuinely exists in the system or not.
                   4988: #
                   4989: IS_BUILTIN.foo?=        no
                   4990: 
                   4991: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
                   4992: # version can be determined.
                   4993: #
                   4994: .  if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
                   4995: BUILTIN_PKG.foo?=       foo-1.0
                   4996: .  endif
                   4997: .endif  # IS_BUILTIN.foo
                   4998: 
                   4999: .if !defined(USE_BUILTIN.foo)
                   5000: USE_BUILTIN.foo?=       ${IS_BUILTIN.foo}
                   5001: .  if defined(BUILTIN_PKG.foo)
                   5002: .    for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
                   5003: .      if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
                   5004: USE_BUILTIN.foo!=                                                       \
                   5005:         ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo}            \
                   5006:         &amp;&amp; ${ECHO} "yes" || ${ECHO} "no"
                   5007: .      endif
                   5008: .    endfor
                   5009: .  endif
                   5010: .endif  # USE_BUILTIN.foo
                   5011: 
                   5012: CHECK_BUILTIN.foo?=     no
                   5013: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
                   5014: #
                   5015: # Here we place code that depends on whether USE_BUILTIN.foo is set to
                   5016: # "yes" or "no".
                   5017: #
                   5018: .endif  # CHECK_BUILTIN.foo
                   5019: </pre>
1.87      wiz      5020: <p>The first section sets
                   5021:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5022:       depending on if <em class="replaceable"><code>pkg</code></em> really exists
                   5023:       in the base system.  This should not be a base system software
                   5024:       with similar functionality to <em class="replaceable"><code>pkg</code></em>;
1.128     wiz      5025:       it should only be <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> if the actual package is
1.87      wiz      5026:       included as part of the base system.  This variable is only
                   5027:       used internally within the <code class="filename">builtin.mk</code>
                   5028:       file.</p>
                   5029: <p>The second section sets
                   5030:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   5031:       to the version of <em class="replaceable"><code>pkg</code></em> in the base
                   5032:       system if it exists (if
                   5033:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128     wiz      5034:       is <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>).  This variable is only used internally
1.87      wiz      5035:       within the <code class="filename">builtin.mk</code> file.</p>
                   5036: <p>The third section sets
                   5037:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5038:       and is <span class="emphasis"><em>required</em></span> in all
                   5039:       <code class="filename">builtin.mk</code> files.  The code in this
                   5040:       section must make the determination whether the built-in
                   5041:       software is adequate to satisfy the dependencies listed in
                   5042:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   5043:       This is typically done by comparing
                   5044:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   5045:       against each of the dependencies in
                   5046:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   5047:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5048:       <span class="emphasis"><em>must</em></span> be set to the correct value by the
                   5049:       end of the <code class="filename">builtin.mk</code> file.  Note that
                   5050:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128     wiz      5051:       may be <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> even if
1.87      wiz      5052:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.128     wiz      5053:       is <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span> because we may make the determination
1.87      wiz      5054:       that the built-in version of the software is similar enough to
                   5055:       be used as a replacement.</p>
                   5056: <p>The last section is guarded by
                   5057:       <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
                   5058:       and includes code that uses the value of
                   5059:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5060:       set in the previous section.  This typically includes, e.g.,
                   5061:       adding additional dependency restrictions and listing additional
                   5062:       files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
                   5063:       <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
1.75      rillig   5064: </div>
1.148     asau     5065: <div class="sect2">
1.75      rillig   5066: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   5067: <a name="native-or-pkgsrc-preference"></a>16.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.87      wiz      5068: <p>When building packages, it's possible to choose whether to set
                   5069:        a global preference for using either the built-in (native)
                   5070:        version or the pkgsrc version of software to satisfy a
                   5071:        dependency.  This is controlled by setting
                   5072:        <code class="varname">PREFER_PKGSRC</code> and
                   5073:        <code class="varname">PREFER_NATIVE</code>.  These variables take values
1.128     wiz      5074:        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
1.87      wiz      5075:        packages.  <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
                   5076:        use the pkgsrc versions of software, while
                   5077:        <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
                   5078:        built-in versions.  Preferences are determined by the most
                   5079:        specific instance of the package in either
                   5080:        <code class="varname">PREFER_PKGSRC</code> or
                   5081:        <code class="varname">PREFER_NATIVE</code>.  If a package is specified
                   5082:        in neither or in both variables, then
                   5083:        <code class="varname">PREFER_PKGSRC</code> has precedence over
                   5084:        <code class="varname">PREFER_NATIVE</code>.  For example, to require
                   5085:        using pkgsrc versions of software for all but the most basic
                   5086:       bits on a NetBSD system, you can set:</p>
                   5087: <pre class="programlisting">
1.100     rillig   5088: PREFER_PKGSRC=  yes
                   5089: PREFER_NATIVE=  getopt skey tcp_wrappers
                   5090: </pre>
1.87      wiz      5091: <p>A package <span class="emphasis"><em>must</em></span> have a
                   5092:       <code class="filename">builtin.mk</code>
                   5093:       file to be listed in <code class="varname">PREFER_NATIVE</code>,
                   5094:       otherwise it is simply ignored in that list.</p>
1.229     sevan    5095: <p>Setting <code class="varname">PREFER_NATIVE</code> should be performed
                   5096:       straight after bootstrap and <code class="varname">PREFER_PKGSRC</code> during
                   5097:       bootstrap.
                   5098:       Switching between settings globally at a later date can introduce
                   5099:       complications with dependency resolution. This is caused by packages
                   5100:       built with the opposite preference being installed alongside each other.</p>
                   5101: <pre class="screen">
                   5102: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap --prefer-pkgsrc yes</code></strong>
                   5103: </pre>
1.75      rillig   5104: </div>
                   5105: </div>
                   5106: </div>
1.148     asau     5107: <div class="chapter">
1.75      rillig   5108: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   5109: <a name="pkginstall"></a>Chapter 17. The pkginstall framework</h2></div></div></div>
1.75      rillig   5110: <div class="toc">
                   5111: <p><b>Table of Contents</b></p>
1.210     leot     5112: <dl class="toc">
1.267     rillig   5113: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">17.1. Files and directories outside the installation prefix</a></span></dt>
1.75      rillig   5114: <dd><dl>
1.267     rillig   5115: <dt><span class="sect2"><a href="#dirs-outside-prefix">17.1.1. Directory manipulation</a></span></dt>
                   5116: <dt><span class="sect2"><a href="#files-outside-prefix">17.1.2. File manipulation</a></span></dt>
1.75      rillig   5117: </dl></dd>
1.267     rillig   5118: <dt><span class="sect1"><a href="#conf-files">17.2. Configuration files</a></span></dt>
1.75      rillig   5119: <dd><dl>
1.267     rillig   5120: <dt><span class="sect2"><a href="#conf-files-sysconfdir">17.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
                   5121: <dt><span class="sect2"><a href="#conf-files-configure">17.2.2. Telling the software where configuration files are</a></span></dt>
                   5122: <dt><span class="sect2"><a href="#conf-files-patching">17.2.3. Patching installations</a></span></dt>
                   5123: <dt><span class="sect2"><a href="#conf-files-disable">17.2.4. Disabling handling of configuration files</a></span></dt>
                   5124: </dl></dd>
                   5125: <dt><span class="sect1"><a href="#rcd-scripts">17.3. System startup scripts</a></span></dt>
                   5126: <dd><dl><dt><span class="sect2"><a href="#rcd-scripts-disable">17.3.1. Disabling handling of system startup scripts</a></span></dt></dl></dd>
                   5127: <dt><span class="sect1"><a href="#users-and-groups">17.4. System users and groups</a></span></dt>
                   5128: <dt><span class="sect1"><a href="#shells">17.5. System shells</a></span></dt>
                   5129: <dd><dl><dt><span class="sect2"><a href="#shells-disable">17.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   5130: <dt><span class="sect1"><a href="#fonts">17.6. Fonts</a></span></dt>
                   5131: <dd><dl><dt><span class="sect2"><a href="#fonts-disable">17.6.1. Disabling automatic update of the fonts databases</a></span></dt></dl></dd>
1.75      rillig   5132: </dl>
                   5133: </div>
                   5134: <p>This chapter describes the framework known as
                   5135: <code class="literal">pkginstall</code>, whose key features are:</p>
1.148     asau     5136: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      5137: <li class="listitem"><p>Generic installation and manipulation of directories and files
1.75      rillig   5138:     outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
1.128     wiz      5139: <li class="listitem"><p>Automatic handling of configuration files during installation,
1.75      rillig   5140:     provided that packages are correctly designed.</p></li>
1.128     wiz      5141: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
                   5142: <li class="listitem"><p>Registration of system users and groups.</p></li>
                   5143: <li class="listitem"><p>Registration of system shells.</p></li>
                   5144: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
1.75      rillig   5145: </ul></div>
                   5146: <p>The following sections inspect each of the above points in detail.</p>
                   5147: <p>You may be thinking that many of the things described here could be
                   5148: easily done with simple code in the package's post-installation target
                   5149: (<code class="literal">post-install</code>).  <span class="emphasis"><em>This is incorrect</em></span>,
                   5150: as the code in them is only executed when building from source.  Machines
                   5151: using binary packages could not benefit from it at all (as the code itself
                   5152: could be unavailable).  Therefore, the only way to achieve any of the items
                   5153: described above is by means of the installation scripts, which are
                   5154: automatically generated by pkginstall.</p>
1.148     asau     5155: <div class="sect1">
1.75      rillig   5156: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   5157: <a name="files-and-dirs-outside-prefix"></a>17.1. Files and directories outside the installation prefix</h2></div></div></div>
1.76      rillig   5158: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
1.75      rillig   5159: of files and directories that belong to a package.  The names used in it
1.76      rillig   5160: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
1.75      rillig   5161: which means that it cannot register files outside this directory (absolute
                   5162: path names are not allowed).  Despite this restriction, some packages need
                   5163: to install files outside this location; e.g., under
1.76      rillig   5164: <code class="filename">${VARBASE}</code> or
1.87      wiz      5165: <code class="filename">${PKG_SYSCONFDIR}</code>.  The only way to achieve this
                   5166: is to create such files during installation time by using
                   5167: installation scripts.</p>
                   5168: <p>The generic installation scripts are shell scripts that can
                   5169: contain arbitrary code.  The list of scripts to execute is taken from
                   5170: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
                   5171: <code class="filename">INSTALL</code>.  A similar variable exists for package
                   5172: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
                   5173: <code class="filename">DEINSTALL</code>).  These scripts can run arbitrary
                   5174: commands, so they have the potential to create and manage files
                   5175: anywhere in the file system.</p>
                   5176: <p>Using these general installation files is not recommended, but
                   5177: may be needed in some special cases.  One reason for avoiding them is
                   5178: that the user has to trust the packager that there is no unwanted or
                   5179: simply erroneous code included in the installation script. Also,
                   5180: previously there were many similar scripts for the same functionality,
                   5181: and fixing a common error involved finding and changing all of
                   5182: them.</p>
                   5183: <p>The pkginstall framework offers another, standardized way.  It
                   5184: provides generic scripts to abstract the manipulation of such files
                   5185: and directories based on variables set in the package's
                   5186: <code class="filename">Makefile</code>.  The rest of this section describes
                   5187: these variables.</p>
1.148     asau     5188: <div class="sect2">
1.75      rillig   5189: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   5190: <a name="dirs-outside-prefix"></a>17.1.1. Directory manipulation</h3></div></div></div>
1.75      rillig   5191: <p>The following variables can be set to request the creation of
                   5192: directories anywhere in the file system:</p>
1.148     asau     5193: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.218     rillig   5194: <li class="listitem">
                   5195: <p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
1.75      rillig   5196:     contain a list of directories that should be created and should attempt
                   5197:     to be destroyed by the installation scripts.  The difference between
                   5198:     the two is that the latter prompts the administrator to remove any
                   5199:     directories that may be left after deinstallation (because they were
1.218     rillig   5200:     not empty), while the former does not.  Example:</p>
                   5201: <pre class="programlisting">
                   5202: MAKE_DIRS+=             ${VARBASE}/foo/private
                   5203: </pre>
                   5204: </li>
1.128     wiz      5205: <li class="listitem">
1.75      rillig   5206: <p><code class="varname">MAKE_DIRS_PERMS</code> and
                   5207:     <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
                   5208:     which directories should be created and should attempt to be destroyed
                   5209:     by the installation scripts.  Each tuple holds the following values,
                   5210:     separated by spaces: the directory name, its owner, its group and its
                   5211:     numerical mode.  For example:</p>
                   5212: <pre class="programlisting">
1.218     rillig   5213: MAKE_DIRS_PERMS+=       ${VARBASE}/foo/private \
                   5214:                         ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1       grant    5215: </pre>
1.75      rillig   5216: <p>The difference between the two is exactly the same as their
                   5217:     non-<code class="varname">PERMS</code> counterparts.</p>
                   5218: </li>
                   5219: </ul></div>
                   5220: </div>
1.148     asau     5221: <div class="sect2">
1.75      rillig   5222: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   5223: <a name="files-outside-prefix"></a>17.1.2. File manipulation</h3></div></div></div>
1.75      rillig   5224: <p>Creating non-empty files outside the installation prefix is tricky
1.76      rillig   5225: because the <code class="filename">PLIST</code> forces all files to be inside it.
1.75      rillig   5226: To overcome this problem, the only solution is to extract the file in the
                   5227: known place (i.e., inside the installation prefix) and copy it to the
                   5228: appropriate location during installation (done by the installation scripts
                   5229: generated by pkginstall).  We will call the former the <span class="emphasis"><em>master
                   5230: file</em></span> in the following paragraphs, which describe the variables
                   5231: that can be used to automatically and consistently handle files outside the
                   5232: installation prefix:</p>
1.148     asau     5233: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      5234: <li class="listitem">
1.75      rillig   5235: <p><code class="varname">CONF_FILES</code> and
1.137     wiz      5236:     <code class="varname">REQD_FILES</code> are pairs of master and target files.
1.75      rillig   5237:     During installation time, the master file is copied to the target one
                   5238:     if and only if the latter does not exist.  Upon deinstallation, the
                   5239:     target file is removed provided that it was not modified by the
                   5240:     installation.</p>
                   5241: <p>The difference between the two is that the latter prompts the
                   5242:     administrator to remove any files that may be left after
                   5243:     deinstallation (because they were not empty), while the former does
                   5244:     not.</p>
                   5245: </li>
1.128     wiz      5246: <li class="listitem">
1.75      rillig   5247: <p><code class="varname">CONF_FILES_PERMS</code> and
1.137     wiz      5248:     <code class="varname">REQD_FILES_PERMS</code> contain tuples describing master
1.75      rillig   5249:     files as well as their target locations.  For each of them, it also
                   5250:     specifies their owner, their group and their numeric permissions, in
                   5251:     this order.  For example:</p>
                   5252: <pre class="programlisting">
1.218     rillig   5253: REQD_FILES_PERMS+=      ${PREFIX}/share/somefile ${VARBASE}/somefile \
                   5254:                         ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1       grant    5255: </pre>
1.75      rillig   5256: <p>The difference between the two is exactly the same as their
                   5257:     non-<code class="varname">PERMS</code> counterparts.</p>
                   5258: </li>
                   5259: </ul></div>
                   5260: </div>
                   5261: </div>
1.148     asau     5262: <div class="sect1">
1.75      rillig   5263: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   5264: <a name="conf-files"></a>17.2. Configuration files</h2></div></div></div>
1.75      rillig   5265: <p>Configuration files are special in the sense that they are installed
                   5266: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
                   5267: need special treatment during installation (most of which is automated by
                   5268: pkginstall).  The main concept you must bear in mind is that files marked
                   5269: as configuration files are automatically copied to the right place (somewhere
                   5270: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
                   5271: and only if</em></span> they didn't exist before.  Similarly, they will not
                   5272: be removed if they have local modifications.  This ensures that
                   5273: administrators never lose any custom changes they may have made.</p>
1.148     asau     5274: <div class="sect2">
1.75      rillig   5275: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   5276: <a name="conf-files-sysconfdir"></a>17.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</h3></div></div></div>
1.75      rillig   5277: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
                   5278: specifies where configuration files shall be installed.  Its contents are
                   5279: set based upon the following variables:</p>
1.148     asau     5280: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      5281: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
1.76      rillig   5282:     directory.  Defaults to <code class="filename">${PREFIX}/etc</code> although it may
1.75      rillig   5283:     be overridden by the user to point to his preferred location (e.g.,
1.76      rillig   5284:     <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
1.75      rillig   5285:     Packages must not use it directly.</p></li>
1.128     wiz      5286: <li class="listitem">
1.75      rillig   5287: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
                   5288:     <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
                   5289:     for the package being built shall be installed.  The definition of this
                   5290:     variable only makes sense in the package's
1.76      rillig   5291:     <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
1.75      rillig   5292: <p>As an example, consider the Apache package,
1.250     leot     5293:     <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
1.75      rillig   5294:     configuration files under the
1.76      rillig   5295:     <code class="filename">httpd/</code> subdirectory of
1.75      rillig   5296:     <code class="varname">PKG_SYSCONFBASE</code>.  This should be set in the package
                   5297:     Makefile.</p>
                   5298: </li>
1.128     wiz      5299: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
1.75      rillig   5300:     variable that holds this package's configuration directory (if
                   5301:     different from <code class="varname">PKG_SYSCONFBASE</code>).  It defaults to
                   5302:     <code class="varname">PKGBASE</code>'s value, and is always prefixed with
                   5303:     <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
1.128     wiz      5304: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
1.75      rillig   5305:     directory where the configuration files for the package identified by
                   5306:     <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
                   5307: </ul></div>
                   5308: <p>Based on the above variables, pkginstall determines the value of
                   5309: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
                   5310: variable that can be used within a package to refer to its configuration
                   5311: directory.  The algorithm used to set its value is basically the
                   5312: following:</p>
1.128     wiz      5313: <div class="orderedlist"><ol class="orderedlist" type="1">
                   5314: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
1.75      rillig   5315:     its value is used.</p></li>
1.128     wiz      5316: <li class="listitem"><p>If the previous variable is not defined but
1.75      rillig   5317:     <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
1.76      rillig   5318:     <code class="filename">Makefile</code>, the resulting value is
                   5319:     <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
1.128     wiz      5320: <li class="listitem"><p>Otherwise, it is set to
1.76      rillig   5321:     <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
1.75      rillig   5322: </ol></div>
1.76      rillig   5323: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.267     rillig   5324: automatically added to <code class="filename">OWN_DIRS</code>.  See <a class="xref" href="#dirs-outside-prefix" title="17.1.1. Directory manipulation">Section 17.1.1, &#8220;Directory manipulation&#8221;</a> what this means.  This does not apply to
1.117     jnemeth  5325: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
                   5326: be created with OWN_DIRS or MAKE_DIRS.</p>
1.75      rillig   5327: </div>
1.148     asau     5328: <div class="sect2">
1.75      rillig   5329: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   5330: <a name="conf-files-configure"></a>17.2.2. Telling the software where configuration files are</h3></div></div></div>
1.75      rillig   5331: <p>Given that pkgsrc (and users!) expect configuration files to be in a
                   5332: known place, you need to teach each package where it shall install its
                   5333: files.  In some cases you will have to patch the package Makefiles to
                   5334: achieve it.  If you are lucky, though, it may be as easy as passing an
                   5335: extra flag to the configuration script; this is the case of GNU Autoconf-
                   5336: generated files:</p>
                   5337: <pre class="programlisting">
1.100     rillig   5338: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
1.1       grant    5339: </pre>
1.75      rillig   5340: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
                   5341: for</em></span> its configuration files, not where they will be originally
                   5342: installed (although the difference is never explicit,
                   5343: unfortunately).</p>
                   5344: </div>
1.148     asau     5345: <div class="sect2">
1.75      rillig   5346: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   5347: <a name="conf-files-patching"></a>17.2.3. Patching installations</h3></div></div></div>
1.75      rillig   5348: <p>As said before, pkginstall automatically handles configuration files.
                   5349: This means that <span class="strong"><strong>the packages themselves must not
1.76      rillig   5350: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
1.75      rillig   5351: directly</strong></span>.  Bad news is that many software installation scripts
                   5352: will, out of the box, mess with the contents of that directory.  So what is
                   5353: the correct procedure to fix this issue?</p>
                   5354: <p>You must teach the package (usually by manually patching it) to
                   5355: install any configuration files under the examples hierarchy,
1.76      rillig   5356: <code class="filename">share/examples/${PKGBASE}/</code>.  This way, the
                   5357: <code class="filename">PLIST</code> registers them and the administrator always
1.75      rillig   5358: has the original copies available.</p>
                   5359: <p>Once the required configuration files are in place (i.e., under the
                   5360: examples hierarchy), the pkginstall framework can use them as master copies
                   5361: during the package installation to update what is in
1.76      rillig   5362: <code class="filename">${PKG_SYSCONFDIR}</code>.  To achieve this, the variables
1.75      rillig   5363: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.267     rillig   5364: used.  Check out <a class="xref" href="#files-outside-prefix" title="17.1.2. File manipulation">Section 17.1.2, &#8220;File manipulation&#8221;</a> for information
1.75      rillig   5365: about their syntax and their purpose.  Here is an example, taken from the
1.250     leot     5366: <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.75      rillig   5367: <pre class="programlisting">
1.100     rillig   5368: EGDIR=        ${PREFIX}/share/doc/mutt/samples
                   5369: CONF_FILES=   ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
1.1       grant    5370: </pre>
1.75      rillig   5371: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
                   5372: package and has no meaning outside it.</p>
                   5373: </div>
1.148     asau     5374: <div class="sect2">
1.75      rillig   5375: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   5376: <a name="conf-files-disable"></a>17.2.4. Disabling handling of configuration files</h3></div></div></div>
1.75      rillig   5377: <p>The automatic copying of config files can be toggled by setting the
                   5378: environment variable <code class="varname">PKG_CONFIG</code> prior to package
                   5379: installation.</p>
                   5380: </div>
                   5381: </div>
1.148     asau     5382: <div class="sect1">
1.75      rillig   5383: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   5384: <a name="rcd-scripts"></a>17.3. System startup scripts</h2></div></div></div>
1.75      rillig   5385: <p>System startup scripts are special files because they must be
                   5386: installed in a place known by the underlying OS, usually outside the
1.267     rillig   5387: installation prefix.  Therefore, the same rules described in <a class="xref" href="#files-and-dirs-outside-prefix" title="17.1. Files and directories outside the installation prefix">Section 17.1, &#8220;Files and directories outside the installation prefix&#8221;</a> apply, and the same solutions
1.75      rillig   5388: can be used.  However, pkginstall provides a special mechanism to handle
                   5389: these files.</p>
                   5390: <p>In order to provide system startup scripts, the package has
                   5391: to:</p>
1.128     wiz      5392: <div class="orderedlist"><ol class="orderedlist" type="1">
                   5393: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
1.75      rillig   5394:     the <code class="literal">.sh</code> suffix appended.  Considering the
1.250     leot     5395:     <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
1.76      rillig   5396:     <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.128     wiz      5397: <li class="listitem">
1.75      rillig   5398: <p>Tell pkginstall to handle it, appending the name of the script,
                   5399:     without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
                   5400:     Continuing the previous example:</p>
                   5401: <pre class="programlisting">
1.100     rillig   5402: RCD_SCRIPTS+=   cupsd
1.1       grant    5403: </pre>
1.75      rillig   5404: </li>
                   5405: </ol></div>
                   5406: <p>Once this is done, pkginstall will do the following steps for each
                   5407: script in an automated fashion:</p>
1.128     wiz      5408: <div class="orderedlist"><ol class="orderedlist" type="1">
                   5409: <li class="listitem"><p>Process the file found in the files directory applying all the
1.76      rillig   5410:     substitutions described in the <code class="filename">FILES_SUBST</code>
1.75      rillig   5411:     variable.</p></li>
1.128     wiz      5412: <li class="listitem"><p>Copy the script from the files directory to the examples
1.76      rillig   5413:     hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>.  Note
1.75      rillig   5414:     that this master file must be explicitly registered in the
1.76      rillig   5415:     <code class="filename">PLIST</code>.</p></li>
1.128     wiz      5416: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
1.75      rillig   5417:     from the examples hierarchy into the system-wide startup scripts
                   5418:     directory.</p></li>
                   5419: </ol></div>
1.148     asau     5420: <div class="sect2">
1.75      rillig   5421: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   5422: <a name="rcd-scripts-disable"></a>17.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.75      rillig   5423: <p>The automatic copying of config files can be toggled by setting the
                   5424: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
                   5425: installation.  Note that the scripts will be always copied inside the
1.76      rillig   5426: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
1.75      rillig   5427: matter what the value of this variable is.</p>
                   5428: </div>
                   5429: </div>
1.148     asau     5430: <div class="sect1">
1.75      rillig   5431: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   5432: <a name="users-and-groups"></a>17.4. System users and groups</h2></div></div></div>
1.75      rillig   5433: <p>If a package needs to create special users and/or groups during
                   5434: installation, it can do so by using the pkginstall framework.</p>
                   5435: <p>Users can be created by adding entries to the
                   5436: <code class="varname">PKG_USERS</code> variable.  Each entry has the following
                   5437: syntax:</p>
                   5438: <pre class="programlisting">
1.100     rillig   5439: user:group
1.1       grant    5440: </pre>
1.87      wiz      5441: <p>Further specification of user details may be done by setting
                   5442: per-user variables.
                   5443: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
                   5444: numeric UID for the user.
                   5445: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
                   5446: user's description or comment.
                   5447: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
                   5448: user's home directory, and defaults to
                   5449: <code class="filename">/nonexistent</code> if not specified.
                   5450: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
1.94      dmcmahil 5451: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
1.87      wiz      5452: not specified.</p>
1.75      rillig   5453: <p>Similarly, groups can be created by adding entries to the
                   5454: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
                   5455: <pre class="programlisting">
1.100     rillig   5456: group
1.1       grant    5457: </pre>
1.93      rillig   5458: <p>The numeric GID of the group may be set by defining
1.75      rillig   5459: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
                   5460: <p>If a package needs to create the users and groups at an earlier
1.227     wiz      5461: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to either
                   5462: <code class="literal">configure</code>,<code class="literal">build</code>, or
                   5463: <code class="literal">pre-install</code> to indicate the phase before which the
                   5464: users and groups are created. In this case, the numeric UIDs and GIDs
                   5465: of the created users and groups are automatically hardcoded into the
                   5466: final installation scripts.</p>
1.75      rillig   5467: </div>
1.148     asau     5468: <div class="sect1">
1.75      rillig   5469: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   5470: <a name="shells"></a>17.5. System shells</h2></div></div></div>
1.75      rillig   5471: <p>Packages that install system shells should register them in the shell
1.76      rillig   5472: database, <code class="filename">/etc/shells</code>, to make things easier to the
1.75      rillig   5473: administrator.  This must be done from the installation scripts to keep
                   5474: binary packages working on any system.  pkginstall provides an easy way to
                   5475: accomplish this task.</p>
                   5476: <p>When a package provides a shell interpreter, it has to set the
                   5477: <code class="varname">PKG_SHELL</code> variable to its absolute file name.  This will
                   5478: add some hooks to the installation scripts to handle it.  Consider the
1.250     leot     5479: 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>
1.75      rillig   5480: <pre class="programlisting">
1.100     rillig   5481: PKG_SHELL=      ${PREFIX}/bin/zsh
1.1       grant    5482: </pre>
1.148     asau     5483: <div class="sect2">
1.75      rillig   5484: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   5485: <a name="shells-disable"></a>17.5.1. Disabling shell registration</h3></div></div></div>
1.75      rillig   5486: <p>The automatic registration of shell interpreters can be disabled by
1.76      rillig   5487: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
1.75      rillig   5488: environment variable to <code class="literal">NO</code>.</p>
                   5489: </div>
                   5490: </div>
1.148     asau     5491: <div class="sect1">
1.75      rillig   5492: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   5493: <a name="fonts"></a>17.6. Fonts</h2></div></div></div>
1.75      rillig   5494: <p>Packages that install X11 fonts should update the database files
                   5495: that index the fonts within each fonts directory.  This can easily be
                   5496: accomplished within the pkginstall framework.</p>
                   5497: <p>When a package installs X11 fonts, it must list the directories in
                   5498: which fonts are installed in the
                   5499: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
1.128     wiz      5500: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">&#8220;<span class="quote">ttf</span>&#8221;</span>,
                   5501: <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
1.75      rillig   5502: installation scripts to run the appropriate commands to update the fonts
                   5503: database files within each of those directories.  For convenience, if the
                   5504: directory path is relative, it is taken to be relative to the package's
1.250     leot     5505: installation prefix.  Consider the following example, taken from <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/fonts/dbz-ttf/README.html" target="_top"><code class="filename">fonts/dbz-ttf</code></a>:</p>
1.75      rillig   5506: <pre class="programlisting">
1.175     wiz      5507: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF
1.1       grant    5508: </pre>
1.148     asau     5509: <div class="sect2">
1.75      rillig   5510: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   5511: <a name="fonts-disable"></a>17.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.75      rillig   5512: <p>The automatic update of fonts databases can be disabled by
1.76      rillig   5513: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
1.75      rillig   5514: environment variable to <code class="literal">NO</code>.</p>
                   5515: </div>
                   5516: </div>
                   5517: </div>
1.148     asau     5518: <div class="chapter">
1.75      rillig   5519: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   5520: <a name="options"></a>Chapter 18. Options handling</h2></div></div></div>
1.75      rillig   5521: <div class="toc">
                   5522: <p><b>Table of Contents</b></p>
1.210     leot     5523: <dl class="toc">
1.267     rillig   5524: <dt><span class="sect1"><a href="#global-default-options">18.1. Global default options</a></span></dt>
                   5525: <dt><span class="sect1"><a href="#converting-to-options">18.2. Converting packages to use <code class="filename">bsd.options.mk</code></a></span></dt>
                   5526: <dt><span class="sect1"><a href="#option-names">18.3. Option Names</a></span></dt>
                   5527: <dt><span class="sect1"><a href="#option-build">18.4. Determining the options of dependencies</a></span></dt>
1.75      rillig   5528: </dl>
                   5529: </div>
                   5530: <p>Many packages have the ability to be built to support different
1.76      rillig   5531: sets of features.  <code class="filename">bsd.options.mk</code> is a framework
1.75      rillig   5532: in pkgsrc that provides generic handling of those options that
                   5533: determine different ways in which the packages can be built.  It's
                   5534: possible for the user to specify exactly which sets of options will be
                   5535: built into a package or to allow a set of global default options
                   5536: apply.</p>
1.107     rillig   5537: <p>There are two broad classes of behaviors that one might want to
                   5538: control via options.  One is whether some particular feature is
                   5539: enabled in a program that will be built anyway, often by including or
                   5540: not including a dependency on some other package.  The other is
                   5541: whether or not an additional program will be built as part of the
                   5542: package.  Generally, it is better to make a split package for such
                   5543: additional programs instead of using options, because it enables
                   5544: binary packages to be built which can then be added separately.  For
                   5545: example, the foo package might have minimal dependencies (those
                   5546: packages without which foo doesn't make sense), and then the foo-gfoo
                   5547: package might include the GTK frontend program gfoo.  This is better
                   5548: than including a gtk option to foo that adds gfoo, because either that
                   5549: option is default, in which case binary users can't get foo without
                   5550: gfoo, or not default, in which case they can't get gfoo.  With split
                   5551: packages, they can install foo without having GTK, and later decide to
                   5552: install gfoo (pulling in GTK at that time).  This is an advantage to
                   5553: source users too, avoiding the need for rebuilds.</p>
                   5554: <p>Plugins with widely varying dependencies should usually be split
                   5555: instead of options.</p>
                   5556: <p>It is often more work to maintain split packages, especially if
                   5557: the upstream package does not support this.  The decision of split
                   5558: vs. option should be made based on the likelihood that users will want
                   5559: or object to the various pieces, the size of the dependencies that are
                   5560: included, and the amount of work.</p>
                   5561: <p>A further consideration is licensing.  Non-free parts, or parts
                   5562: that depend on non-free dependencies (especially plugins) should
                   5563: almost always be split if feasible.</p>
1.148     asau     5564: <div class="sect1">
1.75      rillig   5565: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   5566: <a name="global-default-options"></a>18.1. Global default options</h2></div></div></div>
1.75      rillig   5567: <p>Global default options are listed in
                   5568: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
                   5569: that should be built into every package if that option is supported.
1.110     hubertf  5570: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.75      rillig   5571: </div>
1.148     asau     5572: <div class="sect1">
1.75      rillig   5573: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   5574: <a name="converting-to-options"></a>18.2. Converting packages to use <code class="filename">bsd.options.mk</code>
1.93      rillig   5575: </h2></div></div></div>
1.75      rillig   5576: <p>The following example shows how
1.76      rillig   5577: <code class="filename">bsd.options.mk</code> should be used
1.75      rillig   5578: by the hypothetical ``wibble'' package, either in the package
1.76      rillig   5579: <code class="filename">Makefile</code>, or in a file,
                   5580: e.g. <code class="filename">options.mk</code>, that is included by the
                   5581: main package <code class="filename">Makefile</code>.</p>
1.75      rillig   5582: <pre class="programlisting">
1.100     rillig   5583: PKG_OPTIONS_VAR=                PKG_OPTIONS.wibble
                   5584: PKG_SUPPORTED_OPTIONS=          wibble-foo ldap
                   5585: PKG_OPTIONS_OPTIONAL_GROUPS=    database
                   5586: PKG_OPTIONS_GROUP.database=     mysql pgsql
                   5587: PKG_SUGGESTED_OPTIONS=          wibble-foo
                   5588: PKG_OPTIONS_LEGACY_VARS+=       WIBBLE_USE_OPENLDAP:ldap
                   5589: PKG_OPTIONS_LEGACY_OPTS+=       foo:wibble-foo
                   5590: 
                   5591: .include "../../mk/bsd.prefs.mk"
                   5592: 
                   5593: # this package was previously named wibble2
                   5594: .if defined(PKG_OPTIONS.wibble2)
                   5595: PKG_LEGACY_OPTIONS+=            ${PKG_OPTIONS.wibble2}
                   5596: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
                   5597:         "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
                   5598: .endif
                   5599: 
                   5600: .include "../../mk/bsd.options.mk"
                   5601: 
                   5602: # Package-specific option-handling
                   5603: 
                   5604: ###
                   5605: ### FOO support
                   5606: ###
                   5607: .if !empty(PKG_OPTIONS:Mwibble-foo)
                   5608: CONFIGURE_ARGS+=    --enable-foo
                   5609: .endif
                   5610: 
                   5611: ###
                   5612: ### LDAP support
                   5613: ###
                   5614: .if !empty(PKG_OPTIONS:Mldap)
                   5615: .  include "../../databases/openldap-client/buildlink3.mk"
                   5616: CONFIGURE_ARGS+=    --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
                   5617: .endif
                   5618: 
                   5619: ###
                   5620: ### database support
                   5621: ###
                   5622: .if !empty(PKG_OPTIONS:Mmysql)
                   5623: .  include "../../mk/mysql.buildlink3.mk"
                   5624: .endif
                   5625: .if !empty(PKG_OPTIONS:Mpgsql)
                   5626: .  include "../../mk/pgsql.buildlink3.mk"
                   5627: .endif
1.75      rillig   5628: </pre>
                   5629: <p>The first section contains the information about which build
                   5630: options are supported by the package, and any default options settings
                   5631: if needed.</p>
1.128     wiz      5632: <div class="orderedlist"><ol class="orderedlist" type="1">
                   5633: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.289     leot     5634: <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> variable that the user can set to override the default
1.75      rillig   5635: options.  It should be set to
1.78      rillig   5636: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
                   5637: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
                   5638: at the point where the options are processed.</p></li>
1.128     wiz      5639: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
1.75      rillig   5640: build options supported by the package.</p></li>
1.128     wiz      5641: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
1.75      rillig   5642: list of names of groups of mutually exclusive options.  The options in
                   5643: each group are listed in
                   5644: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
                   5645: The most specific setting of any option from the group takes
                   5646: precedence over all other options in the group.  Options from the
                   5647: groups will be automatically added to
                   5648: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
1.128     wiz      5649: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
1.75      rillig   5650: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
                   5651: packages will fail if no option from the group is
                   5652: selected.</p></li>
1.128     wiz      5653: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
1.75      rillig   5654: of names of sets of options.  At least one option from each set must
                   5655: be selected.  The options in each set are listed in
                   5656: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
                   5657: Options from the sets will be automatically added to
                   5658: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.  Building the package will
                   5659: fail if no option from the set is selected.</p></li>
1.128     wiz      5660: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
1.75      rillig   5661: build options which are enabled by default.</p></li>
1.128     wiz      5662: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
1.75      rillig   5663: of
1.128     wiz      5664: <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>
1.110     hubertf  5665: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
1.75      rillig   5666: their option counterparts.  Pairs should be added with
1.128     wiz      5667: <span class="quote">&#8220;<span class="quote">+=</span>&#8221;</span> to keep the listing of global legacy variables.  A
1.75      rillig   5668: warning will be issued if the user uses a legacy
                   5669: variable.</p></li>
1.128     wiz      5670: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
1.75      rillig   5671: of
1.128     wiz      5672: <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>
1.75      rillig   5673: pairs that map options that have been renamed to their new
1.128     wiz      5674: counterparts.  Pairs should be added with <span class="quote">&#8220;<span class="quote">+=</span>&#8221;</span> to keep
1.75      rillig   5675: the listing of global legacy options.  A warning will be issued if
                   5676: the user uses a legacy option.</p></li>
1.128     wiz      5677: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
1.75      rillig   5678: options implied by deprecated variables used.  This can be used for
                   5679: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
                   5680: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
                   5681: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
1.128     wiz      5682: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
1.75      rillig   5683: a list of warnings about deprecated variables or options used, and
                   5684: what to use instead.</p></li>
                   5685: </ol></div>
                   5686: <p>A package should never modify
                   5687: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
                   5688: <code class="varname">PKG_OPTIONS_VAR</code>.  These are strictly user-settable.
                   5689: To suggest a default set of options, use
                   5690: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
                   5691: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
1.76      rillig   5692: including <code class="filename">bsd.options.mk</code>.  If none of
1.75      rillig   5693: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
                   5694: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
                   5695: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
                   5696: happen with platform-specific options if none of them is supported on
                   5697: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
                   5698: empty list and the package is otherwise treated as not using the
                   5699: options framework.</p>
1.76      rillig   5700: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
1.75      rillig   5701: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
                   5702: build options, properly filtered to remove unsupported and duplicate
                   5703: options.</p>
                   5704: <p>The remaining sections contain the logic that is specific to
                   5705: each option.  The correct way to check for an option is to check
                   5706: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
                   5707: <pre class="programlisting">
1.100     rillig   5708: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
1.75      rillig   5709: </pre>
                   5710: </div>
1.148     asau     5711: <div class="sect1">
1.75      rillig   5712: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   5713: <a name="option-names"></a>18.3. Option Names</h2></div></div></div>
1.75      rillig   5714: <p>Options that enable similar features in different packages (like
                   5715: optional support for a library) should use a common name in all
                   5716: packages that support it (like the name of the library).  If another
                   5717: package already has an option with the same meaning, use the same
                   5718: name.</p>
                   5719: <p>Options that enable features specific to one package, where it's
                   5720: unlikely that another (unrelated) package has the same (or a similar)
                   5721: optional feature, should use a name prefixed with
                   5722: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
                   5723: <p>If a group of related packages share an optional feature
                   5724: specific to that group, prefix it with the name of the
1.128     wiz      5725: <span class="quote">&#8220;<span class="quote">main</span>&#8221;</span> package
1.75      rillig   5726: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
                   5727: <p>For new options, add a line to
1.76      rillig   5728: <code class="filename">mk/defaults/options.description</code>.  Lines have two
1.75      rillig   5729: fields, separated by tab.  The first field is the option name, the
                   5730: second its description.  The description should be a whole sentence
                   5731: (starting with an uppercase letter and ending with a period) that
1.128     wiz      5732: describes what enabling the option does.  E. g. <span class="quote">&#8220;<span class="quote">Enable ispell
                   5733: support.</span>&#8221;</span> The file is sorted by option names.</p>
1.75      rillig   5734: </div>
1.148     asau     5735: <div class="sect1">
1.107     rillig   5736: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   5737: <a name="option-build"></a>18.4. Determining the options of dependencies</h2></div></div></div>
1.110     hubertf  5738: <p>When writing <a class="link" href="#buildlink3.mk"><code class="filename">buildlink3.mk</code></a> files, it is often necessary to list
1.107     rillig   5739: different dependencies based on the options with which the package was
                   5740: built. For querying these options, the file
                   5741: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
                   5742: typical example looks like this:</p>
                   5743: <pre class="programlisting">
                   5744: pkgbase := libpurple
                   5745: .include "../../mk/pkg-build-options.mk"
                   5746: 
                   5747: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
                   5748: ...
                   5749: .endif
                   5750: </pre>
                   5751: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
                   5752: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
                   5753: options of the libpurple package, which can then be queried like
                   5754: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
                   5755: file. See the file <code class="filename">pkg-build-options.mk</code> for more
                   5756: details.</p>
                   5757: </div>
1.75      rillig   5758: </div>
1.148     asau     5759: <div class="chapter">
1.75      rillig   5760: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   5761: <a name="build"></a>Chapter 19. The build process</h2></div></div></div>
1.75      rillig   5762: <div class="toc">
                   5763: <p><b>Table of Contents</b></p>
1.210     leot     5764: <dl class="toc">
1.267     rillig   5765: <dt><span class="sect1"><a href="#build.intro">19.1. Introduction</a></span></dt>
                   5766: <dt><span class="sect1"><a href="#build.prefix">19.2. Program location</a></span></dt>
                   5767: <dt><span class="sect1"><a href="#build.builddirs">19.3. Directories used during the build process</a></span></dt>
                   5768: <dt><span class="sect1"><a href="#build.running">19.4. Running a phase</a></span></dt>
                   5769: <dt><span class="sect1"><a href="#build.fetch">19.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                   5770: <dd><dl>
                   5771: <dt><span class="sect2"><a href="#build.fetch.what">19.5.1. What to fetch and where to get it from</a></span></dt>
                   5772: <dt><span class="sect2"><a href="#build.fetch.how">19.5.2. How are the files fetched?</a></span></dt>
                   5773: </dl></dd>
                   5774: <dt><span class="sect1"><a href="#build.checksum">19.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                   5775: <dt><span class="sect1"><a href="#build.extract">19.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                   5776: <dt><span class="sect1"><a href="#build.patch">19.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                   5777: <dt><span class="sect1"><a href="#build.tools">19.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                   5778: <dt><span class="sect1"><a href="#build.wrapper">19.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                   5779: <dt><span class="sect1"><a href="#build.configure">19.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   5780: <dt><span class="sect1"><a href="#build.build">19.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   5781: <dt><span class="sect1"><a href="#build.test">19.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                   5782: <dt><span class="sect1"><a href="#build.install">19.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   5783: <dt><span class="sect1"><a href="#build.package">19.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
                   5784: <dt><span class="sect1"><a href="#build.clean">19.16. Cleaning up</a></span></dt>
                   5785: <dt><span class="sect1"><a href="#build.helpful-targets">19.17. Other helpful targets</a></span></dt>
1.75      rillig   5786: </dl>
                   5787: </div>
1.148     asau     5788: <div class="sect1">
1.75      rillig   5789: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   5790: <a name="build.intro"></a>19.1. Introduction</h2></div></div></div>
1.75      rillig   5791: <p>This chapter gives a detailed description on how a package is
1.87      wiz      5792:     built. Building a package is separated into different
                   5793:     <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
                   5794:     <code class="varname">build</code>, <code class="varname">install</code>), all of which are
1.120     snj      5795:     described in the following sections. Each phase is split into
1.87      wiz      5796:     so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
                   5797:     containing phase, prefixed by one of <code class="varname">pre-</code>,
                   5798:     <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
                   5799:     <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
                   5800:     of the actual work is done in the <code class="varname">do-*</code> stages.</p>
1.97      rillig   5801: <p>Never override the regular targets (like
                   5802:     <code class="varname">fetch</code>), if you have to, override the
                   5803:     <code class="varname">do-*</code> ones instead.</p>
1.75      rillig   5804: <p>The basic steps for building a program are always the same.  First
1.87      wiz      5805:     the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
                   5806:     the local system and then extracted. After any pkgsrc-specific patches
                   5807:     to compile properly are applied, the software can be configured, then
                   5808:     built (usually by compiling), and finally the generated binaries, etc.
                   5809:     can be put into place on the system.</p>
1.97      rillig   5810: <p>To get more details about what is happening at each step,
                   5811:     you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
                   5812:     <code class="varname">PATCH_DEBUG</code> variable if you are just interested
                   5813:     in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
1.75      rillig   5814: </div>
1.148     asau     5815: <div class="sect1">
1.75      rillig   5816: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   5817: <a name="build.prefix"></a>19.2. Program location</h2></div></div></div>
1.75      rillig   5818: <p>Before outlining the process performed by the NetBSD package system in
1.87      wiz      5819:     the next section, here's a brief discussion on where programs are
                   5820:     installed, and which variables influence this.</p>
1.75      rillig   5821: <p>The automatic variable <code class="varname">PREFIX</code> indicates
1.87      wiz      5822:     where all files of the final program shall be installed. It is
                   5823:     usually set to <code class="varname">LOCALBASE</code>
                   5824:     (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
1.88      wiz      5825:     for pkgs in the <code class="filename">cross</code> category.  The value of
1.87      wiz      5826:     <code class="varname">PREFIX</code> needs to be put
                   5827:     into the various places in the program's source where paths to
1.267     rillig   5828:     these files are encoded.  See <a class="xref" href="#components.patches" title="13.3. patches/*">Section 13.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>
1.75      rillig   5829: <p>When choosing which of these variables to use,
1.87      wiz      5830:     follow the following rules:</p>
1.148     asau     5831: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      5832: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
1.88      wiz      5833:        where the current pkg will be installed.  When referring to a
                   5834:        pkg's own installation path, use
1.128     wiz      5835:        <span class="quote">&#8220;<span class="quote">${PREFIX}</span>&#8221;</span>.</p></li>
                   5836: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
1.88      wiz      5837:        are installed.  If you need to construct a -I or -L argument
                   5838:        to the compiler to find includes and libraries installed by
1.128     wiz      5839:        another non-X11 pkg, use <span class="quote">&#8220;<span class="quote">${LOCALBASE}</span>&#8221;</span>. The name
1.87      wiz      5840:        <code class="varname">LOCALBASE</code> stems from FreeBSD, which
                   5841:        installed all packages in <code class="filename">/usr/local</code>. As
                   5842:        pkgsrc leaves <code class="filename">/usr/local</code> for the system
                   5843:        administrator, this variable is a misnomer.</p></li>
1.128     wiz      5844: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
1.88      wiz      5845:        distribution (from xsrc, etc.) is installed. When looking for
                   5846:        <span class="emphasis"><em>standard</em></span> X11 includes (not those
1.128     wiz      5847:        installed by a package), use <span class="quote">&#8220;<span class="quote">${X11BASE}</span>&#8221;</span>.</p></li>
1.209     sevan    5848: <li class="listitem"><p>X11-based packages using imake must set
                   5849:        <code class="varname">USE_IMAKE</code> to be installed correctly under
                   5850:        <code class="varname">LOCALBASE</code>.</p></li>
1.128     wiz      5851: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.289     leot     5852:        install files according to <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?hier+7.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">hier</span>(7)</span></a>, with the exception that
1.87      wiz      5853:        manual pages go into <code class="filename">${PREFIX}/man</code>, not
                   5854:        <code class="filename">${PREFIX}/share/man</code>.</p></li>
1.75      rillig   5855: </ul></div>
                   5856: </div>
1.148     asau     5857: <div class="sect1">
1.75      rillig   5858: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   5859: <a name="build.builddirs"></a>19.3. Directories used during the build process</h2></div></div></div>
1.114     jmcneill 5860: <p>When building a package, various directories are used to store
1.87      wiz      5861:     source files, temporary files, pkgsrc-internal files, and so on. These
                   5862:     directories are explained here.</p>
1.75      rillig   5863: <p>Some of the directory variables contain relative pathnames. There
1.87      wiz      5864:     are two common base directories for these relative directories:
                   5865:     <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
                   5866:     pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
                   5867:     inside the package itself.</p>
1.148     asau     5868: <div class="variablelist"><dl class="variablelist">
1.75      rillig   5869: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
                   5870: <dd><p>This is an absolute pathname that points to the pkgsrc
1.87      wiz      5871:       root directory. Generally, you don't need
                   5872:       it.</p></dd>
1.97      rillig   5873: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
                   5874: <dd><p>This is an absolute pathname that points to the
                   5875:       current package.</p></dd>
1.75      rillig   5876: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
                   5877: <dd><p>This is a pathname relative to
1.87      wiz      5878:       <code class="varname">PKGSRCDIR</code> that points to the current
                   5879:       package.</p></dd>
1.75      rillig   5880: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
                   5881: <dd><p>This is an absolute pathname pointing to the directory
1.93      rillig   5882:       where all work takes place. The distfiles are extracted to this
1.87      wiz      5883:       directory. It also contains temporary directories and log files used by
                   5884:       the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
                   5885:       the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
1.75      rillig   5886: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
                   5887: <dd><p>This is an absolute pathname pointing to the directory
1.87      wiz      5888:       where the distfiles are extracted. It is usually a direct subdirectory
                   5889:       of <code class="varname">WRKDIR</code>, and often it's the only directory entry
                   5890:       that isn't hidden. This variable may be changed by a package
                   5891:       <code class="filename">Makefile</code>.</p></dd>
1.75      rillig   5892: </dl></div>
1.114     jmcneill 5893: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
                   5894:     the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
1.116     rillig   5895:     to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
1.114     jmcneill 5896:     <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
                   5897:     If users would like to have their pkgsrc trees behave in a
                   5898:     read-only manner, then the value of
                   5899:     <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
                   5900:     <span class="emphasis"><em>no</em></span>.</p>
1.75      rillig   5901: </div>
1.148     asau     5902: <div class="sect1">
1.75      rillig   5903: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   5904: <a name="build.running"></a>19.4. Running a phase</h2></div></div></div>
1.110     hubertf  5905: <p>You can run a particular phase by typing <span class="command"><strong>make
1.87      wiz      5906:     phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
                   5907:     phase. This will automatically run all phases that are required for this
                   5908:     phase. The default phase is <code class="varname">build</code>, that is, when you
1.110     hubertf  5909:     run <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.87      wiz      5910:     the package will be built, but not installed.</p>
1.75      rillig   5911: </div>
1.148     asau     5912: <div class="sect1">
1.75      rillig   5913: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   5914: <a name="build.fetch"></a>19.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.81      rillig   5915: <p>The first step in building a package is to fetch the
1.88      wiz      5916:     distribution files (distfiles) from the sites that are providing
                   5917:     them. This is the task of the <span class="emphasis"><em>fetch</em></span>
                   5918:     phase.</p>
1.148     asau     5919: <div class="sect2">
1.81      rillig   5920: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   5921: <a name="build.fetch.what"></a>19.5.1. What to fetch and where to get it from</h3></div></div></div>
1.88      wiz      5922: <p>In simple cases, <code class="varname">MASTER_SITES</code>
                   5923:       defines all URLs from where the distfile, whose name is
                   5924:       derived from the <code class="varname">DISTNAME</code> variable, is
                   5925:       fetched. The more complicated cases are described
                   5926:       below.</p>
                   5927: <p>The variable <code class="varname">DISTFILES</code> specifies
                   5928:       the list of distfiles that have to be fetched. Its value
1.174     asau     5929:       defaults to <code class="literal">${DEFAULT_DISTFILES}</code> and
                   5930:       its value is <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
1.88      wiz      5931:       so that most packages don't need to define it at all.
                   5932:       <code class="varname">EXTRACT_SUFX</code> is
                   5933:       <code class="literal">.tar.gz</code> by default, but can be changed
                   5934:       freely. Note that if your package requires additional
                   5935:       distfiles to the default one, you cannot just append the
                   5936:       additional filenames using the <code class="literal">+=</code>
                   5937:       operator, but you have write for example:</p>
1.81      rillig   5938: <pre class="programlisting">
1.174     asau     5939: DISTFILES=      ${DEFAULT_DISTFILES} additional-files.tar.gz
1.100     rillig   5940: </pre>
1.88      wiz      5941: <p>Each distfile is fetched from a list of sites, usually
                   5942:       <code class="varname">MASTER_SITES</code>. If the package has multiple
                   5943:       <code class="varname">DISTFILES</code> or multiple
                   5944:       <code class="varname">PATCHFILES</code> from different sites, you can
                   5945:       set
                   5946:       <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
                   5947:       to the list of URLs where the file
                   5948:       <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
                   5949:       (including the suffix) can be found.</p>
                   5950: <pre class="programlisting">
1.100     rillig   5951: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX}
                   5952: DISTFILES+=     foo-file.tar.gz
                   5953: SITES.foo-file.tar.gz= \
1.289     leot     5954: https://www.somewhere.com/somehow/ \
                   5955: https://www.somewhereelse.com/mirror/somehow/
1.100     rillig   5956: </pre>
1.81      rillig   5957: <p>When actually fetching the distfiles, each item from
1.88      wiz      5958:       <code class="varname">MASTER_SITES</code> or
                   5959:       <code class="varname">SITES.*</code> gets the name of each distfile
                   5960:       appended to it, without an intermediate slash. Therefore,
                   5961:       all site values have to end with a slash or other separator
                   5962:       character. This allows for example to set
                   5963:       <code class="varname">MASTER_SITES</code> to a URL of a CGI script
                   5964:       that gets the name of the distfile as a parameter. In this
                   5965:       case, the definition would look like:</p>
1.81      rillig   5966: <pre class="programlisting">
1.289     leot     5967: MASTER_SITES=   https://www.example.com/download.cgi?file=
1.100     rillig   5968: </pre>
1.125     wiz      5969: <p> The exception to this rule are URLs starting with a dash.
1.174     asau     5970:       In that case the URL is taken as is, fetched and the result
                   5971:       stored under the name of the distfile. You can use this style
                   5972:       for the case when the download URL style does not match the
                   5973:       above common case. For example, if permanent download URL is a
                   5974:       redirector to the real download URL, or the download file name
                   5975:       is offered by an HTTP Content-Disposition header. In the
                   5976:       following example, <code class="filename">foo-1.0.0.tar.gz</code> will be
                   5977:       created instead of the default
                   5978:       <code class="filename">v1.0.0.tar.gz</code>.</p>
                   5979: <pre class="programlisting">
                   5980: DISTNAME=       foo-1.0.0
1.289     leot     5981: MASTER_SITES=   -https://www.example.com/archive/v1.0.0.tar.gz
1.174     asau     5982: </pre>
1.81      rillig   5983: <p>There are some predefined values for
1.88      wiz      5984:       <code class="varname">MASTER_SITES</code>, which can be used in
                   5985:       packages.  The names of the variables should speak for
                   5986:       themselves.</p>
1.269     leot     5987: <table border="0" summary="Simple list" class="simplelist">
                   5988: <tr>
                   5989: <td>MASTER_SITE_APACHE</td>
                   5990: <td>MASTER_SITE_BACKUP</td>
                   5991: </tr>
                   5992: <tr>
                   5993: <td>MASTER_SITE_CRATESIO</td>
                   5994: <td>MASTER_SITE_CYGWIN</td>
                   5995: </tr>
                   5996: <tr>
                   5997: <td>MASTER_SITE_DEBIAN</td>
                   5998: <td>MASTER_SITE_FREEBSD</td>
                   5999: </tr>
                   6000: <tr>
                   6001: <td>MASTER_SITE_FREEBSD_LOCAL</td>
                   6002: <td>MASTER_SITE_GENTOO</td>
                   6003: </tr>
                   6004: <tr>
                   6005: <td>MASTER_SITE_GITHUB</td>
                   6006: <td>MASTER_SITE_GNOME</td>
                   6007: </tr>
                   6008: <tr>
                   6009: <td>MASTER_SITE_GNU</td>
                   6010: <td>MASTER_SITE_GNUSTEP</td>
                   6011: </tr>
                   6012: <tr>
                   6013: <td>MASTER_SITE_HASKELL_HACKAGE</td>
                   6014: <td>MASTER_SITE_IFARCHIVE</td>
                   6015: </tr>
                   6016: <tr>
                   6017: <td>MASTER_SITE_KDE</td>
                   6018: <td>MASTER_SITE_MOZILLA</td>
                   6019: </tr>
                   6020: <tr>
                   6021: <td>MASTER_SITE_MOZILLA_ALL</td>
                   6022: <td>MASTER_SITE_MYSQL</td>
                   6023: </tr>
                   6024: <tr>
                   6025: <td>MASTER_SITE_NETLIB</td>
                   6026: <td>MASTER_SITE_OPENBSD</td>
                   6027: </tr>
                   6028: <tr>
                   6029: <td>MASTER_SITE_OPENOFFICE</td>
                   6030: <td>MASTER_SITE_OSDN</td>
                   6031: </tr>
                   6032: <tr>
                   6033: <td>MASTER_SITE_PERL_CPAN</td>
                   6034: <td>MASTER_SITE_PGSQL</td>
                   6035: </tr>
                   6036: <tr>
                   6037: <td>MASTER_SITE_PYPI</td>
                   6038: <td>MASTER_SITE_RUBYGEMS</td>
                   6039: </tr>
                   6040: <tr>
                   6041: <td>MASTER_SITE_R_CRAN</td>
                   6042: <td>MASTER_SITE_SOURCEFORGE</td>
                   6043: </tr>
                   6044: <tr>
                   6045: <td>MASTER_SITE_SUNSITE</td>
                   6046: <td>MASTER_SITE_SUSE</td>
                   6047: </tr>
                   6048: <tr>
                   6049: <td>MASTER_SITE_TEX_CTAN</td>
                   6050: <td>MASTER_SITE_XCONTRIB</td>
                   6051: </tr>
                   6052: <tr>
                   6053: <td>MASTER_SITE_XEMACS</td>
                   6054: <td>MASTER_SITE_XORG</td>
                   6055: </tr>
                   6056: </table>
1.88      wiz      6057: <p>Some explanations for the less self-explaining ones:
                   6058:       <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.133     wiz      6059:       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
1.132     spz      6060:       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>
1.88      wiz      6061: <p>If you choose one of these predefined sites, you may
                   6062:       want to specify a subdirectory of that site. Since these
                   6063:       macros may expand to more than one actual site, you
                   6064:       <span class="emphasis"><em>must</em></span> use the following construct to
                   6065:       specify a subdirectory:</p>
1.81      rillig   6066: <pre class="programlisting">
1.100     rillig   6067: MASTER_SITES=   ${MASTER_SITE_GNU:=subdirectory/name/}
                   6068: MASTER_SITES=   ${MASTER_SITE_SOURCEFORGE:=project_name/}
                   6069: </pre>
1.81      rillig   6070: <p>Note the trailing slash after the subdirectory
1.88      wiz      6071:       name.</p>
1.81      rillig   6072: </div>
1.148     asau     6073: <div class="sect2">
1.81      rillig   6074: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   6075: <a name="build.fetch.how"></a>19.5.2. How are the files fetched?</h3></div></div></div>
1.88      wiz      6076: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
                   6077:       all the distfiles exist in a local directory
1.93      rillig   6078:       (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
1.88      wiz      6079:       user). If the files do not exist, they are fetched using
                   6080:       commands of the form</p>
1.75      rillig   6081: <pre class="programlisting">
1.100     rillig   6082: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
                   6083: </pre>
1.88      wiz      6084: <p>where <code class="literal">${site}</code> varies through
                   6085:       several possibilities in turn: first,
                   6086:       <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
                   6087:       sites specified in either <code class="varname">SITES.file</code> if
                   6088:       defined, else <code class="varname">MASTER_SITES</code> or
                   6089:       <code class="varname">PATCH_SITES</code>, as applies, then finally the
                   6090:       value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
1.91      rillig   6091:       all except the first and the last can be optionally sorted
                   6092:       by the user, via setting either
                   6093:       <code class="varname">MASTER_SORT_RANDOM</code>, and
                   6094:       <code class="varname">MASTER_SORT_AWK</code> or
1.88      wiz      6095:       <code class="varname">MASTER_SORT_REGEX</code>.</p>
1.117     jnemeth  6096: <p> The specific command and arguments used depend on the
                   6097:       <code class="varname">FETCH_USING</code> parameter. The example above is
                   6098:       for <code class="literal">FETCH_USING=custom</code>.</p>
1.97      rillig   6099: <p>The distfiles mirror run by the NetBSD Foundation uses the
                   6100:       <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
                   6101:       distfiles, if they are freely distributable.  Packages setting
                   6102:       <code class="varname">NO_SRC_ON_FTP</code> (usually to
1.128     wiz      6103:       <span class="quote">&#8220;<span class="quote">${RESTRICTED}</span>&#8221;</span>) will not have their distfiles
1.97      rillig   6104:       mirrored.</p>
1.81      rillig   6105: </div>
1.75      rillig   6106: </div>
1.148     asau     6107: <div class="sect1">
1.75      rillig   6108: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   6109: <a name="build.checksum"></a>19.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.88      wiz      6110: <p>After the distfile(s) are fetched, their checksum is
                   6111:     generated and compared with the checksums stored in the
                   6112:     distinfo file. If the checksums don't match, the build is
                   6113:     aborted. This is to ensure the same distfile is used for
                   6114:     building, and that the distfile wasn't changed, e.g. by some
                   6115:     malign force, deliberately changed distfiles on the master
                   6116:     distribution site or network lossage.</p>
1.75      rillig   6117: </div>
1.148     asau     6118: <div class="sect1">
1.75      rillig   6119: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   6120: <a name="build.extract"></a>19.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.75      rillig   6121: <p>When the distfiles are present on the local system, they
1.88      wiz      6122:     need to be extracted, as they usually come in the form of some
                   6123:     compressed archive format.</p>
1.75      rillig   6124: <p>By default, all <code class="varname">DISTFILES</code> are
1.88      wiz      6125:     extracted. If you only need some of them, you can set the
                   6126:     <code class="varname">EXTRACT_ONLY</code> variable to the list of those
                   6127:     files.</p>
                   6128: <p>Extracting the files is usually done by a little
1.93      rillig   6129:     program, <code class="filename">mk/extract/extract</code>, which
1.88      wiz      6130:     already knows how to extract various archive formats, so most
                   6131:     likely you will not need to change anything here. But if you
                   6132:     need, the following variables may help you:</p>
1.148     asau     6133: <div class="variablelist"><dl class="variablelist">
1.75      rillig   6134: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
                   6135: <dd><p>Use these variables to override the default
1.88      wiz      6136:       options for an extract command, which are defined in
1.93      rillig   6137:       <code class="filename">mk/extract/extract</code>.</p></dd>
1.75      rillig   6138: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
                   6139: <dd><p>This variable can be set to
1.114     jmcneill 6140:       <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
                   6141:       (which is the default value), <code class="literal">pax</code>, or an
1.88      wiz      6142:       absolute pathname pointing to the command with which tar
1.114     jmcneill 6143:       archives should be extracted.  It is preferred to choose bsdtar over gtar
                   6144:       if NetBSD's pax-as-tar is not good enough.</p></dd>
1.75      rillig   6145: </dl></div>
1.88      wiz      6146: <p>If the <code class="filename">extract</code> program doesn't
                   6147:     serve your needs, you can also override the
                   6148:     <code class="varname">EXTRACT_CMD</code> variable, which holds the
                   6149:     command used for extracting the files. This command is
                   6150:     executed in the <code class="filename">${WRKSRC}</code>
                   6151:     directory. During execution of this command, the shell
                   6152:     variable <code class="varname">extract_file</code> holds the absolute
                   6153:     pathname of the file that is going to be extracted.</p>
1.75      rillig   6154: <p>And if that still does not suffice, you can override the
1.88      wiz      6155:     <code class="varname">do-extract</code> target in the package
                   6156:     Makefile.</p>
1.75      rillig   6157: </div>
1.148     asau     6158: <div class="sect1">
1.75      rillig   6159: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   6160: <a name="build.patch"></a>19.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.75      rillig   6161: <p>After extraction, all the patches named by the
1.88      wiz      6162:     <code class="varname">PATCHFILES</code>, those present in the patches
                   6163:     subdirectory of the package as well as in
                   6164:     $LOCALPATCHES/$PKGPATH (e.g.
                   6165:     <code class="filename">/usr/local/patches/graphics/png</code>) are
                   6166:     applied.  Patchfiles ending in <code class="filename">.Z</code> or
                   6167:     <code class="filename">.gz</code> are uncompressed before they are
                   6168:     applied, files ending in <code class="filename">.orig</code> or
                   6169:     <code class="filename">.rej</code> are ignored. Any special options to
1.289     leot     6170:     <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?patch+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> can be handed in
1.267     rillig   6171:     <code class="varname">PATCH_DIST_ARGS</code>.  See <a class="xref" href="#components.patches" title="13.3. patches/*">Section 13.3, &#8220;<code class="filename">patches/*</code>&#8221;</a> for more details.</p>
1.289     leot     6172: <p>By default <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?patch+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> is given special args to make
1.88      wiz      6173:     it fail if the patches apply with some lines of fuzz. Please
                   6174:     fix (regen) the patches so that they apply cleanly. The
                   6175:     rationale behind this is that patches that don't apply cleanly
                   6176:     may end up being applied in the wrong place, and cause severe
                   6177:     harm there.</p>
1.75      rillig   6178: </div>
1.148     asau     6179: <div class="sect1">
1.75      rillig   6180: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   6181: <a name="build.tools"></a>19.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
                   6182: <p>This is covered in <a class="xref" href="#tools" title="Chapter 20. Tools needed for building or running">Chapter 20, <i>Tools needed for building or running</i></a>.
1.88      wiz      6183:     </p>
1.75      rillig   6184: </div>
1.148     asau     6185: <div class="sect1">
1.75      rillig   6186: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   6187: <a name="build.wrapper"></a>19.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.75      rillig   6188: <p>This phase creates wrapper programs for the compilers and
1.88      wiz      6189:     linkers. The following variables can be used to tweak the
                   6190:     wrappers.</p>
1.148     asau     6191: <div class="variablelist"><dl class="variablelist">
1.75      rillig   6192: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
                   6193: <dd><p>The command used to print progress
1.88      wiz      6194:       messages. Does nothing by default. Set to
                   6195:       <code class="literal">${ECHO}</code> to see the progress
                   6196:       messages.</p></dd>
1.75      rillig   6197: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
                   6198: <dd><p>This variable can be set to
1.88      wiz      6199:       <code class="literal">yes</code> (default) or <code class="literal">no</code>,
                   6200:       depending on whether you want additional information in the
                   6201:       wrapper log file.</p></dd>
1.75      rillig   6202: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
                   6203: <dd><p>This variable can be set to
1.88      wiz      6204:       <code class="literal">yes</code> or <code class="literal">no</code>, depending
                   6205:       on whether the wrapper should use its cache, which will
                   6206:       improve the speed. The default value is
                   6207:       <code class="literal">yes</code>, but is forced to
                   6208:       <code class="literal">no</code> if the platform does not support
                   6209:       it.</p></dd>
1.75      rillig   6210: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
1.88      wiz      6211: <dd><p>A list of reordering commands. A reordering
                   6212:       command has the form
                   6213:       <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
                   6214:       It ensures that that
                   6215:       <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
                   6216:       before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
                   6217:       </p></dd>
1.75      rillig   6218: </dl></div>
                   6219: </div>
1.148     asau     6220: <div class="sect1">
1.75      rillig   6221: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   6222: <a name="build.configure"></a>19.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.88      wiz      6223: <p>Most pieces of software need information on the header
                   6224:     files, system calls, and library routines which are available
                   6225:     on the platform they run on. The process of determining this
                   6226:     information is known as configuration, and is usually
                   6227:     automated. In most cases, a script is supplied with the
                   6228:     distfiles, and its invocation results in generation of header
                   6229:     files, Makefiles, etc.</p>
                   6230: <p>If the package contains a configure script, this can be
                   6231:     invoked by setting <code class="varname">HAS_CONFIGURE</code> to
1.128     wiz      6232:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. If the configure script is a GNU autoconf
1.88      wiz      6233:     script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.128     wiz      6234:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> instead. What happens in the
1.88      wiz      6235:     <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
                   6236: <pre class="programlisting">
1.100     rillig   6237: .for d in ${CONFIGURE_DIRS}
                   6238:         cd ${WRKSRC} \
                   6239:         &amp;&amp; cd ${d} \
                   6240:         &amp;&amp; env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
                   6241: .endfor
                   6242: </pre>
1.88      wiz      6243: <p><code class="varname">CONFIGURE_DIRS</code> (default:
1.128     wiz      6244:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span>) is a list of pathnames relative to
1.88      wiz      6245:     <code class="varname">WRKSRC</code>. In each of these directories, the
                   6246:     configure script is run with the environment
                   6247:     <code class="varname">CONFIGURE_ENV</code> and arguments
                   6248:     <code class="varname">CONFIGURE_ARGS</code>. The variables
                   6249:     <code class="varname">CONFIGURE_ENV</code>,
                   6250:     <code class="varname">CONFIGURE_SCRIPT</code> (default:
1.128     wiz      6251:     <span class="quote">&#8220;<span class="quote">./configure</span>&#8221;</span>) and
1.88      wiz      6252:     <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
                   6253:     package.</p>
1.144     wiz      6254: <p>If the program uses the Perl way of configuration (mainly Perl
                   6255:     modules, but not only), i.e. a file called
                   6256:     <code class="filename">Makefile.PL</code>, it should include
                   6257:     <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
                   6258:     <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
                   6259:     variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
1.88      wiz      6260: <p>If the program uses an <code class="filename">Imakefile</code>
                   6261:     for configuration, the appropriate steps can be invoked by
                   6262:     setting <code class="varname">USE_IMAKE</code> to
1.209     sevan    6263:     <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>.
                   6264:     You can add variables to xmkmf's environment by adding them to the
1.97      rillig   6265:     <code class="varname">SCRIPTS_ENV</code> variable.</p>
1.111     rillig   6266: <p>If the program uses <code class="filename">cmake</code>
                   6267:     for configuration, the appropriate steps can be invoked by
1.128     wiz      6268:     setting <code class="varname">USE_CMAKE</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.
1.111     rillig   6269:     You can add variables to cmake's environment by adding them to the
                   6270:     <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
                   6271:     by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
                   6272:     The top directory argument is given by the
                   6273:     <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
1.128     wiz      6274:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span> (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
1.97      rillig   6275: <p>If there is no configure step at all, set
1.128     wiz      6276:     <code class="varname">NO_CONFIGURE</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.</p>
1.75      rillig   6277: </div>
1.148     asau     6278: <div class="sect1">
1.75      rillig   6279: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   6280: <a name="build.build"></a>19.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.88      wiz      6281: <p>For building a package, a rough equivalent of the
                   6282:     following code is executed.</p>
1.75      rillig   6283: <pre class="programlisting">
1.100     rillig   6284: .for d in ${BUILD_DIRS}
                   6285:         cd ${WRKSRC} \
                   6286:         &amp;&amp; cd ${d} \
                   6287:         &amp;&amp; env ${MAKE_ENV} \
                   6288:             ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
                   6289:                 -f ${MAKE_FILE} \
                   6290:                 ${BUILD_TARGET}
                   6291: .endfor
                   6292: </pre>
1.88      wiz      6293: <p><code class="varname">BUILD_DIRS</code> (default:
1.128     wiz      6294:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span>) is a list of pathnames relative to
1.88      wiz      6295:     <code class="varname">WRKSRC</code>. In each of these directories,
                   6296:     <code class="varname">MAKE_PROGRAM</code> is run with the environment
                   6297:     <code class="varname">MAKE_ENV</code> and arguments
                   6298:     <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
                   6299:     <code class="varname">MAKE_ENV</code>,
                   6300:     <code class="varname">BUILD_MAKE_FLAGS</code>,
                   6301:     <code class="varname">MAKE_FILE</code> and
                   6302:     <code class="varname">BUILD_TARGET</code> may all be changed by the
                   6303:     package.</p>
1.75      rillig   6304: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.128     wiz      6305:     <span class="quote">&#8220;<span class="quote">gmake</span>&#8221;</span> if <code class="varname">USE_TOOLS</code> contains
                   6306:     <span class="quote">&#8220;<span class="quote">gmake</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">make</span>&#8221;</span> otherwise. The
1.88      wiz      6307:     default value of <code class="varname">MAKE_FILE</code> is
1.128     wiz      6308:     <span class="quote">&#8220;<span class="quote">Makefile</span>&#8221;</span>, and <code class="varname">BUILD_TARGET</code>
                   6309:     defaults to <span class="quote">&#8220;<span class="quote">all</span>&#8221;</span>.</p>
1.97      rillig   6310: <p>If there is no build step at all, set
1.128     wiz      6311:     <code class="varname">NO_BUILD</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.</p>
1.75      rillig   6312: </div>
1.148     asau     6313: <div class="sect1">
1.75      rillig   6314: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   6315: <a name="build.test"></a>19.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.75      rillig   6316: <p>[TODO]</p>
                   6317: </div>
1.148     asau     6318: <div class="sect1">
1.75      rillig   6319: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   6320: <a name="build.install"></a>19.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.75      rillig   6321: <p>Once the build stage has completed, the final step is to
1.88      wiz      6322:     install the software in public directories, so users can
                   6323:     access the programs and files.</p>
1.75      rillig   6324: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
1.88      wiz      6325:     equivalent of the following code is executed. Additionally,
                   6326:     before and after this code, much magic is performed to do
                   6327:     consistency checks, registering the package, and so on.</p>
                   6328: <pre class="programlisting">
1.100     rillig   6329: .for d in ${INSTALL_DIRS}
                   6330:         cd ${WRKSRC} \
                   6331:         &amp;&amp; cd ${d} \
                   6332:         &amp;&amp; env ${MAKE_ENV} \
                   6333:             ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
                   6334:                 -f ${MAKE_FILE} \
                   6335:                 ${INSTALL_TARGET}
                   6336: .endfor
                   6337: </pre>
1.75      rillig   6338: <p>The variable's meanings are analogous to the ones in the
1.88      wiz      6339:     <span class="emphasis"><em>build</em></span> phase.
                   6340:     <code class="varname">INSTALL_DIRS</code> defaults to
                   6341:     <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
1.128     wiz      6342:     is <span class="quote">&#8220;<span class="quote">install</span>&#8221;</span> by default, plus
                   6343:     <span class="quote">&#8220;<span class="quote">install.man</span>&#8221;</span> if <code class="varname">USE_IMAKE</code> is
1.88      wiz      6344:     defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
                   6345:     defined.</p>
1.75      rillig   6346: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
1.88      wiz      6347:     variables are useful. They are all variations of the
1.289     leot     6348:     <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?install+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a> command that have the owner, group and
1.88      wiz      6349:     permissions preset. <code class="varname">INSTALL</code> is the plain
                   6350:     install command. The specialized variants, together with their
                   6351:     intended use, are:</p>
1.148     asau     6352: <div class="variablelist"><dl class="variablelist">
1.75      rillig   6353: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
1.88      wiz      6354: <dd><p>directories that contain
                   6355:       binaries</p></dd>
1.75      rillig   6356: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
1.88      wiz      6357: <dd><p>directories that contain
                   6358:       scripts</p></dd>
1.75      rillig   6359: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
1.88      wiz      6360: <dd><p>directories that contain shared and static
                   6361:       libraries</p></dd>
1.75      rillig   6362: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
1.88      wiz      6363: <dd><p>directories that contain data
                   6364:       files</p></dd>
1.75      rillig   6365: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
1.88      wiz      6366: <dd><p>directories that contain man
                   6367:       pages</p></dd>
1.210     leot     6368: <dt><span class="term"><code class="varname">INSTALL_GAME_DIR</code></span></dt>
                   6369: <dd><p>directories that contain data files for games
                   6370:       </p></dd>
1.75      rillig   6371: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
1.88      wiz      6372: <dd><p>binaries that can be stripped from debugging
                   6373:       symbols</p></dd>
1.75      rillig   6374: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
1.88      wiz      6375: <dd><p>binaries that cannot be
                   6376:       stripped</p></dd>
1.75      rillig   6377: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
1.88      wiz      6378: <dd><p>game
                   6379:       binaries</p></dd>
1.75      rillig   6380: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
1.88      wiz      6381: <dd><p>shared and static
                   6382:       libraries</p></dd>
1.75      rillig   6383: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
                   6384: <dd><p>data files</p></dd>
                   6385: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
1.88      wiz      6386: <dd><p>data files for
                   6387:       games</p></dd>
1.75      rillig   6388: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
                   6389: <dd><p>man pages</p></dd>
                   6390: </dl></div>
                   6391: <p>Some other variables are:</p>
1.148     asau     6392: <div class="variablelist"><dl class="variablelist">
1.216     tnn      6393: <dt><span class="term"><code class="varname">INSTALL_UNSTRIPPED</code></span></dt>
1.289     leot     6394: <dd><p>If set to <code class="literal">yes</code>, do not run <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?strip+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">strip</span>(1)</span></a>
1.216     tnn      6395:       when installing binaries. Any debugging sections and symbols present in
                   6396:       binaries will be preserved.
                   6397:       </p></dd>
1.75      rillig   6398: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
                   6399: <dd><p>A list of directories relative to
1.88      wiz      6400:       <code class="varname">PREFIX</code> that are created by pkgsrc at the
1.98      wiz      6401:       beginning of the <span class="emphasis"><em>install</em></span> phase.
                   6402:       The package is supposed to create all needed directories itself
                   6403:       before installing files to it and list all other directories here.
                   6404:       </p></dd>
1.75      rillig   6405: </dl></div>
1.97      rillig   6406: <p>In the rare cases that a package shouldn't install anything,
1.128     wiz      6407:     set <code class="varname">NO_INSTALL</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. This is
1.97      rillig   6408:     mostly relevant for packages in the <code class="filename">regress</code>
                   6409:     category.</p>
1.75      rillig   6410: </div>
1.148     asau     6411: <div class="sect1">
1.75      rillig   6412: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   6413: <a name="build.package"></a>19.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.88      wiz      6414: <p>Once the install stage has completed, a binary package of
                   6415:     the installed files can be built.  These binary packages can be
                   6416:     used for quick installation without previous compilation, e.g. by
1.110     hubertf  6417:     the <span class="command"><strong>make bin-install</strong></span> or by using
                   6418:     <span class="command"><strong>pkg_add</strong></span>.</p>
1.88      wiz      6419: <p>By default, the binary packages are created in
                   6420:     <code class="filename">${PACKAGES}/All</code> and symlinks are created in
                   6421:     <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
                   6422:     one for each category in the <code class="varname">CATEGORIES</code>
                   6423:     variable.  <code class="varname">PACKAGES</code> defaults to
                   6424:     <code class="filename">pkgsrc/packages</code>.</p>
                   6425: </div>
1.148     asau     6426: <div class="sect1">
1.88      wiz      6427: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   6428: <a name="build.clean"></a>19.16. Cleaning up</h2></div></div></div>
1.88      wiz      6429: <p>Once you're finished with a package, you can clean the work
1.110     hubertf  6430:     directory by running <span class="command"><strong>make clean</strong></span>.  If you want
1.88      wiz      6431:     to clean the work directories of all dependencies too, use
1.110     hubertf  6432:     <span class="command"><strong>make clean-depends</strong></span>.</p>
1.75      rillig   6433: </div>
1.148     asau     6434: <div class="sect1">
1.75      rillig   6435: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   6436: <a name="build.helpful-targets"></a>19.17. Other helpful targets</h2></div></div></div>
1.148     asau     6437: <div class="variablelist"><dl class="variablelist">
1.75      rillig   6438: <dt><span class="term">pre/post-*</span></dt>
1.88      wiz      6439: <dd><p>For any of the main targets described in the
                   6440:          previous section, two auxiliary targets exist with
1.128     wiz      6441:          <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
1.87      wiz      6442:          prefix for the main target's name.  These targets are
1.88      wiz      6443:          invoked before and after the main target is called,
                   6444:          allowing extra configuration or installation steps be
                   6445:          performed from a package's Makefile, for example, which
                   6446:          a program's configure script or install target
                   6447:          omitted.</p></dd>
1.75      rillig   6448: <dt><span class="term">do-*</span></dt>
1.88      wiz      6449: <dd><p>Should one of the main targets do the wrong thing,
                   6450:          and should there be no variable to fix this, you can
                   6451:          redefine it with the do-* target.  (Note that redefining
                   6452:          the target itself instead of the do-* target is a bad
                   6453:          idea, as the pre-* and post-* targets won't be called
                   6454:          anymore, etc.) You will not usually need to do
                   6455:          this.</p></dd>
1.75      rillig   6456: <dt><span class="term">reinstall</span></dt>
1.88      wiz      6457: <dd>
1.110     hubertf  6458: <p>If you did a <span class="command"><strong>make install</strong></span> and
1.88      wiz      6459:          you noticed some file was not installed properly, you
                   6460:          can repeat the installation with this target, which will
1.128     wiz      6461:          ignore the <span class="quote">&#8220;<span class="quote">already installed</span>&#8221;</span> flag.</p>
1.88      wiz      6462: <p>This is the default value of
                   6463:          <code class="varname">DEPENDS_TARGET</code> except in the case of
1.110     hubertf  6464:          <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
1.88      wiz      6465:          package</strong></span>, where the defaults are
1.128     wiz      6466:          <span class="quote">&#8220;<span class="quote">package</span>&#8221;</span> and <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span>,
1.88      wiz      6467:          respectively.</p>
                   6468: </dd>
1.75      rillig   6469: <dt><span class="term">deinstall</span></dt>
                   6470: <dd>
1.289     leot     6471: <p>This target does a <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> in the
1.88      wiz      6472:          current directory, effectively de-installing the
                   6473:          package. The following variables can be used to tune the
                   6474:          behaviour:</p>
1.148     asau     6475: <div class="variablelist"><dl class="variablelist">
1.75      rillig   6476: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.289     leot     6477: <dd><p>Add a "-v" to the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> command.</p></dd>
1.75      rillig   6478: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
1.88      wiz      6479: <dd><p>Remove all packages that require (depend on)
                   6480:                the given package.  This can be used to remove any
                   6481:                packages that may have been pulled in by a given
1.110     hubertf  6482:                package, e.g. if <span class="command"><strong>make deinstall
1.87      wiz      6483:                DEINSTALLDEPENDS=1</strong></span> is done in
1.88      wiz      6484:                <code class="filename">pkgsrc/x11/kde</code>, this is
                   6485:                likely to remove whole KDE. Works by adding
1.289     leot     6486:                <span class="quote">&#8220;<span class="quote">-R</span>&#8221;</span> to the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
1.88      wiz      6487:                command line.</p></dd>
1.75      rillig   6488: </dl></div>
                   6489: </dd>
1.88      wiz      6490: <dt><span class="term">bin-install</span></dt>
                   6491: <dd><p>Install a binary package from local disk and via FTP
                   6492:          from a list of sites (see the
                   6493:          <code class="varname">BINPKG_SITES</code> variable), and do a
1.110     hubertf  6494:          <span class="command"><strong>make package</strong></span> if no binary package is
1.88      wiz      6495:          available anywhere.  The arguments given to
1.110     hubertf  6496:          <span class="command"><strong>pkg_add</strong></span> can be set via
1.88      wiz      6497:          <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
                   6498:          operation, etc.</p></dd>
1.205     wiz      6499: <dt><span class="term">install-clean</span></dt>
                   6500: <dd><p>This target removes the state files for the "install" and later
                   6501:          phases so that the "install" target may be re-invoked. This can be
                   6502:          used after editing the PLIST to install the package without
                   6503:          rebuilding it.</p></dd>
                   6504: <dt><span class="term">build-clean</span></dt>
                   6505: <dd><p>This target removes the state files for the "build" and later
                   6506:          phases so that the "build" target may be re-invoked.</p></dd>
1.75      rillig   6507: <dt><span class="term">update</span></dt>
                   6508: <dd>
1.88      wiz      6509: <p>This target causes the current package to be
                   6510:          updated to the latest version.  The package and all
                   6511:          depending packages first get de-installed, then current
                   6512:          versions of the corresponding packages get compiled and
                   6513:          installed.  This is similar to manually noting which
                   6514:          packages are currently installed, then performing a
1.110     hubertf  6515:          series of <span class="command"><strong>make deinstall</strong></span> and
                   6516:          <span class="command"><strong>make install</strong></span> (or whatever
1.88      wiz      6517:          <code class="varname">UPDATE_TARGET</code> is set to) for these
                   6518:          packages.</p>
1.128     wiz      6519: <p>You can use the <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> target to
1.110     hubertf  6520:          resume package updating in case a previous <span class="command"><strong>make
1.88      wiz      6521:          update</strong></span> was interrupted for some reason.
                   6522:          However, in this case, make sure you don't call
1.110     hubertf  6523:          <span class="command"><strong>make clean</strong></span> or otherwise remove the
1.88      wiz      6524:          list of dependent packages in <code class="varname">WRKDIR</code>.
                   6525:          Otherwise, you lose the ability to automatically update
                   6526:          the current package along with the dependent packages
                   6527:          you have installed.</p>
1.110     hubertf  6528: <p>Resuming an interrupted <span class="command"><strong>make
1.88      wiz      6529:          update</strong></span> will only work as long as the package
                   6530:          tree remains unchanged.  If the source code for one of
                   6531:          the packages to be updated has been changed, resuming
1.110     hubertf  6532:          <span class="command"><strong>make update</strong></span> will most certainly
1.88      wiz      6533:          fail!</p>
                   6534: <p>The following variables can be used either on the
1.110     hubertf  6535:          command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
                   6536:          alter the behaviour of <span class="command"><strong>make
1.88      wiz      6537:          update</strong></span>:</p>
1.148     asau     6538: <div class="variablelist"><dl class="variablelist">
1.75      rillig   6539: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
1.88      wiz      6540: <dd><p>Install target to recursively use for the
                   6541:                updated package and the dependent packages.
                   6542:                Defaults to <code class="varname">DEPENDS_TARGET</code> if
1.128     wiz      6543:                set, <span class="quote">&#8220;<span class="quote">install</span>&#8221;</span> otherwise for
1.110     hubertf  6544:                <span class="command"><strong>make update</strong></span>.  Other good
1.128     wiz      6545:                targets are <span class="quote">&#8220;<span class="quote">package</span>&#8221;</span> or
                   6546:                <span class="quote">&#8220;<span class="quote">bin-install</span>&#8221;</span>.  Do not set this to
                   6547:                <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> or you will get stuck in an
1.88      wiz      6548:                endless loop!</p></dd>
1.75      rillig   6549: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
1.88      wiz      6550: <dd><p>Don't clean up after updating.  Useful if
                   6551:                you want to leave the work sources of the updated
                   6552:                packages around for inspection or other purposes.
                   6553:                Be sure you eventually clean up the source tree
1.128     wiz      6554:                (see the <span class="quote">&#8220;<span class="quote">clean-update</span>&#8221;</span> target below)
1.88      wiz      6555:                or you may run into troubles with old source code
                   6556:                still lying around on your next
1.110     hubertf  6557:                <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
1.88      wiz      6558:                update</strong></span>.</p></dd>
1.75      rillig   6559: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
1.88      wiz      6560: <dd><p>Deinstall each package before installing
                   6561:                (making <code class="varname">DEPENDS_TARGET</code>). This
                   6562:                may be necessary if the
1.128     wiz      6563:                <span class="quote">&#8220;<span class="quote">clean-update</span>&#8221;</span> target (see below) was
1.110     hubertf  6564:                called after interrupting a running <span class="command"><strong>make
1.88      wiz      6565:                update</strong></span>.</p></dd>
1.75      rillig   6566: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
1.88      wiz      6567: <dd><p>Allows you to disable recursion and hardcode
                   6568:                the target for packages.  The default is
1.128     wiz      6569:                <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> for the update target,
1.88      wiz      6570:                facilitating a recursive update of prerequisite
                   6571:                packages.  Only set
                   6572:                <code class="varname">DEPENDS_TARGET</code> if you want to
                   6573:                disable recursive updates. Use
                   6574:                <code class="varname">UPDATE_TARGET</code> instead to just
                   6575:                set a specific target for each package to be
1.110     hubertf  6576:                installed during <span class="command"><strong>make update</strong></span>
1.88      wiz      6577:                (see above).</p></dd>
1.75      rillig   6578: </dl></div>
                   6579: </dd>
                   6580: <dt><span class="term">clean-update</span></dt>
                   6581: <dd>
1.88      wiz      6582: <p>Clean the source tree for all packages that would
1.110     hubertf  6583:          get updated if <span class="command"><strong>make update</strong></span> was called
1.88      wiz      6584:          from the current directory.  This target should not be
                   6585:          used if the current package (or any of its depending
                   6586:          packages) have already been de-installed (e.g., after
1.110     hubertf  6587:          calling <span class="command"><strong>make update</strong></span>) or you may lose
1.88      wiz      6588:          some packages you intended to update. As a rule of
                   6589:          thumb: only use this target <span class="emphasis"><em>before</em></span>
1.110     hubertf  6590:          the first time you run <span class="command"><strong>make update</strong></span>
1.88      wiz      6591:          and only if you have a dirty package tree (e.g., if you
                   6592:          used <code class="varname">NOCLEAN</code>).</p>
                   6593: <p>If you are unsure about whether your tree is
1.110     hubertf  6594:          clean, you can either perform a <span class="command"><strong>make
1.88      wiz      6595:          clean</strong></span> at the top of the tree, or use the
                   6596:          following sequence of commands from the directory of the
                   6597:          package you want to update (<span class="emphasis"><em>before</em></span>
1.110     hubertf  6598:          running <span class="command"><strong>make update</strong></span> for the first
1.88      wiz      6599:          time, otherwise you lose all the packages you wanted to
                   6600:          update!):</p>
1.87      wiz      6601: <pre class="screen">
                   6602: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
1.75      rillig   6603: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
1.87      wiz      6604: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
                   6605:          </pre>
1.88      wiz      6606: <p>The following variables can be used either on the
1.110     hubertf  6607:          command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
                   6608:          <span class="command"><strong>make clean-update</strong></span>:</p>
1.148     asau     6609: <div class="variablelist"><dl class="variablelist">
1.75      rillig   6610: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
1.110     hubertf  6611: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
1.88      wiz      6612:                reconstruct the list of directories to update for
1.110     hubertf  6613:                this package.  Only use this if <span class="command"><strong>make
1.88      wiz      6614:                update</strong></span> successfully installed all
                   6615:                packages you wanted to update.  Normally, this is
1.110     hubertf  6616:                done automatically on <span class="command"><strong>make
1.88      wiz      6617:                update</strong></span>, but may have been suppressed by
                   6618:                the <code class="varname">NOCLEAN</code> variable (see
                   6619:                above).</p></dd>
1.75      rillig   6620: </dl></div>
                   6621: </dd>
1.88      wiz      6622: <dt><span class="term">replace</span></dt>
                   6623: <dd>
                   6624: <p>Update the installation of the current package.  This
                   6625:          differs from update in that it does not replace dependent
1.250     leot     6626:          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
1.88      wiz      6627:          target to work.</p>
                   6628: <p><span class="emphasis"><em>Be careful when using this
                   6629:          target!</em></span> There are no guarantees that dependent
                   6630:          packages will still work, in particular they will most
1.110     hubertf  6631:          certainly break if you <span class="command"><strong>make replace</strong></span> a
1.88      wiz      6632:          library package whose shared library major version changed
                   6633:          between your installed version and the new one.  For this
                   6634:          reason, this target is not officially supported and only
                   6635:          recommended for advanced users.</p>
                   6636: </dd>
1.75      rillig   6637: <dt><span class="term">info</span></dt>
1.289     leot     6638: <dd><p>This target invokes <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a> for the current
1.88      wiz      6639:          package. You can use this to check which version of a
                   6640:          package is installed.</p></dd>
                   6641: <dt><span class="term">index</span></dt>
                   6642: <dd>
                   6643: <p>This is a top-level command, i.e. it should be used in
                   6644:          the <code class="filename">pkgsrc</code> directory.  It creates a
                   6645:          database of all packages in the local pkgsrc tree, including
                   6646:          dependencies, comment, maintainer, and some other useful
                   6647:          information.  Individual entries are created by running
1.110     hubertf  6648:          <span class="command"><strong>make describe</strong></span> in the packages'
1.88      wiz      6649:          directories.  This index file is saved as
                   6650:          <code class="filename">pkgsrc/INDEX</code>.  It can be displayed in
1.110     hubertf  6651:          verbose format by running <span class="command"><strong>make
1.88      wiz      6652:          print-index</strong></span>.  You can search in it with
1.110     hubertf  6653:          <span class="command"><strong>make search
1.88      wiz      6654:          key=<em class="replaceable"><code>something</code></em></strong></span>.  You can
                   6655:          extract a list of all packages that depend on a particular
1.110     hubertf  6656:          one by running <span class="command"><strong>make show-deps
1.88      wiz      6657:          PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
                   6658: <p>Running this command takes a very long time, some
                   6659:          hours even on fast machines!</p>
                   6660: </dd>
1.75      rillig   6661: <dt><span class="term">readme</span></dt>
1.88      wiz      6662: <dd>
                   6663: <p>This target generates a
                   6664:          <code class="filename">README.html</code> file, which can be
1.250     leot     6665:          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
1.88      wiz      6666:          contain references to any packages which are in the
                   6667:          <code class="varname">PACKAGES</code> directory on the local
                   6668:          host. The generated files can be made to refer to URLs
                   6669:          based on <code class="varname">FTP_PKG_URL_HOST</code> and
                   6670:          <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
                   6671:          wanted to generate <code class="filename">README.html</code>
                   6672:          files which pointed to binary packages on the local
                   6673:          machine, in the directory
                   6674:          <code class="filename">/usr/packages</code>, set
                   6675:          <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
                   6676:          <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
                   6677:          <code class="varname">${PACKAGES}</code> directory and its
                   6678:          subdirectories will be searched for all the binary
                   6679:          packages.</p>
                   6680: <p>The target can be run at the toplevel or in category
                   6681:          directories, in which case it descends recursively.</p>
                   6682: </dd>
1.75      rillig   6683: <dt><span class="term">readme-all</span></dt>
1.88      wiz      6684: <dd><p>This is a top-level command, run it in
                   6685:          <code class="filename">pkgsrc</code>.  Use this target to create a
                   6686:          file <code class="filename">README-all.html</code> which contains a
                   6687:          list of all packages currently available in the NetBSD
                   6688:          Packages Collection, together with the category they belong
                   6689:          to and a short description. This file is compiled from the
                   6690:          <code class="filename">pkgsrc/*/README.html</code> files, so be sure
1.110     hubertf  6691:          to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
1.88      wiz      6692:          readme</strong></span>.</p></dd>
1.75      rillig   6693: <dt><span class="term">cdrom-readme</span></dt>
1.88      wiz      6694: <dd><p>This is very much the same as the
1.128     wiz      6695:          <span class="quote">&#8220;<span class="quote">readme</span>&#8221;</span> target (see above), but is to be
1.88      wiz      6696:          used when generating a pkgsrc tree to be written to a
                   6697:          CD-ROM.  This target also produces
                   6698:          <code class="filename">README.html</code> files, and can be made
                   6699:          to refer to URLs based on
                   6700:          <code class="varname">CDROM_PKG_URL_HOST</code> and
1.87      wiz      6701:          <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
1.75      rillig   6702: <dt><span class="term">show-distfiles</span></dt>
1.88      wiz      6703: <dd><p>This target shows which distfiles and patchfiles
                   6704:          are needed to build the package
                   6705:          (<code class="varname">ALLFILES</code>, which contains all
                   6706:          <code class="varname">DISTFILES</code> and
1.87      wiz      6707:          <code class="varname">PATCHFILES</code>, but not
                   6708:          <code class="filename">patches/*</code>).</p></dd>
1.75      rillig   6709: <dt><span class="term">show-downlevel</span></dt>
1.88      wiz      6710: <dd><p>This target shows nothing if the package is not
                   6711:          installed. If a version of this package is installed,
                   6712:          but is not the version provided in this version of
                   6713:          pkgsrc, then a warning message is displayed. This target
                   6714:          can be used to show which of your installed packages are
                   6715:          downlevel, and so the old versions can be deleted, and
                   6716:          the current ones added.</p></dd>
1.75      rillig   6717: <dt><span class="term">show-pkgsrc-dir</span></dt>
1.88      wiz      6718: <dd><p>This target shows the directory in the pkgsrc
                   6719:          hierarchy from which the package can be built and
                   6720:          installed. This may not be the same directory as the one
                   6721:          from which the package was installed. This target is
                   6722:          intended to be used by people who may wish to upgrade
                   6723:          many packages on a single host, and can be invoked from
                   6724:          the top-level pkgsrc Makefile by using the
1.128     wiz      6725:          <span class="quote">&#8220;<span class="quote">show-host-specific-pkgs</span>&#8221;</span> target.</p></dd>
1.75      rillig   6726: <dt><span class="term">show-installed-depends</span></dt>
1.88      wiz      6727: <dd><p>This target shows which installed packages match
                   6728:          the current package's <code class="varname">DEPENDS</code>. Useful
                   6729:          if out of date dependencies are causing build
                   6730:          problems.</p></dd>
1.205     wiz      6731: <dt><span class="term">print-build-depends-list</span></dt>
                   6732: <dd><p>This target shows the list of packages that the current package
                   6733:            depends on for building.</p></dd>
                   6734: <dt><span class="term">print-run-depends-list</span></dt>
                   6735: <dd><p>This target shows the list of packages that the current package
                   6736:            depends on for running.</p></dd>
1.75      rillig   6737: <dt><span class="term">check-shlibs</span></dt>
1.88      wiz      6738: <dd><p>After a package is installed, check all its
                   6739:          binaries and (on ELF platforms) shared libraries to see
                   6740:          if they find the shared libs they need.  Run by default
1.110     hubertf  6741:          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>
1.75      rillig   6742: <dt><span class="term">print-PLIST</span></dt>
                   6743: <dd>
1.128     wiz      6744: <p>After a <span class="quote">&#8220;<span class="quote">make install</span>&#8221;</span> from a new or
1.88      wiz      6745:          upgraded pkg, this prints out an attempt to generate a
1.110     hubertf  6746:          new <code class="filename">PLIST</code> from a <span class="command"><strong>find
1.88      wiz      6747:          -newer work/.extract_done</strong></span>.  An attempt is made
                   6748:          to care for shared libs etc., but it is
1.87      wiz      6749:          <span class="emphasis"><em>strongly</em></span> recommended to review the
                   6750:          result before putting it into
                   6751:          <code class="filename">PLIST</code>. On upgrades, it's useful to
                   6752:          diff the output of this command against an already
                   6753:          existing <code class="filename">PLIST</code> file.</p>
1.289     leot     6754: <p>If the package installs files via <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?tar+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a> or
1.88      wiz      6755:          other methods that don't update file access times, be
                   6756:          sure to add these files manually to your
1.128     wiz      6757:          <code class="filename">PLIST</code>, as the <span class="quote">&#8220;<span class="quote">find
                   6758:          -newer</span>&#8221;</span> command used by this target won't catch
1.87      wiz      6759:          them!</p>
1.267     rillig   6760: <p>See <a class="xref" href="#print-PLIST" title="15.3. Tweaking output of make print-PLIST">Section 15.3, &#8220;Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>&#8221;</a> for more
1.87      wiz      6761:          information on this target.</p>
1.75      rillig   6762: </dd>
                   6763: <dt><span class="term">bulk-package</span></dt>
                   6764: <dd>
1.88      wiz      6765: <p>Used to do bulk builds. If an appropriate binary
                   6766:          package already exists, no action is taken. If not, this
                   6767:          target will compile, install and package it (and its
                   6768:          depends, if <code class="varname">PKG_DEPENDS</code> is set
1.267     rillig   6769:          properly. See <a class="xref" href="#bulk" title="Chapter 8. Creating binary packages for everything in pkgsrc (bulk builds)">Chapter 8, <i>Creating binary packages for everything in pkgsrc (bulk
1.174     asau     6770: builds)</i></a>).
1.88      wiz      6771:          After creating the binary package, the sources, the
                   6772:          just-installed package and its required packages are
                   6773:          removed, preserving free disk space.</p>
                   6774: <p><span class="emphasis"><em>Beware that this target may deinstall
                   6775:          all packages installed on a system!</em></span></p>
1.75      rillig   6776: </dd>
                   6777: <dt><span class="term">bulk-install</span></dt>
                   6778: <dd>
1.88      wiz      6779: <p>Used during bulk-installs to install required
                   6780:          packages. If an up-to-date binary package is available,
1.289     leot     6781:          it will be installed via <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. If not,
1.110     hubertf  6782:          <span class="command"><strong>make bulk-package</strong></span> will be executed,
1.87      wiz      6783:          but the installed binary won't be removed.</p>
1.88      wiz      6784: <p>A binary package is considered
1.128     wiz      6785:          <span class="quote">&#8220;<span class="quote">up-to-date</span>&#8221;</span> to be installed via
1.289     leot     6786:          <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> if:</p>
1.148     asau     6787: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      6788: <li class="listitem"><p>None of the package's files
1.88      wiz      6789:              (<code class="filename">Makefile</code>, ...) were modified
                   6790:              since it was built.</p></li>
1.128     wiz      6791: <li class="listitem"><p>None of the package's required (binary)
1.88      wiz      6792:              packages were modified since it was built.</p></li>
1.75      rillig   6793: </ul></div>
1.88      wiz      6794: <p><span class="emphasis"><em>Beware that this target may deinstall
                   6795:          all packages installed on a system!</em></span></p>
1.75      rillig   6796: </dd>
                   6797: </dl></div>
                   6798: </div>
                   6799: </div>
1.148     asau     6800: <div class="chapter">
1.75      rillig   6801: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   6802: <a name="tools"></a>Chapter 20. Tools needed for building or running</h2></div></div></div>
1.75      rillig   6803: <div class="toc">
                   6804: <p><b>Table of Contents</b></p>
1.210     leot     6805: <dl class="toc">
1.267     rillig   6806: <dt><span class="sect1"><a href="#pkgsrc-tools">20.1. Tools for pkgsrc builds</a></span></dt>
                   6807: <dt><span class="sect1"><a href="#package-tools">20.2. Tools needed by packages</a></span></dt>
                   6808: <dt><span class="sect1"><a href="#platform-tools">20.3. Tools provided by platforms</a></span></dt>
1.75      rillig   6809: </dl>
                   6810: </div>
1.87      wiz      6811: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
1.75      rillig   6812: by pkgsrc and also for individual packages to define what commands
1.269     leot     6813: are needed for building a package (like <code class="varname">TOOL_DEPENDS</code>)
1.75      rillig   6814: or for later run-time of an installed packaged (such as
                   6815: <code class="varname">DEPENDS</code>).
                   6816: If the native system provides an adequate tool, then in many cases, a pkgsrc
1.87      wiz      6817: package will not be used.</p>
                   6818: <p>When building a package, the replacement tools are
1.75      rillig   6819: made available in a directory (as symlinks or wrapper scripts)
                   6820: that is early in the executable search path. Just like the buildlink
1.87      wiz      6821: system, this helps with consistent builds.</p>
                   6822: <p>A tool may be needed to help build a specific package. For example,
                   6823: perl, GNU make (gmake) or yacc may be needed.</p>
                   6824: <p>Also a tool may be needed, for example, because the native system's supplied
1.75      rillig   6825: tool may be inefficient for building a package with pkgsrc.
                   6826: For example, a package may need GNU awk, bison (instead of
1.87      wiz      6827: yacc) or a better sed.</p>
                   6828: <p>The tools used by a package can be listed by running
1.110     hubertf  6829: <span class="command"><strong>make show-tools</strong></span>.</p>
1.148     asau     6830: <div class="sect1">
1.75      rillig   6831: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   6832: <a name="pkgsrc-tools"></a>20.1. Tools for pkgsrc builds</h2></div></div></div>
1.87      wiz      6833: <p>The default set of tools used by pkgsrc is defined in
1.76      rillig   6834: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
1.110     hubertf  6835: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
                   6836: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
1.75      rillig   6837: These can be seen by running:
1.110     hubertf  6838: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
1.87      wiz      6839: <p>If a package needs a specific program to build
1.75      rillig   6840: then the <code class="varname">USE_TOOLS</code> variable can be used
1.87      wiz      6841: to define the tools needed.</p>
1.75      rillig   6842: </div>
1.148     asau     6843: <div class="sect1">
1.75      rillig   6844: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   6845: <a name="package-tools"></a>20.2. Tools needed by packages</h2></div></div></div>
1.135     wiz      6846: <p>In the following examples, the :run means that it is needed at
                   6847: run-time (and becomes a DEPENDS).
1.75      rillig   6848: The default is a build dependency which can be set with
                   6849: :build. (So in this example, it is the same as gmake:build
1.87      wiz      6850: and pkg-config:build.)</p>
1.75      rillig   6851: <pre class="programlisting">
                   6852: USE_TOOLS+=     gmake perl:run pkg-config
                   6853: </pre>
1.87      wiz      6854: <p>When using the tools framework, a
1.75      rillig   6855: <code class="varname">TOOLS_PATH.foo</code> variable is defined
                   6856: which contains the full path to the appropriate tool. For example,
1.128     wiz      6857: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">&#8220;<span class="quote">/bin/bash</span>&#8221;</span>
1.87      wiz      6858: on Linux systems.</p>
                   6859: <p>If you always need a pkgsrc version of the
1.75      rillig   6860: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
                   6861: </p>
                   6862: </div>
1.148     asau     6863: <div class="sect1">
1.75      rillig   6864: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   6865: <a name="platform-tools"></a>20.3. Tools provided by platforms</h2></div></div></div>
1.87      wiz      6866: <p>When improving or porting pkgsrc to a new platform, have a look
1.75      rillig   6867: at (or create) the corresponding platform specific make file fragment under
1.76      rillig   6868: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
1.75      rillig   6869: the name of the common tools. For example:</p>
                   6870: <pre class="programlisting">
                   6871: .if exists(/usr/bin/bzcat)
                   6872: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzcat
                   6873: .elif exists(/usr/bin/bzip2)
                   6874: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzip2 -cd
                   6875: .endif
1.69      rillig   6876: 
1.75      rillig   6877: TOOLS_PLATFORM.true?=           true                    # shell builtin
                   6878: </pre>
                   6879: </div>
                   6880: </div>
1.148     asau     6881: <div class="chapter">
1.75      rillig   6882: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   6883: <a name="fixes"></a>Chapter 21. Making your package work</h2></div></div></div>
1.75      rillig   6884: <div class="toc">
                   6885: <p><b>Table of Contents</b></p>
1.210     leot     6886: <dl class="toc">
1.267     rillig   6887: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
1.75      rillig   6888: <dd><dl>
1.267     rillig   6889: <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>
                   6890: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
                   6891: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
                   6892: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
                   6893: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
                   6894: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
                   6895: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
                   6896: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
                   6897: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
                   6898: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
                   6899: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                   6900: </dl></dd>
                   6901: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                   6902: <dd><dl>
                   6903: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   6904: <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>
                   6905: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
                   6906: </dl></dd>
                   6907: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   6908: <dd><dl>
                   6909: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
                   6910: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   6911: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
                   6912: </dl></dd>
                   6913: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
                   6914: <dd><dl>
                   6915: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
                   6916: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
                   6917: <dt><span class="sect2"><a href="#perl-scripts">21.4.3. Packages containing perl scripts</a></span></dt>
                   6918: <dt><span class="sect2"><a href="#shell-scripts">21.4.4. Packages containing shell scripts</a></span></dt>
                   6919: <dt><span class="sect2"><a href="#other-programming-languages">21.4.5. Other programming languages</a></span></dt>
                   6920: </dl></dd>
                   6921: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   6922: <dd><dl>
                   6923: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   6924: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
1.287     rillig   6925: <dt><span class="sect2"><a href="#fixes.build.header">21.5.3. No such file or directory</a></span></dt>
                   6926: <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>
                   6927: <dt><span class="sect2"><a href="#out-of-memory">21.5.5. Running out of memory</a></span></dt>
1.267     rillig   6928: </dl></dd>
                   6929: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   6930: <dd><dl>
                   6931: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
                   6932: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
                   6933: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
                   6934: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
                   6935: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
                   6936: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing perl modules</a></span></dt>
                   6937: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
                   6938: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
                   6939: <dt><span class="sect2"><a href="#gconf-data-files">21.6.9. Packages installing GConf data files</a></span></dt>
                   6940: <dt><span class="sect2"><a href="#scrollkeeper-data-files">21.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
                   6941: <dt><span class="sect2"><a href="#x11-fonts">21.6.11. Packages installing X11 fonts</a></span></dt>
                   6942: <dt><span class="sect2"><a href="#gtk2-modules">21.6.12. Packages installing GTK2 modules</a></span></dt>
                   6943: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.13. Packages installing SGML or XML data</a></span></dt>
                   6944: <dt><span class="sect2"><a href="#mime-database">21.6.14. Packages installing extensions to the MIME database</a></span></dt>
                   6945: <dt><span class="sect2"><a href="#intltool">21.6.15. Packages using intltool</a></span></dt>
                   6946: <dt><span class="sect2"><a href="#startup-scripts">21.6.16. Packages installing startup scripts</a></span></dt>
                   6947: <dt><span class="sect2"><a href="#tex-packages">21.6.17. Packages installing TeX modules</a></span></dt>
                   6948: <dt><span class="sect2"><a href="#emulation-packages">21.6.18. Packages supporting running binaries in
1.87      wiz      6949:     emulation</a></span></dt>
1.267     rillig   6950: <dt><span class="sect2"><a href="#hicolor-theme">21.6.19. Packages installing hicolor theme icons</a></span></dt>
                   6951: <dt><span class="sect2"><a href="#desktop-files">21.6.20. Packages installing desktop files</a></span></dt>
1.75      rillig   6952: </dl></dd>
1.267     rillig   6953: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.75      rillig   6954: </dl>
                   6955: </div>
1.148     asau     6956: <div class="sect1">
1.75      rillig   6957: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   6958: <a name="general-operation"></a>21.1. General operation</h2></div></div></div>
1.78      rillig   6959: <p>One appealing feature of pkgsrc is that it runs on many
1.218     rillig   6960:   different platforms. As a result, it is important to ensure,
                   6961:   where possible, that packages in pkgsrc are portable. This
                   6962:   chapter mentions some particular details you should pay
                   6963:   attention to while working on pkgsrc.</p>
1.148     asau     6964: <div class="sect2">
1.78      rillig   6965: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   6966: <a name="pulling-vars-from-etc-mk.conf"></a>21.1.1. How to pull in user-settable variables from <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.93      rillig   6967: </h3></div></div></div>
1.78      rillig   6968: <p>The pkgsrc user can configure pkgsrc by overriding several
1.87      wiz      6969:     variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.110     hubertf  6970:     which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.87      wiz      6971:     want to use those variables in the preprocessor directives of
1.289     leot     6972:     <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> (for example <code class="literal">.if</code> or
1.87      wiz      6973:     <code class="literal">.for</code>), you need to include the file
                   6974:     <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
                   6975:     loads the user preferences.</p>
1.78      rillig   6976: <p>But note that some variables may not be completely defined
1.219     rillig   6977:     after <code class="filename">../../mk/bsd.prefs.mk</code> has been
                   6978:     included, as they may contain references to variables that are
                   6979:     not yet defined. In shell commands (the lines in
                   6980:     <code class="filename">Makefile</code> that are indented with a tab) this
                   6981:     is no problem, since variables are only expanded when they are
                   6982:     used. But in the preprocessor directives mentioned above and in
                   6983:     dependency lines (of the form <code class="literal">target:
                   6984:     dependencies</code>) the variables are expanded at load
                   6985:     time.</p>
1.148     asau     6986: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.78      rillig   6987: <h3 class="title">Note</h3>
1.218     rillig   6988: <p>To check whether a variable can be used at load time,
                   6989:     run <span class="command"><strong>pkglint -Wall</strong></span> on your package.</p>
1.78      rillig   6990: </div>
                   6991: </div>
1.148     asau     6992: <div class="sect2">
1.78      rillig   6993: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   6994: <a name="user-interaction"></a>21.1.2. User interaction</h3></div></div></div>
1.88      wiz      6995: <p>Occasionally, packages require interaction from the user,
                   6996:     and this can be in a number of ways:</p>
1.148     asau     6997: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      6998: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.87      wiz      6999:        interaction such as entering username/password or accepting a
                   7000:        license on a web page.</p></li>
1.128     wiz      7001: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.88      wiz      7002:        passwords.</p></li>
1.128     wiz      7003: <li class="listitem"><p>help to configure the package before it is built</p></li>
                   7004: <li class="listitem"><p>help during the build process</p></li>
                   7005: <li class="listitem"><p>help during the installation of a package</p></li>
1.78      rillig   7006: </ul></div>
1.218     rillig   7007: <p>A package can set the <code class="varname">INTERACTIVE_STAGE</code>
                   7008:     variable to define which stages need interaction. This should be
                   7009:     done in the package's <code class="filename">Makefile</code>, e.g.:</p>
1.75      rillig   7010: <pre class="programlisting">
1.100     rillig   7011: INTERACTIVE_STAGE=      configure install
1.222     sevan    7012: </pre>
1.88      wiz      7013: <p>The user can then decide to skip this package by setting the
1.218     rillig   7014:     <code class="varname">BATCH</code> variable. Packages that require interaction
                   7015:     are also excluded from bulk builds.</p>
1.75      rillig   7016: </div>
1.148     asau     7017: <div class="sect2">
1.75      rillig   7018: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7019: <a name="handling-licenses"></a>21.1.3. Handling licenses</h3></div></div></div>
1.222     sevan    7020: <p>Authors of software can choose the licence under which software
                   7021:     can be copied.  The Free Software Foundation has declared some
                   7022:     licenses "Free", and the Open Source Initiative has a definition of
                   7023:     "Open Source".</p>
                   7024: <p>By default, pkgsrc allows packages with Free or Open Source
                   7025:     licenses to be built.  To allow packages with other licenses to be
                   7026:     built as well, the pkgsrc user needs to add these licenses to the
                   7027:     <code class="varname">ACCEPTABLE_LICENSES</code> variable in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  Note
                   7028:     that this variable only affects which packages may be
                   7029:     <span class="emphasis"><em>built</em></span>, while the license terms often also
                   7030:     restrict the actual use of the package and its redistribution.</p>
1.98      wiz      7031: <p>One might want to only install packages with a BSD license,
1.218     rillig   7032:     or the GPL, and not the other.  The free licenses are added to the
1.222     sevan    7033:     default <code class="varname">ACCEPTABLE_LICENSES</code> variable.  The pkgsrc
1.121     jnemeth  7034:     user can override the default by setting the
                   7035:     <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
1.222     sevan    7036:     of "+=".  The licenses accepted by default are defined in the
                   7037:     <code class="varname">DEFAULT_ACCEPTABLE_LICENSES</code> variable in the file
                   7038:     <code class="filename">pkgsrc/mk/license.mk</code>.</p>
1.78      rillig   7039: <p>The license tag mechanism is intended to address
1.87      wiz      7040:     copyright-related issues surrounding building, installing and
                   7041:     using a package, and not to address redistribution issues (see
                   7042:     <code class="varname">RESTRICTED</code> and
1.222     sevan    7043:     <code class="varname">NO_SRC_ON_FTP</code>, etc.).
1.121     jnemeth  7044:     Packages with redistribution restrictions should set these
                   7045:     tags.</p>
1.98      wiz      7046: <p>Denoting that a package may be copied according to a
                   7047:     particular license is done by placing the license in
1.87      wiz      7048:     <code class="filename">pkgsrc/licenses</code> and setting the
                   7049:     <code class="varname">LICENSE</code> variable to a string identifying the
1.250     leot     7050:     license, e.g. in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/graphics/xv/README.html" target="_top"><code class="filename">graphics/xv</code></a>:</p>
1.87      wiz      7051: <pre class="programlisting">
1.100     rillig   7052: LICENSE=        xv-license
1.222     sevan    7053: </pre>
1.87      wiz      7054: <p>When trying to build, the user will get a notice that the
1.98      wiz      7055:     package is covered by a license which has not been placed in the
                   7056:     <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
1.87      wiz      7057: <pre class="programlisting">
1.100     rillig   7058: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   7059: ===&gt; xv-3.10anb9 has an unacceptable license: xv-license.
                   7060: ===&gt;     To view the license, enter "/usr/bin/make show-license".
                   7061: ===&gt;     To indicate acceptance, add this line to your /etc/mk.conf:
                   7062: ===&gt;     ACCEPTABLE_LICENSES+=xv-license
                   7063: *** Error code 1
1.222     sevan    7064: </pre>
1.110     hubertf  7065: <p>The license can be viewed with <span class="command"><strong>make
1.98      wiz      7066:     show-license</strong></span>, and if the user so chooses, the line
1.110     hubertf  7067:     printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.98      wiz      7068:     convey to pkgsrc that it should not in the future fail because of
                   7069:     that license:</p>
1.78      rillig   7070: <pre class="programlisting">
1.100     rillig   7071: ACCEPTABLE_LICENSES+=xv-license
1.222     sevan    7072: </pre>
                   7073: <p>The use of <code class="varname">LICENSE=shareware</code>,
                   7074:     <code class="varname">LICENSE=no-commercial-use</code>, and similar language
                   7075:     is deprecated because it does not crisply refer to a particular
                   7076:     license text.  Another problem with such usage is that it does not
                   7077:     enable a user to tell pkgsrc to proceed for a single package
                   7078:     without also telling pkgsrc to proceed for all packages with that
                   7079:     tag.</p>
                   7080: <div class="sect3">
                   7081: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   7082: <a name="new-license"></a>21.1.3.1. Adding a package with a new license</h4></div></div></div>
1.154     rodent   7083: <p>When adding a package with a new license, the following steps
                   7084:     are required:</p>
                   7085: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7086: <li class="listitem">
1.284     rillig   7087: <p>Check whether the license qualifies as Free or Open Source by
                   7088:     referencing <a class="ulink" href="https://www.gnu.org/licenses/license-list.en.html" target="_top">Various
                   7089:     Licenses and Comments about Them</a> and <a class="ulink" href="https://opensource.org/licenses/alphabetical" target="_top">Licenses by Name |
1.222     sevan    7090:     Open Source Initiative</a>.  If this is the case, the filename in
                   7091:     <code class="filename">pkgsrc/licenses/</code> does not need the
                   7092:     <code class="filename">-license</code> suffix, and the license name should be
                   7093:     added to:</p>
1.154     rodent   7094: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.284     rillig   7095: <li class="listitem"><p>DEFAULT_ACCEPTABLE_LICENSES in
                   7096:     <code class="filename">pkgsrc/mk/license.mk</code></p></li>
                   7097: <li class="listitem"><p>default_acceptable_licenses in
                   7098:     <code class="filename">pkgsrc/pkgtools/pkg_install/files/lib/license.c</code></p></li>
1.154     rodent   7099: </ul></div>
                   7100: </li>
1.284     rillig   7101: <li class="listitem"><p>The license text should be added to
                   7102:     <code class="filename">pkgsrc/licenses</code> for displaying.  A list of known
                   7103:     licenses can be seen in this directory.</p></li>
1.154     rodent   7104: </ol></div>
1.222     sevan    7105: </div>
                   7106: <div class="sect3">
                   7107: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   7108: <a name="change-license"></a>21.1.3.2. Change to the license</h4></div></div></div>
1.98      wiz      7109: <p>When the license changes (in a way other than formatting),
1.222     sevan    7110:     make sure that the new license has a different name (e.g.,
1.98      wiz      7111:     append the version number if it exists, or the date).  Just
                   7112:     because a user told pkgsrc to build programs under a previous
                   7113:     version of a license does not mean that pkgsrc should build
1.99      rillig   7114:     programs under the new licenses.  The higher-level point is that
1.98      wiz      7115:     pkgsrc does not evaluate licenses for reasonableness; the only
                   7116:     test is a mechanistic test of whether a particular text has been
1.222     sevan    7117:     approved by either of two bodies (FSF or OSI).</p>
                   7118: </div>
1.75      rillig   7119: </div>
1.148     asau     7120: <div class="sect2">
1.75      rillig   7121: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7122: <a name="restricted-packages"></a>21.1.4. Restricted packages</h3></div></div></div>
1.75      rillig   7123: <p>Some licenses restrict how software may be re-distributed.
1.222     sevan    7124:     By declaring the restrictions, package tools can
1.98      wiz      7125:     automatically refrain from e.g. placing binary packages on FTP
                   7126:     sites.</p>
1.222     sevan    7127: <p>There are four possible restrictions, which are
1.98      wiz      7128:     the cross product of sources (distfiles) and binaries not being
                   7129:     placed on FTP sites and CD-ROMs.  Because this is rarely the exact
                   7130:     language in any license, and because non-Free licenses tend to be
                   7131:     different from each other, pkgsrc adopts a definition of FTP and
1.222     sevan    7132:     CD-ROM.
                   7133: 
                   7134:     "FTP" means making the source or binary file available over the
                   7135:     Internet at no charge.
                   7136: 
                   7137:     "CD-ROM" means making the source or binary available on some kind of
                   7138:     media, together with other source and binary packages, which is sold
                   7139:     for a distribution charge.
1.98      wiz      7140:     </p>
                   7141: <p>In order to encode these restrictions, the package system
1.87      wiz      7142:     defines five make variables that can be set to note these
                   7143:     restrictions:</p>
1.148     asau     7144: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      7145: <li class="listitem">
1.75      rillig   7146: <p><code class="varname">RESTRICTED</code></p>
                   7147: <p>This variable should be set whenever a restriction
1.87      wiz      7148:        exists (regardless of its kind).  Set this variable to a
1.98      wiz      7149:        string containing the reason for the restriction.  It should
                   7150:        be understood that those wanting to understand the restriction
                   7151:        will have to read the license, and perhaps seek advice of
                   7152:        counsel.</p>
1.75      rillig   7153: </li>
1.128     wiz      7154: <li class="listitem">
1.75      rillig   7155: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
1.98      wiz      7156: <p>Binaries may not be placed on CD-ROM containing other
                   7157:        binary packages, for which a distribution charge may be made.
                   7158:        In this case, set this variable to
                   7159:        <code class="varname">${RESTRICTED}</code>.</p>
1.75      rillig   7160: </li>
1.128     wiz      7161: <li class="listitem">
1.75      rillig   7162: <p><code class="varname">NO_BIN_ON_FTP</code></p>
1.98      wiz      7163: <p>Binaries may not made available on the Internet without
                   7164:        charge.  In this case, set this variable to
                   7165:        <code class="varname">${RESTRICTED}</code>.  If this variable is set,
                   7166:        binary packages will not be included on ftp.NetBSD.org.</p>
1.75      rillig   7167: </li>
1.128     wiz      7168: <li class="listitem">
1.75      rillig   7169: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
1.98      wiz      7170: <p>Distfiles may not be placed on CD-ROM, together with
                   7171:        other distfiles, for which a fee may be charged.  In this
                   7172:        case, set this variable to <code class="varname">${RESTRICTED}</code>.
                   7173:        </p>
1.75      rillig   7174: </li>
1.128     wiz      7175: <li class="listitem">
1.75      rillig   7176: <p><code class="varname">NO_SRC_ON_FTP</code></p>
1.98      wiz      7177: <p>Distfiles may not made available via FTP at no charge.
                   7178:        In this case, set this variable to
                   7179:        <code class="varname">${RESTRICTED}</code>.  If this variable is set,
                   7180:        the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
1.75      rillig   7181: </li>
                   7182: </ul></div>
1.222     sevan    7183: <p>Please note that packages will be removed from pkgsrc when the
                   7184:     distfiles are not distributable and cannot be obtained for a period
                   7185:     of one full quarter branch. Packages with manual/interactive fetch
                   7186:     must have a maintainer and it is his/her responsibility to ensure
                   7187:     this.</p>
1.75      rillig   7188: </div>
1.148     asau     7189: <div class="sect2">
1.75      rillig   7190: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7191: <a name="dependencies"></a>21.1.5. Handling dependencies</h3></div></div></div>
1.290     gutterid 7192: <p>Your package may depend on some other package being present,
                   7193:     and there are various ways of expressing this dependency.
                   7194:     pkgsrc supports the <code class="varname">DEPENDS</code>,
                   7195:     <code class="varname">BUILD_DEPENDS</code>,
                   7196:     <code class="varname">TOOL_DEPENDS</code>, and
                   7197:     <code class="varname">TEST_DEPENDS</code> definitions, the
1.88      wiz      7198:     <code class="varname">USE_TOOLS</code> definition, as well as dependencies
                   7199:     via <code class="filename">buildlink3.mk</code>, which is the preferred way
                   7200:     to handle dependencies, and which uses the variables named above.
1.267     rillig   7201:     See <a class="xref" href="#buildlink" title="Chapter 16. Buildlink methodology">Chapter 16, <i>Buildlink methodology</i></a> for more information.</p>
1.290     gutterid 7202: <p>The basic difference is that the <code class="varname">DEPENDS</code>
                   7203:     definition registers that pre-requisite in the binary package so it
                   7204:     will be pulled in when the binary package is later installed, whilst
                   7205:     the <code class="varname">BUILD_DEPENDS</code>, <code class="varname">TOOL_DEPENDS</code>,
                   7206:     and <code class="varname">TEST_DEPENDS</code> definitions do not, marking a
                   7207:     dependency that is only needed for building or testing the resulting
                   7208:     package. See also <a class="xref" href="#creating" title="Chapter 12. Creating a new pkgsrc package from scratch">Chapter 12, <i>Creating a new pkgsrc package from scratch</i></a> for more information.</p>
1.75      rillig   7209: <p>This means that if you only need a package present whilst
1.290     gutterid 7210:     you are building or testing, it should be noted as a
                   7211:     <code class="varname">TOOL_DEPENDS</code>,
                   7212:     <code class="varname">BUILD_DEPENDS</code>, or
                   7213:     <code class="varname">TEST_DEPENDS</code>.  When cross-compiling,
1.269     leot     7214:     <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
                   7215:     packages, i.e. packages for the architecture where the package
                   7216:     is built;
                   7217:     <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
1.290     gutterid 7218:     packages, i.e., packages for the architecture for which the package
1.269     leot     7219:     is built.</p>
1.290     gutterid 7220: <p>The format for a <code class="varname">DEPENDS</code>,
                   7221:     <code class="varname">BUILD_DEPENDS</code>, <code class="varname">TOOL_DEPENDS</code>,
                   7222:     and <code class="varname">TEST_DEPENDS</code> definition is:</p>
1.75      rillig   7223: <pre class="programlisting">
1.100     rillig   7224: &lt;pre-req-package-name&gt;:../../&lt;category&gt;/&lt;pre-req-package&gt;
1.222     sevan    7225: </pre>
1.128     wiz      7226: <p>Please note that the <span class="quote">&#8220;<span class="quote">pre-req-package-name</span>&#8221;</span>
1.87      wiz      7227:     may include any of the wildcard version numbers recognized by
1.289     leot     7228:     <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a>.</p>
1.128     wiz      7229: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7230: <li class="listitem">
1.75      rillig   7231: <p>If your package needs another package's binaries or
1.160     wiz      7232:        libraries to build and run, and if that package has a
1.87      wiz      7233:        <code class="filename">buildlink3.mk</code> file available, use it:</p>
1.75      rillig   7234: <pre class="programlisting">
1.100     rillig   7235: .include "../../graphics/jpeg/buildlink3.mk"
1.222     sevan    7236: </pre>
1.75      rillig   7237: </li>
1.128     wiz      7238: <li class="listitem">
1.160     wiz      7239: <p>If your package needs another package's binaries or
                   7240:        libraries only for building, and if that package has a
                   7241:        <code class="filename">buildlink3.mk</code> file available, use it:</p>
                   7242: <pre class="programlisting">
                   7243: .include "../../graphics/jpeg/buildlink3.mk"
1.222     sevan    7244: </pre>
1.160     wiz      7245: <p>but set
                   7246:        <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>jpeg</code></em>?=build</code>
                   7247:        to make it a build dependency only. This case is rather
                   7248:        rare.</p>
                   7249: </li>
                   7250: <li class="listitem">
1.132     spz      7251: <p>If your package needs binaries from another package to build,
1.269     leot     7252:        use the <code class="varname">TOOL_DEPENDS</code> definition:</p>
1.75      rillig   7253: <pre class="programlisting">
1.269     leot     7254: TOOL_DEPENDS+= itstool-[0-9]*:../../textproc/itstool
1.222     sevan    7255: </pre>
1.75      rillig   7256: </li>
1.269     leot     7257: <li class="listitem"><p>If your package needs static libraries to link against, header
                   7258:        files to include, etc. from another package to build,
                   7259:        use the <code class="varname">BUILD_DEPENDS</code> definition.</p></li>
1.132     spz      7260: <li class="listitem"><p>If your package needs a library with which to link and
                   7261:        there is no <code class="filename">buildlink3.mk</code> file
                   7262:        available, create one. Using
                   7263:        <code class="varname">DEPENDS</code> won't be sufficient because the
                   7264:        include files and libraries will be hidden from the compiler.</p></li>
1.128     wiz      7265: <li class="listitem">
1.132     spz      7266: <p>If your package needs some executable to be able to run
                   7267:        correctly and if there's no
                   7268:        <code class="filename">buildlink3.mk</code> file, this is specified
                   7269:        using the <code class="varname">DEPENDS</code> variable. The
1.250     leot     7270:        <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/lyx/README.html" target="_top"><code class="filename">print/lyx</code></a> package needs to
1.242     wiz      7271:        be able to execute the latex binary from the tex-latex-bin package
1.132     spz      7272:        when it runs, and that is specified:</p>
1.75      rillig   7273: <pre class="programlisting">
1.242     wiz      7274: DEPENDS+=        tex-latex-bin-[0-9]*:../../print/tex-latex-bin
1.222     sevan    7275: </pre>
1.132     spz      7276: </li>
1.290     gutterid 7277: <li class="listitem"><p>If your package includes a test suite that has extra
                   7278:         dependencies only required for this purpose (frequently this
                   7279:         can be run as a <span class="quote">&#8220;<span class="quote">make test</span>&#8221;</span> target), use the
                   7280:         <code class="varname">TEST_DEPENDS</code> variable.</p></li>
1.132     spz      7281: <li class="listitem">
                   7282: <p>You can use wildcards in package dependencies. Note that
                   7283:        such wildcard dependencies are retained when creating binary
                   7284:        packages. The dependency is checked when installing the binary
                   7285:        package and any package which matches the pattern will be
                   7286:        used. Wildcard dependencies should be used with care.</p>
1.128     wiz      7287: <p>The <span class="quote">&#8220;<span class="quote">-[0-9]*</span>&#8221;</span> should be used instead of
                   7288:        <span class="quote">&#8220;<span class="quote">-*</span>&#8221;</span> to avoid potentially ambiguous matches
                   7289:        such as <span class="quote">&#8220;<span class="quote">tk-postgresql</span>&#8221;</span> matching a
                   7290:        <span class="quote">&#8220;<span class="quote">tk-*</span>&#8221;</span> <code class="varname">DEPENDS</code>.</p>
1.75      rillig   7291: <p>Wildcards can also be used to specify that a package
1.87      wiz      7292:        will only build against a certain minimum version of a
                   7293:        pre-requisite:</p>
1.75      rillig   7294: <pre class="programlisting">
1.132     spz      7295: DEPENDS+=       ImageMagick&gt;=6.0:../../graphics/ImageMagick
1.222     sevan    7296: </pre>
1.132     spz      7297: <p>This means that the package will build using version 6.0
                   7298:        of ImageMagick or newer. Such a dependency may be warranted
                   7299:        if, for example, the command line options of an executable
                   7300:        have changed.</p>
                   7301: <p>If you need to depend on minimum versions of libraries,
                   7302:        see the buildlink section of the pkgsrc guide.</p>
1.75      rillig   7303: <p>For security fixes, please update the package
1.267     rillig   7304:        vulnerabilities file. See <a class="xref" href="#security-handling" title="21.1.9. Handling packages with security problems">Section 21.1.9, &#8220;Handling packages with security problems&#8221;</a> for more
1.87      wiz      7305:        information.</p>
1.75      rillig   7306: </li>
                   7307: </ol></div>
                   7308: <p>If your package needs files from another package to build,
1.87      wiz      7309:     add the relevant distribution files to
                   7310:     <code class="varname">DISTFILES</code>, so they will be extracted
1.250     leot     7311:     automatically. See the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/ghostscript/README.html" target="_top"><code class="filename">print/ghostscript</code></a> package for an example.
1.87      wiz      7312:     (It relies on the jpeg sources being present in source form
                   7313:     during the build.)</p>
1.75      rillig   7314: </div>
1.148     asau     7315: <div class="sect2">
1.75      rillig   7316: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7317: <a name="conflicts"></a>21.1.6. Handling conflicts with other packages</h3></div></div></div>
1.75      rillig   7318: <p>Your package may conflict with other packages a user might
1.87      wiz      7319:     already have installed on his system, e.g. if your package
1.88      wiz      7320:     installs the same set of files as another package in the pkgsrc
1.190     wiz      7321:     tree or has the same <code class="varname">PKGNAME</code>.</p>
1.255     leot     7322: <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>
                   7323:     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>
                   7324:     install the same shared library, thus you set in
                   7325:     <code class="filename">pkgsrc/x11/libXaw3d/Makefile</code>:</p>
                   7326: <pre class="programlisting">
                   7327: CONFLICTS=      Xaw-Xpm-[0-9]*
                   7328:     </pre>
                   7329: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
                   7330: <pre class="programlisting">
                   7331: CONFLICTS=      libXaw3d-[0-9]*
                   7332:     </pre>
1.289     leot     7333: <p><a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> is able to detect attempts to install packages
1.255     leot     7334:     that conflict with existing packages and abort. However, in many
                   7335:     situations this is too late in the process. Binary package managers
                   7336:     will not know about the conflict until they attempt to install the
                   7337:     package after already downloading it and all its dependencies.
                   7338:     Users may also waste time building a package and its dependencies
                   7339:     only to find out at the end that it conflicts with another package
                   7340:     they have installed.</p>
                   7341: <p>To avoid these issues <code class="varname">CONFLICTS</code> entries
                   7342:     should be added in all cases where it is known that packages conflict
                   7343:     with each other.  These <code class="varname">CONFLICTS</code> entries are
1.289     leot     7344:     exported in <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_summary+5.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_summary</span>(5)</span></a> files and consumed by binary package
1.255     leot     7345:     managers to inform users that packages cannot be installed onto
                   7346:     the target system.</p>
1.75      rillig   7347: </div>
1.148     asau     7348: <div class="sect2">
1.75      rillig   7349: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7350: <a name="not-building-packages"></a>21.1.7. Packages that cannot or should not be built</h3></div></div></div>
1.75      rillig   7351: <p>There are several reasons why a package might be
1.88      wiz      7352:     instructed to not build under certain circumstances.  If the
1.87      wiz      7353:     package builds and runs on most platforms, the exceptions
1.193     dholland 7354:     should be noted with <code class="varname">BROKEN_ON_PLATFORM</code>.  If
                   7355:     the package builds and runs on a small handful of platforms,
                   7356:     set <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> instead.
                   7357:     Both <code class="varname">BROKEN_ON_PLATFORM</code> and
                   7358:     <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> are OS triples
                   7359:     (OS-version-platform) that can use glob-style
                   7360:     wildcards.</p>
                   7361: <p>If a package is not appropriate for some platforms (as
1.225     maya     7362:     opposed to merely broken), a different set of variables should be
1.193     dholland 7363:     used as this affects failure reporting and statistics.
                   7364:     If the package is appropriate for most platforms, the exceptions
1.87      wiz      7365:     should be noted with <code class="varname">NOT_FOR_PLATFORM</code>.  If
1.193     dholland 7366:     the package is appropriate for only a small handful of platforms
                   7367:     (often exactly one), set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
1.87      wiz      7368:     Both <code class="varname">ONLY_FOR_PLATFORM</code> and
                   7369:     <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
                   7370:     (OS-version-platform) that can use glob-style
                   7371:     wildcards.</p>
1.88      wiz      7372: <p>Some packages are tightly bound to a specific version of an
1.250     leot     7373:     operating system, e.g. LKMs or <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/sysutils/lsof/README.html" target="_top"><code class="filename">sysutils/lsof</code></a>.  Such binary packages are not
1.88      wiz      7374:     backwards compatible with other versions of the OS, and should be
                   7375:     uploaded to a version specific directory on the FTP server.  Mark
                   7376:     these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.128     wiz      7377:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.  This variable is not currently used by any of
1.88      wiz      7378:     the package system internals, but may be used in the
                   7379:     future.</p>
1.75      rillig   7380: <p>If the package should be skipped (for example, because it
1.87      wiz      7381:     provides functionality already provided by the system), set
1.88      wiz      7382:     <code class="varname">PKG_SKIP_REASON</code> to a descriptive message.  If
                   7383:     the package should fail because some preconditions are not met,
                   7384:     set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
1.87      wiz      7385:     message.</p>
1.75      rillig   7386: </div>
1.148     asau     7387: <div class="sect2">
1.75      rillig   7388: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7389: <a name="undeletable-packages"></a>21.1.8. Packages which should not be deleted, once installed</h3></div></div></div>
1.75      rillig   7390: <p>To ensure that a package may not be deleted, once it has been
1.87      wiz      7391:     installed, the <code class="varname">PKG_PRESERVE</code> definition should
                   7392:     be set in the package Makefile. This will be carried into any
                   7393:     binary package that is made from this pkgsrc entry. A
1.128     wiz      7394:     <span class="quote">&#8220;<span class="quote">preserved</span>&#8221;</span> package will
1.289     leot     7395:     not be deleted using <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> unless the
1.128     wiz      7396:     <span class="quote">&#8220;<span class="quote">-f</span>&#8221;</span> option is used.</p>
1.75      rillig   7397: </div>
1.148     asau     7398: <div class="sect2">
1.75      rillig   7399: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7400: <a name="security-handling"></a>21.1.9. Handling packages with security problems</h3></div></div></div>
1.75      rillig   7401: <p>When a vulnerability is found, this should be noted in
1.87      wiz      7402:     <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
1.138     wiz      7403:     and after committing that file, ask pkgsrc-security@NetBSD.org to
                   7404:     update the file on ftp.NetBSD.org.</p>
1.75      rillig   7405: <p>After fixing the vulnerability by a patch, its
1.138     wiz      7406:     <code class="varname">PKGREVISION</code> should be increased (this is of
                   7407:     course not necessary if the problem is fixed by using a newer
                   7408:     release of the software), and the pattern in the
                   7409:     pkg-vulnerabilities file must be updated.</p>
1.75      rillig   7410: <p>Also, if the fix should be applied to the stable pkgsrc
1.87      wiz      7411:     branch, be sure to submit a pullup request!</p>
1.75      rillig   7412: <p>Binary packages already on ftp.NetBSD.org will be handled
1.87      wiz      7413:     semi-automatically by a weekly cron job.</p>
1.75      rillig   7414: </div>
1.148     asau     7415: <div class="sect2">
1.75      rillig   7416: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7417: <a name="bumping-pkgrevision"></a>21.1.10. How to handle incrementing versions when fixing an existing package</h3></div></div></div>
1.75      rillig   7418: <p>When making fixes to an existing package it can be useful
1.87      wiz      7419:     to change the version number in <code class="varname">PKGNAME</code>. To
                   7420:     avoid conflicting with future versions by the original author, a
1.128     wiz      7421:     <span class="quote">&#8220;<span class="quote">nb1</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">nb2</span>&#8221;</span>, ... suffix can be used
1.87      wiz      7422:     on package versions by setting <code class="varname">PKGREVISION=1</code>
1.128     wiz      7423:     (2, ...). The <span class="quote">&#8220;<span class="quote">nb</span>&#8221;</span> is treated like a
                   7424:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span> by the package tools. e.g.</p>
1.87      wiz      7425: <pre class="programlisting">
1.100     rillig   7426: DISTNAME=       foo-17.42
                   7427: PKGREVISION=    9
1.222     sevan    7428: </pre>
1.75      rillig   7429: <p>will result in a <code class="varname">PKGNAME</code> of
1.128     wiz      7430:     <span class="quote">&#8220;<span class="quote">foo-17.42nb9</span>&#8221;</span>. If you want to use the original
                   7431:     value of <code class="varname">PKGNAME</code> without the <span class="quote">&#8220;<span class="quote">nbX</span>&#8221;</span>
1.87      wiz      7432:     suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
                   7433:     <code class="varname">PKGNAME_NOREV</code>.</p>
1.75      rillig   7434: <p>When a new release of the package is released, the
1.87      wiz      7435:     <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
                   7436:     minor release of the above package, things should be like:</p>
1.75      rillig   7437: <pre class="programlisting">
1.100     rillig   7438: DISTNAME=       foo-17.43
1.222     sevan    7439: </pre>
1.87      wiz      7440: <p><code class="varname">PKGREVISION</code> should be incremented for any
                   7441:     non-trivial change in the resulting binary package.  Without a
                   7442:     <code class="varname">PKGREVISION</code> bump, someone with the previous
                   7443:     version installed has no way of knowing that their package is out
                   7444:     of date.  Thus, changes without increasing
                   7445:     <code class="varname">PKGREVISION</code> are essentially labeled "this is so
                   7446:     trivial that no reasonable person would want to upgrade", and this
                   7447:     is the rough test for when increasing
                   7448:     <code class="varname">PKGREVISION</code> is appropriate.  Examples of
                   7449:     changes that do not merit increasing
                   7450:     <code class="varname">PKGREVISION</code> are:</p>
1.148     asau     7451: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      7452: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.284     rillig   7453:       <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>, or
                   7454:       comments in Makefile.</p></li>
                   7455: <li class="listitem"><p>Changing build variables if the resulting binary
                   7456:       package is the same.</p></li>
                   7457: <li class="listitem"><p>Changing
                   7458:       <code class="filename">DESCR</code>.</p></li>
                   7459: <li class="listitem"><p>Adding <code class="varname">PKG_OPTIONS</code> if the
                   7460:       default options don't change.</p></li>
1.100     rillig   7461: </ul></div>
1.87      wiz      7462: <p>Examples of changes that do merit an increase to
                   7463:     <code class="varname">PKGREVISION</code> include:</p>
1.148     asau     7464: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.284     rillig   7465: <li class="listitem"><p>Security fixes</p></li>
                   7466: <li class="listitem"><p>Changes or additions to a patch
                   7467:       file</p></li>
                   7468: <li class="listitem"><p>Changes to the
                   7469:       <code class="filename">PLIST</code></p></li>
                   7470: <li class="listitem"><p>A dependency is changed or
                   7471:       renamed.</p></li>
1.100     rillig   7472: </ul></div>
1.78      rillig   7473: <p>PKGREVISION must also be incremented when dependencies have ABI
                   7474:     changes.</p>
1.75      rillig   7475: </div>
1.148     asau     7476: <div class="sect2">
1.79      rillig   7477: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7478: <a name="fixes.subst"></a>21.1.11. Substituting variable text in the package files (the SUBST framework)</h3></div></div></div>
1.79      rillig   7479: <p>When you want to replace the same text in multiple files
1.87      wiz      7480:     or when the replacement text varies, patches alone cannot help.
                   7481:     This is where the SUBST framework comes in. It provides an
                   7482:     easy-to-use interface for replacing text in files.
1.287     rillig   7483:     It just needs the following information:</p>
                   7484: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   7485: <li class="listitem"><p><span class="emphasis"><em>When</em></span> should the replacement
                   7486: happen?</p></li>
                   7487: <li class="listitem"><p><span class="emphasis"><em>Where</em></span> should the replacement happen,
                   7488: i.e. in which files?</p></li>
                   7489: <li class="listitem"><p><span class="emphasis"><em>Which</em></span> text should be
                   7490: replaced with what?</p></li>
                   7491: </ul></div>
                   7492: <p>This information is encoded in a block of <code class="varname">SUBST</code>
                   7493: variables, like in this example:</p>
1.87      wiz      7494: <pre class="programlisting">
1.100     rillig   7495: SUBST_CLASSES+=                 fix-paths
                   7496: SUBST_STAGE.fix-paths=          pre-configure
                   7497: SUBST_MESSAGE.fix-paths=        Fixing absolute paths.
                   7498: SUBST_FILES.fix-paths=          src/*.c
                   7499: SUBST_FILES.fix-paths+=         scripts/*.sh
                   7500: SUBST_SED.fix-paths=            -e 's,"/usr/local,"${PREFIX},g'
                   7501: SUBST_SED.fix-paths+=           -e 's,"/var/log,"${VARBASE}/log,g'
1.222     sevan    7502: </pre>
1.79      rillig   7503: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
1.87      wiz      7504:     that are used to identify the different SUBST blocks that are
                   7505:     defined. The SUBST framework is heavily used by pkgsrc, so it is
                   7506:     important to always use the <code class="literal">+=</code> operator with
1.287     rillig   7507:     this variable. Otherwise some substitutions may be skipped.</p>
1.79      rillig   7508: <p>The remaining variables of each SUBST block are
1.87      wiz      7509:     parameterized with the identifier from the first line
                   7510:     (<code class="literal">fix-paths</code> in this case.) They can be seen as
                   7511:     parameters to a function call.</p>
1.79      rillig   7512: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
1.87      wiz      7513:     which the replacement will take place. All combinations of
                   7514:     <code class="literal">pre-</code>, <code class="literal">do-</code> and
                   7515:     <code class="literal">post-</code> together with a phase name are
                   7516:     possible, though only few are actually used. Most commonly used
                   7517:     are <code class="literal">post-patch</code> and
                   7518:     <code class="literal">pre-configure</code>. Of these two,
                   7519:     <code class="literal">pre-configure</code> should be preferred because
1.110     hubertf  7520:     then it is possible to run <span class="command"><strong>bmake patch</strong></span> and
1.87      wiz      7521:     have the state after applying the patches but before making any
                   7522:     other changes. This is especially useful when you are debugging
                   7523:     a package in order to create new patches for it. Similarly,
                   7524:     <code class="literal">post-build</code> is preferred over
                   7525:     <code class="literal">pre-install</code>, because the install phase should
                   7526:     generally be kept as simple as possible. When you use
                   7527:     <code class="literal">post-build</code>, you have the same files in the
                   7528:     working directory that will be installed later, so you can check
                   7529:     if the substitution has succeeded.</p>
1.79      rillig   7530: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
1.87      wiz      7531:     that is printed just before the substitution is done.</p>
1.79      rillig   7532: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
1.87      wiz      7533:     globbing patterns that specifies the files in which the
                   7534:     substitution will take place. The patterns are interpreted
                   7535:     relatively to the <code class="varname">WRKSRC</code> directory.</p>
1.79      rillig   7536: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
1.289     leot     7537:     <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?sed+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">sed</span>(1)</span></a> that specify the actual substitution. Every sed
1.87      wiz      7538:     command should be prefixed with <code class="literal">-e</code>, so that
                   7539:     all SUBST blocks look uniform.</p>
1.287     rillig   7540: <p><code class="varname">SUBST_VARS.*</code> is a list of variable names.
                   7541:     For each of these variables, the text <code class="literal">@VAR@</code> is
                   7542:     replaced with the value of the variable
                   7543:     <code class="varname">VAR</code>.</p>
1.79      rillig   7544: <p>There are some more variables, but they are so seldomly
1.87      wiz      7545:     used that they are only documented in the
                   7546:     <code class="filename">mk/subst.mk</code> file.</p>
1.79      rillig   7547: </div>
1.75      rillig   7548: </div>
1.148     asau     7549: <div class="sect1">
1.75      rillig   7550: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   7551: <a name="fixes.fetch"></a>21.2. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.148     asau     7552: <div class="sect2">
1.75      rillig   7553: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7554: <a name="no-plain-download"></a>21.2.1. Packages whose distfiles aren't available for plain downloading</h3></div></div></div>
1.75      rillig   7555: <p>If you need to download from a dynamic URL you can set
1.110     hubertf  7556:     <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.87      wiz      7557:     fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
                   7558:     with the name of each file to download as an argument, expecting
                   7559:     it to output the URL of the directory from which to download
1.250     leot     7560:     it. <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/graphics/ns-cult3d/README.html" target="_top"><code class="filename">graphics/ns-cult3d</code></a> is an
1.87      wiz      7561:     example of this usage.</p>
1.75      rillig   7562: <p>If the download can't be automated, because the user must
1.87      wiz      7563:     submit personal information to apply for a password, or must pay
                   7564:     for the source, or whatever, you can set
                   7565:     <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
                   7566:     displayed to the user before aborting the build. Example:</p>
                   7567: <pre class="programlisting">
1.100     rillig   7568: FETCH_MESSAGE=  "Please download the files"
                   7569: FETCH_MESSAGE+= "    "${DISTFILES:Q}
                   7570: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.222     sevan    7571: </pre>
1.75      rillig   7572: </div>
1.148     asau     7573: <div class="sect2">
1.75      rillig   7574: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7575: <a name="modified-distfiles-same-name"></a>21.2.2. How to handle modified distfiles with the 'old' name</h3></div></div></div>
1.75      rillig   7576: <p>Sometimes authors of a software package make some
1.87      wiz      7577:     modifications after the software was released, and they put up a
                   7578:     new distfile without changing the package's version number. If a
                   7579:     package is already in pkgsrc at that time, the checksum will
                   7580:     no longer match. The contents of the new distfile should be
                   7581:     compared against the old one before changing anything, to make
                   7582:     sure the distfile was really updated on purpose, and that
                   7583:     no trojan horse or so crept in.
1.97      rillig   7584:     Please mention that the distfiles were compared and what was found
1.159     rodent   7585:     in your commit message.</p>
1.220     wiz      7586: <p>Then, the correct way to work around this is to set
                   7587:     <code class="varname">DIST_SUBDIR</code> to a unique directory name, usually
                   7588:     based on <code class="varname">PKGNAME_NOREV</code> (but take care with
                   7589:     python or ruby packages, where <code class="varname">PKGNAME</code> includes
                   7590:     a variable prefix). All <code class="varname">DISTFILES</code> and
1.93      rillig   7591:     <code class="varname">PATCHFILES</code> for this package will be put in that
1.267     rillig   7592:     subdirectory of the local distfiles directory. (See <a class="xref" href="#bumping-pkgrevision" title="21.1.10. How to handle incrementing versions when fixing an existing package">Section 21.1.10, &#8220;How to handle incrementing versions when fixing an existing package&#8221;</a> for more details.) In case this
1.87      wiz      7593:     happens more often, <code class="varname">PKGNAME</code> can be used (thus
1.220     wiz      7594:     including the <code class="filename">nbX</code> suffix) or a date stamp can
                   7595:     be appended, like
                   7596:     <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.</p>
1.284     rillig   7597: <p><code class="varname">DIST_SUBDIR</code> is also used when a distfile's
                   7598:     name does not contain a version and the distfile is apt to change. In
                   7599:     cases where the likelihood of this is very small,
                   7600:     <code class="varname">DIST_SUBDIR</code> might not be required. Additionally,
                   7601:     <code class="varname">DIST_SUBDIR</code> must not be removed unless the
                   7602:     distfile name changes, even if a package is being moved or
                   7603:     renamed.</p>
1.159     rodent   7604: <p>Do not forget regenerating the <code class="filename">distinfo</code> file
1.87      wiz      7605:     after that, since it contains the <code class="varname">DIST_SUBDIR</code>
                   7606:     path in the filenames.
1.159     rodent   7607:     Also, increase the PKGREVISION if the installed package is different.
1.87      wiz      7608:     Furthermore, a mail to the package's authors seems appropriate
                   7609:     telling them that changing distfiles after releases without
                   7610:     changing the file names is not good practice.</p>
1.75      rillig   7611: </div>
1.199     tnn      7612: <div class="sect2">
                   7613: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7614: <a name="build.fetch.github"></a>21.2.3. Packages hosted on github.com</h3></div></div></div>
1.284     rillig   7615: <p>Helper methods exist for packages hosted on github.com which
                   7616:     will often have distfile names that clash with other packages, for
                   7617:     example <code class="filename">1.0.tar.gz</code>. Use one of the three recipes
                   7618:     from below:</p>
1.199     tnn      7619: <div class="sect3">
                   7620: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   7621: <a name="build.fetch.github.tag"></a>21.2.3.1. Fetch based on a tagged release</h4></div></div></div>
1.284     rillig   7622: <p>If your distfile URL looks similar to
1.289     leot     7623:       <code class="literal">https://github.com/username/exampleproject/archive/v1.0.zip</code>,
1.284     rillig   7624:       then you are packaging a tagged release.</p>
1.199     tnn      7625: <pre class="programlisting">
                   7626: DISTNAME=       exampleproject-1.0
1.200     tnn      7627: MASTER_SITES=   ${MASTER_SITE_GITHUB:=username/}
                   7628: #GITHUB_PROJECT=        # can be omitted if same as DISTNAME
                   7629: GITHUB_TAG=     v${PKGVERSION_NOREV}
1.199     tnn      7630: EXTRACT_SUFX=   .zip
                   7631: </pre>
                   7632: </div>
                   7633: <div class="sect3">
                   7634: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   7635: <a name="build.fetch.github.commit"></a>21.2.3.2. Fetch based on a specific commit</h4></div></div></div>
1.284     rillig   7636: <p>If your distfile URL looks similar to
1.289     leot     7637:       <code class="literal">https://github.com&#8203;/example&#8203;/example&#8203;/archive&#8203;/988881adc9fc3655077dc2d4d757d480b5ea0e11.tar.gz</code>,
1.284     rillig   7638:       then you are packaging a specific commit not tied to a
                   7639:       release.</p>
1.199     tnn      7640: <pre class="programlisting">
                   7641: DISTNAME=       example-1.0
1.217     jnemeth  7642: MASTER_SITES=   ${MASTER_SITE_GITHUB:=example/}
1.200     tnn      7643: #GITHUB_PROJECT=        # can be omitted if same as DISTNAME
                   7644: GITHUB_TAG=     988881adc9fc3655077dc2d4d757d480b5ea0e11
1.222     sevan    7645: </pre>
1.199     tnn      7646: </div>
                   7647: <div class="sect3">
                   7648: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   7649: <a name="build.fetch.github.release"></a>21.2.3.3. Fetch based on release</h4></div></div></div>
1.284     rillig   7650: <p>If your distfile URL looks similar to
1.289     leot     7651:       <code class="literal">https://github.com&#8203;/username/exampleproject&#8203;/releases&#8203;/download&#8203;/rel-1.6&#8203;/offensive-1.6.zip</code>,
1.284     rillig   7652:       then you are packaging a release.</p>
1.199     tnn      7653: <pre class="programlisting">
                   7654: DISTNAME=       offensive-1.6
1.200     tnn      7655: PKGNAME=        ${DISTNAME:S/offensive/proper/}
                   7656: MASTER_SITES=   ${MASTER_SITE_GITHUB:=username/}
                   7657: GITHUB_PROJECT= exampleproject
                   7658: GITHUB_RELEASE= rel-${PKGVERSION_NOREV} # usually just set this to ${DISTNAME}
                   7659: EXTRACT_SUFX=   .zip
1.222     sevan    7660: </pre>
1.199     tnn      7661: </div>
                   7662: </div>
1.75      rillig   7663: </div>
1.148     asau     7664: <div class="sect1">
1.75      rillig   7665: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   7666: <a name="fixes.configure"></a>21.3. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.148     asau     7667: <div class="sect2">
1.75      rillig   7668: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7669: <a name="fixes.libtool"></a>21.3.1. Shared libraries - libtool</h3></div></div></div>
1.75      rillig   7670: <p>pkgsrc supports many different machines, with different
1.87      wiz      7671:     object formats like a.out and ELF, and varying abilities to do
                   7672:     shared library and dynamic loading at all. To accompany this,
                   7673:     varying commands and options have to be passed to the
                   7674:     compiler, linker, etc. to get the Right Thing, which can be
                   7675:     pretty annoying especially if you don't have all the machines
                   7676:     at your hand to test things.  The
1.250     leot     7677:     <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/libtool/README.html" target="_top"><code class="filename">devel/libtool</code></a> pkg
1.128     wiz      7678:     can help here, as it just <span class="quote">&#8220;<span class="quote">knows</span>&#8221;</span> how to build
1.87      wiz      7679:     both static and dynamic libraries from a set of source files,
                   7680:     thus being platform-independent.</p>
                   7681: <p>Here's how to use libtool in a package in seven simple
                   7682:     steps:</p>
1.128     wiz      7683: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7684: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.87      wiz      7685:        Makefile.</p></li>
1.128     wiz      7686: <li class="listitem"><p>For library objects, use <span class="quote">&#8220;<span class="quote">${LIBTOOL} --mode=compile
                   7687:        ${CC}</span>&#8221;</span> in place of <span class="quote">&#8220;<span class="quote">${CC}</span>&#8221;</span>. You could even
1.87      wiz      7688:        add it to the definition of <code class="varname">CC</code>, if only
                   7689:        libraries are being built in a given Makefile. This one command
                   7690:        will build both PIC and non-PIC library objects, so you need not
                   7691:        have separate shared and non-shared library rules.</p></li>
1.128     wiz      7692: <li class="listitem">
1.75      rillig   7693: <p>For the linking of the library, remove any
1.128     wiz      7694:        <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
                   7695:        -Bshareable</span>&#8221;</span> commands, and instead use:</p>
1.75      rillig   7696: <pre class="programlisting">
1.100     rillig   7697: ${LIBTOOL} --mode=link \
                   7698:     ${CC} -o ${.TARGET:.a=.la} \
                   7699:         ${OBJS:.o=.lo} \
                   7700:         -rpath ${PREFIX}/lib \
                   7701:         -version-info major:minor
1.222     sevan    7702: </pre>
1.75      rillig   7703: <p>Note that the library is changed to have a
1.87      wiz      7704:        <code class="filename">.la</code> extension, and the objects are
                   7705:        changed to have a <code class="filename">.lo</code>
                   7706:        extension. Change <code class="varname">OBJS</code> as
                   7707:        necessary. This automatically creates all of the
                   7708:        <code class="filename">.a</code>,
                   7709:        <code class="filename">.so.major.minor</code>, and ELF symlinks (if
                   7710:        necessary) in the build directory. Be sure to include
1.128     wiz      7711:        <span class="quote">&#8220;<span class="quote">-version-info</span>&#8221;</span>, especially when major and
1.87      wiz      7712:        minor are zero, as libtool will otherwise strip off the
                   7713:        shared library version.</p>
1.75      rillig   7714: <p>From the libtool manual:</p>
                   7715: <pre class="programlisting">
1.100     rillig   7716: So, libtool library versions are described by three integers:
1.69      rillig   7717: 
1.100     rillig   7718: CURRENT
                   7719: The most recent interface number that this library implements.
1.69      rillig   7720: 
1.100     rillig   7721: REVISION
                   7722: The implementation number of the CURRENT interface.
1.69      rillig   7723: 
1.100     rillig   7724: AGE
                   7725: The difference between the newest and oldest interfaces that
                   7726: this library implements.  In other words, the library implements
                   7727: all the interface numbers in the range from number `CURRENT -
                   7728: AGE' to `CURRENT'.
1.1       grant    7729: 
1.100     rillig   7730: If two libraries have identical CURRENT and AGE numbers, then the
                   7731: dynamic linker chooses the library with the greater REVISION number.
1.222     sevan    7732: </pre>
1.128     wiz      7733: <p>The <span class="quote">&#8220;<span class="quote">-release</span>&#8221;</span> option will produce
1.87      wiz      7734:        different results for a.out and ELF (excluding symlinks)
                   7735:        in only one case. An ELF library of the form
1.128     wiz      7736:        <span class="quote">&#8220;<span class="quote">libfoo-release.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>&#8221;</span>
1.87      wiz      7737:        will have a symlink of
1.128     wiz      7738:        <span class="quote">&#8220;<span class="quote">libfoo.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>&#8221;</span>
1.87      wiz      7739:        on an a.out platform. This is handled
                   7740:        automatically.</p>
1.128     wiz      7741: <p>The <span class="quote">&#8220;<span class="quote">-rpath argument</span>&#8221;</span> is the install
1.87      wiz      7742:        directory of the library being built.</p>
1.76      rillig   7743: <p>In the <code class="filename">PLIST</code>, include only the
1.87      wiz      7744:        <code class="filename">.la</code> file, the other files will be
                   7745:        added automatically.</p>
1.75      rillig   7746: </li>
1.128     wiz      7747: <li class="listitem">
1.76      rillig   7748: <p>When linking shared object (<code class="filename">.so</code>)
1.289     leot     7749:        files, i.e. files that are loaded via <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?dlopen+3.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">dlopen</span>(3)</span></a>, NOT
1.128     wiz      7750:        shared libraries, use <span class="quote">&#8220;<span class="quote">-module
                   7751:        -avoid-version</span>&#8221;</span> to prevent them getting version
1.87      wiz      7752:        tacked on.</p>
1.76      rillig   7753: <p>The <code class="filename">PLIST</code> file gets the
1.87      wiz      7754:        <code class="filename">foo.so</code> entry.</p>
1.75      rillig   7755: </li>
1.128     wiz      7756: <li class="listitem">
1.75      rillig   7757: <p>When linking programs that depend on these libraries
1.87      wiz      7758:        <span class="emphasis"><em>before</em></span> they are installed, preface
1.289     leot     7759:        the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?cc+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">cc</span>(1)</span></a> or <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?ld+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">ld</span>(1)</span></a> line with <span class="quote">&#8220;<span class="quote">${LIBTOOL}
1.128     wiz      7760:        --mode=link</span>&#8221;</span>, and it will find the correct
1.87      wiz      7761:        libraries (static or shared), but please be aware that
                   7762:        libtool will not allow you to specify a relative path in
1.128     wiz      7763:        -L (such as <span class="quote">&#8220;<span class="quote">-L../somelib</span>&#8221;</span>), because it
1.87      wiz      7764:        expects you to change that argument to be the
                   7765:        <code class="filename">.la</code> file. e.g.</p>
1.75      rillig   7766: <pre class="programlisting">
1.100     rillig   7767: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.222     sevan    7768: </pre>
1.75      rillig   7769: <p>should be changed to:</p>
                   7770: <pre class="programlisting">
1.100     rillig   7771: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.222     sevan    7772: </pre>
1.75      rillig   7773: <p>and it will do the right thing with the libraries.</p>
                   7774: </li>
1.128     wiz      7775: <li class="listitem">
1.289     leot     7776: <p>When installing libraries, preface the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?install+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a>
                   7777:        or <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?cp+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">cp</span>(1)</span></a> command with <span class="quote">&#8220;<span class="quote">${LIBTOOL}
1.128     wiz      7778:        --mode=install</span>&#8221;</span>, and change the library name to
1.87      wiz      7779:        <code class="filename">.la</code>. e.g.</p>
1.75      rillig   7780: <pre class="programlisting">
1.126     jakllsch 7781: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.222     sevan    7782: </pre>
1.76      rillig   7783: <p>This will install the static <code class="filename">.a</code>,
1.87      wiz      7784:        shared library, any needed symlinks, and run
1.289     leot     7785:        <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?ldconfig+8.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">ldconfig</span>(8)</span></a>.</p>
1.75      rillig   7786: </li>
1.128     wiz      7787: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.87      wiz      7788:        the <code class="filename">.la</code>
                   7789:        file (this is a change from previous behaviour).</p></li>
1.75      rillig   7790: </ol></div>
                   7791: </div>
1.148     asau     7792: <div class="sect2">
1.75      rillig   7793: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7794: <a name="using-libtool"></a>21.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.75      rillig   7795: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
1.87      wiz      7796:     package Makefile. This will override the package's own libtool
                   7797:     in most cases.  For older libtool using packages,  libtool is
                   7798:     made by ltconfig script during the do-configure step; you can
1.110     hubertf  7799:     check the libtool script location by doing <span class="command"><strong>make
1.87      wiz      7800:     configure; find work*/ -name libtool</strong></span>.</p>
1.75      rillig   7801: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
1.87      wiz      7802:     scripts, relative to <code class="varname">WRKSRC</code>, to override.  By
1.128     wiz      7803:     default, it is set to <span class="quote">&#8220;<span class="quote">libtool */libtool
                   7804:     */*/libtool</span>&#8221;</span>.  If this does not match the location of the
1.87      wiz      7805:     package's libtool script(s), set it as appropriate.</p>
1.76      rillig   7806: <p>If you do not need <code class="filename">*.a</code> static
1.87      wiz      7807:     libraries built and installed, then use
                   7808:     <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
1.75      rillig   7809: <p>If your package makes use of the platform-independent library
1.87      wiz      7810:     for loading dynamic shared objects, that comes with libtool
                   7811:     (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
                   7812: <p>Some packages use libtool incorrectly so that the package
                   7813:     may not work or build in some circumstances. Some of the more
                   7814:     common errors are:</p>
1.148     asau     7815: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      7816: <li class="listitem">
1.75      rillig   7817: <p>The inclusion of a shared object (-module) as a dependent library in an
1.87      wiz      7818:        executable or library. This in itself isn't a problem if one of two things
                   7819:        has been done:</p>
1.128     wiz      7820: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7821: <li class="listitem"><p>The shared object is named correctly, i.e.
1.87      wiz      7822:            <code class="filename">libfoo.la</code>, not
                   7823:            <code class="filename">foo.la</code></p></li>
1.128     wiz      7824: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.75      rillig   7825: </ol></div>
                   7826: </li>
1.128     wiz      7827: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.87      wiz      7828:        The function lt_dlinit() should be called and the macro
                   7829:        <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
                   7830:        executables.</p></li>
1.75      rillig   7831: </ul></div>
                   7832: </div>
1.148     asau     7833: <div class="sect2">
1.75      rillig   7834: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7835: <a name="autoconf-automake"></a>21.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.75      rillig   7836: <p>If a package needs GNU autoconf or automake to be executed
1.87      wiz      7837:     to regenerate the configure script and Makefile.in makefile
                   7838:     templates, then they should be executed in a pre-configure
                   7839:     target.</p>
1.75      rillig   7840: <p>For packages that need only autoconf:</p>
                   7841: <pre class="programlisting">
1.100     rillig   7842: AUTOCONF_REQD=  2.50            # if default version is not good enough
                   7843: USE_TOOLS+=     autoconf        # use "autoconf213" for autoconf-2.13
                   7844: ...
1.1       grant    7845: 
1.100     rillig   7846: pre-configure:
                   7847:         cd ${WRKSRC} &amp;&amp; autoconf
1.1       grant    7848: 
1.100     rillig   7849: ...
1.222     sevan    7850: </pre>
1.75      rillig   7851: <p>and for packages that need automake and autoconf:</p>
                   7852: <pre class="programlisting">
1.100     rillig   7853: AUTOMAKE_REQD=  1.7.1           # if default version is not good enough
                   7854: USE_TOOLS+=     automake        # use "automake14" for automake-1.4
                   7855: ...
                   7856: 
                   7857: pre-configure:
                   7858:         set -e; cd ${WRKSRC}; \
                   7859:         aclocal; autoheader; automake -a --foreign -i; autoconf
1.1       grant    7860: 
1.100     rillig   7861: ...
1.222     sevan    7862: </pre>
1.75      rillig   7863: <p>Packages which use GNU Automake will almost certainly
1.87      wiz      7864:     require GNU Make.</p>
1.75      rillig   7865: <p>There are times when the configure process makes
1.87      wiz      7866:     additional changes to the generated files, which then causes
                   7867:     the build process to try to re-execute the automake sequence.
                   7868:     This is prevented by touching various files in the configure
                   7869:     stage. If this causes problems with your package you can set
                   7870:     <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
                   7871:     Makefile.</p>
1.75      rillig   7872: </div>
                   7873: </div>
1.148     asau     7874: <div class="sect1">
1.75      rillig   7875: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   7876: <a name="programming-languages"></a>21.4. Programming languages</h2></div></div></div>
1.148     asau     7877: <div class="sect2">
1.87      wiz      7878: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7879: <a name="basic-programming-languages"></a>21.4.1. C, C++, and Fortran</h3></div></div></div>
1.87      wiz      7880: <p>Compilers for the C, C++, and Fortran languages comes with
                   7881:     the NetBSD base system.  By default, pkgsrc assumes that a package
                   7882:     is written in C and will hide all other compilers (via the wrapper
1.267     rillig   7883:     framework, see <a class="xref" href="#buildlink" title="Chapter 16. Buildlink methodology">Chapter 16, <i>Buildlink methodology</i></a>).</p>
1.87      wiz      7884: <p>To declare which language's compiler a package needs, set
                   7885:     the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.128     wiz      7886:     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
                   7887:     <span class="quote">&#8220;<span class="quote">fortran</span>&#8221;</span> (and any combination).  The default is
                   7888:     <span class="quote">&#8220;<span class="quote">c</span>&#8221;</span>.  Packages using GNU configure scripts, even if
1.87      wiz      7889:     written in C++, usually need a C compiler for the configure
                   7890:     phase.</p>
                   7891: </div>
1.148     asau     7892: <div class="sect2">
1.87      wiz      7893: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7894: <a name="java-programming-language"></a>21.4.2. Java</h3></div></div></div>
1.87      wiz      7895: <p>If a program is written in Java, use the Java framework in
                   7896:     pkgsrc.  The package must include
                   7897:     <code class="filename">../../mk/java-vm.mk</code>.  This Makefile fragment
                   7898:     provides the following variables:</p>
1.148     asau     7899: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      7900: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.87      wiz      7901:       dependency on the JDK is added.  If
1.128     wiz      7902:       <code class="varname">USE_JAVA</code> is set to <span class="quote">&#8220;<span class="quote">run</span>&#8221;</span>, then
1.87      wiz      7903:       there is only a runtime dependency on the JDK.  The default is
1.128     wiz      7904:       <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>, which also adds a build dependency on the
1.87      wiz      7905:       JDK.</p></li>
1.128     wiz      7906: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.87      wiz      7907:       a package needs a Java2 implementation.  The supported values
1.128     wiz      7908:       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
                   7909:       <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
                   7910:       implementation, <span class="quote">&#8220;<span class="quote">1.4</span>&#8221;</span> insists on versions 1.4 or
                   7911:       above, and <span class="quote">&#8220;<span class="quote">1.5</span>&#8221;</span> only accepts versions 1.5 or
1.87      wiz      7912:       above. This variable is not set by default.</p></li>
1.130     wiz      7913: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
                   7914:       automatically set to the runtime location of the used Java
                   7915:       implementation dependency. It may be used to set
                   7916:       <code class="varname">JAVA_HOME</code> to a good value if the program
                   7917:       needs this variable to be defined.
                   7918:       </p></li>
1.87      wiz      7919: </ul></div>
                   7920: </div>
1.148     asau     7921: <div class="sect2">
1.87      wiz      7922: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7923: <a name="perl-scripts"></a>21.4.3. Packages containing perl scripts</h3></div></div></div>
1.87      wiz      7924: <p>If your package contains interpreted perl scripts, add
1.128     wiz      7925:     <span class="quote">&#8220;<span class="quote">perl</span>&#8221;</span> to the <code class="varname">USE_TOOLS</code> variable
1.87      wiz      7926:     and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
                   7927:     interpreter path is set. <code class="varname">REPLACE_PERL</code> should
                   7928:     contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
1.183     wiz      7929:     that you want adjusted. Every occurrence of
                   7930:     <code class="filename">*/bin/perl</code> in a she-bang line will be
                   7931:     replaced with the full path to the perl executable.</p>
1.87      wiz      7932: <p>If a particular version of perl is needed, set the
                   7933:     <code class="varname">PERL5_REQD</code> variable to the version number.  The
1.128     wiz      7934:     default is <span class="quote">&#8220;<span class="quote">5.0</span>&#8221;</span>.</p>
1.267     rillig   7935: <p>See <a class="xref" href="#perl-modules" title="21.6.6. Packages installing perl modules">Section 21.6.6, &#8220;Packages installing perl modules&#8221;</a> for information
1.87      wiz      7936:     about handling perl modules.</p>
                   7937: </div>
1.148     asau     7938: <div class="sect2">
1.87      wiz      7939: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7940: <a name="shell-scripts"></a>21.4.4. Packages containing shell scripts</h3></div></div></div>
1.147     wiz      7941: <p><code class="varname">REPLACE_SH</code>,
                   7942:     <code class="varname">REPLACE_BASH</code>, <code class="varname">REPLACE_CSH</code>,
                   7943:     and <code class="varname">REPLACE_KSH</code> can be used to replace shell
                   7944:     hash bangs in files. Please use the appropriate one, prefering
                   7945:     <code class="varname">REPLACE_SH</code> in case this shell is sufficient.
1.183     wiz      7946:     Each should contain a list of scripts, relative to
                   7947:     <code class="varname">WRKSRC</code>, that you want adjusted. Every
                   7948:     occurrence of the matching shell in a she-bang line will be
                   7949:     replaced with the full path to the shell executable.
1.147     wiz      7950:     When using <code class="varname">REPLACE_BASH</code>, don't forget to add
                   7951:     <code class="filename">bash</code> to <code class="varname">USE_TOOLS</code>.</p>
                   7952: </div>
1.148     asau     7953: <div class="sect2">
1.147     wiz      7954: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7955: <a name="other-programming-languages"></a>21.4.5. Other programming languages</h3></div></div></div>
1.87      wiz      7956: <p>Currently, there is no special handling for other languages
                   7957:     in pkgsrc.  If a compiler package provides a
                   7958:     <code class="filename">buildlink3.mk</code> file, include that, otherwise
                   7959:     just add a (build) dependency on the appropriate compiler
                   7960:     package.</p>
                   7961: </div>
                   7962: </div>
1.148     asau     7963: <div class="sect1">
1.87      wiz      7964: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   7965: <a name="fixes.build"></a>21.5. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.77      rillig   7966: <p>The most common failures when building a package are that
                   7967:        some platforms do not provide certain header files, functions or
                   7968:        libraries, or they provide the functions in a library that the
                   7969:        original package author didn't know. To work around this, you
                   7970:        can rewrite the source code in most cases so that it does not
                   7971:        use the missing functions or provides a replacement function.</p>
1.148     asau     7972: <div class="sect2">
1.77      rillig   7973: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   7974: <a name="fixes.build.cpp"></a>21.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.77      rillig   7975: <p>If a package already comes with a GNU configure script, the
                   7976:        preferred way to fix the build failure is to change the
                   7977:        configure script, not the code. In the other cases, you can
                   7978:        utilize the C preprocessor, which defines certain macros
                   7979:        depending on the operating system and hardware architecture it
                   7980:        compiles for. These macros can be queried using for example
                   7981:        <code class="varname">#if defined(__i386)</code>. Almost every operating
                   7982:        system, hardware architecture and compiler has its own macro.
                   7983:        For example, if the macros <code class="varname">__GNUC__</code>,
                   7984:        <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
                   7985:        are all defined, you know that you are using NetBSD on an i386
                   7986:        compatible CPU, and your compiler is GCC.</p>
                   7987: <p>The list of the following macros for hardware and
                   7988:        operating system depends on the compiler that is used. For
                   7989:        example, if you want to conditionally compile code on Solaris,
                   7990:        don't use <code class="varname">__sun__</code>, as the SunPro compiler
                   7991:        does not define it. Use <code class="varname">__sun</code> instead.</p>
1.148     asau     7992: <div class="sect3">
1.75      rillig   7993: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   7994: <a name="fixes.build.cpp.os"></a>21.5.1.1. C preprocessor macros to identify the operating system</h4></div></div></div>
1.75      rillig   7995: <p>To distinguish between 4.4 BSD-derived systems and the
                   7996:         rest of the world, you should use the following code.</p>
                   7997: <pre class="programlisting">
1.100     rillig   7998: #include &lt;sys/param.h&gt;
                   7999: #if (defined(BSD) &amp;&amp; BSD &gt;= 199306)
                   8000: /* BSD-specific code goes here */
                   8001: #else
                   8002: /* non-BSD-specific code goes here */
                   8003: #endif
1.75      rillig   8004: </pre>
1.77      rillig   8005: <p>If this distinction is not fine enough, you can also test
                   8006:        for the following macros.</p>
1.75      rillig   8007: <pre class="programlisting">
1.151     obache   8008: Cygwin      __CYGWIN__
                   8009: DragonFly   __DragonFly__
1.100     rillig   8010: FreeBSD     __FreeBSD__
1.151     obache   8011: Haiku       __HAIKU__
1.100     rillig   8012: Interix     __INTERIX
                   8013: IRIX        __sgi (TODO: get a definite source for this)
                   8014: Linux       linux, __linux, __linux__
1.193     dholland 8015: Mac OS X    __APPLE__
1.151     obache   8016: MirBSD      __MirBSD__ (__OpenBSD__ is also defined)
                   8017: Minix3      __minix
1.100     rillig   8018: NetBSD      __NetBSD__
                   8019: OpenBSD     __OpenBSD__
                   8020: Solaris     sun, __sun
1.75      rillig   8021: </pre>
                   8022: </div>
1.148     asau     8023: <div class="sect3">
1.75      rillig   8024: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   8025: <a name="fixes.build.cpp.arch"></a>21.5.1.2. C preprocessor macros to identify the hardware architecture</h4></div></div></div>
1.75      rillig   8026: <pre class="programlisting">
1.100     rillig   8027: i386        i386, __i386, __i386__
                   8028: MIPS        __mips
                   8029: SPARC       sparc, __sparc
1.75      rillig   8030: </pre>
                   8031: </div>
1.148     asau     8032: <div class="sect3">
1.75      rillig   8033: <div class="titlepage"><div><div><h4 class="title">
1.267     rillig   8034: <a name="fixes.build.cpp.compiler"></a>21.5.1.3. C preprocessor macros to identify the compiler</h4></div></div></div>
1.75      rillig   8035: <pre class="programlisting">
1.100     rillig   8036: GCC         __GNUC__ (major version), __GNUC_MINOR__
                   8037: MIPSpro     _COMPILER_VERSION (0x741 for MIPSpro 7.41)
                   8038: SunPro      __SUNPRO_C (0x570 for Sun C 5.7)
                   8039: SunPro C++  __SUNPRO_CC (0x580 for Sun C++ 5.8)
1.75      rillig   8040: </pre>
                   8041: </div>
                   8042: </div>
1.148     asau     8043: <div class="sect2">
1.78      rillig   8044: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8045: <a name="compiler-bugs"></a>21.5.2. How to handle compiler bugs</h3></div></div></div>
1.78      rillig   8046: <p>Some source files trigger bugs in the compiler, based on
1.87      wiz      8047:         combinations of compiler version and architecture and almost
                   8048:         always relation to optimisation being enabled.  Common symptoms
                   8049:         are gcc internal errors or never finishing compiling a
1.78      rillig   8050:        file.</p>
                   8051: <p>Typically, a workaround involves testing the
                   8052:         <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
                   8053:         optimisation for that combination of file,
1.198     tnn      8054:        <code class="varname">MACHINE_ARCH</code> and compiler.</p>
                   8055: <p>This used to be a big problem in the past, but is rarely
                   8056:        needed now as compiler technology has matured. If you still need
                   8057:        to add a compiler specific workaround, please do so in the file
                   8058:        <code class="filename">hacks.mk</code> and describe the symptom and
                   8059:        compiler version as detailed as possible.</p>
1.78      rillig   8060: </div>
1.148     asau     8061: <div class="sect2">
1.78      rillig   8062: <div class="titlepage"><div><div><h3 class="title">
1.287     rillig   8063: <a name="fixes.build.header"></a>21.5.3. No such file or directory</h3></div></div></div>
                   8064: <p>Compilation sometimes fails with an error message like this:</p>
                   8065: <pre class="programlisting">
                   8066: .../x11/gtk3/work/gtk+-3.24.12/gdk/gdktypes.h:35:10:
                   8067:     fatal error: pango/pango.h: No such file or directory
                   8068: </pre>
                   8069: <p>The proper way to fix this problem depends on the type of the
                   8070: header, which is described in the following sections.</p>
                   8071: <div class="sect3">
                   8072: <div class="titlepage"><div><div><h4 class="title">
                   8073: <a name="fixes.build.header.bl3"></a>21.5.3.1. Headers from other packages</h4></div></div></div>
                   8074: <p>If the header name looks like it comes from a different package,
                   8075: that other package should be included via the buildlink3
                   8076: framework.</p>
                   8077: <p>First, look whether the header is somewhere in the buildlink3
                   8078: directory below <code class="varname">WRKDIR</code>. In the above case of
                   8079: the missing Pango header:</p>
                   8080: <pre class="programlisting">
                   8081: <code class="prompt">$</code> find work/.buildlink/ -print | grep -F pango/pango.h
                   8082: </pre>
                   8083: <p>In the case of Pango, the output is:</p>
                   8084: <pre class="programlisting">
                   8085: work/.buildlink/include/pango-1.0/pango/pango.h
                   8086: </pre>
                   8087: <p>If the <code class="filename">pango/pango.h</code> file were placed directly
                   8088: in the <code class="filename">.buildlink</code> directory, it would have been
                   8089: found automatically. There is an extra <code class="filename">pango-1.0</code>
                   8090: path component though, which means that the compiler command line must
                   8091: contain an option of the form
                   8092: <code class="literal">-I${BUILDLINK3_PREFIX.pango}/include/pango-1.0</code>. In
                   8093: most cases this option is generated by the configure script, which can be examined using:</p>
                   8094: <pre class="programlisting">
                   8095: <code class="prompt">$</code> $ grep -o '[-]I[^[:space:]]*/pango[^[:space:]]*' work/*/Makefile
                   8096: -I/usr/pkg/include/pango-1.0
                   8097: -I/usr/pkg/include/pango-1.0
                   8098: -I/usr/pkg/include/pango-1.0
                   8099: -I/usr/pkg/include/pango-1.0
                   8100: -I/usr/pkg/include/pango-1.0
                   8101: </pre>
                   8102: <p>This looks good. These options are transformed by the buildlink
                   8103: wrapper to refer to the correct path inside
                   8104: <code class="filename">work/.buildlink</code>.</p>
                   8105: <p>Since the compilation fails though, examine the compiler command
                   8106: lines in <code class="filename">work/.work.log</code> to see whether the
                   8107: <code class="literal">-I</code> option is included in the particular command
                   8108: line.</p>
                   8109: <p>To further analyze the situation, run <span class="command"><strong>bmake
                   8110: build-env</strong></span>, which sets up an interactive, realistic environment
                   8111: including all the pkgsrc wrapper commands and environment variables. From
                   8112: there, try to compile some simple example programs that use the
                   8113: header.</p>
                   8114: </div>
                   8115: <div class="sect3">
                   8116: <div class="titlepage"><div><div><h4 class="title">
                   8117: <a name="fixes.build.header.gen"></a>21.5.3.2. Headers generated during the build</h4></div></div></div>
                   8118: <p>If the name of the header seems to come from the package itself,
                   8119: and if the build is run with parallel jobs, the package may have some
                   8120: undeclared dependencies between the <code class="filename">.c</code> and the
                   8121: <code class="filename">.h</code> files, and a C file is compiled before its
                   8122: required header is generated.</p>
                   8123: <p>To see whether the build runs with parallel jobs, run
                   8124: <span class="command"><strong>bmake show-all-build | grep JOBS</strong></span>. Its output looks
                   8125: like this:</p>
                   8126: <pre class="programlisting">
                   8127:   usr   MAKE_JOBS=              7
                   8128:   pkg   MAKE_JOBS_SAFE          # undefined
                   8129:   def   _MAKE_JOBS_N=           7
                   8130: </pre>
                   8131: <p>In this case the pkgsrc user has asked pkgsrc to build packages
                   8132: with 7 jobs in parallel (<code class="varname">MAKE_JOBS</code>). The
                   8133: package could have disabled parallel builds by setting
                   8134: <code class="varname">MAKE_JOBS_SAFE</code> to <code class="literal">no</code>, but
                   8135: in this case it hasn't.</p>
                   8136: <p>To see whether the build failure is caused by parallel builds,
                   8137: first save the exact error message and a bit of context, maybe you need
                   8138: it later for reporting a bug. Next, run:</p>
                   8139: <pre class="programlisting">
                   8140: MAKE_JOBS_SAFE=no bmake clean build
                   8141: </pre>
                   8142: <p>If that succeeds, <a class="ulink" href="https://www.NetBSD.org/cgi-bin/sendpr.cgi?gndb=netbsd" target="_top">file a bug
                   8143: report</a> against the pkgsrc package, including the exact error
                   8144: message and the contents of your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file.</p>
                   8145: </div>
1.288     rillig   8146: <div class="sect3">
                   8147: <div class="titlepage"><div><div><h4 class="title">
                   8148: <a name="fixes.build.header.symlink"></a>21.5.3.3. Symlinks</h4></div></div></div>
                   8149: <p>Pkgsrc does not work reliably if any of
                   8150: <code class="varname">LOCALBASE</code>, <code class="varname">VARBASE</code> or
                   8151: <code class="varname">WRKDIR</code> contains a symlink. Since 2019Q2, the pkgsrc
                   8152: bootstrap program prevents installing pkgsrc in symlink-based
                   8153: directories. Existing pkgsrc installations are not checked for symlinks
                   8154: though.</p>
                   8155: <p>The "No such file or directory" error messages are a typical
                   8156: symptom of symlinks, and it's quite difficult to find out that this is
                   8157: the actual cause.</p>
                   8158: </div>
                   8159: <div class="sect3">
                   8160: <div class="titlepage"><div><div><h4 class="title">
                   8161: <a name="fixes.build.header.stale"></a>21.5.3.4. Stale working directories</h4></div></div></div>
                   8162: <p>When building a hierarchy of packages, it may happen that one
                   8163: package is built and then pkgsrc is updated. This situation can provoke
                   8164: various hard to diagnose build errors. To clean up the situation:</p>
                   8165: <pre class="programlisting">
                   8166: <code class="prompt">$</code> (cd ../../ &amp;&amp; test -f mk/bsd.pkg.mk &amp;&amp; rm -rf */*/work)
                   8167: </pre>
                   8168: <p>(The test for <code class="filename">bsd.pkg.mk</code> just prevents running
                   8169: this command in the wrong directory.)</p>
                   8170: <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
                   8171: that directory as well.</p>
                   8172: </div>
                   8173: <div class="sect3">
                   8174: <div class="titlepage"><div><div><h4 class="title">
                   8175: <a name="fixes.build.header.misc"></a>21.5.3.5. Other possible reasons</h4></div></div></div>
                   8176: <p>On platforms other than BSD, third-party packages are installed in
                   8177: <code class="filename">/usr/include</code>, together with the base system. This
                   8178: means that pkgsrc cannot distinguish between headers provided by the base
                   8179: system (which it needs) and headers from third-party packages (which are
                   8180: often included in pkgsrc as well). This can lead to subtle version
                   8181: mismatches.</p>
                   8182: <p>In pkgsrc installations that have been active for several years, it
                   8183: may happen that some files are manually deleted. To exclude this unlikely
                   8184: reason, run <span class="command"><strong>pkg_admin check</strong></span>.</p>
                   8185: <p>It may help to run <span class="command"><strong>pkg_admin rebuild-tree</strong></span> to
                   8186: check/fix dependencies.</p>
                   8187: <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>
                   8188: for contact information. Be prepared to describe what you have tried so
                   8189: far and what any error messages were.</p>
                   8190: </div>
1.287     rillig   8191: </div>
                   8192: <div class="sect2">
                   8193: <div class="titlepage"><div><div><h3 class="title">
                   8194: <a name="undefined-reference"></a>21.5.4. Undefined reference to <span class="quote">&#8220;<span class="quote">...</span>&#8221;</span>
1.128     wiz      8195: </h3></div></div></div>
1.92      rillig   8196: <p>This error message often means that a package did not
1.78      rillig   8197:        link to a shared library it needs. The following functions are
                   8198:        known to cause this error message over and over.</p>
                   8199: <div class="informaltable">
1.216     tnn      8200: <a name="undefined-reference-functions"></a><table class="informaltable" border="1">
1.78      rillig   8201: <colgroup>
                   8202: <col>
                   8203: <col>
                   8204: <col>
                   8205: </colgroup>
                   8206: <thead><tr>
                   8207: <th>Function</th>
                   8208: <th>Library</th>
                   8209: <th>Affected platforms</th>
                   8210: </tr></thead>
                   8211: <tbody>
                   8212: <tr>
                   8213: <td>accept, bind, connect</td>
                   8214: <td>-lsocket</td>
                   8215: <td>Solaris</td>
                   8216: </tr>
                   8217: <tr>
                   8218: <td>crypt</td>
                   8219: <td>-lcrypt</td>
                   8220: <td>DragonFly, NetBSD</td>
                   8221: </tr>
                   8222: <tr>
                   8223: <td>dlopen, dlsym</td>
                   8224: <td>-ldl</td>
                   8225: <td>Linux</td>
                   8226: </tr>
                   8227: <tr>
                   8228: <td>gethost*</td>
                   8229: <td>-lnsl</td>
                   8230: <td>Solaris</td>
                   8231: </tr>
                   8232: <tr>
                   8233: <td>inet_aton</td>
                   8234: <td>-lresolv</td>
                   8235: <td>Solaris</td>
                   8236: </tr>
                   8237: <tr>
                   8238: <td>nanosleep, sem_*, timer_*</td>
                   8239: <td>-lrt</td>
                   8240: <td>Solaris</td>
                   8241: </tr>
                   8242: <tr>
                   8243: <td>openpty</td>
                   8244: <td>-lutil</td>
                   8245: <td>Linux</td>
                   8246: </tr>
                   8247: </tbody>
                   8248: </table>
                   8249: </div>
                   8250: <p>To fix these linker errors, it is often sufficient to say
1.87      wiz      8251:     <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
                   8252:     -l<em class="replaceable"><code>foo</code></em></code> to the package
1.110     hubertf  8253:     <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
1.87      wiz      8254:     bmake</strong></span>.</p>
1.148     asau     8255: <div class="sect3">
1.92      rillig   8256: <div class="titlepage"><div><div><h4 class="title">
1.287     rillig   8257: <a name="undefined-reference-sunpro"></a>21.5.4.1. Special issue: The SunPro compiler</h4></div></div></div>
1.92      rillig   8258: <p>When you are using the SunPro compiler, there is another
                   8259: possibility. That compiler cannot handle the following code:</p>
                   8260: <pre class="programlisting">
1.100     rillig   8261: extern int extern_func(int);
1.93      rillig   8262: 
1.100     rillig   8263: static inline int
                   8264: inline_func(int x)
                   8265: {
1.92      rillig   8266:         return extern_func(x);
1.100     rillig   8267: }
1.93      rillig   8268: 
1.100     rillig   8269: int main(void)
                   8270: {
1.92      rillig   8271:         return 0;
1.100     rillig   8272: }
1.92      rillig   8273: </pre>
                   8274: <p>It generates the code for <code class="function">inline_func</code> even if
                   8275: that function is never used. This code then refers to
                   8276: <code class="function">extern_func</code>, which can usually not be resolved. To
                   8277: solve this problem you can try to tell the package to disable inlining
                   8278: of functions.</p>
                   8279: </div>
1.87      wiz      8280: </div>
1.148     asau     8281: <div class="sect2">
1.87      wiz      8282: <div class="titlepage"><div><div><h3 class="title">
1.287     rillig   8283: <a name="out-of-memory"></a>21.5.5. Running out of memory</h3></div></div></div>
1.87      wiz      8284: <p>Sometimes packages fail to build because the compiler runs
                   8285:     into an operating system specific soft limit.  With the
                   8286:     <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
1.204     wiz      8287:     to unlimit the resources.  Currently, the allowed values are any combination of
                   8288:     <span class="quote">&#8220;<span class="quote">cputime</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">datasize</span>&#8221;</span>,
                   8289:     <span class="quote">&#8220;<span class="quote">memorysize</span>&#8221;</span>, and <span class="quote">&#8220;<span class="quote">stacksize</span>&#8221;</span>.
1.87      wiz      8290:     Setting this variable is similar to running the shell builtin
1.110     hubertf  8291:     <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.87      wiz      8292:     segment size or maximum stack size of a process, respectively, to
                   8293:     their hard limits.</p>
1.78      rillig   8294: </div>
1.75      rillig   8295: </div>
1.148     asau     8296: <div class="sect1">
1.75      rillig   8297: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   8298: <a name="fixes.install"></a>21.6. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.148     asau     8299: <div class="sect2">
1.75      rillig   8300: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8301: <a name="install-scripts"></a>21.6.1. Creating needed directories</h3></div></div></div>
1.110     hubertf  8302: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.87      wiz      8303:     with some operating systems cannot create more than one
                   8304:     directory at a time. As such, you should call
                   8305:     <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
                   8306: <pre class="programlisting">
1.100     rillig   8307: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
                   8308: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.222     sevan    8309: </pre>
1.128     wiz      8310: <p>You can also just append <span class="quote">&#8220;<span class="quote"><code class="literal">dir1
                   8311:     dir2</code></span>&#8221;</span> to the
1.87      wiz      8312:     <code class="varname">INSTALLATION_DIRS</code> variable, which will
                   8313:     automatically do the right thing.</p>
1.75      rillig   8314: </div>
1.148     asau     8315: <div class="sect2">
1.75      rillig   8316: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8317: <a name="where-to-install-documentation"></a>21.6.2. Where to install documentation</h3></div></div></div>
1.83      wiz      8318: <p>In general, documentation should be installed into
1.87      wiz      8319:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
                   8320:     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
                   8321:     includes the version number of the package).</p>
1.84      wiz      8322: <p>Many modern packages using GNU autoconf allow to set the
1.87      wiz      8323:     directory where HTML documentation is installed with the
1.128     wiz      8324:     <span class="quote">&#8220;<span class="quote">--with-html-dir</span>&#8221;</span> option. Sometimes using this flag
1.87      wiz      8325:     is needed because otherwise the documentation ends up in
                   8326:     <code class="filename">${PREFIX}/share/doc/html</code> or other
                   8327:     places.</p>
                   8328: <p>An exception to the above is that library API documentation
1.250     leot     8329:     generated with the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/textproc/gtk-doc/README.html" target="_top"><code class="filename">textproc/gtk-doc</code></a> tools, for use by special
1.87      wiz      8330:     browsers (devhelp) should be left at their default location, which
                   8331:     is <code class="filename">${PREFIX}/share/gtk-doc</code>.  Such
                   8332:     documentation can be recognized from files ending in
                   8333:     <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
                   8334:     (It is also acceptable to install such files in
                   8335:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
                   8336:     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
                   8337:     <code class="filename">.devhelp*</code> file must be directly in that
                   8338:     directory then, no additional subdirectory level is allowed in
                   8339:     this case. This is usually achieved by using
1.128     wiz      8340:     <span class="quote">&#8220;<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>&#8221;</span>.
1.87      wiz      8341:     <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
                   8342:     though.)</p>
1.75      rillig   8343: </div>
1.148     asau     8344: <div class="sect2">
1.75      rillig   8345: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8346: <a name="installing-score-files"></a>21.6.3. Installing highscore files</h3></div></div></div>
1.75      rillig   8347: <p>Certain packages, most of them in the games category, install
1.87      wiz      8348:     a score file that allows all users on the system to record their
                   8349:     highscores.  In order for this to work, the binaries need to be
                   8350:     installed setgid and the score files owned by the appropriate
1.142     wiz      8351:     group and/or owner (traditionally the "games" user/group).  Set
                   8352:     <code class="varname">USE_GAMESGROUP</code> to yes to support this. The
1.87      wiz      8353:     following variables, documented in more detail in
                   8354:     <code class="filename">mk/defaults/mk.conf</code>, control this
1.142     wiz      8355:     behaviour: <code class="varname">GAMEDATAMODE</code>,
                   8356:     <code class="varname">GAMEDIRMODE</code>, <code class="varname">GAMES_GROUP</code>,
1.210     leot     8357:     <code class="varname">GAMEMODE</code>, <code class="varname">GAME_USER</code>.
                   8358:     Other useful variables are: <code class="varname">GAMEDIR_PERMS</code>,
                   8359:     <code class="varname">GAMEDATA_PERMS</code> and
                   8360:     <code class="varname">SETGID_GAMES_PERMS</code>.</p>
                   8361: <p>An example that illustrates some of the variables described above is
                   8362:     <code class="filename">games/moon-buggy</code>. <code class="varname">OWN_DIRS_PERMS</code> is
                   8363:     used to properly set directory permissions of the directory where the
                   8364:     scorefile is saved, <code class="varname">REQD_FILES_PERMS</code> is used to create a
                   8365:     dummy scorefile (<code class="filename">mbscore</code>) with the proper permissions
                   8366:     and <code class="varname">SPECIAL_PERMS</code> is used to install setgid the game
                   8367:     binary:</p>
                   8368: <pre class="programlisting">
1.223     rillig   8369: USE_GAMESGROUP=         yes
1.210     leot     8370: 
1.223     rillig   8371: BUILD_DEFS+=            VARBASE
1.210     leot     8372: 
1.223     rillig   8373: OWN_DIRS_PERMS+=        ${VARBASE}/games/moon-buggy ${GAMEDIR_PERMS}
                   8374: REQD_FILES_PERMS+=      /dev/null ${VARBASE}/games/moon-buggy/mbscore ${GAMEDATA_PERMS}
                   8375: SPECIAL_PERMS+=         ${PREFIX}/bin/moon-buggy ${SETGID_GAMES_PERMS}
1.222     sevan    8376: </pre>
1.210     leot     8377: <p>Various <code class="varname">INSTALL_*</code> variables are also available:
                   8378:     <code class="varname">INSTALL_GAME</code> to install setgid game binaries,
                   8379:     <code class="varname">INSTALL_GAME_DIR</code> to install game directories that are
                   8380:     needed to be accessed by setgid games and
                   8381:     <code class="varname">INSTALL_GAME_DATA</code> to install scorefiles.</p>
1.114     jmcneill 8382: <p>A package should therefore never hard code file ownership or
1.210     leot     8383:     access permissions but rely on <code class="varname">*_PERMS</code> as described above
                   8384:     or alternatively on <code class="varname">INSTALL_GAME</code>,
                   8385:     <code class="varname">INSTALL_GAME_DATA</code> and
                   8386:     <code class="varname">INSTALL_GAME_DIR</code> to set these correctly.</p>
1.75      rillig   8387: </div>
1.148     asau     8388: <div class="sect2">
1.75      rillig   8389: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8390: <a name="destdir-support"></a>21.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.114     jmcneill 8391: <p><code class="varname">DESTDIR</code> support means that a package
                   8392:     installs into a staging directory, not the final location of the
                   8393:     files. Then a binary package is created which can be used for
                   8394:     installation as usual. There are two ways: Either the package must
1.128     wiz      8395:     install as root (<span class="quote">&#8220;<span class="quote">destdir</span>&#8221;</span>) or the package can
                   8396:     install as non-root user (<span class="quote">&#8220;<span class="quote">user-destdir</span>&#8221;</span>).</p>
1.148     asau     8397: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      8398: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
1.224     leot     8399:       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>.
                   8400:       By default <code class="varname">PKG_DESTDIR_SUPPORT</code>
1.145     wiz      8401:       is set to <span class="quote">&#8220;<span class="quote">user-destdir</span>&#8221;</span> to help catching more
                   8402:       potential packaging problems. If bsd.prefs.mk is included in the Makefile,
1.114     jmcneill 8403:       <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
                   8404:       the inclusion.</p></li>
1.128     wiz      8405: <li class="listitem"><p>All installation operations have to be prefixed with
1.103     wiz      8406:       <code class="filename">${DESTDIR}</code>.</p></li>
1.128     wiz      8407: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.103     wiz      8408:       automatically. Many manual rules and pre/post-install often are
                   8409:       incorrect; fix them.</p></li>
1.128     wiz      8410: <li class="listitem"><p>If files are installed with special owner/group
1.118     imil     8411:       use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.128     wiz      8412: <li class="listitem"><p>In general, packages should support
1.103     wiz      8413:       <code class="varname">UNPRIVILEGED</code> to be able to use
                   8414:       DESTDIR.</p></li>
                   8415: </ul></div>
                   8416: </div>
1.148     asau     8417: <div class="sect2">
1.103     wiz      8418: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8419: <a name="hardcoded-paths"></a>21.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.87      wiz      8420: <p>Your package may also contain scripts with hardcoded paths to
                   8421:       other interpreters besides (or as well as) perl.  To correct the
                   8422:       full pathname to the script interpreter, you need to set the
                   8423:       following definitions in your <code class="filename">Makefile</code> (we
1.110     hubertf  8424:     shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.87      wiz      8425: <pre class="programlisting">
1.100     rillig   8426: REPLACE_INTERPRETER+=   tcl
                   8427: REPLACE.tcl.old=        .*/bin/tclsh
                   8428: REPLACE.tcl.new=        ${PREFIX}/bin/tclsh
                   8429: REPLACE_FILES.tcl=      # list of tcl scripts which need to be fixed,
                   8430: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.222     sevan    8431: </pre>
1.148     asau     8432: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   8433: <h3 class="title">Note</h3>
                   8434: <p>Before March 2006, these variables were called
1.87      wiz      8435:     <code class="varname">_REPLACE.*</code> and
                   8436:     <code class="varname">_REPLACE_FILES.*</code>.</p>
1.75      rillig   8437: </div>
                   8438: </div>
1.148     asau     8439: <div class="sect2">
1.75      rillig   8440: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8441: <a name="perl-modules"></a>21.6.6. Packages installing perl modules</h3></div></div></div>
1.75      rillig   8442: <p>Makefiles of packages providing perl5 modules should include
1.87      wiz      8443:     the Makefile fragment
                   8444:     <code class="filename">../../lang/perl5/module.mk</code>.  It provides a
1.110     hubertf  8445:     <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.87      wiz      8446:     configuration for such modules as well as various hooks to tune
                   8447:     this configuration.  See comments in this file for
                   8448:     details.</p>
1.75      rillig   8449: <p>Perl5 modules will install into different places depending
1.87      wiz      8450:     on the version of perl used during the build process.  To
                   8451:     address this, pkgsrc will append lines to the
                   8452:     <code class="filename">PLIST</code> corresponding to the files listed in
                   8453:     the installed <code class="filename">.packlist</code> file generated by
                   8454:     most perl5 modules.  This is invoked by defining
                   8455:     <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
1.153     wiz      8456:     packlist files relative to <code class="varname">PERL5_PACKLIST_DIR</code>
                   8457:     (<code class="varname">PERL5_INSTALLVENDORARCH</code> by default),
                   8458:     e.g.:</p>
1.75      rillig   8459: <pre class="programlisting">
1.153     wiz      8460: PERL5_PACKLIST= auto/Pg/.packlist
1.222     sevan    8461: </pre>
1.153     wiz      8462: <p>The perl5 config variables
                   8463:     <code class="varname">installarchlib</code>,
                   8464:     <code class="varname">installscript</code>,
                   8465:     <code class="varname">installvendorbin</code>,
                   8466:     <code class="varname">installvendorscript</code>,
                   8467:     <code class="varname">installvendorarch</code>,
                   8468:     <code class="varname">installvendorlib</code>,
                   8469:     <code class="varname">installvendorman1dir</code>, and
                   8470:     <code class="varname">installvendorman3dir</code> represent those
                   8471:     locations in which components of perl5 modules may be installed,
                   8472:     provided as variable with uppercase and prefixed with
                   8473:     <code class="varname">PERL5_</code>, e.g. <code class="varname">PERL5_INSTALLARCHLIB</code>
                   8474:     and may be used by perl5 packages that don't have a packlist.
                   8475:     These variables are also substituted for in the
                   8476:     <code class="filename">PLIST</code> as uppercase prefixed with
                   8477:     <code class="varname">PERL5_SUB_</code>.</p>
1.75      rillig   8478: </div>
1.148     asau     8479: <div class="sect2">
1.75      rillig   8480: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8481: <a name="faq.info-files"></a>21.6.7. Packages installing info files</h3></div></div></div>
1.75      rillig   8482: <p>Some packages install info files or use the
1.128     wiz      8483:     <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span>  or <span class="quote">&#8220;<span class="quote">install-info</span>&#8221;</span>
1.87      wiz      8484:     commands.  <code class="varname">INFO_FILES</code> should be defined in
                   8485:     the package Makefile so that <code class="filename">INSTALL</code> and
                   8486:     <code class="filename">DEINSTALL</code> scripts will be generated to
                   8487:     handle registration of the info files in the Info directory
1.128     wiz      8488:     file. The <span class="quote">&#8220;<span class="quote">install-info</span>&#8221;</span> command used for the info
1.87      wiz      8489:     files registration is either provided by the system, or by a
                   8490:     special purpose package automatically added as dependency if
                   8491:     needed.</p>
1.75      rillig   8492: <p><code class="varname">PKGINFODIR</code> is the directory under
1.87      wiz      8493:     <code class="filename">${PREFIX}</code> where info files are primarily
                   8494:     located. <code class="varname">PKGINFODIR</code> defaults to
1.128     wiz      8495:     <span class="quote">&#8220;<span class="quote">info</span>&#8221;</span> and can be overridden by the user.</p>
1.75      rillig   8496: <p>The info files for the package should be listed in the
1.87      wiz      8497:     package <code class="filename">PLIST</code>; however any split info files
                   8498:     need not be listed.</p>
1.128     wiz      8499: <p>A package which needs the <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> command
                   8500:     at build time must add <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> to
1.87      wiz      8501:     <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.128     wiz      8502:     version of the <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> command is needed it
1.87      wiz      8503:     should be noted with the <code class="varname">TEXINFO_REQD</code>
                   8504:     variable in the package <code class="filename">Makefile</code>. By
                   8505:     default, a minimum version of 3.12 is required. If the system
1.110     hubertf  8506:     does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.87      wiz      8507:     does not match the required minimum, a build dependency on the
1.250     leot     8508:     <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/gtexinfo/README.html" target="_top"><code class="filename">devel/gtexinfo</code></a> package will
1.87      wiz      8509:     be added automatically.</p>
1.75      rillig   8510: <p>The build and installation process of the software provided
1.87      wiz      8511:     by the package should not use the
1.110     hubertf  8512:     <span class="command"><strong>install-info</strong></span> command as the registration of
1.87      wiz      8513:     info files is the task of the package
                   8514:     <code class="filename">INSTALL</code> script, and it must use the
1.110     hubertf  8515:     appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.75      rillig   8516: <p>To achieve this goal, the pkgsrc infrastructure creates
1.110     hubertf  8517:     overriding scripts for the <span class="command"><strong>install-info</strong></span> and
                   8518:     <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.87      wiz      8519:     in <code class="varname">PATH</code>.</p>
1.110     hubertf  8520: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.87      wiz      8521:     no effect except the logging of a message. The script overriding
1.110     hubertf  8522:     <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.87      wiz      8523:     value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.110     hubertf  8524:     <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.75      rillig   8525: </div>
1.148     asau     8526: <div class="sect2">
1.75      rillig   8527: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8528: <a name="manpages"></a>21.6.8. Packages installing man pages</h3></div></div></div>
1.81      rillig   8529: <p>All packages that install manual pages should install them
1.87      wiz      8530:     into the same directory, so that there is one common place to look
                   8531:     for them. In pkgsrc, this place is
                   8532:     <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
                   8533:     should be used in packages. The default for
                   8534:     <code class="varname">PKGMANDIR</code> is
1.128     wiz      8535:     <span class="quote">&#8220;<span class="quote"><code class="filename">man</code></span>&#8221;</span>. Another often-used value
                   8536:     is <span class="quote">&#8220;<span class="quote"><code class="filename">share/man</code></span>&#8221;</span>.</p>
1.148     asau     8537: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   8538: <h3 class="title">Note</h3>
1.87      wiz      8539: <p>The support for a custom <code class="varname">PKGMANDIR</code>
                   8540:     is far from complete.</p>
1.75      rillig   8541: </div>
1.81      rillig   8542: <p>The <code class="filename">PLIST</code> files can just use
1.87      wiz      8543:     <code class="filename">man/</code> as the top level directory for the man
                   8544:     page file entries, and the pkgsrc framework will convert as
                   8545:     needed. In all other places, the correct
                   8546:     <code class="varname">PKGMANDIR</code> must be used.</p>
                   8547: <p>Packages that are
                   8548:     configured with <code class="varname">GNU_CONFIGURE</code> set as
1.128     wiz      8549:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>, by default will use the
1.87      wiz      8550:     <code class="filename">./configure</code>
                   8551:     --mandir switch to set where the man pages should be installed.
                   8552:     The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
                   8553:     to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
                   8554: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
                   8555:     use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.128     wiz      8556:     to <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span>.
1.87      wiz      8557:     Or if the <code class="filename">./configure</code> script uses
                   8558:     a non-standard use of --mandir, you can set
                   8559:     <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.267     rillig   8560: <p>See <a class="xref" href="#manpage-compression" title="15.5. Man page compression">Section 15.5, &#8220;Man page compression&#8221;</a> for
1.87      wiz      8561:     information on installation of compressed manual pages.</p>
1.75      rillig   8562: </div>
1.148     asau     8563: <div class="sect2">
1.75      rillig   8564: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8565: <a name="gconf-data-files"></a>21.6.9. Packages installing GConf data files</h3></div></div></div>
1.87      wiz      8566: <p>If a package installs <code class="filename">.schemas</code> or
1.107     rillig   8567:     <code class="filename">.entries</code> files, used by GConf,
1.87      wiz      8568:     you need to take some extra steps to make sure they get registered
                   8569:     in the database:</p>
1.128     wiz      8570: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8571: <li class="listitem"><p>Include <code class="filename">../../devel/GConf/schemas.mk</code>
1.87      wiz      8572:        instead of its <code class="filename">buildlink3.mk</code> file.  This
1.107     rillig   8573:        takes care of rebuilding the GConf database at installation and
1.87      wiz      8574:        deinstallation time, and tells the package where to install
1.107     rillig   8575:        GConf data files using some standard configure arguments.  It
1.87      wiz      8576:        also disallows any access to the database directly from the
                   8577:        package.</p></li>
1.128     wiz      8578: <li class="listitem"><p>Ensure that the package installs its
1.87      wiz      8579:        <code class="filename">.schemas</code> files under
                   8580:        <code class="filename">${PREFIX}/share/gconf/schemas</code>.  If they get
                   8581:        installed under <code class="filename">${PREFIX}/etc</code>, you will
                   8582:        need to manually patch the package.</p></li>
1.128     wiz      8583: <li class="listitem"><p>Check the PLIST and remove any entries under the etc/gconf
1.87      wiz      8584:        directory, as they will be handled automatically.  See
1.267     rillig   8585:        <a class="xref" href="#faq.conf" title="10.13. How do I change the location of configuration files?">Section 10.13, &#8220;How do I change the location of configuration files?&#8221;</a> for more information.</p></li>
1.128     wiz      8586: <li class="listitem"><p>Define the <code class="varname">GCONF_SCHEMAS</code> variable in
1.87      wiz      8587:        your <code class="filename">Makefile</code> with a list of all
                   8588:        <code class="filename">.schemas</code> files installed by the package, if
                   8589:        any.  Names must not contain any directories in them.</p></li>
1.128     wiz      8590: <li class="listitem"><p>Define the <code class="varname">GCONF_ENTRIES</code> variable in
1.87      wiz      8591:        your <code class="filename">Makefile</code> with a
                   8592:        list of all <code class="filename">.entries</code> files installed by the
                   8593:        package, if any. Names must not contain any directories in
                   8594:        them.</p></li>
1.75      rillig   8595: </ol></div>
                   8596: </div>
1.148     asau     8597: <div class="sect2">
1.75      rillig   8598: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8599: <a name="scrollkeeper-data-files"></a>21.6.10. Packages installing scrollkeeper/rarian data files</h3></div></div></div>
1.87      wiz      8600: <p>If a package installs <code class="filename">.omf</code> files, used by
1.119     mishka   8601:     scrollkeeper/rarian, you need to take some extra steps to make sure they
1.87      wiz      8602:     get registered in the database:</p>
1.128     wiz      8603: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8604: <li class="listitem"><p>Include
1.119     mishka   8605:        <code class="filename">../../mk/omf-scrollkeeper.mk</code>
                   8606:        instead of rarian's <code class="filename">buildlink3.mk</code> file.  This
1.87      wiz      8607:        takes care of rebuilding the scrollkeeper database at
                   8608:        installation and deinstallation time, and disallows any access
                   8609:        to it directly from the package.</p></li>
1.128     wiz      8610: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.87      wiz      8611:        <code class="filename">libdata/scrollkeeper</code> directory, as they
                   8612:        will be handled automatically.</p></li>
1.128     wiz      8613: <li class="listitem"><p>Remove the <code class="filename">share/omf</code> directory from
1.119     mishka   8614:        the PLIST.  It will be handled by rarian. (<span class="command"><strong>make
                   8615:        print-PLIST</strong></span> does this automatically.)</p></li>
1.75      rillig   8616: </ol></div>
                   8617: </div>
1.148     asau     8618: <div class="sect2">
1.75      rillig   8619: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8620: <a name="x11-fonts"></a>21.6.11. Packages installing X11 fonts</h3></div></div></div>
1.75      rillig   8621: <p>If a package installs font files, you will need to rebuild
1.87      wiz      8622:     the fonts database in the directory where they get installed at
                   8623:     installation and deinstallation time.  This can be automatically
                   8624:     done by using the pkginstall framework.</p>
1.75      rillig   8625: <p>You can list the directories where fonts are installed in the
1.87      wiz      8626:     <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
                   8627:     variables, where <em class="replaceable"><code>type</code></em> can be one of
1.128     wiz      8628:     <span class="quote">&#8220;<span class="quote">ttf</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">type1</span>&#8221;</span> or <span class="quote">&#8220;<span class="quote">x11</span>&#8221;</span>.
1.87      wiz      8629:     Also make sure that the database file
                   8630:     <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
1.75      rillig   8631: <p>Note that you should not create new directories for fonts;
1.87      wiz      8632:     instead use the standard ones to avoid that the user needs to
                   8633:     manually configure his X server to find them.</p>
1.75      rillig   8634: </div>
1.148     asau     8635: <div class="sect2">
1.75      rillig   8636: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8637: <a name="gtk2-modules"></a>21.6.12. Packages installing GTK2 modules</h3></div></div></div>
1.75      rillig   8638: <p>If a package installs GTK2 immodules or loaders, you need to
1.87      wiz      8639:     take some extra steps to get them registered in the GTK2 database
                   8640:     properly:</p>
1.128     wiz      8641: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8642: <li class="listitem"><p>Include
1.87      wiz      8643:       <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
                   8644:       <code class="filename">buildlink3.mk</code> file.  This takes care of
                   8645:       rebuilding the database at installation and deinstallation time.</p></li>
1.128     wiz      8646: <li class="listitem"><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
1.87      wiz      8647:       your package installs GTK2 immodules.</p></li>
1.128     wiz      8648: <li class="listitem"><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
1.87      wiz      8649:       GTK2 loaders.</p></li>
1.128     wiz      8650: <li class="listitem">
1.87      wiz      8651: <p>Patch the package to not touch any of the GTK2
                   8652:       databases directly.  These are:</p>
1.148     asau     8653: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      8654: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
                   8655: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.75      rillig   8656: </ul></div>
                   8657: </li>
1.128     wiz      8658: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove
1.87      wiz      8659:       any entries under the <code class="filename">libdata/gtk-2.0</code>
                   8660:       directory, as they will be handled automatically.</p></li>
1.75      rillig   8661: </ol></div>
                   8662: </div>
1.148     asau     8663: <div class="sect2">
1.75      rillig   8664: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8665: <a name="sgml-xml-data"></a>21.6.13. Packages installing SGML or XML data</h3></div></div></div>
1.75      rillig   8666: <p>If a package installs SGML or XML data files that need to be
1.87      wiz      8667:     registered in system-wide catalogs (like DTDs, sub-catalogs,
                   8668:     etc.), you need to take some extra steps:</p>
1.128     wiz      8669: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8670: <li class="listitem"><p>Include
1.87      wiz      8671:        <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
                   8672:        your <code class="filename">Makefile</code>, which takes care of
                   8673:        registering those files in system-wide catalogs at
                   8674:        installation and deinstallation time.</p></li>
1.128     wiz      8675: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.87      wiz      8676:        any SGML catalogs installed by the package.</p></li>
1.128     wiz      8677: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.87      wiz      8678:        any XML catalogs installed by the package.</p></li>
1.128     wiz      8679: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.87      wiz      8680:        to be added to the SGML catalog.  These come in groups of
                   8681:        three strings; see xmlcatmgr(1) for more information
                   8682:        (specifically, arguments recognized by the 'add' action).
                   8683:        Note that you will normally not use this variable.</p></li>
1.128     wiz      8684: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.87      wiz      8685:        to be added to the XML catalog.  These come in groups of three
                   8686:        strings; see xmlcatmgr(1) for more information (specifically,
                   8687:        arguments recognized by the 'add' action).  Note that you will
                   8688:        normally not use this variable.</p></li>
1.75      rillig   8689: </ol></div>
                   8690: </div>
1.148     asau     8691: <div class="sect2">
1.75      rillig   8692: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8693: <a name="mime-database"></a>21.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
1.75      rillig   8694: <p>If a package provides extensions to the MIME database by
1.87      wiz      8695:     installing <code class="filename">.xml</code> files inside
                   8696:     <code class="filename">${PREFIX}/share/mime/packages</code>, you
                   8697:     need to take some extra steps to ensure that the database is kept
                   8698:     consistent with respect to these new files:</p>
1.128     wiz      8699: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8700: <li class="listitem"><p>Include
1.87      wiz      8701:        <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
                   8702:        (avoid using the <code class="filename">buildlink3.mk</code> file from
                   8703:        this same directory, which is reserved for inclusion from
                   8704:        other <code class="filename">buildlink3.mk</code> files).  It takes
                   8705:        care of rebuilding the MIME database at installation and
                   8706:        deinstallation time, and disallows any access to it directly
                   8707:        from the package.</p></li>
1.128     wiz      8708: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.87      wiz      8709:        <code class="filename">share/mime</code> directory,
                   8710:        <span class="emphasis"><em>except</em></span> for files saved under
                   8711:        <code class="filename">share/mime/packages</code>.  The former are
                   8712:        handled automatically by
                   8713:        the update-mime-database program, but the latter are
                   8714:        package-dependent and must be removed by the package that
                   8715:        installed them in the first place.</p></li>
1.128     wiz      8716: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.87      wiz      8717:        from the PLIST.  They will be handled by the shared-mime-info
                   8718:        package.</p></li>
1.75      rillig   8719: </ol></div>
                   8720: </div>
1.148     asau     8721: <div class="sect2">
1.75      rillig   8722: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8723: <a name="intltool"></a>21.6.15. Packages using intltool</h3></div></div></div>
1.93      rillig   8724: <p>If a package uses intltool during its build, add
                   8725:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
1.87      wiz      8726:     which forces it to use the intltool package provided by pkgsrc,
                   8727:     instead of the one bundled with the distribution file.</p>
1.75      rillig   8728: <p>This tracks intltool's build-time dependencies and uses the
1.87      wiz      8729:     latest available version; this way, the package benefits of any
                   8730:     bug fixes that may have appeared since it was released.</p>
1.75      rillig   8731: </div>
1.148     asau     8732: <div class="sect2">
1.75      rillig   8733: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8734: <a name="startup-scripts"></a>21.6.16. Packages installing startup scripts</h3></div></div></div>
1.75      rillig   8735: <p>If a package contains a rc.d script, it won't be copied into
1.87      wiz      8736:     the startup directory by default, but you can enable it, by adding
                   8737:     the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.110     hubertf  8738:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.87      wiz      8739:     into <code class="filename">/etc/rc.d</code> when a package is installed, and
                   8740:     it will automatically remove the scripts when the package is
                   8741:     deinstalled.</p>
1.75      rillig   8742: </div>
1.148     asau     8743: <div class="sect2">
1.75      rillig   8744: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8745: <a name="tex-packages"></a>21.6.17. Packages installing TeX modules</h3></div></div></div>
1.75      rillig   8746: <p>If a package installs TeX packages into the texmf tree,
1.87      wiz      8747:     the <code class="filename">ls-R</code> database of the tree needs to be
                   8748:     updated.</p>
1.148     asau     8749: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.75      rillig   8750: <h3 class="title">Note</h3>
1.125     wiz      8751: <p>Except the main TeX packages such as kpathsea,
1.87      wiz      8752:     packages should install files
1.125     wiz      8753:     into <code class="filename">${PREFIX}/share/texmf-dist</code>,
                   8754:     not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.75      rillig   8755: </div>
1.128     wiz      8756: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8757: <li class="listitem"><p>Include
1.125     wiz      8758:       <code class="filename">../../print/kpathsea/texmf.mk</code>.  This
1.87      wiz      8759:       takes care of rebuilding the <code class="filename">ls-R</code>
                   8760:       database at installation and deinstallation time.</p></li>
1.128     wiz      8761: <li class="listitem">
1.75      rillig   8762: <p>If your package installs files into a texmf
1.87      wiz      8763:       tree other than the one
1.125     wiz      8764:       at <code class="filename">${PREFIX}/share/texmf-dist</code>,
                   8765:       set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.87      wiz      8766:       trees that need database update.</p>
1.75      rillig   8767: <p>If your package also installs font map files that need
1.110     hubertf  8768:       to be registered using <span class="command"><strong>updmap</strong></span>,
1.136     dholland 8769:       include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.125     wiz      8770:       set <code class="varname">TEX_MAP_FILES</code> and/or
                   8771:       <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.110     hubertf  8772:       such font map files.  Then <span class="command"><strong>updmap</strong></span> will
1.87      wiz      8773:       be run automatically at installation/deinstallation to
                   8774:       enable/disable font map files for TeX output
                   8775:       drivers.</p>
1.75      rillig   8776: </li>
1.128     wiz      8777: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.87      wiz      8778:       databases are included in <code class="filename">PLIST</code>, as
1.136     dholland 8779:       they will be removed only by the kpathsea package.</p></li>
1.75      rillig   8780: </ol></div>
                   8781: </div>
1.148     asau     8782: <div class="sect2">
1.85      jmmv     8783: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8784: <a name="emulation-packages"></a>21.6.18. Packages supporting running binaries in
1.87      wiz      8785:     emulation</h3></div></div></div>
                   8786: <p>There are some packages that provide libraries and
                   8787:     executables for running binaries from a one operating system
                   8788:     on a different one (if the latter supports it).  One example
                   8789:     is running Linux binaries on NetBSD.</p>
1.250     leot     8790: <p>The <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/rpm2pkg/README.html" target="_top"><code class="filename">pkgtools/rpm2pkg</code></a>
1.87      wiz      8791:     helps in extracting and packaging Linux rpm packages.</p>
                   8792: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.110     hubertf  8793:     avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.87      wiz      8794:     if all libraries for each installed executable can be found by
                   8795:     the dynamic linker.  Since the standard dynamic linker is run,
                   8796:     this fails for emulation packages, because the libraries used
                   8797:     by the emulation are not in the standard directories.</p>
                   8798: </div>
1.148     asau     8799: <div class="sect2">
1.87      wiz      8800: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8801: <a name="hicolor-theme"></a>21.6.19. Packages installing hicolor theme icons</h3></div></div></div>
1.85      jmmv     8802: <p>If a package installs images under the
1.87      wiz      8803:     <code class="filename">share/icons/hicolor</code> and/or updates the
                   8804:     <code class="filename">share/icons/hicolor/icon-theme.cache</code>
                   8805:     database, you need to take some extra steps to make sure that the
                   8806:     shared theme directory is handled appropriately and that the cache
                   8807:     database is rebuilt:</p>
1.128     wiz      8808: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8809: <li class="listitem"><p>Include
1.87      wiz      8810:        <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
1.128     wiz      8811: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
1.87      wiz      8812:        entry that refers to the theme cache.</p></li>
1.128     wiz      8813: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
1.85      jmmv     8814:          directories from the <code class="filename">share/icons/hicolor</code>
                   8815:          hierarchy because they will be handled automatically.</p></li>
                   8816: </ol></div>
                   8817: <p>The best way to verify that the PLIST is correct with
                   8818:       respect to the last two points is to regenerate it using
1.110     hubertf  8819:       <span class="command"><strong>make print-PLIST</strong></span>.</p>
1.85      jmmv     8820: </div>
1.148     asau     8821: <div class="sect2">
1.85      jmmv     8822: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   8823: <a name="desktop-files"></a>21.6.20. Packages installing desktop files</h3></div></div></div>
1.85      jmmv     8824: <p>If a package installs <code class="filename">.desktop</code> files
                   8825:       under <code class="filename">share/applications</code> and these include
1.159     rodent   8826:       MIME information (MimeType key), you need to take extra steps to
                   8827:       ensure that they are registered into the MIME database:</p>
1.128     wiz      8828: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8829: <li class="listitem"><p>Include
1.85      jmmv     8830:          <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
1.128     wiz      8831: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
1.85      jmmv     8832:          <code class="filename">share/applications/mimeinfo.cache</code> file.
                   8833:          It will be handled automatically.</p></li>
                   8834: </ol></div>
                   8835: <p>The best way to verify that the PLIST is correct with
1.110     hubertf  8836:       respect to the last point is to regenerate it using <span class="command"><strong>make
1.85      jmmv     8837:       print-PLIST</strong></span>.</p>
1.75      rillig   8838: </div>
                   8839: </div>
1.148     asau     8840: <div class="sect1">
1.87      wiz      8841: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   8842: <a name="punting"></a>21.7. Marking packages as having problems</h2></div></div></div>
1.87      wiz      8843: <p>In some cases one does not have the time to solve a problem
1.125     wiz      8844:   immediately. In this case, one can plainly mark a package as broken.  For
                   8845:   this, one just sets the variable <code class="varname">BROKEN</code> to the
                   8846:   reason why the package is broken (similar to the
1.277     rillig   8847:   <code class="varname">PKG_FAIL_REASON</code> variable).  A user trying to build
1.125     wiz      8848:   the package will immediately be shown this message, and the build
                   8849:   will not be even tried.</p>
                   8850: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
1.87      wiz      8851:   intervals.</p>
                   8852: </div>
1.75      rillig   8853: </div>
1.148     asau     8854: <div class="chapter">
1.75      rillig   8855: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   8856: <a name="debug"></a>Chapter 22. Debugging</h2></div></div></div>
1.88      wiz      8857: <p>To check out all the gotchas when building a package, here are
                   8858:   the steps that I do in order to get a package working.  Please note
                   8859:   this is basically the same as what was explained in the previous
                   8860:   sections, only with some debugging aids.</p>
1.148     asau     8861: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      8862: <li class="listitem"><p>Be sure to set <code class="varname">PKG_DEVELOPER=yes</code> in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p></li>
                   8863: <li class="listitem">
1.250     leot     8864: <p>Install <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a>,
1.88      wiz      8865:       create a directory for a new package, change into it, then run
1.110     hubertf  8866:       <span class="command"><strong>url2pkg</strong></span>:</p>
1.75      rillig   8867: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>mkdir /usr/pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>examplepkg</code></em></code></strong>
                   8868: <code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>examplepkg</code></em></code></strong>
1.289     leot     8869: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg https://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
1.75      rillig   8870: </li>
1.128     wiz      8871: <li class="listitem"><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
                   8872: <li class="listitem"><p>Fill in the <code class="filename">DESCR</code> file</p></li>
                   8873: <li class="listitem"><p>Run <span class="command"><strong>make configure</strong></span></p></li>
                   8874: <li class="listitem"><p>Add any dependencies glimpsed from documentation and the
1.88      wiz      8875:       configure step to the package's
                   8876:       <code class="filename">Makefile</code>.</p></li>
1.128     wiz      8877: <li class="listitem">
1.75      rillig   8878: <p>Make the package compile, doing multiple rounds of</p>
                   8879: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   8880: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
                   8881: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
                   8882: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
                   8883: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
                   8884: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
                   8885: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
1.88      wiz      8886: <p>Doing this step as non-root user will ensure that no files
                   8887:       are modified that shouldn't be, especially during the build
1.110     hubertf  8888:       phase.  <span class="command"><strong>mkpatches</strong></span>,
                   8889:       <span class="command"><strong>patchdiff</strong></span> and <span class="command"><strong>pkgvi</strong></span> are
1.250     leot     8890:       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>
1.88      wiz      8891:       package.</p>
1.75      rillig   8892: </li>
1.128     wiz      8893: <li class="listitem"><p>Look at the <code class="filename">Makefile</code>, fix if
1.267     rillig   8894:       necessary; see <a class="xref" href="#components.Makefile" title="13.1. Makefile">Section 13.1, &#8220;<code class="filename">Makefile</code>&#8221;</a>.</p></li>
1.128     wiz      8895: <li class="listitem">
1.76      rillig   8896: <p>Generate a <code class="filename">PLIST</code>:</p>
1.75      rillig   8897: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   8898: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST &gt;PLIST</code></strong>
                   8899: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
                   8900: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   8901: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
1.88      wiz      8902: <p>You usually need to be <code class="username">root</code> to do
                   8903:       this.  Look if there are any files left:</p>
1.75      rillig   8904: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
                   8905: <p>If this reveals any files that are missing in
1.88      wiz      8906:       <code class="filename">PLIST</code>, add them.</p>
1.75      rillig   8907: </li>
1.128     wiz      8908: <li class="listitem">
1.88      wiz      8909: <p>Now that the <code class="filename">PLIST</code> is OK, install the
                   8910:       package again and make a binary package:</p>
1.75      rillig   8911: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
                   8912: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
                   8913: </li>
1.128     wiz      8914: <li class="listitem">
1.75      rillig   8915: <p>Delete the installed package:</p>
1.88      wiz      8916: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_delete <em class="replaceable"><code>examplepkg</code></em></code></strong></pre>
1.75      rillig   8917: </li>
1.128     wiz      8918: <li class="listitem">
1.110     hubertf  8919: <p>Repeat the above <span class="command"><strong>make print-PLIST</strong></span>
1.88      wiz      8920:       command, which shouldn't find anything now:</p>
1.75      rillig   8921: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
                   8922: </li>
1.128     wiz      8923: <li class="listitem">
1.75      rillig   8924: <p>Reinstall the binary package:</p>
1.93      rillig   8925: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add .../<em class="replaceable"><code>examplepkg</code></em>.tgz</code></strong></pre>
1.75      rillig   8926: </li>
1.128     wiz      8927: <li class="listitem"><p>Play with it.  Make sure everything works.</p></li>
                   8928: <li class="listitem">
1.250     leot     8929: <p>Run <span class="command"><strong>pkglint</strong></span> from <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>, and fix the problems it
1.88      wiz      8930:       reports:</p>
1.75      rillig   8931: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
                   8932: </li>
1.267     rillig   8933: <li class="listitem"><p>Submit (or commit, if you have cvs access); see <a class="xref" href="#submit" title="Chapter 23. Submitting and Committing">Chapter 23, <i>Submitting and Committing</i></a>.</p></li>
1.75      rillig   8934: </ul></div>
                   8935: </div>
1.148     asau     8936: <div class="chapter">
1.75      rillig   8937: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   8938: <a name="submit"></a>Chapter 23. Submitting and Committing</h2></div></div></div>
1.75      rillig   8939: <div class="toc">
                   8940: <p><b>Table of Contents</b></p>
1.210     leot     8941: <dl class="toc">
1.267     rillig   8942: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
                   8943: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   8944: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
                   8945: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
                   8946: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
                   8947: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
                   8948: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
                   8949: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
1.75      rillig   8950: </dl>
                   8951: </div>
1.148     asau     8952: <div class="sect1">
1.75      rillig   8953: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   8954: <a name="submitting-binary-packages"></a>23.1. Submitting binary packages</h2></div></div></div>
1.75      rillig   8955: <p>Our policy is that we accept binaries only from pkgsrc
                   8956:        developers to guarantee that the packages don't contain any
                   8957:        trojan horses etc. This is not to annoy anyone but rather to
                   8958:        protect our users! You're still free to put up your home-made
                   8959:        binary packages and tell the world where to get them. NetBSD
                   8960:        developers doing bulk builds and wanting to upload them please
1.267     rillig   8961:        see <a class="xref" href="#bulk" title="Chapter 8. Creating binary packages for everything in pkgsrc (bulk builds)">Chapter 8, <i>Creating binary packages for everything in pkgsrc (bulk
1.174     asau     8962: builds)</i></a>.</p>
1.75      rillig   8963: </div>
1.148     asau     8964: <div class="sect1">
1.75      rillig   8965: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   8966: <a name="submitting-your-package"></a>23.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.75      rillig   8967: <p>First, check that your package is complete, compiles and
1.267     rillig   8968:        runs well; see <a class="xref" href="#debug" title="Chapter 22. Debugging">Chapter 22, <i>Debugging</i></a> and the rest of this
1.289     leot     8969:        document. Next, generate an uuencoded gzipped <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?tar+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a>
1.82      rillig   8970:        archive that contains all files that make up the package.
1.87      wiz      8971:        Finally, send this package to the pkgsrc bug tracking system,
1.289     leot     8972:        either with the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> command, or if you don't have
1.87      wiz      8973:        that, go to the web page
1.289     leot     8974:        <a class="ulink" href="https://www.NetBSD.org/support/send-pr.html" target="_top">https://www.NetBSD.org/support/send-pr.html</a>,
1.124     snj      8975:        which contains some instructions and a link to a form where you
                   8976:        can submit packages.  The
1.250     leot     8977:        <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/sysutils/gtk-send-pr/README.html" target="_top"><code class="filename">sysutils/gtk-send-pr</code></a> package is
1.124     snj      8978:        also available as a substitute for either of the above two tools.
                   8979:        </p>
1.87      wiz      8980: <p>In the form of the problem report, the category should be
1.128     wiz      8981:        <span class="quote">&#8220;<span class="quote">pkg</span>&#8221;</span>, the synopsis should include the package name
1.87      wiz      8982:        and version number, and the description field should contain a
                   8983:        short description of your package (contents of the COMMENT
                   8984:        variable or DESCR file are OK). The uuencoded package data should
1.128     wiz      8985:        go into the <span class="quote">&#8220;<span class="quote">fix</span>&#8221;</span> field.</p>
1.75      rillig   8986: <p>If you want to submit several packages, please send a
                   8987:        separate PR for each one, it's easier for us to track things
                   8988:        that way.</p>
                   8989: <p>Alternatively, you can also import new packages into
1.128     wiz      8990:        pkgsrc-wip (<span class="quote">&#8220;<span class="quote">pkgsrc work-in-progress</span>&#8221;</span>); see the
1.289     leot     8991:        homepage at <a class="ulink" href="https://pkgsrc.org/wip/" target="_top">https://pkgsrc.org/wip/</a>
1.75      rillig   8992:        for details.</p>
                   8993: </div>
1.148     asau     8994: <div class="sect1">
1.75      rillig   8995: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   8996: <a name="general-notes-for-changes"></a>23.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.75      rillig   8997: <p>Please note all package additions, updates, moves, and
1.93      rillig   8998:        removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
1.75      rillig   8999:        important to keep this file up to date and conforming to the
                   9000:        existing format, because it will be used by scripts to
1.289     leot     9001:        automatically update pages on <a class="ulink" href="https://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.75      rillig   9002:        sites. Additionally, check the
1.76      rillig   9003:        <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
1.75      rillig   9004:        for the package you updated or removed, in case it was mentioned
                   9005:        there.</p>
                   9006: <p>When the <code class="varname">PKGREVISION</code> of a package is
                   9007:        bumped, the change should appear in
1.93      rillig   9008:        <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
1.75      rillig   9009:        related or otherwise relevant. Mass bumps that result from a
                   9010:        dependency being updated should not be mentioned. In all other
                   9011:        cases it's the developer's decision.</p>
                   9012: <p>There is a make target that helps in creating proper
1.110     hubertf  9013:   <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries:  <span class="command"><strong>make
1.75      rillig   9014:   changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
                   9015:   and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
1.93      rillig   9016:   usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
1.75      rillig   9017:   file is up-to-date (to avoid having to resolve conflicts later-on)
1.110     hubertf  9018:   and then to <span class="command"><strong>cd</strong></span> to the package directory.  For
                   9019:   package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.75      rillig   9020:   For new packages, or package moves or removals, set the
                   9021:   <code class="varname">CTYPE</code> variable on the command line to "Added",
                   9022:   "Moved", or "Removed".  You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.110     hubertf  9023:   in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.125     wiz      9024:   not the same as your NetBSD login name. The target also automatically
                   9025:   removes possibly existing entries for the package in the
                   9026:   <code class="filename">TODO</code> file. Don't forget to commit
1.174     asau     9027:   the changes, e.g. by using <span class="command"><strong>make commit-changes-entry</strong></span>!
1.126     jakllsch 9028:   If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
1.125     wiz      9029:   a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
                   9030:   makes the cvs commands use the main repository.
                   9031:   </p>
1.75      rillig   9032: </div>
1.148     asau     9033: <div class="sect1">
1.75      rillig   9034: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9035: <a name="commit-messages"></a>23.4. Commit Messages</h2></div></div></div>
1.243     wiz      9036: <p>For several years, there have been mirrors of pkgsrc in
                   9037:   fossil, git, and hg. Standard practise when using these tools is to
                   9038:   make the first line of a commit message function as a summary that
                   9039:   can be read without the rest, such as is commonly done with "git log
                   9040:   --oneline". For this reason, we have the following guidelines for
                   9041:   pkgsrc commit messages:</p>
                   9042: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   9043: <li class="listitem"><p>Start the commit message with a line that explains the
1.244     wiz      9044:     big picture in 65 characters or less. When a commit is for one
1.243     wiz      9045:     package, include the name of the package. For updates, include the
                   9046:     version to which it is updated.</p></li>
                   9047: <li class="listitem"><p>Leave the next line empty.</p></li>
                   9048: <li class="listitem"><p>Then come the details for the commit (changes in that
                   9049:     package, reason for a change) and any relevant PRs. Wrap this
                   9050:     section.</p></li>
                   9051: </ul></div>
                   9052: <p>Here is an example:
                   9053:   </p>
                   9054: <pre class="programlisting">
                   9055:   libxslt: update to 1.0.30
                   9056: 
                   9057:   Changes since 1.0.29:
                   9058:   ...
                   9059:   </pre>
                   9060: <p>
                   9061:   </p>
                   9062: <p>Here is another example:
                   9063:   </p>
                   9064: <pre class="programlisting">
                   9065:   mk/bsd.pkg.mk: enable SSP by default on NetBSD
                   9066: 
                   9067:   (rationale)
                   9068:   </pre>
                   9069: <p>
                   9070:   </p>
                   9071: <p>Commit messages are final: no <span class="quote">&#8220;<span class="quote">cvs admin</span>&#8221;</span> is
                   9072:   allowed on the pkgsrc repository to change commit messages.</p>
                   9073: </div>
                   9074: <div class="sect1">
                   9075: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9076: <a name="committing-importing"></a>23.5. Committing: Adding a package to CVS</h2></div></div></div>
1.87      wiz      9077: <p>This section is only of interest for pkgsrc developers with write
1.140     wiz      9078:   access to the pkgsrc repository.</p>
                   9079: <p>When the package is finished, <span class="quote">&#8220;<span class="quote">cvs add</span>&#8221;</span> the files.
                   9080: Start by adding the directory and then files in the directory. Don't
                   9081: forget to add the new package to the category's
                   9082: <code class="filename">Makefile</code>. Make sure you don't forget any files;
                   9083: you can check by running <span class="quote">&#8220;<span class="quote">cvs status</span>&#8221;</span>. An example:</p>
                   9084: <pre class="programlisting">
                   9085: <code class="prompt">$</code> cd .../pkgsrc/category
                   9086: <code class="prompt">$</code> cvs add pkgname
                   9087: <code class="prompt">$</code> cd pkgname
                   9088: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
                   9089: <code class="prompt">$</code> cvs add patches/p*
                   9090: <code class="prompt">$</code> cvs status | less
1.141     wiz      9091: <code class="prompt">$</code> cvs commit
1.140     wiz      9092: <code class="prompt">$</code> cd ..
                   9093: <code class="prompt">$</code> vi Makefile # add SUBDIRS+=pkgname line
1.141     wiz      9094: <code class="prompt">$</code> cvs commit Makefile
1.174     asau     9095: <code class="prompt">$</code> cd pkgname
1.182     jnemeth  9096: <code class="prompt">$</code> make CTYPE=Added commit-changes-entry
1.140     wiz      9097: </pre>
1.87      wiz      9098: <p>The commit message of the initial import should include part of the
1.76      rillig   9099:   <code class="filename">DESCR</code> file, so people reading the mailing lists know
1.87      wiz      9100:   what the package is/does.</p>
1.140     wiz      9101: <p>Also mention the new package in
                   9102: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
                   9103: <p>Previously, <span class="quote">&#8220;<span class="quote">cvs import</span>&#8221;</span> was suggested, but it was
                   9104: much easier to get wrong than <span class="quote">&#8220;<span class="quote">cvs add</span>&#8221;</span>.</p>
1.75      rillig   9105: </div>
1.148     asau     9106: <div class="sect1">
1.75      rillig   9107: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9108: <a name="updating-package"></a>23.6. Updating a package to a newer version</h2></div></div></div>
1.87      wiz      9109: <p>Please always put a concise, appropriate and relevant summary of the
1.75      rillig   9110:   changes between old and new versions into the commit log when updating
1.87      wiz      9111:   a package. There are various reasons for this:</p>
1.148     asau     9112: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      9113: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.87      wiz      9114:   or its information may be overwritten by newer information.</p></li>
1.128     wiz      9115: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.87      wiz      9116:   repository is very useful for people who use either cvs or anoncvs.</p></li>
1.128     wiz      9117: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.75      rillig   9118:   repository is very useful for people who read the pkgsrc-changes mailing
                   9119:   list, so that they can make tactical decisions about when to upgrade
1.87      wiz      9120:   the package.</p></li>
1.75      rillig   9121: </ul></div>
1.87      wiz      9122: <p>Please also recognize that, just because a new version of a package
1.75      rillig   9123:   has been released, it should not automatically be upgraded in the CVS
                   9124:   repository.  We prefer to be conservative in the packages that are
                   9125:   included in pkgsrc - development or beta packages are not really the
                   9126:   best thing for most places in which pkgsrc is used. Please use your
                   9127:   judgement about what should go into pkgsrc, and bear in mind that
1.87      wiz      9128:   stability is to be preferred above new and possibly untested features.</p>
1.75      rillig   9129: </div>
1.148     asau     9130: <div class="sect1">
1.75      rillig   9131: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9132: <a name="renaming-package"></a>23.7. Renaming a package in pkgsrc</h2></div></div></div>
1.122     reed     9133: <p>Renaming packages is not recommended.</p>
1.290     gutterid 9134: <p>When renaming packages, be sure to fix any references to the old name
1.122     reed     9135:   in other Makefiles, options, buildlink files, etc.</p>
1.282     leot     9136: <p>
1.290     gutterid 9137:   Also, when renaming a package, please add
1.282     leot     9138:   the package name and version pattern(s) of the previous package
                   9139:   to <code class="varname">SUPERSEDES</code>.
1.122     reed     9140:   This may be repeated for multiple renames.
                   9141:   The new package would be an exact replacement.
1.282     leot     9142:   Example:
1.122     reed     9143: </p>
1.282     leot     9144: <pre class="programlisting">
                   9145: SUPERSEDES+=    p5-IO-Compress-Zlib&lt;2.017
                   9146: SUPERSEDES+=    optcomp-[0-9]*
                   9147: </pre>
1.128     wiz      9148: <p>Note that <span class="quote">&#8220;<span class="quote">successor</span>&#8221;</span> in the
1.122     reed     9149:   CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
                   9150:   mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
                   9151:   not be an exact replacement but is a suggestion for the replaced
                   9152:   functionality.</p>
                   9153: </div>
1.148     asau     9154: <div class="sect1">
1.122     reed     9155: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9156: <a name="moving-package"></a>23.8. Moving a package in pkgsrc</h2></div></div></div>
1.122     reed     9157: <p>It is preferred that packages are not renamed or moved, but if needed
                   9158:   please follow these steps.
                   9159: </p>
1.128     wiz      9160: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9161: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
                   9162: <li class="listitem">
1.75      rillig   9163: <p>Remove all CVS dirs.</p>
1.87      wiz      9164: <p>Alternatively to the first two steps you can also do:</p>
1.75      rillig   9165: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs -d user@cvs.NetBSD.org:/cvsroot export -D today pkgsrc/category/package</code></strong></pre>
1.87      wiz      9166: <p>and use that for further work.</p>
1.75      rillig   9167: </li>
1.128     wiz      9168: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
                   9169: <code class="varname">DEPENDS</code> paths that just did <span class="quote">&#8220;<span class="quote">../package</span>&#8221;</span>
                   9170: instead of <span class="quote">&#8220;<span class="quote">../../category/package</span>&#8221;</span>.</p></li>
                   9171: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.122     reed     9172: <code class="varname">PREV_PKGPATH</code> to the previous category/package
                   9173: pathname.  The <code class="varname">PREV_PKGPATH</code> can be used by tools
                   9174: for doing an update using pkgsrc building; for example, it can
1.289     leot     9175: search the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_summary+5.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">pkg_summary</span>(5)</span></a> database for <code class="varname">PREV_PKGPATH</code>
1.122     reed     9176: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
                   9177: new <code class="varname">PKGPATH</code> for that moved package.  Note that
                   9178: it may have multiple matches, so the tool should also check on the
                   9179: <code class="varname">PKGBASE</code> too.  The <code class="varname">PREV_PKGPATH</code>
                   9180: probably has no value unless <code class="varname">SUPERSEDES</code> is not
                   9181: set, i.e.  <code class="varname">PKGBASE</code> stays the same.  </p></li>
1.128     wiz      9182: <li class="listitem"><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.75      rillig   9183: place.</p></li>
1.128     wiz      9184: <li class="listitem">
1.75      rillig   9185: <p>Check if any package depends on it:
                   9186: </p>
                   9187: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   9188: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
                   9189: </li>
1.128     wiz      9190: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
                   9191: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
                   9192: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
                   9193: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
                   9194: <li class="listitem">
1.75      rillig   9195: <p>Commit the changed and removed files:</p>
                   9196: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile</code></strong></pre>
1.87      wiz      9197: <p>(and any packages from step 5, of course).</p>
1.75      rillig   9198: </li>
                   9199: </ol></div>
                   9200: </div>
                   9201: </div>
1.148     asau     9202: <div class="chapter">
1.75      rillig   9203: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   9204: <a name="devfaq"></a>Chapter 24. Frequently Asked Questions</h2></div></div></div>
1.75      rillig   9205: <p>This section contains the answers to questions that may
                   9206:        arise when you are writing a package. If you don't find your
                   9207:        question answered here, first have a look in the other chapters,
                   9208:        and if you still don't have the answer, ask on the
                   9209:        <code class="literal">pkgsrc-users</code> mailing list.</p>
1.148     asau     9210: <div class="qandaset">
1.289     leot     9211: <a name="devfaq.qandaset"></a><dl>
1.267     rillig   9212: <dt>24.1. <a href="#devfaq.makeflags">What is the difference between
1.75      rillig   9213:        MAKEFLAGS, .MAKEFLAGS and
                   9214:        MAKE_FLAGS?</a>
                   9215: </dt>
1.267     rillig   9216: <dt>24.2. <a href="#devfaq.make">What is the difference between
1.75      rillig   9217:        MAKE, GMAKE and
                   9218:        MAKE_PROGRAM?</a>
                   9219: </dt>
1.267     rillig   9220: <dt>24.3. <a href="#devfaq.cc">What is the difference between
1.75      rillig   9221:        CC, PKG_CC and
                   9222:        PKGSRC_COMPILER?</a>
                   9223: </dt>
1.267     rillig   9224: <dt>24.4. <a href="#devfaq.bl3flags">What is the difference between
1.75      rillig   9225:        BUILDLINK_LDFLAGS,
                   9226:        BUILDLINK_LDADD and
                   9227:        BUILDLINK_LIBS?</a>
                   9228: </dt>
1.267     rillig   9229: <dt>24.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.75      rillig   9230:        VARNAME=BUILDLINK_PREFIX.foo
                   9231:        say it's empty?</a>
                   9232: </dt>
1.267     rillig   9233: <dt>24.6. <a href="#devfaq.master_sites">What does
1.78      rillig   9234:        ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
                   9235:        don't understand the := inside
                   9236:        it.</a>
                   9237: </dt>
1.267     rillig   9238: <dt>24.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.78      rillig   9239:        developers?</a>
                   9240: </dt>
1.267     rillig   9241: <dt>24.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.80      rillig   9242:        documentation?</a>
                   9243: </dt>
1.289     leot     9244: <dt>24.9. <a href="#devfaq.too-much-time">I have a little time to kill. 
                   9245: What shall I do?</a>
1.92      rillig   9246: </dt>
1.75      rillig   9247: </dl>
1.148     asau     9248: <table border="0" style="width: 100%;">
                   9249: <colgroup>
1.75      rillig   9250: <col align="left" width="1%">
1.128     wiz      9251: <col>
1.148     asau     9252: </colgroup>
1.75      rillig   9253: <tbody>
1.148     asau     9254: <tr class="question">
1.75      rillig   9255: <td align="left" valign="top">
1.289     leot     9256: <a name="devfaq.makeflags"></a><a name="devfaq.makeflags.q"></a><p><b>24.1.</b></p>
1.75      rillig   9257: </td>
                   9258: <td align="left" valign="top"><p>What is the difference between
                   9259:        <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
                   9260:        <code class="varname">MAKE_FLAGS</code>?</p></td>
                   9261: </tr>
                   9262: <tr class="answer">
1.91      rillig   9263: <td align="left" valign="top"></td>
1.75      rillig   9264: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
1.289     leot     9265:        to the pkgsrc-internal invocations of <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>, while
1.75      rillig   9266:        <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
                   9267:        the <code class="varname">MAKE_PROGRAM</code> when building the
                   9268:        package. [FIXME: What is .MAKEFLAGS for?]</p></td>
                   9269: </tr>
1.148     asau     9270: <tr class="question">
1.75      rillig   9271: <td align="left" valign="top">
1.289     leot     9272: <a name="devfaq.make"></a><a name="devfaq.make.q"></a><p><b>24.2.</b></p>
1.75      rillig   9273: </td>
                   9274: <td align="left" valign="top"><p>What is the difference between
                   9275:        <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
                   9276:        <code class="varname">MAKE_PROGRAM</code>?</p></td>
                   9277: </tr>
                   9278: <tr class="answer">
1.91      rillig   9279: <td align="left" valign="top"></td>
1.75      rillig   9280: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
1.289     leot     9281:        <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> program that is used in the pkgsrc
1.75      rillig   9282:        infrastructure. <code class="varname">GMAKE</code> is the path to GNU
                   9283:        Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
                   9284:        use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
                   9285:        Make program that is used for building the
                   9286:        package.</p></td>
                   9287: </tr>
1.148     asau     9288: <tr class="question">
1.75      rillig   9289: <td align="left" valign="top">
1.289     leot     9290: <a name="devfaq.cc"></a><a name="devfaq.cc.q"></a><p><b>24.3.</b></p>
1.75      rillig   9291: </td>
                   9292: <td align="left" valign="top"><p>What is the difference between
                   9293:        <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
                   9294:        <code class="varname">PKGSRC_COMPILER</code>?</p></td>
                   9295: </tr>
                   9296: <tr class="answer">
1.91      rillig   9297: <td align="left" valign="top"></td>
1.75      rillig   9298: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
                   9299:        compiler, which can be configured by the pkgsrc user.
                   9300:        <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
                   9301:        <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
                   9302:        path to a compiler, but the type of compiler that should be
1.76      rillig   9303:        used. See <code class="filename">mk/compiler.mk</code> for more
1.75      rillig   9304:        information about the latter variable.</p></td>
                   9305: </tr>
1.148     asau     9306: <tr class="question">
1.75      rillig   9307: <td align="left" valign="top">
1.289     leot     9308: <a name="devfaq.bl3flags"></a><a name="devfaq.bl3flags.q"></a><p><b>24.4.</b></p>
1.75      rillig   9309: </td>
                   9310: <td align="left" valign="top"><p>What is the difference between
                   9311:        <code class="varname">BUILDLINK_LDFLAGS</code>,
                   9312:        <code class="varname">BUILDLINK_LDADD</code> and
                   9313:        <code class="varname">BUILDLINK_LIBS</code>?</p></td>
                   9314: </tr>
                   9315: <tr class="answer">
1.91      rillig   9316: <td align="left" valign="top"></td>
1.75      rillig   9317: <td align="left" valign="top"><p>[FIXME]</p></td>
                   9318: </tr>
1.148     asau     9319: <tr class="question">
1.75      rillig   9320: <td align="left" valign="top">
1.289     leot     9321: <a name="devfaq.bl3prefix"></a><a name="devfaq.bl3prefix.q"></a><p><b>24.5.</b></p>
1.75      rillig   9322: </td>
1.110     hubertf  9323: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.75      rillig   9324:        VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
                   9325:        say it's empty?</p></td>
                   9326: </tr>
                   9327: <tr class="answer">
1.91      rillig   9328: <td align="left" valign="top"></td>
1.75      rillig   9329: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.128     wiz      9330:        available in the <span class="quote">&#8220;<span class="quote">wrapper</span>&#8221;</span> phase and later. To
                   9331:        <span class="quote">&#8220;<span class="quote">simulate</span>&#8221;</span> the wrapper phase, append
1.110     hubertf  9332:        <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.75      rillig   9333:        command.</p></td>
                   9334: </tr>
1.148     asau     9335: <tr class="question">
1.78      rillig   9336: <td align="left" valign="top">
1.289     leot     9337: <a name="devfaq.master_sites"></a><a name="devfaq.master_sites.q"></a><p><b>24.6.</b></p>
1.78      rillig   9338: </td>
                   9339: <td align="left" valign="top"><p>What does
1.220     wiz      9340:        <code class="code">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
                   9341:        don't understand the <code class="code">:=</code> inside
1.78      rillig   9342:        it.</p></td>
                   9343: </tr>
                   9344: <tr class="answer">
1.91      rillig   9345: <td align="left" valign="top"></td>
1.220     wiz      9346: <td align="left" valign="top"><p>The <code class="code">:=</code> is not really an
                   9347:        assignment operator, although it looks like it.
1.78      rillig   9348:        Instead, it is a degenerate form of
1.220     wiz      9349:        <code class="code">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.289     leot     9350:        which is documented in the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man page and which is
1.220     wiz      9351:        commonly used in the form <code class="code">${SRCS:.c=.o}</code>. In the
1.78      rillig   9352:        case of <code class="varname">MASTER_SITE_*</code>,
                   9353:        <em class="replaceable"><code>old_string</code></em> is the empty string and
                   9354:        <em class="replaceable"><code>new_string</code></em> is
1.220     wiz      9355:        <code class="code">package/</code>. That's where the
                   9356:        <code class="code">:</code> and the <code class="code">=</code> fall
1.78      rillig   9357:        together.</p></td>
                   9358: </tr>
1.148     asau     9359: <tr class="question">
1.78      rillig   9360: <td align="left" valign="top">
1.289     leot     9361: <a name="devfaq.mailinglists"></a><a name="devfaq.mailinglists.q"></a><p><b>24.7.</b></p>
1.78      rillig   9362: </td>
                   9363: <td align="left" valign="top"><p>Which mailing lists are there for package
                   9364:        developers?</p></td>
                   9365: </tr>
                   9366: <tr class="answer">
1.91      rillig   9367: <td align="left" valign="top"></td>
1.148     asau     9368: <td align="left" valign="top"><div class="variablelist"><dl class="variablelist">
1.289     leot     9369: <dt><span class="term"><a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a></span></dt>
1.78      rillig   9370: <dd><p>This is a list for technical discussions related
                   9371:        to pkgsrc development, e.g. soliciting feedback for changes to
                   9372:        pkgsrc infrastructure, proposed new features, questions related
                   9373:        to porting pkgsrc to a new platform, advice for maintaining a
                   9374:        package, patches that affect many packages, help requests moved
                   9375:        from pkgsrc-users when an infrastructure bug is found,
                   9376:        etc.</p></dd>
1.289     leot     9377: <dt><span class="term"><a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#pkgsrc-bugs" target="_top">pkgsrc-bugs</a></span></dt>
1.78      rillig   9378: <dd><p>All bug reports in category "pkg" sent with
1.289     leot     9379:        <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> appear here. Please do not report your bugs here
1.78      rillig   9380:        directly; use one of the other mailing
                   9381:        lists.</p></dd>
                   9382: </dl></div></td>
                   9383: </tr>
1.148     asau     9384: <tr class="question">
1.80      rillig   9385: <td align="left" valign="top">
1.289     leot     9386: <a name="devfaq.documentation"></a><a name="devfaq.documentation.q"></a><p><b>24.8.</b></p>
1.80      rillig   9387: </td>
                   9388: <td align="left" valign="top"><p>Where is the pkgsrc
                   9389:        documentation?</p></td>
                   9390: </tr>
                   9391: <tr class="answer">
1.91      rillig   9392: <td align="left" valign="top"></td>
1.80      rillig   9393: <td align="left" valign="top">
                   9394: <p>There are many places where you can find
                   9395:        documentation about pkgsrc:</p>
1.148     asau     9396: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      9397: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.80      rillig   9398:        of chapters that explain large parts of pkgsrc, but some
                   9399:        chapters tend to be outdated. Which ones they are is hard to
                   9400:        say.</p></li>
1.289     leot     9401: <li class="listitem"><p>On the mailing list archives (see <a class="ulink" href="https://mail-index.NetBSD.org/" target="_top">https://mail-index.NetBSD.org/</a>), you can find discussions
1.80      rillig   9402:        about certain features, announcements of new parts of the pkgsrc
                   9403:        infrastructure and sometimes even announcements that a certain
                   9404:        feature has been marked as obsolete. The benefit here is that
                   9405:        each message has a date appended to it.</p></li>
1.128     wiz      9406: <li class="listitem"><p>Many of the files in the
1.80      rillig   9407:        <code class="filename">mk/</code> directory start with a comment that
                   9408:        describes the purpose of the file and how it can be used by the
1.92      rillig   9409:        pkgsrc user and package authors. An easy way to find this
1.110     hubertf  9410:        documentation is to run <span class="command"><strong>bmake
1.92      rillig   9411:        help</strong></span>.</p></li>
1.128     wiz      9412: <li class="listitem"><p>The CVS log messages are a rich source of
1.80      rillig   9413:        information, but they tend to be highly abbreviated, especially
                   9414:        for actions that occur often. Some contain a detailed
                   9415:        description of what has changed, but they are geared towards the
                   9416:        other pkgsrc developers, not towards an average pkgsrc user.
                   9417:        They also only document <span class="emphasis"><em>changes</em></span>, so if you
                   9418:        don't know what has been before, these messages may not be worth
                   9419:        too much to you.</p></li>
1.128     wiz      9420: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">&#8220;<span class="quote">implicitly
                   9421:        documented</span>&#8221;</span>, that is the documentation exists only in the
1.80      rillig   9422:        mind of the developer who wrote the code. To get this
1.110     hubertf  9423:        information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.80      rillig   9424:        to see who has written it and ask on the
                   9425:        <code class="literal">tech-pkg</code> mailing list, so that others can
                   9426:        find your questions later (see above). To be sure that the
                   9427:        developer in charge reads the mail, you may CC him or
                   9428:        her.</p></li>
                   9429: </ul></div>
                   9430: </td>
                   9431: </tr>
1.148     asau     9432: <tr class="question">
1.92      rillig   9433: <td align="left" valign="top">
1.289     leot     9434: <a name="devfaq.too-much-time"></a><a name="devfaq.too-much-time.q"></a><p><b>24.9.</b></p>
1.92      rillig   9435: </td>
1.289     leot     9436: <td align="left" valign="top"><p>I have a little time to kill. 
                   9437: What shall I do?</p></td>
1.92      rillig   9438: </tr>
                   9439: <tr class="answer">
                   9440: <td align="left" valign="top"></td>
                   9441: <td align="left" valign="top">
1.93      rillig   9442: <p>This is not really an FAQ yet, but here's the answer
1.92      rillig   9443: anyway.</p>
1.148     asau     9444: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      9445: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.250     leot     9446:     <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
1.92      rillig   9447:     will tell you about newer versions of installed packages that are
                   9448:     available, but not yet updated in pkgsrc.</p></li>
1.128     wiz      9449: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
1.126     jakllsch 9450:     &mdash; it contains a list of suggested new packages and a list of
1.92      rillig   9451:     cleanups and enhancements for pkgsrc that would be nice to
                   9452:     have.</p></li>
1.128     wiz      9453: <li class="listitem"><p>Review packages for which review was requested on
1.289     leot     9454:     the <a class="ulink" href="https://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a>
1.92      rillig   9455:     mailing list.</p></li>
                   9456: </ul></div>
                   9457: </td>
                   9458: </tr>
1.75      rillig   9459: </tbody>
                   9460: </table>
                   9461: </div>
                   9462: </div>
1.148     asau     9463: <div class="chapter">
1.85      jmmv     9464: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   9465: <a name="gnome"></a>Chapter 25. GNOME packaging and porting</h2></div></div></div>
1.85      jmmv     9466: <div class="toc">
                   9467: <p><b>Table of Contents</b></p>
1.210     leot     9468: <dl class="toc">
1.267     rillig   9469: <dt><span class="sect1"><a href="#meta-packages">25.1. Meta packages</a></span></dt>
                   9470: <dt><span class="sect1"><a href="#new-package">25.2. Packaging a GNOME application</a></span></dt>
                   9471: <dt><span class="sect1"><a href="#full-update">25.3. Updating GNOME to a newer version</a></span></dt>
                   9472: <dt><span class="sect1"><a href="#patching">25.4. Patching guidelines</a></span></dt>
1.85      jmmv     9473: </dl>
                   9474: </div>
1.289     leot     9475: <p>Quoting <a class="ulink" href="https://www.gnome.org/" target="_top">GNOME's web
1.85      jmmv     9476: site</a>:</p>
                   9477: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
                   9478:   environment, an intuitive and attractive desktop for users, and the
                   9479:   GNOME development platform, an extensive framework for building
                   9480:   applications that integrate into the rest of the desktop.</p></blockquote></div>
                   9481: <p>pkgsrc provides a seamless way to automatically build and install
                   9482: a complete GNOME environment <span class="emphasis"><em>under many different
                   9483: platforms</em></span>.  We can say with confidence that pkgsrc is one of
                   9484: the most advanced build and packaging systems for GNOME due to its
                   9485: included technologies buildlink3, the wrappers and tools framework and
                   9486: automatic configuration file management.  Lots of efforts are put into
                   9487: achieving a completely clean deinstallation of installed software
                   9488: components.</p>
1.289     leot     9489: <p>Given that pkgsrc is <a class="ulink" href="https://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
1.85      jmmv     9490: the above also means that great efforts are put into making GNOME work
1.289     leot     9491: under this operating system.  Recently, <a class="ulink" href="https://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
1.85      jmmv     9492: pkgsrc as its preferred packaging system, contributing lots of
                   9493: portability fixes to make GNOME build and install under it.</p>
                   9494: <p>This chapter is aimed at pkgsrc developers and other people
                   9495: interested in helping our GNOME porting and packaging efforts.  It
                   9496: provides instructions on how to manage the existing packages and some
                   9497: important information regarding their internals.</p>
1.148     asau     9498: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.85      jmmv     9499: <h3 class="title">We need your help!</h3>
                   9500: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
                   9501:   and GNOME and are willing to learn new exciting stuff, please jump
1.289     leot     9502:   straight to the <a class="ulink" href="https://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
1.85      jmmv     9503:   work</a> list!  There is still a long way to go to get a
                   9504:   fully-functional GNOME desktop under NetBSD and we need your help to
                   9505:   achieve it!</p>
                   9506: </div>
1.148     asau     9507: <div class="sect1">
1.85      jmmv     9508: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9509: <a name="meta-packages"></a>25.1. Meta packages</h2></div></div></div>
1.85      jmmv     9510: <p>pkgsrc includes three GNOME-related meta packages:</p>
1.148     asau     9511: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.250     leot     9512: <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
1.85      jmmv     9513:     the core GNOME desktop environment.  It only includes the necessary
                   9514:     bits to get it to boot correctly, although it may lack important
                   9515:     functionality for daily operation.  The idea behind this package is
                   9516:     to let end users build their own configurations on top of this one,
                   9517:     first installing this meta package to achieve a functional setup and
                   9518:     then adding individual applications.</p></li>
1.250     leot     9519: <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
1.85      jmmv     9520:     complete installation of the GNOME platform and desktop as defined
                   9521:     by the GNOME project; this is based on the components distributed in
                   9522:     the <code class="filename">platform/x.y/x.y.z/sources</code> and
                   9523:     <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
                   9524:     official FTP server.  Developer-only tools found in those
                   9525:     directories are not installed unless required by some other
                   9526:     component to work properly.  Similarly, packages from the bindings
                   9527:     set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
                   9528:     in unless required as a dependency for an end-user component.  This
1.250     leot     9529:     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>
                   9530: <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>:
1.85      jmmv     9531:     Installs all the tools required to build a GNOME component when
                   9532:     fetched from the CVS repository.  These are required to let the
1.110     hubertf  9533:     <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
1.85      jmmv     9534: </ul></div>
                   9535: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
                   9536: sorted in a way that eases updates: a package may depend on other
                   9537: packages listed before it but not on any listed after it.  It is very
                   9538: important to keep this order to ease updates so... <span class="emphasis"><em>do not
                   9539: change it to alphabetical sorting!</em></span></p>
                   9540: </div>
1.148     asau     9541: <div class="sect1">
1.85      jmmv     9542: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9543: <a name="new-package"></a>25.2. Packaging a GNOME application</h2></div></div></div>
1.85      jmmv     9544: <p>Almost all GNOME applications are written in C and use a common
                   9545: set of tools as their build system.  Things get different with the new
                   9546: bindings to other languages (such as Python), but the following will
                   9547: give you a general idea on the minimum required tools:</p>
1.148     asau     9548: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      9549: <li class="listitem">
1.85      jmmv     9550: <p>Almost all GNOME applications use the GNU Autotools as their
                   9551:     build system.  As a general rule you will need to tell this to your
                   9552:     package:</p>
1.100     rillig   9553: <pre class="programlisting">
                   9554: GNU_CONFIGURE=yes
1.85      jmmv     9555: USE_LIBTOOL=yes
1.100     rillig   9556: USE_TOOLS+=gmake
                   9557: </pre>
1.85      jmmv     9558: </li>
1.128     wiz      9559: <li class="listitem">
1.85      jmmv     9560: <p>If the package uses pkg-config to detect dependencies, add this
                   9561:     tool to the list of required utilities:</p>
1.222     sevan    9562: <pre class="programlisting">
                   9563: USE_TOOLS+=pkg-config
                   9564: </pre>
1.250     leot     9565: <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
1.85      jmmv     9566:     the end of the build process to ensure that you did not miss to
                   9567:     specify any dependency in your package and that the version
                   9568:     requirements are all correct.</p>
                   9569: </li>
1.128     wiz      9570: <li class="listitem"><p>If the package uses intltool, be sure to add
1.93      rillig   9571:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
1.85      jmmv     9572:     to handle dependencies and to force the package to use the latest
                   9573:     available version.</p></li>
1.128     wiz      9574: <li class="listitem">
1.85      jmmv     9575: <p>If the package uses gtk-doc (a documentation generation
                   9576:     utility), do <span class="emphasis"><em>not</em></span> add a dependency on it.  The
                   9577:     tool is rather big and the distfile should come with pregenerated
                   9578:     documentation anyway; if it does not, it is a bug that you ought to
                   9579:     report.  For such packages you should disable gtk-doc (unless it is
1.89      rillig   9580:     the default):</p>
1.222     sevan    9581: <pre class="programlisting">
                   9582: CONFIGURE_ARGS+=--disable-gtk-doc
                   9583: </pre>
1.89      rillig   9584: <p>The default location of installed HTML files
                   9585:     (<code class="filename">share/gtk-doc/&lt;package-name&gt;</code>) is correct
                   9586:     and should not be changed unless the package insists on installing
                   9587:     them somewhere else.  Otherwise programs as
1.110     hubertf  9588:     <span class="command"><strong>devhelp</strong></span> will not be able to open them.  You can
1.89      rillig   9589:     do that with an entry similar to:</p>
1.222     sevan    9590: <pre class="programlisting">
                   9591: CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...
                   9592: </pre>
1.85      jmmv     9593: </li>
                   9594: </ul></div>
                   9595: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
                   9596: files under the installation prefix to maintain databases.  In this
                   9597: context, shared means that those exact same directories and files are
                   9598: used among several different packages, leading to conflicts in the
                   9599: <code class="filename">PLIST</code>.  pkgsrc currently includes functionality to
                   9600: handle the most common cases, so you have to forget about using
                   9601: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
                   9602: omitting shared files from them.  If you find yourself doing those,
                   9603: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
                   9604: <p>The following table lists the common situations that result in
                   9605: using shared directories or files.  For each of them, the appropriate
                   9606: solution is given.  After applying the solution be sure to
                   9607: <span class="emphasis"><em>regenerate the package's file list</em></span> with
1.110     hubertf  9608: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
1.85      jmmv     9609: <div class="table">
1.267     rillig   9610: <a name="plist-handling"></a><p class="title"><b>Table 25.1. PLIST handling for GNOME packages</b></p>
1.216     tnn      9611: <div class="table-contents"><table class="table" summary="PLIST handling for GNOME packages" border="1">
1.85      jmmv     9612: <colgroup>
                   9613: <col>
                   9614: <col>
                   9615: </colgroup>
                   9616: <thead><tr>
                   9617: <th>If the package...</th>
                   9618: <th>Then...</th>
                   9619: </tr></thead>
                   9620: <tbody>
                   9621: <tr>
                   9622: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.267     rillig   9623: <td>See <a class="xref" href="#scrollkeeper-data-files" title="21.6.10. Packages installing scrollkeeper/rarian data files">Section 21.6.10, &#8220;Packages installing scrollkeeper/rarian data files&#8221;</a>.</td>
1.85      jmmv     9624: </tr>
                   9625: <tr>
                   9626: <td>Installs icons under the
                   9627:         <code class="filename">share/icons/hicolor</code> hierarchy or updates
                   9628:         <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.267     rillig   9629: <td>See <a class="xref" href="#hicolor-theme" title="21.6.19. Packages installing hicolor theme icons">Section 21.6.19, &#8220;Packages installing hicolor theme icons&#8221;</a>.</td>
1.85      jmmv     9630: </tr>
                   9631: <tr>
                   9632: <td>Installs files under
                   9633:         <code class="filename">share/mime/packages</code>.</td>
1.267     rillig   9634: <td>See <a class="xref" href="#mime-database" title="21.6.14. Packages installing extensions to the MIME database">Section 21.6.14, &#8220;Packages installing extensions to the MIME database&#8221;</a>.</td>
1.85      jmmv     9635: </tr>
                   9636: <tr>
                   9637: <td>Installs <code class="filename">.desktop</code> files under
                   9638:         <code class="filename">share/applications</code> and these include MIME
                   9639:         information.</td>
1.267     rillig   9640: <td>See <a class="xref" href="#desktop-files" title="21.6.20. Packages installing desktop files">Section 21.6.20, &#8220;Packages installing desktop files&#8221;</a>.</td>
1.85      jmmv     9641: </tr>
                   9642: </tbody>
1.91      rillig   9643: </table></div>
1.85      jmmv     9644: </div>
1.91      rillig   9645: <br class="table-break">
1.85      jmmv     9646: </div>
1.148     asau     9647: <div class="sect1">
1.85      jmmv     9648: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9649: <a name="full-update"></a>25.3. Updating GNOME to a newer version</h2></div></div></div>
1.85      jmmv     9650: <p>When seeing GNOME as a whole, there are two kinds of
                   9651: updates:</p>
1.148     asau     9652: <div class="variablelist"><dl class="variablelist">
1.85      jmmv     9653: <dt><span class="term">Major update</span></dt>
                   9654: <dd>
                   9655: <p>Given that there is still a very long way for GNOME 3 (if it
                   9656:       ever appears), we consider a major update one that goes from a
                   9657:       <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
                   9658:       where <code class="literal">Y</code> is even and greater than
                   9659:       <code class="literal">X</code>.  These are hard to achieve because they
                   9660:       introduce lots of changes in the components' code and almost all
                   9661:       GNOME distfiles are updated to newer versions.  Some of them can
                   9662:       even break API and ABI compatibility with the previous major
                   9663:       version series.  As a result, the update needs to be done all at
                   9664:       once to minimize breakage.</p>
                   9665: <p>A major update typically consists of around 80 package
                   9666:       updates and the addition of some new ones.</p>
                   9667: </dd>
                   9668: <dt><span class="term">Minor update</span></dt>
                   9669: <dd>
                   9670: <p>We consider a minor update one that goes from a
                   9671:       <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
                   9672:       one where <code class="literal">Y</code> is greater than
                   9673:       <code class="literal">X</code>.  These are easy to achieve because they do
                   9674:       not update all GNOME components, can be done in an incremental way
                   9675:       and do not break API nor ABI compatibility.</p>
                   9676: <p>A minor update typically consists of around 50 package
                   9677:       updates, although the numbers here may vary a lot.</p>
                   9678: </dd>
                   9679: </dl></div>
                   9680: <p>In order to update the GNOME components in pkgsrc to a new stable
                   9681: release (either major or minor), the following steps should be
                   9682: followed:</p>
1.128     wiz      9683: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9684: <li class="listitem">
1.85      jmmv     9685: <p>Get a list of all the tarballs that form the new release by
                   9686:     using the following commands.  These will leave the full list of the
1.120     snj      9687:     components' distfiles into the <code class="filename">list.txt</code>
1.85      jmmv     9688:     file:</p>
1.88      wiz      9689: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85      jmmv     9690:     ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
                   9691:     awk '{ print $9 }' &gt;list.txt</code></strong>
1.88      wiz      9692: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
1.85      jmmv     9693:     ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
                   9694:     awk '{ print $9 }' &gt;&gt;list.txt</code></strong></pre>
                   9695: </li>
1.128     wiz      9696: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
1.85      jmmv     9697:     bump their version to the release you are updating them to.  The
                   9698:     three meta packages should be always consistent with versioning.
                   9699:     Obviously remove any <code class="varname">PKGREVISION</code>s that might be
                   9700:     in them.</p></li>
1.128     wiz      9701: <li class="listitem">
1.85      jmmv     9702: <p>For each meta package, update all its
                   9703:     <code class="varname">DEPENDS</code> lines to match the latest versions as
                   9704:     shown by the above commands.  Do <span class="emphasis"><em>not</em></span> list any
                   9705:     newer version (even if found in the FTP) because the meta packages
                   9706:     are supposed to list the exact versions that form a specific GNOME
                   9707:     release.  Exceptions are permitted here if a newer version solves a
                   9708:     serious issue in the overall desktop experience; these typically
                   9709:     come in the form of a revision bump in pkgsrc, not in newer versions
                   9710:     from the developers.</p>
                   9711: <p>Packages not listed in the <code class="filename">list.txt</code> file
                   9712:     should be updated to the latest version available (if found in
                   9713:     pkgsrc).  This is the case, for example, of the dependencies on the
1.250     leot     9714:     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.85      jmmv     9715: </li>
1.128     wiz      9716: <li class="listitem">
1.85      jmmv     9717: <p>Generate a patch from the modified meta packages and extract the
                   9718:     list of "new" lines.  This will provide you an outline on what
                   9719:     packages need to be updated in pkgsrc and in what order:</p>
1.93      rillig   9720: <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.85      jmmv     9721: </li>
1.128     wiz      9722: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
1.85      jmmv     9723:     installed packages and start over from scratch at this point.</p></li>
1.128     wiz      9724: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
1.85      jmmv     9725:     of <code class="filename">todo.txt</code> and update the packages listed in
                   9726:     it in order.  For major desktop updates none of these should be
1.93      rillig   9727:     committed until the entire set is completed because there are chances
1.85      jmmv     9728:     of breaking not-yet-updated packages.</p></li>
1.128     wiz      9729: <li class="listitem"><p>Once the packages are up to date and working, commit them to
1.85      jmmv     9730:     the tree one by one with appropriate log messages.  At the end,
                   9731:     commit the three meta package updates and all the corresponding
                   9732:     changes to the <code class="filename">doc/CHANGES-&lt;YEAR&gt;</code> and
                   9733:     <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>
                   9734: </ol></div>
                   9735: </div>
1.148     asau     9736: <div class="sect1">
1.85      jmmv     9737: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9738: <a name="patching"></a>25.4. Patching guidelines</h2></div></div></div>
1.85      jmmv     9739: <p>GNOME is a very big component in pkgsrc which approaches 100
                   9740: packages.  Please, it is very important that you always, always,
                   9741: <span class="strong"><strong>always</strong></span> feed back any portability
1.267     rillig   9742: fixes you do to a GNOME package to the mainstream developers (see <a class="xref" href="#components.patches.feedback" title="13.3.5. Feedback to the author">Section 13.3.5, &#8220;Feedback to the author&#8221;</a>).  This is the only way to get
1.85      jmmv     9743: their attention on portability issues and to ensure that future versions
                   9744: can be built out-of-the box on NetBSD.  The less custom patches in
                   9745: pkgsrc, the easier further updates are.  Those developers in charge of
                   9746: issuing major GNOME updates will be grateful if you do that.</p>
1.289     leot     9747: <p>The most common places to report bugs are the <a class="ulink" href="https://bugzilla.gnome.org/" target="_top">GNOME's Bugzilla</a> and the <a class="ulink" href="https://bugzilla.freedesktop.org/" target="_top">freedesktop.org's
1.85      jmmv     9748: Bugzilla</a>.  Not all components use these to track bugs, but most
                   9749: of them do.  Do not be short on your reports: always provide detailed
                   9750: explanations of the current failure, how it can be improved to achieve
                   9751: maximum portability and, if at all possible, provide a patch against CVS
                   9752: head.  The more verbose you are, the higher chances of your patch being
                   9753: accepted.</p>
                   9754: <p>Also, please avoid using preprocessor magic to fix portability
                   9755: issues.  While the FreeBSD GNOME people are doing a great job in porting
                   9756: GNOME to their operating system, the official GNOME sources are now
                   9757: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
                   9758: and similar macros.  This hurts portability.  Please see our patching
1.267     rillig   9759: guidelines (<a class="xref" href="#components.patches.guidelines" title="13.3.4. Patching guidelines">Section 13.3.4, &#8220;Patching guidelines&#8221;</a>) for more
1.85      jmmv     9760: details.</p>
                   9761: </div>
                   9762: </div>
1.75      rillig   9763: </div>
1.148     asau     9764: <div class="part">
1.75      rillig   9765: <div class="titlepage"><div><div><h1 class="title">
                   9766: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.148     asau     9767: <div class="partintro">
1.75      rillig   9768: <div></div>
                   9769: <p>This part of the guide deals with everything
                   9770:        from the infrastructure that is behind the interfaces described
                   9771:        in the developer's guide. A casual package maintainer should not
                   9772:        need anything from this part.</p>
                   9773: <div class="toc">
                   9774: <p><b>Table of Contents</b></p>
1.210     leot     9775: <dl class="toc">
1.267     rillig   9776: <dt><span class="chapter"><a href="#infr.design">26. Design of the pkgsrc infrastructure</a></span></dt>
1.75      rillig   9777: <dd><dl>
1.267     rillig   9778: <dt><span class="sect1"><a href="#infr.vardef">26.1. The meaning of variable definitions</a></span></dt>
                   9779: <dt><span class="sect1"><a href="#infr.vardef.problems">26.2. Avoiding problems before they arise</a></span></dt>
                   9780: <dt><span class="sect1"><a href="#infr.var">26.3. Variable evaluation</a></span></dt>
1.75      rillig   9781: <dd><dl>
1.267     rillig   9782: <dt><span class="sect2"><a href="#infr.var.load">26.3.1. At load time</a></span></dt>
                   9783: <dt><span class="sect2"><a href="#infr.var.run">26.3.2. At runtime</a></span></dt>
1.75      rillig   9784: </dl></dd>
1.267     rillig   9785: <dt><span class="sect1"><a href="#infr.varspec">26.4. How can variables be specified?</a></span></dt>
                   9786: <dt><span class="sect1"><a href="#infr.design.intf">26.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig   9787: <dd><dl>
1.267     rillig   9788: <dt><span class="sect2"><a href="#infr.design.intf.proc">26.5.1. Procedures with parameters</a></span></dt>
                   9789: <dt><span class="sect2"><a href="#infr.design.intf.action">26.5.2. Actions taken on behalf of parameters</a></span></dt>
1.81      rillig   9790: </dl></dd>
1.267     rillig   9791: <dt><span class="sect1"><a href="#infr.order">26.6. The order in which files are loaded</a></span></dt>
1.81      rillig   9792: <dd><dl>
1.267     rillig   9793: <dt><span class="sect2"><a href="#infr.order.prefs">26.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
                   9794: <dt><span class="sect2"><a href="#infr.order.pkg">26.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.75      rillig   9795: </dl></dd>
                   9796: </dl></dd>
1.267     rillig   9797: <dt><span class="chapter"><a href="#regression">27. Regression tests</a></span></dt>
1.75      rillig   9798: <dd><dl>
1.267     rillig   9799: <dt><span class="sect1"><a href="#regression.run">27.1. Running the regression tests</a></span></dt>
                   9800: <dt><span class="sect1"><a href="#regression.new">27.2. Adding a new regression test</a></span></dt>
1.75      rillig   9801: <dd><dl>
1.267     rillig   9802: <dt><span class="sect2"><a href="#regression.fun.override">27.2.1. Overridable functions</a></span></dt>
                   9803: <dt><span class="sect2"><a href="#regression.fun.helper">27.2.2. Helper functions</a></span></dt>
1.75      rillig   9804: </dl></dd>
                   9805: </dl></dd>
1.267     rillig   9806: <dt><span class="chapter"><a href="#porting">28. Porting pkgsrc</a></span></dt>
                   9807: <dd><dl><dt><span class="sect1"><a href="#porting.opsys">28.1. Porting pkgsrc to a new operating system</a></span></dt></dl></dd>
1.75      rillig   9808: </dl>
                   9809: </div>
                   9810: </div>
1.148     asau     9811: <div class="chapter">
1.75      rillig   9812: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   9813: <a name="infr.design"></a>Chapter 26. Design of the pkgsrc infrastructure</h2></div></div></div>
1.75      rillig   9814: <div class="toc">
                   9815: <p><b>Table of Contents</b></p>
1.210     leot     9816: <dl class="toc">
1.267     rillig   9817: <dt><span class="sect1"><a href="#infr.vardef">26.1. The meaning of variable definitions</a></span></dt>
                   9818: <dt><span class="sect1"><a href="#infr.vardef.problems">26.2. Avoiding problems before they arise</a></span></dt>
                   9819: <dt><span class="sect1"><a href="#infr.var">26.3. Variable evaluation</a></span></dt>
1.81      rillig   9820: <dd><dl>
1.267     rillig   9821: <dt><span class="sect2"><a href="#infr.var.load">26.3.1. At load time</a></span></dt>
                   9822: <dt><span class="sect2"><a href="#infr.var.run">26.3.2. At runtime</a></span></dt>
1.81      rillig   9823: </dl></dd>
1.267     rillig   9824: <dt><span class="sect1"><a href="#infr.varspec">26.4. How can variables be specified?</a></span></dt>
                   9825: <dt><span class="sect1"><a href="#infr.design.intf">26.5. Designing interfaces for Makefile fragments</a></span></dt>
1.75      rillig   9826: <dd><dl>
1.267     rillig   9827: <dt><span class="sect2"><a href="#infr.design.intf.proc">26.5.1. Procedures with parameters</a></span></dt>
                   9828: <dt><span class="sect2"><a href="#infr.design.intf.action">26.5.2. Actions taken on behalf of parameters</a></span></dt>
1.75      rillig   9829: </dl></dd>
1.267     rillig   9830: <dt><span class="sect1"><a href="#infr.order">26.6. The order in which files are loaded</a></span></dt>
1.75      rillig   9831: <dd><dl>
1.267     rillig   9832: <dt><span class="sect2"><a href="#infr.order.prefs">26.6.1. The order in <code class="filename">bsd.prefs.mk</code></a></span></dt>
                   9833: <dt><span class="sect2"><a href="#infr.order.pkg">26.6.2. The order in <code class="filename">bsd.pkg.mk</code></a></span></dt>
1.75      rillig   9834: </dl></dd>
                   9835: </dl>
                   9836: </div>
                   9837: <p>The pkgsrc infrastructure consists of many small Makefile
                   9838:        fragments. Each such fragment needs a properly specified
                   9839:        interface. This chapter explains how such an interface looks
                   9840:        like.</p>
1.148     asau     9841: <div class="sect1">
1.75      rillig   9842: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9843: <a name="infr.vardef"></a>26.1. The meaning of variable definitions</h2></div></div></div>
1.81      rillig   9844: <p>Whenever a variable is defined in the pkgsrc
                   9845:        infrastructure, the location and the way of definition provide
                   9846:        much information about the intended use of that variable.
                   9847:        Additionally, more documentation may be found in a header
                   9848:        comment or in this pkgsrc guide.</p>
                   9849: <p>A special file is
                   9850:        <code class="filename">mk/defaults/mk.conf</code>, which lists all
                   9851:        variables that are intended to be user-defined. They are either
                   9852:        defined using the <code class="literal">?=</code> operator or they are
                   9853:        left undefined because defining them to anything would
1.128     wiz      9854:        effectively mean <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. All these variables may be
1.81      rillig   9855:        overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
                   9856:        file.</p>
                   9857: <p>Outside this file, the following conventions apply:
                   9858:        Variables that are defined using the <code class="literal">?=</code>
                   9859:        operator may be overridden by a package.</p>
                   9860: <p>Variables that are defined using the <code class="literal">=</code>
                   9861:        operator may be used read-only at run-time.</p>
                   9862: <p>Variables whose name starts with an underscore must not be
                   9863:        accessed outside the pkgsrc infrastructure at all. They may
                   9864:        change without further notice.</p>
1.148     asau     9865: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.81      rillig   9866: <h3 class="title">Note</h3>
                   9867: <p>These conventions are currently not applied
                   9868:        consistently to the complete pkgsrc
                   9869:        infrastructure.</p>
                   9870: </div>
                   9871: </div>
1.148     asau     9872: <div class="sect1">
1.81      rillig   9873: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9874: <a name="infr.vardef.problems"></a>26.2. Avoiding problems before they arise</h2></div></div></div>
1.81      rillig   9875: <p>All variables that contain lists of things should default
                   9876:        to being empty. Two examples that do not follow this rule are
                   9877:        <code class="varname">USE_LANGUAGES</code> and
                   9878:        <code class="varname">DISTFILES</code>. These variables cannot simply be
                   9879:        modified using the <code class="literal">+=</code> operator in package
                   9880:        <code class="filename">Makefile</code>s (or other files included by
                   9881:        them), since there is no guarantee whether the variable is
                   9882:        already set or not, and what its value is. In the case of
1.128     wiz      9883:        <code class="varname">DISTFILES</code>, the packages <span class="quote">&#8220;<span class="quote">know</span>&#8221;</span>
1.81      rillig   9884:        the default value and just define it as in the following
                   9885:        example.</p>
                   9886: <pre class="programlisting">
1.100     rillig   9887: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
1.81      rillig   9888: </pre>
                   9889: <p>Because of the selection of this default value, the same
                   9890:        value appears in many package Makefiles. Similarly for
                   9891:        <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.128     wiz      9892:        value (<span class="quote">&#8220;<span class="quote"><code class="literal">c</code></span>&#8221;</span>) is so short that it
1.81      rillig   9893:        doesn't stand out. Nevertheless it is mentioned in many
                   9894:        files.</p>
                   9895: </div>
1.148     asau     9896: <div class="sect1">
1.81      rillig   9897: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9898: <a name="infr.var"></a>26.3. Variable evaluation</h2></div></div></div>
1.148     asau     9899: <div class="sect2">
1.75      rillig   9900: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   9901: <a name="infr.var.load"></a>26.3.1. At load time</h3></div></div></div>
1.75      rillig   9902: <p>Variable evaluation takes place either at load time or at
                   9903:        runtime, depending on the context in which they occur. The
                   9904:        contexts where variables are evaluated at load time are:</p>
1.148     asau     9905: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      9906: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.75      rillig   9907:        and <code class="literal">!=</code> operators,</p></li>
1.128     wiz      9908: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.75      rillig   9909:        <code class="literal">.for</code>,</p></li>
1.128     wiz      9910: <li class="listitem"><p>Dependency lines.</p></li>
1.75      rillig   9911: </ul></div>
                   9912: <p>A special exception are references to the iteration
                   9913:        variables of <code class="literal">.for</code> loops, which are expanded
                   9914:        inline, no matter in which context they appear.</p>
                   9915: <p>As the values of variables may change during load time,
                   9916:        care must be taken not to evaluate them by accident. Typical
                   9917:        examples for variables that should not be evaluated at load time
                   9918:        are <code class="varname">DEPENDS</code> and
                   9919:        <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
                   9920:        clear, here is an example:</p>
                   9921: <pre class="programlisting">
1.100     rillig   9922: CONFIGURE_ARGS=         # none
                   9923: CFLAGS=                 -O
                   9924: CONFIGURE_ARGS+=        CFLAGS=${CFLAGS:Q}
1.1       grant    9925: 
1.100     rillig   9926: CONFIGURE_ARGS:=        ${CONFIGURE_ARGS}
1.1       grant    9927: 
1.100     rillig   9928: CFLAGS+=                -Wall
1.222     sevan    9929: </pre>
1.75      rillig   9930: <p>This code shows how the use of the <code class="literal">:=</code>
                   9931:        operator can quickly lead to unexpected results. The first
                   9932:        paragraph is fairly common code. The second paragraph evaluates
                   9933:        the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
                   9934:        <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
                   9935:        <code class="literal">-Wall</code> is appended to the
                   9936:        <code class="varname">CFLAGS</code>, but this addition will not appear in
                   9937:        <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
                   9938:        paragraphs from above typically occur in completely unrelated
                   9939:        files.</p>
                   9940: </div>
1.148     asau     9941: <div class="sect2">
1.75      rillig   9942: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   9943: <a name="infr.var.run"></a>26.3.2. At runtime</h3></div></div></div>
1.75      rillig   9944: <p>After all the files have been loaded, the values of the
                   9945:        variables cannot be changed anymore. Variables that are used in
                   9946:        the shell commands are expanded at this point.</p>
                   9947: </div>
                   9948: </div>
1.148     asau     9949: <div class="sect1">
1.75      rillig   9950: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9951: <a name="infr.varspec"></a>26.4. How can variables be specified?</h2></div></div></div>
1.78      rillig   9952: <p>There are many ways in which the definition and use of a
1.218     rillig   9953:        variable can be restricted in order to detect bugs and violations
                   9954:        of the (mostly unwritten) policies. A package can be checked with
                   9955:        <code class="literal">pkglint -Wall</code> to see whether it meets these
                   9956:        rules.</p>
1.78      rillig   9957: </div>
1.148     asau     9958: <div class="sect1">
1.78      rillig   9959: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   9960: <a name="infr.design.intf"></a>26.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.76      rillig   9961: <p>Most of the <code class="filename">.mk</code> files fall into one
1.75      rillig   9962:        of the following classes. Cases where a file falls into more
                   9963:        than one class should be avoided as it often leads to subtle
                   9964:        bugs.</p>
1.148     asau     9965: <div class="sect2">
1.75      rillig   9966: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   9967: <a name="infr.design.intf.proc"></a>26.5.1. Procedures with parameters</h3></div></div></div>
1.75      rillig   9968: <p>In a traditional imperative programming language some of
1.76      rillig   9969:        the <code class="filename">.mk</code> files could be described as
1.126     jakllsch 9970:        procedures. They take some input parameters and&mdash;after
                   9971:        inclusion&mdash;provide a result in output parameters. Since all
1.76      rillig   9972:        variables in <code class="filename">Makefile</code>s have global scope
1.75      rillig   9973:        care must be taken not to use parameter names that have already
                   9974:        another meaning. For example, <code class="varname">PKGNAME</code> is a
                   9975:        bad choice for a parameter name.</p>
                   9976: <p>Procedures are completely evaluated at preprocessing time.
                   9977:        That is, when calling a procedure all input parameters must be
                   9978:        completely resolvable. For example,
                   9979:        <code class="varname">CONFIGURE_ARGS</code> should never be an input
                   9980:        parameter since it is very likely that further text will be
                   9981:        added after calling the procedure, which would effectively apply
                   9982:        the procedure to only a part of the variable. Also, references
1.218     rillig   9983:        to other variables will be modified after calling the
1.75      rillig   9984:        procedure.</p>
                   9985: <p>A procedure can declare its output parameters either as
                   9986:        suitable for use in preprocessing directives or as only
                   9987:        available at runtime. The latter alternative is for variables
                   9988:        that contain references to other runtime variables.</p>
                   9989: <p>Procedures shall be written such that it is possible to
                   9990:        call the procedure more than once. That is, the file must not
                   9991:        contain multiple-inclusion guards.</p>
                   9992: <p>Examples for procedures are
1.76      rillig   9993:        <code class="filename">mk/bsd.options.mk</code> and
                   9994:        <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
1.75      rillig   9995:        that the parameters are evaluated at load time, they should be
                   9996:        assigned using the <code class="literal">:=</code> operator, which should
                   9997:        be used only for this purpose.</p>
                   9998: </div>
1.148     asau     9999: <div class="sect2">
1.75      rillig   10000: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   10001: <a name="infr.design.intf.action"></a>26.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.75      rillig   10002: <p>Action files take some input parameters and may define
                   10003:        runtime variables. They shall not define loadtime variables.
                   10004:        There are action files that are included implicitly by the
                   10005:        pkgsrc infrastructure, while other must be included
                   10006:        explicitly.</p>
                   10007: <p>An example for action files is
1.76      rillig   10008:        <code class="filename">mk/subst.mk</code>.</p>
1.75      rillig   10009: </div>
                   10010: </div>
1.148     asau     10011: <div class="sect1">
1.81      rillig   10012: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   10013: <a name="infr.order"></a>26.6. The order in which files are loaded</h2></div></div></div>
1.81      rillig   10014: <p>Package <code class="filename">Makefile</code>s usually consist of
                   10015:        a set of variable definitions, and include the file
                   10016:        <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
                   10017:        Before that, they may also include various other
                   10018:        <code class="filename">*.mk</code> files if they need to query the
                   10019:        availability of certain features like the type of compiler or
                   10020:        the X11 implementation. Due to the heavy use of preprocessor
                   10021:        directives like <code class="literal">.if</code> and
                   10022:        <code class="literal">.for</code>, the order in which the files are loaded
                   10023:        matters.</p>
                   10024: <p>This section describes at which point the various files
                   10025:        are loaded and gives reasons for that order.</p>
1.148     asau     10026: <div class="sect2">
1.81      rillig   10027: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   10028: <a name="infr.order.prefs"></a>26.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.93      rillig   10029: </h3></div></div></div>
                   10030: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
1.81      rillig   10031:        is to define some essential variables like
                   10032:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
                   10033:        <code class="varname">MACHINE_ARCH</code>.</p>
                   10034: <p>Then, the user settings are loaded from the file specified
1.110     hubertf  10035:        in <code class="varname">MAKECONF</code>, which is usually <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.
1.104     rillig   10036:        After that, those variables
1.81      rillig   10037:        that have not been overridden by the user are loaded from
                   10038:        <code class="filename">mk/defaults/mk.conf</code>.</p>
                   10039: <p>After the user settings, the system settings and platform
                   10040:        settings are loaded, which may override the user
                   10041:        settings.</p>
                   10042: <p>Then, the tool definitions are loaded. The tool wrappers
                   10043:        are not yet in effect. This only happens when building a
                   10044:        package, so the proper variables must be used instead of the
                   10045:        direct tool names.</p>
                   10046: <p>As the last steps, some essential variables from the
                   10047:        wrapper and the package system flavor are loaded, as well as the
                   10048:        variables that have been cached in earlier phases of a package
                   10049:        build.</p>
                   10050: </div>
1.148     asau     10051: <div class="sect2">
1.81      rillig   10052: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   10053: <a name="infr.order.pkg"></a>26.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.93      rillig   10054: </h3></div></div></div>
1.81      rillig   10055: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
                   10056: <p>Then, the various <code class="filename">*-vars.mk</code> files are
                   10057:        loaded, which fill default values for those variables that have
1.93      rillig   10058:        not been defined by the package. These variables may later
1.81      rillig   10059:        be used even in unrelated files.</p>
                   10060: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
                   10061:        provides the target <code class="literal">error-check</code> that is added
                   10062:        as a special dependency to all other targets that use
                   10063:        <code class="varname">DELAYED_ERROR_MSG</code> or
                   10064:        <code class="varname">DELAYED_WARNING_MSG</code>.</p>
                   10065: <p>Then, the package-specific hacks from
                   10066:        <code class="filename">hacks.mk</code> are included.</p>
                   10067: <p>Then, various other files follow. Most of them don't have
                   10068:        any dependencies on what they need to have included before or
                   10069:        after them, though some do.</p>
                   10070: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
                   10071:        <code class="varname">PKG_SKIP_REASON</code> is then executed, which
                   10072:        restricts the use of these variables to all the files that have
                   10073:        been included before. Appearances in later files will be
                   10074:        silently ignored.</p>
                   10075: <p>Then, the files for the main targets are included, in the
                   10076:        order of later execution, though the actual order should not
                   10077:        matter.</p>
                   10078: <p>At last, some more files are included that don't set any
                   10079:        interesting variables but rather just define make targets to be
                   10080:        executed.</p>
                   10081: </div>
                   10082: </div>
1.75      rillig   10083: </div>
1.148     asau     10084: <div class="chapter">
1.75      rillig   10085: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   10086: <a name="regression"></a>Chapter 27. Regression tests</h2></div></div></div>
1.75      rillig   10087: <div class="toc">
                   10088: <p><b>Table of Contents</b></p>
1.210     leot     10089: <dl class="toc">
1.267     rillig   10090: <dt><span class="sect1"><a href="#regression.run">27.1. Running the regression tests</a></span></dt>
                   10091: <dt><span class="sect1"><a href="#regression.new">27.2. Adding a new regression test</a></span></dt>
1.75      rillig   10092: <dd><dl>
1.267     rillig   10093: <dt><span class="sect2"><a href="#regression.fun.override">27.2.1. Overridable functions</a></span></dt>
                   10094: <dt><span class="sect2"><a href="#regression.fun.helper">27.2.2. Helper functions</a></span></dt>
1.75      rillig   10095: </dl></dd>
                   10096: </dl>
                   10097: </div>
                   10098: <p>The pkgsrc infrastructure consists of a large codebase,
                   10099:        and there are many corners where every little bit of a file is
                   10100:        well thought out, making pkgsrc likely to fail as soon as
                   10101:        anything is changed near those parts. To prevent most changes
                   10102:        from breaking anything, a suite of regression tests should go
                   10103:        along with every important part of the pkgsrc infrastructure.
                   10104:        This chapter describes how regression tests work in pkgsrc and
                   10105:        how you can add new tests.</p>
1.148     asau     10106: <div class="sect1">
1.75      rillig   10107: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   10108: <a name="regression.run"></a>27.1. Running the regression tests</h2></div></div></div>
1.250     leot     10109: <p>You first need to install the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_regress/README.html" target="_top"><code class="filename">pkgtools/pkg_regress</code></a> package, which
1.110     hubertf  10110:        provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.75      rillig   10111:        can simply run that command, which will run all tests in the
1.283     rillig   10112:        <code class="filename">regress/</code> directory.</p>
1.75      rillig   10113: </div>
1.148     asau     10114: <div class="sect1">
1.75      rillig   10115: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   10116: <a name="regression.new"></a>27.2. Adding a new regression test</h2></div></div></div>
1.283     rillig   10117: <p>Every directory in the <code class="filename">regress/</code>
                   10118:        directory that contains a file called <code class="filename">spec</code>
1.75      rillig   10119:        is considered a regression test. This file is a shell program
1.110     hubertf  10120:        that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.75      rillig   10121:        The following functions can be overridden to suit your
                   10122:        needs.</p>
1.148     asau     10123: <div class="sect2">
1.75      rillig   10124: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   10125: <a name="regression.fun.override"></a>27.2.1. Overridable functions</h3></div></div></div>
1.218     rillig   10126: <p>These functions do not take any parameters. Although they
                   10127:        are called in <span class="quote">&#8220;<span class="quote">set -e</span>&#8221;</span> mode, they don't stop at the
1.289     leot     10128:        first failing command. See <a class="ulink" href="https://stackoverflow.com/q/4072984" target="_top">this Stack Overflow
1.218     rillig   10129:        question</a> for details.</p>
1.148     asau     10130: <div class="variablelist"><dl class="variablelist">
1.218     rillig   10131: <dt><span class="term"><code class="varname">do_setup</code></span></dt>
1.75      rillig   10132: <dd><p>This function prepares the environment for the
                   10133:        test. By default it does nothing.</p></dd>
1.218     rillig   10134: <dt><span class="term"><code class="varname">do_test</code></span></dt>
                   10135: <dd>
                   10136: <p>This function runs the actual test. By default,
1.75      rillig   10137:        it calls <code class="varname">TEST_MAKE</code> with the arguments
                   10138:        <code class="varname">MAKEARGS_TEST</code> and writes its output including
                   10139:        error messages into the file
1.218     rillig   10140:        <code class="varname">TEST_OUTFILE</code>.</p>
                   10141: <p>When defining this function, make sure that all output that
                   10142:        needs to be checked is written to the correct output file.
                   10143:        Example:</p>
                   10144: <pre class="programlisting">
                   10145: do_test() {
1.223     rillig   10146:         echo "Example output"
1.218     rillig   10147: } 1&gt;$TEST_OUTFILE 2&gt;&amp;1
                   10148: </pre>
                   10149: </dd>
                   10150: <dt><span class="term"><code class="varname">check_result</code></span></dt>
                   10151: <dd>
                   10152: <p>This function is run after the test and is
1.75      rillig   10153:        typically used to compare the actual output from the one that is
                   10154:        expected. It can make use of the various helper functions from
1.218     rillig   10155:        the next section. Example:</p>
                   10156: <pre class="programlisting">
                   10157: check_result() {
1.223     rillig   10158:         exit_status 0
                   10159:         output_require "Example"
                   10160:         output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
                   10161:         output_prohibit "no such file or directory"
1.283     rillig   10162:         regress_fail "expected $expected but got $actual for input $input"
1.218     rillig   10163: }
                   10164: </pre>
                   10165: </dd>
                   10166: <dt><span class="term"><code class="varname">do_cleanup</code></span></dt>
1.75      rillig   10167: <dd><p>This function cleans everything up after the
                   10168:        test has been run. By default it does nothing.</p></dd>
                   10169: </dl></div>
                   10170: </div>
1.148     asau     10171: <div class="sect2">
1.75      rillig   10172: <div class="titlepage"><div><div><h3 class="title">
1.267     rillig   10173: <a name="regression.fun.helper"></a>27.2.2. Helper functions</h3></div></div></div>
1.148     asau     10174: <div class="variablelist"><dl class="variablelist">
1.283     rillig   10175: <dt><span class="term"><code class="varname">regress_fail <em class="replaceable"><code>message...</code></em></code></span></dt>
                   10176: <dd><p>This function makes the test fail with the given error message.</p></dd>
1.218     rillig   10177: <dt><span class="term"><code class="varname">exit_status expected</code></span></dt>
1.75      rillig   10178: <dd><p>This function compares the exitcode of the
1.218     rillig   10179:        <span class="command"><strong>do_test</strong></span> function with its first parameter.
1.75      rillig   10180:        If they differ, the test will fail.</p></dd>
1.218     rillig   10181: <dt><span class="term"><code class="varname">output_require regex...</code></span></dt>
                   10182: <dd>
                   10183: <p>This function checks for each of its parameters
                   10184:        if the output from <span class="command"><strong>do_test</strong></span> matches the
1.75      rillig   10185:        extended regular expression. If it does not, the test will
1.218     rillig   10186:        fail. Example:</p>
                   10187: <pre class="programlisting">
1.219     rillig   10188: output_require "looks fine"
                   10189: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
1.218     rillig   10190: </pre>
                   10191: </dd>
1.292   ! leot     10192: <dt><span class="term"><code class="varname">output_prohibit regex...</code></span></dt>
1.75      rillig   10193: <dd><p>This function checks for each of its parameters
1.110     hubertf  10194:        if the output from <span class="command"><strong>do_test()</strong></span> does
1.75      rillig   10195:        <span class="emphasis"><em>not</em></span> match the extended regular expression.
                   10196:        If any of the regular expressions matches, the test will
                   10197:        fail.</p></dd>
                   10198: </dl></div>
                   10199: </div>
                   10200: </div>
                   10201: </div>
1.148     asau     10202: <div class="chapter">
1.75      rillig   10203: <div class="titlepage"><div><div><h2 class="title">
1.267     rillig   10204: <a name="porting"></a>Chapter 28. Porting pkgsrc</h2></div></div></div>
1.75      rillig   10205: <div class="toc">
                   10206: <p><b>Table of Contents</b></p>
1.267     rillig   10207: <dl class="toc"><dt><span class="sect1"><a href="#porting.opsys">28.1. Porting pkgsrc to a new operating system</a></span></dt></dl>
1.75      rillig   10208: </div>
                   10209: <p>The pkgsrc system has already been ported to many
                   10210:        operating systems, hardware architectures and compilers. This
                   10211:        chapter explains the necessary steps to make pkgsrc even more
                   10212:        portable.</p>
1.148     asau     10213: <div class="sect1">
1.75      rillig   10214: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   10215: <a name="porting.opsys"></a>28.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.75      rillig   10216: <p>To port pkgsrc to a new operating system (called
                   10217:        <code class="literal">MyOS</code> in this example), you need to touch the
                   10218:        following files:</p>
1.148     asau     10219: <div class="variablelist"><dl class="variablelist">
1.93      rillig   10220: <dt><span class="term"><code class="filename">pkgtools/bootstrap-mk-files/files/mods/<em class="replaceable"><code>MyOS</code></em>.sys.mk</code></span></dt>
1.75      rillig   10221: <dd><p>This file contains some basic definitions, for
                   10222:        example the name of the C
                   10223:        compiler.</p></dd>
1.76      rillig   10224: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
1.75      rillig   10225: <dd><p>Insert code that defines the variables
                   10226:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
                   10227:        <code class="varname">LOWER_OS_VERSION</code>,
                   10228:        <code class="varname">LOWER_VENDOR</code>,
                   10229:        <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
                   10230:        <code class="varname">APPEND_ELF</code>, and the other variables that
                   10231:        appear in this file.</p></dd>
1.93      rillig   10232: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75      rillig   10233: <dd><p>This file contains the platform-specific
                   10234:        definitions that are used by pkgsrc. Start by copying one of the
                   10235:        other files and edit it to your
                   10236:        needs.</p></dd>
1.93      rillig   10237: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
1.75      rillig   10238: <dd><p>This file defines the paths to all the tools
                   10239:        that are needed by one or the other package in pkgsrc, as well
                   10240:        as by pkgsrc itself. Find out where these tools are on your
                   10241:        platform and add them.</p></dd>
                   10242: </dl></div>
                   10243: <p>Now, you should be able to build some basic packages, like
1.250     leot     10244:        <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/perl5/README.html" target="_top"><code class="filename">lang/perl5</code></a>, <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/bash/README.html" target="_top"><code class="filename">shells/bash</code></a>.</p>
1.75      rillig   10245: </div>
                   10246: </div>
                   10247: </div>
1.148     asau     10248: <div class="appendix">
                   10249: <div class="titlepage"><div><div><h1 class="title">
                   10250: <a name="examples"></a>Appendix A. A simple example package: bison</h1></div></div></div>
1.75      rillig   10251: <div class="toc">
                   10252: <p><b>Table of Contents</b></p>
1.210     leot     10253: <dl class="toc">
1.75      rillig   10254: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
                   10255: <dd><dl>
                   10256: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
                   10257: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
                   10258: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.287     rillig   10259: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with pkglint</a></span></dt>
1.75      rillig   10260: </dl></dd>
                   10261: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
                   10262: </dl>
                   10263: </div>
                   10264: <p>We checked to find a piece of software that wasn't in the packages
                   10265:     collection, and picked GNU bison. Quite why someone would want to have
1.110     hubertf  10266:     <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.75      rillig   10267:     present in the tree is beyond us, but it's useful for the purposes of
                   10268:     this exercise.</p>
1.148     asau     10269: <div class="sect1">
1.75      rillig   10270: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10271: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.148     asau     10272: <div class="sect2">
1.75      rillig   10273: <div class="titlepage"><div><div><h3 class="title">
                   10274: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
                   10275: <pre class="programlisting">
1.100     rillig   10276: # $NetBSD$
                   10277: #
1.1       grant    10278: 
1.100     rillig   10279: DISTNAME=       bison-1.25
                   10280: CATEGORIES=     devel
1.286     rillig   10281: MASTER_SITES=   ${MASTER_SITE_GNU:=bison/}
1.1       grant    10282: 
1.136     dholland 10283: MAINTAINER=     pkgsrc-users@NetBSD.org
1.289     leot     10284: HOMEPAGE=       https://www.gnu.org/software/bison/bison.html
1.100     rillig   10285: COMMENT=        GNU yacc clone
1.1       grant    10286: 
1.100     rillig   10287: GNU_CONFIGURE=  yes
1.152     wiz      10288: INFO_FILES=     yes
1.1       grant    10289: 
1.100     rillig   10290: .include "../../mk/bsd.pkg.mk"
1.1       grant    10291: </pre>
1.75      rillig   10292: </div>
1.148     asau     10293: <div class="sect2">
1.75      rillig   10294: <div class="titlepage"><div><div><h3 class="title">
                   10295: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
                   10296: <pre class="programlisting">
1.100     rillig   10297: GNU version of yacc.  Can make re-entrant parsers, and numerous other
1.289     leot     10298: improvements.  Why you would want this when Berkeley <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?yacc+1.i386+NetBSD-9.0"><span class="citerefentry"><span class="refentrytitle">yacc</span>(1)</span></a> is part
1.100     rillig   10299: of the NetBSD source tree is beyond me.
1.1       grant    10300: </pre>
1.75      rillig   10301: </div>
1.148     asau     10302: <div class="sect2">
1.75      rillig   10303: <div class="titlepage"><div><div><h3 class="title">
                   10304: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
                   10305: <pre class="programlisting">
1.100     rillig   10306: @comment $NetBSD$
                   10307: bin/bison
                   10308: man/man1/bison.1.gz
                   10309: share/bison.simple
                   10310: share/bison.hairy
1.1       grant    10311: </pre>
1.75      rillig   10312: </div>
1.148     asau     10313: <div class="sect2">
1.75      rillig   10314: <div class="titlepage"><div><div><h3 class="title">
1.287     rillig   10315: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with pkglint</h3></div></div></div>
1.75      rillig   10316: <p>The NetBSD package system comes with
1.250     leot     10317:         <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>
1.75      rillig   10318:        which helps to check the contents of these
                   10319:        files. After installation it is quite easy to use, just change to the
1.286     rillig   10320:        directory of the package you wish to examine and run
1.110     hubertf  10321:        <span class="command"><strong>pkglint</strong></span>:</p>
1.75      rillig   10322: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
1.286     rillig   10323: ERROR: Makefile: Each package must define its LICENSE.
                   10324: WARN: Makefile:9: HOMEPAGE should migrate from http to https.
                   10325: NOTE: PLIST:3: The .gz extension is unnecessary for manual pages.
                   10326: WARN: PLIST:5: "share/bison.hairy" should be sorted before "share/bison.simple".
                   10327: 1 error, 2 warnings and 1 note found.
                   10328: (Run "pkglint -e" to show explanations.)
                   10329: (Run "pkglint -fs" to show what can be fixed automatically.)
1.287     rillig   10330: (Run "pkglint -F" to automatically fix some issues.)</pre>
1.75      rillig   10331: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.285     rillig   10332:        more checks will be performed. Use e.g. <span class="command"><strong>pkglint
1.75      rillig   10333:        -Wall</strong></span> for a very thorough check.</p>
                   10334: </div>
                   10335: </div>
1.148     asau     10336: <div class="sect1">
1.75      rillig   10337: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10338: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
                   10339: <p>Create the directory where the package lives,
                   10340:       plus any auxiliary directories:</p>
                   10341: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
                   10342: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
                   10343: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
                   10344: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
1.76      rillig   10345: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.267     rillig   10346:       <code class="filename">PLIST</code> (see <a class="xref" href="#components" title="Chapter 13. Package components - files, directories and contents">Chapter 13, <i>Package components - files, directories and contents</i></a>)
1.75      rillig   10347:       then continue with fetching the distfile:</p>
                   10348: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
1.1       grant    10349: &gt;&gt; bison-1.25.tar.gz doesn't seem to exist on this system.
                   10350: &gt;&gt; Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
                   10351: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   10352: ftp: Error retrieving file: 500 Internal error
                   10353: 
                   10354: &gt;&gt; Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
                   10355: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   10356: ftp: Error retrieving file: 500 Internal error
                   10357: 
                   10358: &gt;&gt; Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
                   10359: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
1.75      rillig   10360: Successfully retrieved file.</pre>
                   10361: <p>Generate the checksum of the distfile into
1.76      rillig   10362:       <code class="filename">distinfo</code>:</p>
1.88      wiz      10363: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
1.75      rillig   10364: <p>Now compile:</p>
                   10365: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1       grant    10366: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10367: ===&gt;  Extracting for bison-1.25
                   10368: ===&gt;  Patching for bison-1.25
                   10369: ===&gt;   Ignoring empty patch directory
                   10370: ===&gt;  Configuring for bison-1.25
                   10371: creating cache ./config.cache
                   10372: checking for gcc... cc
                   10373: checking whether we are using GNU C... yes
                   10374: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
                   10375: checking how to run the C preprocessor... cc -E
                   10376: checking for minix/config.h... no
                   10377: checking for POSIXized ISC... no
                   10378: checking whether cross-compiling... no
                   10379: checking for ANSI C header files... yes
                   10380: checking for string.h... yes
                   10381: checking for stdlib.h... yes
                   10382: checking for memory.h... yes
                   10383: checking for working const... yes
                   10384: checking for working alloca.h... no
                   10385: checking for alloca... yes
                   10386: checking for strerror... yes
                   10387: updating cache ./config.cache
                   10388: creating ./config.status
                   10389: creating Makefile
                   10390: ===&gt;  Building for bison-1.25
                   10391: 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
                   10392: 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
                   10393: 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
                   10394: 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
                   10395: cc -c -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1 -I./../include  -g derives.c
1.68      rillig   10396: cc -c -DXPFILE=\"/usr/pkg/share/bison.simple\"  -DXPFILE1=\"/usr/pkg/share/bison.hairy\" -DSTDC_HEADERS=1 -DHAVE_STRING_H=1 -DHAVE_STDLIB_H=1 -DHAVE_MEMORY_H=1 -DHAVE_ALLOCA=1 -DHAVE_STRERROR=1  -g  ./files.c
1.1       grant    10397: 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
                   10398: 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
                   10399: 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
                   10400: 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
                   10401: 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
                   10402: 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
                   10403: 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
                   10404: 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
                   10405: 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
                   10406: 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
                   10407: 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
                   10408: 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
                   10409: 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
                   10410: 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
                   10411: 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
                   10412: 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
                   10413: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
                   10414: rm -f bison.s1
1.75      rillig   10415: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" &lt; ./bison.simple &gt; bison.s1</pre>
                   10416: <p>Everything seems OK, so install the files:</p>
                   10417: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1       grant    10418: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10419: ===&gt;  Installing for bison-1.25
                   10420: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share  /usr/pkg/info /usr/pkg/man/man1
                   10421: rm -f /usr/pkg/bin/bison
                   10422: cd /usr/pkg/share; rm -f bison.simple bison.hairy
                   10423: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
                   10424: install -c  -o bin -g bin -m 555 bison /usr/pkg/bin/bison
                   10425: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
                   10426: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
                   10427: cd .; for f in bison.info*;  do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
                   10428: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
1.75      rillig   10429: ===&gt;  Registering installation for bison-1.25</pre>
                   10430: <p>You can now use bison, and also - if you decide so - remove it with
1.110     hubertf  10431:       <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.75      rillig   10432:       binary package, do this now:</p>
                   10433: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1       grant    10434: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10435: ===&gt;  Building package for bison-1.25
                   10436: Creating package bison-1.25.tgz
                   10437: Registering depends:.
1.75      rillig   10438: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
                   10439: <p>Now that you don't need the source and object files
                   10440:       any more, clean up:</p>
                   10441: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
                   10442: ===&gt;  Cleaning for bison-1.25</pre>
                   10443: </div>
                   10444: </div>
1.148     asau     10445: <div class="appendix">
                   10446: <div class="titlepage"><div><div><h1 class="title">
                   10447: <a name="logs"></a>Appendix B. Build logs</h1></div></div></div>
1.75      rillig   10448: <div class="toc">
                   10449: <p><b>Table of Contents</b></p>
1.210     leot     10450: <dl class="toc">
1.75      rillig   10451: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
                   10452: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
                   10453: </dl>
                   10454: </div>
1.148     asau     10455: <div class="sect1">
1.75      rillig   10456: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10457: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
                   10458: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
1.1       grant    10459: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10460: =&gt; figlet221.tar.gz doesn't seem to exist on this system.
                   10461: =&gt; Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
                   10462: =&gt; [172219 bytes]
                   10463: Connected to ftp.plig.net.
                   10464: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
                   10465: 331 Guest login ok, send your complete e-mail address as password.
                   10466: 230-You are user #5 of 500 simultaneous users allowed.
                   10467: 230-
1.68      rillig   10468: 230-  ___ _             _ _
                   10469: 230- |  _| |_ ___   ___| |_|___   ___ ___ ___
1.1       grant    10470: 230- |  _|  _| . |_| . | | | . |_| . |  _| . |
                   10471: 230- |_| |_| |  _|_|  _|_|_|_  |_|___|_| |_  |
                   10472: 230-         |_|   |_|     |___|         |___|
                   10473: 230-
                   10474: 230-** Welcome to ftp.plig.org **
                   10475: 230-
                   10476: 230-Please note that all transfers from this FTP site are logged. If you
                   10477: 230-do not like this, please disconnect now.
                   10478: 230-
1.120     snj      10479: 230-This archive is available via
1.1       grant    10480: 230-
                   10481: 230-HTTP:  http://ftp.plig.org/
                   10482: 230-FTP:   ftp://ftp.plig.org/     (max 500 connections)
                   10483: 230-RSYNC: rsync://ftp.plig.org/   (max  30 connections)
                   10484: 230-
                   10485: 230-Please email comments, bug reports and requests for packages to be
1.68      rillig   10486: 230-mirrored to ftp-admin@plig.org.
1.1       grant    10487: 230-
                   10488: 230-
                   10489: 230 Logged in anonymously.
                   10490: Remote system type is UNIX.
                   10491: Using binary mode to transfer files.
                   10492: 200 Type okay.
                   10493: 250 "/pub" is new cwd.
                   10494: 250-"/pub/figlet" is new cwd.
                   10495: 250-
                   10496: 250-Welcome to the figlet archive at ftp.figlet.org
1.68      rillig   10497: 250-
1.75      rillig   10498: 250-   ftp://ftp.figlet.org/pub/figlet/
1.1       grant    10499: 250-
                   10500: 250-The official FIGlet web page is:
1.75      rillig   10501: 250-   http://www.figlet.org/
1.1       grant    10502: 250-
                   10503: 250-If you have questions, please mailto:info@figlet.org. If you want to
                   10504: 250-contribute a font or something else, you can email us.
1.68      rillig   10505: 250
1.1       grant    10506: 250 "/pub/figlet/program" is new cwd.
                   10507: 250 "/pub/figlet/program/unix" is new cwd.
                   10508: local: figlet221.tar.gz remote: figlet221.tar.gz
                   10509: 502 Unimplemented command.
                   10510: 227 Entering Passive Mode (195,40,6,41,246,104)
                   10511: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
                   10512: 38% |**************                       | 65800      64.16 KB/s    00:01 ETA
                   10513: 226 Transfer completed.
                   10514: 172219 bytes received in 00:02 (75.99 KB/s)
                   10515: 221 Goodbye.
                   10516: =&gt; Checksum OK for figlet221.tar.gz.
                   10517: ===&gt; Extracting for figlet-2.2.1nb2
                   10518: ===&gt; Required installed package ccache-[0-9]*: ccache-2.3nb1 found
                   10519: ===&gt; Patching for figlet-2.2.1nb2
                   10520: ===&gt; Applying pkgsrc patches for figlet-2.2.1nb2
                   10521: ===&gt; Overriding tools for figlet-2.2.1nb2
                   10522: ===&gt; Creating toolchain wrappers for figlet-2.2.1nb2
                   10523: ===&gt; Configuring for figlet-2.2.1nb2
                   10524: ===&gt; Building for figlet-2.2.1nb2
                   10525: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\"  -DDEFAULTFONTFILE=\"standard.flf\"  figlet.c zipio.c crc.c inflate.c -o figlet
                   10526: chmod a+x figlet
                   10527: gcc -O2 -o chkfont chkfont.c
                   10528: =&gt; Unwrapping files-to-be-installed.
1.14      xtraeme  10529: <code class="prompt">#</code>
1.75      rillig   10530: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
1.1       grant    10531: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10532: ===&gt; Installing for figlet-2.2.1nb2
                   10533: install -d -o root -g wheel -m 755 /usr/pkg/bin
                   10534: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
                   10535: mkdir -p /usr/pkg/share/figlet
                   10536: cp figlet /usr/pkg/bin
                   10537: cp chkfont /usr/pkg/bin
                   10538: chmod 555 figlist showfigfonts
                   10539: cp figlist /usr/pkg/bin
                   10540: cp showfigfonts /usr/pkg/bin
                   10541: cp fonts/*.flf /usr/pkg/share/figlet
                   10542: cp fonts/*.flc /usr/pkg/share/figlet
                   10543: cp figlet.6 /usr/pkg/man/man6
                   10544: ===&gt; Registering installation for figlet-2.2.1nb2
1.75      rillig   10545: <code class="prompt">#</code></pre>
                   10546: </div>
1.148     asau     10547: <div class="sect1">
1.75      rillig   10548: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10549: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
                   10550: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
1.1       grant    10551: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10552: ===&gt; Packaging figlet-2.2.1nb2
                   10553: ===&gt; Building binary package for figlet-2.2.1nb2
                   10554: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
                   10555: Using SrcDir value of /usr/pkg
1.68      rillig   10556: Registering depends:.
1.75      rillig   10557: <code class="prompt">#</code></pre>
                   10558: </div>
                   10559: </div>
1.148     asau     10560: <div class="appendix">
                   10561: <div class="titlepage"><div><div><h1 class="title">
                   10562: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h1></div></div></div>
1.76      rillig   10563: <div class="toc">
                   10564: <p><b>Table of Contents</b></p>
1.210     leot     10565: <dl class="toc">
1.128     wiz      10566: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
                   10567: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
                   10568: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
                   10569: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
                   10570: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
1.261     leot     10571: <code class="filename">stable</code>,
1.128     wiz      10572: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76      rillig   10573: source packages</a></span></dt>
                   10574: </dl>
                   10575: </div>
                   10576: <p>As in other big projects, the directory layout of pkgsrc
                   10577:        is quite complex for newbies. This chapter explains where you
                   10578:        find things on the FTP server. The base directory on
1.110     hubertf  10579:        <code class="filename">ftp.NetBSD.org</code> is <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top"><code class="filename">/pub/pkgsrc/</code></a>.
1.89      rillig   10580:        On other servers it may be different, but inside this directory,
                   10581:        everything should look the same, no matter on which server you
                   10582:        are. This directory contains some subdirectories, which are
                   10583:        explained below.</p>
1.148     asau     10584: <div class="sect1">
1.76      rillig   10585: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126     jakllsch 10586: <a name="ftp-distfiles"></a>C.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
1.76      rillig   10587: <p>The directory <code class="filename">distfiles</code> contains lots
                   10588:        of archive files from all pkgsrc packages, which are mirrored
                   10589:        here. The subdirectories are called after their package names
                   10590:        and are used when the distributed files have names that don't
                   10591:        explicitly contain a version number or are otherwise too generic
                   10592:        (for example <code class="filename">release.tar.gz</code>).</p>
                   10593: </div>
1.148     asau     10594: <div class="sect1">
1.76      rillig   10595: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126     jakllsch 10596: <a name="ftp-misc"></a>C.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
1.76      rillig   10597: <p>This directory contains things that individual pkgsrc
                   10598:        developers find worth publishing.</p>
                   10599: </div>
1.148     asau     10600: <div class="sect1">
1.76      rillig   10601: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126     jakllsch 10602: <a name="ftp-packages"></a>C.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
1.102     rillig   10603: <p>This directory contains binary packages for the various
                   10604:        platforms that are supported by pkgsrc.
                   10605:        Each subdirectory is of the form <em class="replaceable"><code>OPSYS</code></em>/<em class="replaceable"><code>ARCH</code></em>/<em class="replaceable"><code>OSVERSION_TAG</code></em>. The meaning of these variables is:</p>
1.148     asau     10606: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      10607: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
1.109     rillig   10608:        operating system for which the packages have been built. The
1.110     hubertf  10609:        name is taken from the output of the <span class="command"><strong>uname</strong></span>
1.109     rillig   10610:        command, so it may differ from the one you are used to
                   10611:        hear.</p></li>
1.128     wiz      10612: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
1.108     rillig   10613:        architecture of the platform for which the packages have been
1.110     hubertf  10614:        built. It also includes the <code class="varname">ABI</code> (Application
                   10615:        Binary Interface) for platforms that have several of
                   10616:        them.</p></li>
1.128     wiz      10617: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
1.108     rillig   10618:        the operating system. For version numbers that change often (for
                   10619:        example NetBSD-current), the often-changing part should be
                   10620:        replaced with an <code class="literal">x</code>, for example
                   10621:        <code class="literal">4.99.x</code>.</p></li>
1.128     wiz      10622: <li class="listitem"><p><code class="varname">TAG</code> is either
1.126     jakllsch 10623:        <code class="literal">20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
1.108     rillig   10624:        for a stable branch, or <code class="literal">head</code> for packages
                   10625:        built from the HEAD branch. The latter should only be used when
                   10626:        the packages are updated on a regular basis. Otherwise the date
                   10627:        from checking out pkgsrc should be appended, for example
                   10628:        <code class="literal">head_20071015</code>.</p></li>
1.102     rillig   10629: </ul></div>
                   10630: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
                   10631:        can quickly click through the directories on the
                   10632:        server and find the best binary packages for their machines. Since they
                   10633:        usually know the operating system and the hardware architecture, OPSYS
                   10634:        and ARCH are placed first. After these choices, they can select the
                   10635:        best combination of OSVERSION and TAG together, since it is usually the
                   10636:        case that packages stay compatible between different version of the
                   10637:        operating system.</p>
                   10638: <p>In each of these directories, there is a
                   10639:        whole binary packages collection for a specific platform. It has a directory called
1.76      rillig   10640:        <code class="filename">All</code> which contains all binary packages.
                   10641:        Besides that, there are various category directories that
                   10642:        contain symbolic links to the real binary packages.</p>
                   10643: </div>
1.148     asau     10644: <div class="sect1">
1.76      rillig   10645: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126     jakllsch 10646: <a name="ftp-reports"></a>C.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.108     rillig   10647: <p>Here are the reports from bulk builds, for those who want
                   10648:        to fix packages that didn't build on some of the platforms. The
1.128     wiz      10649:        structure of subdirectories should look like the one in <a class="xref" href="#ftp-packages" title="C.3. packages: Binary packages">Section C.3, &#8220;<code class="filename">packages</code>: Binary packages&#8221;</a>.</p>
1.108     rillig   10650: </div>
1.148     asau     10651: <div class="sect1">
1.108     rillig   10652: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.126     jakllsch 10653: <a name="ftp-source"></a>C.5. <code class="filename">current</code>,
1.261     leot     10654: <code class="filename">stable</code>,
1.126     jakllsch 10655: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.76      rillig   10656: source packages</h2></div></div></div>
1.128     wiz      10657: <p>These directories contain the <span class="quote">&#8220;<span class="quote">real</span>&#8221;</span> pkgsrc,
1.76      rillig   10658:        that is the files that define how to create binary packages from
                   10659:        source archives.</p>
1.262     leot     10660: <p>Each of the <code class="filename">current</code>,
                   10661:        <code class="filename">stable</code> and
                   10662:        <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
                   10663:        directories share the same structure.  They each contain a
                   10664:        <code class="filename">pkgsrc</code> directory and
                   10665:        <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> file.</p>
1.76      rillig   10666: <p>The directory <code class="filename">pkgsrc</code> contains a
1.89      rillig   10667:        snapshot of the CVS repository, which is updated regularly. The
1.262     leot     10668:        file <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> contains the same
                   10669:        as the directory, ready to be downloaded as a whole.</p>
                   10670: <p>The <code class="filename">current</code> directory contains files
                   10671:        related to the HEAD branch of the CVS repository.
                   10672:        In this directory there is an additional file called
                   10673:        <code class="filename">pkgsrc-readmes.tar.{bz,gz,xz}</code> that contains
                   10674:        all pkgsrc <code class="filename">README</code>s with information about
                   10675:        categories and packages.
                   10676:        </p>
                   10677: <p>The <code class="filename">stable</code> directory is a symlink to
                   10678:        the latest 
                   10679:        <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
                   10680:        </p>
                   10681: <p>The
                   10682:        <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
                   10683:        directories contain files related to the 
                   10684:        <code class="filename">-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
                   10685:        stable branch of the CVS repository. In these directories there is
                   10686:        an additional file called
                   10687:        <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em>.tar.{bz,gz,xz}</code>,
1.76      rillig   10688:        which contains the state of pkgsrc when it was branched.</p>
                   10689: </div>
1.75      rillig   10690: </div>
1.148     asau     10691: <div class="appendix">
                   10692: <div class="titlepage"><div><div><h1 class="title">
1.267     rillig   10693: <a name="help-topics"></a>Appendix D. Help topics</h1></div></div></div>
                   10694: <p>
                   10695:        The following list contains all help topics that are available
                   10696:        when running <span class="command"><strong>bmake help topic=:index</strong></span>.
                   10697: </p>
1.269     leot     10698: <table border="0" summary="Simple list" class="simplelist">
                   10699: <tr>
                   10700: <td>#!</td>
                   10701: <td>-lintl</td>
                   10702: </tr>
                   10703: <tr>
                   10704: <td>64bit</td>
                   10705: <td>ABI</td>
                   10706: </tr>
                   10707: <tr>
                   10708: <td>ACCEPTABLE_LICENSES</td>
                   10709: <td>ACROREAD_FONTPATH</td>
                   10710: </tr>
                   10711: <tr>
                   10712: <td>ADDITIONAL</td>
                   10713: <td>AFAIK</td>
                   10714: </tr>
                   10715: <tr>
                   10716: <td>AIX</td>
                   10717: <td>ALLOW_VULNERABLE_PACKAGES</td>
                   10718: </tr>
                   10719: <tr>
                   10720: <td>ALL_ENV</td>
1.292   ! leot     10721: <td>ALSA_PC</td>
        !          10722: </tr>
        !          10723: <tr>
1.290     gutterid 10724: <td>ALTERNATIVES_SRC</td>
1.292   ! leot     10725: <td>AMANDA_TMP</td>
1.274     rillig   10726: </tr>
                   10727: <tr>
1.290     gutterid 10728: <td>AMANDA_USER</td>
1.292   ! leot     10729: <td>AMANDA_VAR</td>
1.269     leot     10730: </tr>
                   10731: <tr>
1.290     gutterid 10732: <td>APACHE_GROUP</td>
1.292   ! leot     10733: <td>APACHE_MODULE_NAME</td>
1.269     leot     10734: </tr>
                   10735: <tr>
1.290     gutterid 10736: <td>APACHE_MODULE_SRC</td>
1.292   ! leot     10737: <td>APACHE_MODULE_SRCDIR</td>
1.269     leot     10738: </tr>
                   10739: <tr>
1.290     gutterid 10740: <td>APACHE_PKG_PREFIX</td>
1.292   ! leot     10741: <td>APACHE_SUEXEC_CONFIGURE_ARGS</td>
1.269     leot     10742: </tr>
                   10743: <tr>
1.290     gutterid 10744: <td>APACHE_SUEXEC_DOCROOT</td>
1.292   ! leot     10745: <td>APACHE_USER</td>
1.269     leot     10746: </tr>
                   10747: <tr>
1.290     gutterid 10748: <td>APPEND_ABI</td>
1.292   ! leot     10749: <td>APPEND_ELF</td>
1.269     leot     10750: </tr>
                   10751: <tr>
1.290     gutterid 10752: <td>ARLA_CACHE</td>
1.292   ! leot     10753: <td>AUDIT_PACKAGES_FLAGS</td>
1.269     leot     10754: </tr>
                   10755: <tr>
1.290     gutterid 10756: <td>AUTOCONF_REQD</td>
1.292   ! leot     10757: <td>AUTOMAKE_OVERRIDE</td>
1.269     leot     10758: </tr>
                   10759: <tr>
1.290     gutterid 10760: <td>AUTOMAKE_REQD</td>
1.292   ! leot     10761: <td>AUTO_MKDIRS</td>
1.269     leot     10762: </tr>
                   10763: <tr>
1.290     gutterid 10764: <td>BDB185_DEFAULT</td>
1.292   ! leot     10765: <td>BDBBASE</td>
1.269     leot     10766: </tr>
                   10767: <tr>
1.290     gutterid 10768: <td>BDB_ACCEPTED</td>
1.292   ! leot     10769: <td>BDB_DEFAULT</td>
1.269     leot     10770: </tr>
                   10771: <tr>
1.290     gutterid 10772: <td>BDB_LIBS</td>
1.292   ! leot     10773: <td>BDB_TYPE</td>
1.269     leot     10774: </tr>
                   10775: <tr>
1.290     gutterid 10776: <td>BIND_DIR</td>
1.292   ! leot     10777: <td>BIND_GROUP</td>
1.269     leot     10778: </tr>
                   10779: <tr>
1.290     gutterid 10780: <td>BIND_USER</td>
1.292   ! leot     10781: <td>BINPKG_SITES</td>
1.269     leot     10782: </tr>
                   10783: <tr>
1.290     gutterid 10784: <td>BIN_INSTALL_FLAGS</td>
1.292   ! leot     10785: <td>BISON_PKGDATADIR</td>
        !          10786: </tr>
        !          10787: <tr>
        !          10788: <td>BLAS_ACCEPTED</td>
        !          10789: <td>BLAS_LIBS</td>
1.269     leot     10790: </tr>
                   10791: <tr>
1.292   ! leot     10792: <td>BLAS_TYPE</td>
1.269     leot     10793: <td>BOOTSTRAP_DEPENDS</td>
                   10794: </tr>
                   10795: <tr>
                   10796: <td>BOOTSTRAP_SETUPTOOLS</td>
                   10797: <td>BROKEN</td>
                   10798: </tr>
                   10799: <tr>
                   10800: <td>BROKEN_EXCEPT_ON_PLATFORM</td>
                   10801: <td>BROKEN_ON_PLATFORM</td>
                   10802: </tr>
                   10803: <tr>
                   10804: <td>BSDSRCDIR</td>
                   10805: <td>BSDXSRCDIR</td>
                   10806: </tr>
                   10807: <tr>
                   10808: <td>BSD_MAKE_ENV</td>
                   10809: <td>BUILDLINK_AUTO_DIRS</td>
                   10810: </tr>
                   10811: <tr>
                   10812: <td>BUILDLINK_AUTO_VARS</td>
                   10813: <td>BUILDLINK_CFLAGS</td>
                   10814: </tr>
                   10815: <tr>
                   10816: <td>BUILDLINK_CONTENTS_FILTER</td>
                   10817: <td>BUILDLINK_CPPFLAGS</td>
                   10818: </tr>
                   10819: <tr>
                   10820: <td>BUILDLINK_DEPMETHOD</td>
                   10821: <td>BUILDLINK_FILES</td>
                   10822: </tr>
                   10823: <tr>
                   10824: <td>BUILDLINK_FILES_CMD</td>
                   10825: <td>BUILDLINK_FNAME_TRANSFORM</td>
                   10826: </tr>
                   10827: <tr>
                   10828: <td>BUILDLINK_LDFLAGS</td>
                   10829: <td>BUILDLINK_LIBS</td>
                   10830: </tr>
                   10831: <tr>
                   10832: <td>BUILDLINK_OPSYS_SUPPORT_PTHREAD</td>
                   10833: <td>BUILDLINK_PKGNAME</td>
                   10834: </tr>
                   10835: <tr>
                   10836: <td>BUILDLINK_PREFIX</td>
                   10837: <td>BUILDLINK_RPATHDIRS</td>
                   10838: </tr>
                   10839: <tr>
                   10840: <td>BUILDLINK_TREE</td>
                   10841: <td>BUILD_DEFS</td>
                   10842: </tr>
                   10843: <tr>
                   10844: <td>BUILD_DEFS_EFFECTS</td>
                   10845: <td>BUILD_DEPENDS</td>
                   10846: </tr>
                   10847: <tr>
                   10848: <td>BUILD_DIRS</td>
                   10849: <td>BUILD_ENV_SHELL</td>
                   10850: </tr>
                   10851: <tr>
                   10852: <td>BUILD_MAKE_CMD</td>
                   10853: <td>BUILD_MAKE_FLAGS</td>
                   10854: </tr>
                   10855: <tr>
                   10856: <td>BUILD_TARGET</td>
                   10857: <td>BUILTIN_FIND_FILES</td>
                   10858: </tr>
                   10859: <tr>
                   10860: <td>BUILTIN_FIND_FILES_VAR</td>
                   10861: <td>BUILTIN_FIND_GREP</td>
                   10862: </tr>
                   10863: <tr>
                   10864: <td>BUILTIN_FIND_HEADERS</td>
                   10865: <td>BUILTIN_FIND_HEADERS_VAR</td>
                   10866: </tr>
                   10867: <tr>
                   10868: <td>BUILTIN_PKG</td>
                   10869: <td>BUILTIN_TEST_CURSES_DEFINES</td>
                   10870: </tr>
                   10871: <tr>
                   10872: <td>BUILTIN_TEST_CURSES_FUNCS</td>
                   10873: <td>BUILTIN_VERSION_SCRIPT</td>
                   10874: </tr>
                   10875: <tr>
                   10876: <td>BUILTIN_X11_TYPE</td>
                   10877: <td>BUILTIN_X11_VERSION</td>
                   10878: </tr>
                   10879: <tr>
                   10880: <td>CACTI_GROUP</td>
                   10881: <td>CACTI_USER</td>
                   10882: </tr>
                   10883: <tr>
                   10884: <td>CANNA_GROUP</td>
                   10885: <td>CANNA_USER</td>
                   10886: </tr>
                   10887: <tr>
                   10888: <td>CAT</td>
                   10889: <td>CCACHE_BASE</td>
                   10890: </tr>
                   10891: <tr>
                   10892: <td>CCACHE_DIR</td>
                   10893: <td>CCACHE_LOGFILE</td>
                   10894: </tr>
                   10895: <tr>
                   10896: <td>CC_VERSION</td>
                   10897: <td>CC_VERSION_STRING</td>
                   10898: </tr>
                   10899: <tr>
                   10900: <td>CDRECORD_CONF</td>
                   10901: <td>CDROM_PKG_URL_DIR</td>
                   10902: </tr>
                   10903: <tr>
                   10904: <td>CDROM_PKG_URL_HOST</td>
1.292   ! leot     10905: <td>CHECKOUT_DATE</td>
        !          10906: </tr>
        !          10907: <tr>
1.290     gutterid 10908: <td>CHECK_FAKEHOME</td>
1.292   ! leot     10909: <td>CHECK_FILES</td>
1.274     rillig   10910: </tr>
                   10911: <tr>
1.290     gutterid 10912: <td>CHECK_FILES_SKIP</td>
1.292   ! leot     10913: <td>CHECK_FILES_STRICT</td>
1.269     leot     10914: </tr>
                   10915: <tr>
1.290     gutterid 10916: <td>CHECK_HEADERS</td>
1.292   ! leot     10917: <td>CHECK_HEADERS_SKIP</td>
1.269     leot     10918: </tr>
                   10919: <tr>
1.290     gutterid 10920: <td>CHECK_INTERPRETER</td>
1.292   ! leot     10921: <td>CHECK_INTERPRETER_SKIP</td>
1.269     leot     10922: </tr>
                   10923: <tr>
1.290     gutterid 10924: <td>CHECK_PERMS</td>
1.292   ! leot     10925: <td>CHECK_PERMS_AUTOFIX</td>
1.269     leot     10926: </tr>
                   10927: <tr>
1.290     gutterid 10928: <td>CHECK_PERMS_SKIP</td>
1.292   ! leot     10929: <td>CHECK_PORTABILITY</td>
1.269     leot     10930: </tr>
                   10931: <tr>
1.292   ! leot     10932: <td>CHECK_PORTABILITY_EXPERIMENTAL</td>
1.290     gutterid 10933: <td>CHECK_PORTABILITY_SKIP</td>
1.269     leot     10934: </tr>
                   10935: <tr>
1.274     rillig   10936: <td>CHECK_RELRO</td>
1.290     gutterid 10937: <td>CHECK_RELRO_SKIP</td>
1.269     leot     10938: </tr>
                   10939: <tr>
1.274     rillig   10940: <td>CHECK_RELRO_SUPPORTED</td>
1.290     gutterid 10941: <td>CHECK_SHLIBS</td>
1.269     leot     10942: </tr>
                   10943: <tr>
1.274     rillig   10944: <td>CHECK_SHLIBS_BLACKLIST</td>
1.290     gutterid 10945: <td>CHECK_SHLIBS_SKIP</td>
1.269     leot     10946: </tr>
                   10947: <tr>
1.274     rillig   10948: <td>CHECK_SHLIBS_SUPPORTED</td>
1.290     gutterid 10949: <td>CHECK_SSP</td>
1.269     leot     10950: </tr>
                   10951: <tr>
1.274     rillig   10952: <td>CHECK_SSP_SKIP</td>
1.290     gutterid 10953: <td>CHECK_SSP_SUPPORTED</td>
1.269     leot     10954: </tr>
                   10955: <tr>
1.274     rillig   10956: <td>CHECK_STRIPPED</td>
1.290     gutterid 10957: <td>CHECK_STRIPPED_SKIP</td>
1.269     leot     10958: </tr>
                   10959: <tr>
1.274     rillig   10960: <td>CHECK_WRKREF</td>
1.290     gutterid 10961: <td>CHECK_WRKREF_EXTRA_DIRS</td>
1.269     leot     10962: </tr>
                   10963: <tr>
1.274     rillig   10964: <td>CHECK_WRKREF_SKIP</td>
1.290     gutterid 10965: <td>CLAMAV_DBDIR</td>
1.269     leot     10966: </tr>
                   10967: <tr>
1.274     rillig   10968: <td>CLAMAV_GROUP</td>
1.290     gutterid 10969: <td>CLAMAV_USER</td>
1.269     leot     10970: </tr>
                   10971: <tr>
1.274     rillig   10972: <td>CLANGBASE</td>
1.290     gutterid 10973: <td>CLEANDEPENDS</td>
1.269     leot     10974: </tr>
                   10975: <tr>
1.274     rillig   10976: <td>CMAKE_DEPENDENCIES_REWRITE</td>
1.290     gutterid 10977: <td>CMAKE_INSTALL_PREFIX</td>
1.269     leot     10978: </tr>
                   10979: <tr>
1.274     rillig   10980: <td>CMAKE_MODULE_PATH_OVERRIDE</td>
1.290     gutterid 10981: <td>CMAKE_PKGSRC_BUILD_FLAGS</td>
1.269     leot     10982: </tr>
                   10983: <tr>
1.274     rillig   10984: <td>CMAKE_PREFIX_PATH</td>
1.269     leot     10985: <td>CMAKE_USE_GNU_INSTALL_DIRS</td>
                   10986: </tr>
                   10987: <tr>
1.292   ! leot     10988: <td>COMMON_LISP_DOCFILES</td>
        !          10989: <td>COMMON_LISP_EXAMPLES</td>
        !          10990: </tr>
        !          10991: <tr>
        !          10992: <td>COMMON_LISP_EXTRAFILES</td>
        !          10993: <td>COMMON_LISP_PACKAGES</td>
        !          10994: </tr>
        !          10995: <tr>
        !          10996: <td>COMMON_LISP_SYSTEM</td>
1.269     leot     10997: <td>COMPILER_RPATH_FLAG</td>
1.292   ! leot     10998: </tr>
        !          10999: <tr>
1.269     leot     11000: <td>COMPILER_USE_SYMLINKS</td>
1.292   ! leot     11001: <td>CONFIGURE_ARGS</td>
1.269     leot     11002: </tr>
                   11003: <tr>
                   11004: <td>CONFIGURE_DIRS</td>
1.292   ! leot     11005: <td>CONFIGURE_ENV</td>
1.269     leot     11006: </tr>
                   11007: <tr>
1.287     rillig   11008: <td>CONFIGURE_ENV_SHELL</td>
1.292   ! leot     11009: <td>CONFIGURE_HAS_INFODIR</td>
1.269     leot     11010: </tr>
                   11011: <tr>
                   11012: <td>CONFIGURE_HAS_MANDIR</td>
1.292   ! leot     11013: <td>CONFIGURE_SCRIPT</td>
1.269     leot     11014: </tr>
                   11015: <tr>
                   11016: <td>CONFIG_SHELL</td>
1.292   ! leot     11017: <td>CONFIG_SHELL_FLAGS</td>
1.269     leot     11018: </tr>
                   11019: <tr>
                   11020: <td>CONF_FILES</td>
1.292   ! leot     11021: <td>CONF_FILES_MODE</td>
1.269     leot     11022: </tr>
                   11023: <tr>
                   11024: <td>CONF_FILES_PERMS</td>
1.292   ! leot     11025: <td>CONSERVER_DEFAULTHOST</td>
1.269     leot     11026: </tr>
                   11027: <tr>
                   11028: <td>CONSERVER_DEFAULTPORT</td>
1.292   ! leot     11029: <td>CP</td>
1.269     leot     11030: </tr>
                   11031: <tr>
                   11032: <td>CPP</td>
1.292   ! leot     11033: <td>CPP_PRECOMP_FLAGS</td>
1.269     leot     11034: </tr>
                   11035: <tr>
                   11036: <td>CREATE_WRKDIR_SYMLINK</td>
1.292   ! leot     11037: <td>CROSSBASE</td>
1.269     leot     11038: </tr>
                   11039: <tr>
                   11040: <td>CTFCONVERT</td>
1.292   ! leot     11041: <td>CTF_FILES_SKIP</td>
1.269     leot     11042: </tr>
                   11043: <tr>
                   11044: <td>CTF_SUPPORTED</td>
1.292   ! leot     11045: <td>CTYPE</td>
1.269     leot     11046: </tr>
                   11047: <tr>
                   11048: <td>CUPS_GROUP</td>
1.292   ! leot     11049: <td>CUPS_SYSTEM_GROUPS</td>
1.269     leot     11050: </tr>
                   11051: <tr>
                   11052: <td>CUPS_USER</td>
1.292   ! leot     11053: <td>CURSES_DEFAULT</td>
1.269     leot     11054: </tr>
                   11055: <tr>
                   11056: <td>CURSES_TYPE</td>
1.292   ! leot     11057: <td>CVS_EXTRACTDIR</td>
        !          11058: </tr>
        !          11059: <tr>
        !          11060: <td>CVS_MODULE</td>
        !          11061: <td>CVS_PROJECT</td>
        !          11062: </tr>
        !          11063: <tr>
        !          11064: <td>CVS_REPOSITORIES</td>
        !          11065: <td>CVS_ROOT</td>
        !          11066: </tr>
        !          11067: <tr>
        !          11068: <td>CVS_ROOT_GNU</td>
        !          11069: <td>CVS_ROOT_NONGNU</td>
        !          11070: </tr>
        !          11071: <tr>
        !          11072: <td>CVS_ROOT_SOURCEFORGE</td>
        !          11073: <td>CVS_TAG</td>
1.274     rillig   11074: </tr>
                   11075: <tr>
1.273     brook    11076: <td>CXX</td>
1.290     gutterid 11077: <td>CYRUS_GROUP</td>
1.269     leot     11078: </tr>
                   11079: <tr>
1.273     brook    11080: <td>CYRUS_IDLE</td>
1.290     gutterid 11081: <td>CYRUS_USER</td>
1.269     leot     11082: </tr>
                   11083: <tr>
1.273     brook    11084: <td>DAEMONTOOLS_GROUP</td>
1.290     gutterid 11085: <td>DAEMONTOOLS_LOG_USER</td>
1.269     leot     11086: </tr>
                   11087: <tr>
1.273     brook    11088: <td>DBUS_GROUP</td>
1.290     gutterid 11089: <td>DBUS_USER</td>
1.269     leot     11090: </tr>
                   11091: <tr>
1.273     brook    11092: <td>DEFANG_GROUP</td>
1.290     gutterid 11093: <td>DEFANG_USER</td>
1.269     leot     11094: </tr>
                   11095: <tr>
1.273     brook    11096: <td>DEFAULT_ACCEPTABLE_LICENSES</td>
1.290     gutterid 11097: <td>DEFAULT_DISTFILES</td>
1.269     leot     11098: </tr>
                   11099: <tr>
1.273     brook    11100: <td>DEFAULT_IRC_SERVER</td>
1.290     gutterid 11101: <td>DEFAULT_SERIAL_DEVICE</td>
1.269     leot     11102: </tr>
                   11103: <tr>
1.273     brook    11104: <td>DEF_UMASK</td>
1.290     gutterid 11105: <td>DEINSTALLDEPENDS</td>
1.269     leot     11106: </tr>
                   11107: <tr>
1.273     brook    11108: <td>DEINSTALL_SRC</td>
1.290     gutterid 11109: <td>DEINSTALL_TEMPLATES</td>
1.269     leot     11110: </tr>
                   11111: <tr>
1.273     brook    11112: <td>DELAYED_ERROR_MSG</td>
1.290     gutterid 11113: <td>DELAYED_WARNING_MSG</td>
1.269     leot     11114: </tr>
                   11115: <tr>
1.273     brook    11116: <td>DEPENDS</td>
1.290     gutterid 11117: <td>DEPENDS_TARGET</td>
1.269     leot     11118: </tr>
                   11119: <tr>
1.273     brook    11120: <td>DEPENDS_TYPE</td>
1.290     gutterid 11121: <td>DESTDIR</td>
1.269     leot     11122: </tr>
                   11123: <tr>
1.273     brook    11124: <td>DESTDIR_VARNAME</td>
1.290     gutterid 11125: <td>DIALER_GROUP</td>
1.269     leot     11126: </tr>
                   11127: <tr>
1.273     brook    11128: <td>DIGEST_REQD</td>
1.290     gutterid 11129: <td>DISTDIR</td>
1.269     leot     11130: </tr>
                   11131: <tr>
1.273     brook    11132: <td>DISTFILES</td>
1.290     gutterid 11133: <td>DISTINFO_FILE</td>
1.269     leot     11134: </tr>
                   11135: <tr>
1.273     brook    11136: <td>DISTNAME</td>
1.290     gutterid 11137: <td>DIST_PATH</td>
1.269     leot     11138: </tr>
                   11139: <tr>
1.273     brook    11140: <td>DIST_SUBDIR</td>
1.290     gutterid 11141: <td>DJBDNS_AXFR_USER</td>
1.269     leot     11142: </tr>
                   11143: <tr>
1.273     brook    11144: <td>DJBDNS_CACHE_USER</td>
1.290     gutterid 11145: <td>DJBDNS_DJBDNS_GROUP</td>
1.269     leot     11146: </tr>
                   11147: <tr>
1.273     brook    11148: <td>DJBDNS_LOG_USER</td>
1.290     gutterid 11149: <td>DJBDNS_RBL_USER</td>
1.269     leot     11150: </tr>
                   11151: <tr>
1.273     brook    11152: <td>DJBDNS_TINY_USER</td>
1.290     gutterid 11153: <td>DLOPEN_REQUIRE_PTHREADS</td>
1.269     leot     11154: </tr>
                   11155: <tr>
1.273     brook    11156: <td>DL_AUTO_VARS</td>
1.290     gutterid 11157: <td>DL_CFLAGS</td>
1.269     leot     11158: </tr>
                   11159: <tr>
1.273     brook    11160: <td>DL_LDFLAGS</td>
1.290     gutterid 11161: <td>DL_LIBS</td>
1.269     leot     11162: </tr>
                   11163: <tr>
1.273     brook    11164: <td>DNS</td>
1.290     gutterid 11165: <td>DOWNLOADED_DISTFILE</td>
1.269     leot     11166: </tr>
                   11167: <tr>
1.273     brook    11168: <td>DT_LAYOUT</td>
1.290     gutterid 11169: <td>DYNAMIC_SITES_CMD</td>
1.269     leot     11170: </tr>
                   11171: <tr>
1.273     brook    11172: <td>DYNAMIC_SITES_SCRIPT</td>
1.290     gutterid 11173: <td>ECHO</td>
1.269     leot     11174: </tr>
                   11175: <tr>
1.273     brook    11176: <td>ECHO_N</td>
1.290     gutterid 11177: <td>ELK_GUI</td>
1.269     leot     11178: </tr>
                   11179: <tr>
1.273     brook    11180: <td>EMACS_TYPE</td>
1.290     gutterid 11181: <td>EMULDIR</td>
1.269     leot     11182: </tr>
                   11183: <tr>
1.273     brook    11184: <td>EMULSUBDIR</td>
1.290     gutterid 11185: <td>EMULSUBDIRSLASH</td>
1.269     leot     11186: </tr>
                   11187: <tr>
1.273     brook    11188: <td>EMUL_ARCH</td>
1.290     gutterid 11189: <td>EMUL_DISTRO</td>
1.269     leot     11190: </tr>
                   11191: <tr>
1.273     brook    11192: <td>EMUL_EXEC_FMT</td>
1.290     gutterid 11193: <td>EMUL_IS_NATIVE</td>
1.269     leot     11194: </tr>
                   11195: <tr>
1.273     brook    11196: <td>EMUL_MODULES</td>
1.290     gutterid 11197: <td>EMUL_OPSYS</td>
1.269     leot     11198: </tr>
                   11199: <tr>
1.273     brook    11200: <td>EMUL_PKG_FMT</td>
1.290     gutterid 11201: <td>EMUL_PLATFORM</td>
1.269     leot     11202: </tr>
                   11203: <tr>
1.273     brook    11204: <td>EMUL_PLATFORMS</td>
1.290     gutterid 11205: <td>EMUL_PREFER</td>
1.269     leot     11206: </tr>
                   11207: <tr>
1.273     brook    11208: <td>EMUL_REQD</td>
1.290     gutterid 11209: <td>EMUL_TYPE</td>
1.269     leot     11210: </tr>
                   11211: <tr>
1.273     brook    11212: <td>ERROR_MSG</td>
1.290     gutterid 11213: <td>EXIM_GROUP</td>
1.269     leot     11214: </tr>
                   11215: <tr>
1.273     brook    11216: <td>EXIM_USER</td>
1.290     gutterid 11217: <td>EXPORT_SYMBOLS_LDFLAGS</td>
1.269     leot     11218: </tr>
                   11219: <tr>
1.273     brook    11220: <td>EXTRACTOR</td>
1.290     gutterid 11221: <td>EXTRACT_CMD</td>
1.269     leot     11222: </tr>
                   11223: <tr>
1.273     brook    11224: <td>EXTRACT_CMD_DEFAULT</td>
1.290     gutterid 11225: <td>EXTRACT_DIR</td>
1.269     leot     11226: </tr>
                   11227: <tr>
1.273     brook    11228: <td>EXTRACT_ELEMENTS</td>
1.290     gutterid 11229: <td>EXTRACT_ENV</td>
1.269     leot     11230: </tr>
                   11231: <tr>
1.273     brook    11232: <td>EXTRACT_ONLY</td>
1.290     gutterid 11233: <td>EXTRACT_OPTS</td>
1.269     leot     11234: </tr>
                   11235: <tr>
1.273     brook    11236: <td>EXTRACT_SUFX</td>
1.290     gutterid 11237: <td>EXTRACT_USING</td>
1.269     leot     11238: </tr>
                   11239: <tr>
1.292   ! leot     11240: <td>FAIL</td>
1.273     brook    11241: <td>FAILOVER_FETCH</td>
1.292   ! leot     11242: </tr>
        !          11243: <tr>
1.290     gutterid 11244: <td>FAIL_MSG</td>
1.292   ! leot     11245: <td>FAKE_NCURSES</td>
1.269     leot     11246: </tr>
                   11247: <tr>
1.290     gutterid 11248: <td>FAM</td>
1.292   ! leot     11249: <td>FAM_ACCEPTED</td>
1.269     leot     11250: </tr>
                   11251: <tr>
1.290     gutterid 11252: <td>FAM_DEFAULT</td>
1.292   ! leot     11253: <td>FAM_SERVER</td>
1.269     leot     11254: </tr>
                   11255: <tr>
1.290     gutterid 11256: <td>FCPATH</td>
1.292   ! leot     11257: <td>FEATURE_CPPFLAGS</td>
1.269     leot     11258: </tr>
                   11259: <tr>
1.290     gutterid 11260: <td>FEATURE_LDFLAGS</td>
1.292   ! leot     11261: <td>FEATURE_LIBS</td>
1.269     leot     11262: </tr>
                   11263: <tr>
1.290     gutterid 11264: <td>FETCH_AFTER_ARGS</td>
1.292   ! leot     11265: <td>FETCH_BEFORE_ARGS</td>
1.269     leot     11266: </tr>
                   11267: <tr>
1.290     gutterid 11268: <td>FETCH_CMD</td>
1.292   ! leot     11269: <td>FETCH_OUTPUT_ARGS</td>
1.269     leot     11270: </tr>
                   11271: <tr>
1.290     gutterid 11272: <td>FETCH_PROXY</td>
1.292   ! leot     11273: <td>FETCH_RESUME_ARGS</td>
1.269     leot     11274: </tr>
                   11275: <tr>
1.290     gutterid 11276: <td>FETCH_USING</td>
1.292   ! leot     11277: <td>FILES_SUBST</td>
1.269     leot     11278: </tr>
                   11279: <tr>
1.290     gutterid 11280: <td>FILES_SUBST_SED</td>
1.292   ! leot     11281: <td>FIX_SYSTEM_HEADERS</td>
1.269     leot     11282: </tr>
                   11283: <tr>
1.290     gutterid 11284: <td>FLUXBOX_USE_GNOME</td>
1.292   ! leot     11285: <td>FLUXBOX_USE_KDE</td>
1.269     leot     11286: </tr>
                   11287: <tr>
1.290     gutterid 11288: <td>FLUXBOX_USE_XFT</td>
1.292   ! leot     11289: <td>FLUXBOX_USE_XINERAMA</td>
1.269     leot     11290: </tr>
                   11291: <tr>
1.292   ! leot     11292: <td>FONTDIR</td>
1.269     leot     11293: <td>FONTS_DIRS</td>
                   11294: </tr>
                   11295: <tr>
1.287     rillig   11296: <td>FONTS_VERBOSE</td>
1.269     leot     11297: <td>FOO_HACKS_MK</td>
1.274     rillig   11298: </tr>
                   11299: <tr>
1.292   ! leot     11300: <td>FOSSIL_EXTRACTDIR</td>
        !          11301: <td>FOSSIL_REPO</td>
        !          11302: </tr>
        !          11303: <tr>
        !          11304: <td>FOSSIL_REPOSITORIES</td>
        !          11305: <td>FOSSIL_VERSION</td>
        !          11306: </tr>
        !          11307: <tr>
1.287     rillig   11308: <td>FOX_USE_XUNICODE</td>
1.269     leot     11309: <td>FREEWNN_GROUP</td>
                   11310: </tr>
                   11311: <tr>
1.287     rillig   11312: <td>FREEWNN_USER</td>
1.269     leot     11313: <td>FTP_PKG_URL_DIR</td>
                   11314: </tr>
                   11315: <tr>
1.287     rillig   11316: <td>FTP_PKG_URL_HOST</td>
1.269     leot     11317: <td>GAMEDATAMODE</td>
                   11318: </tr>
                   11319: <tr>
1.287     rillig   11320: <td>GAMEDATA_PERMS</td>
1.269     leot     11321: <td>GAMEDIRMODE</td>
                   11322: </tr>
                   11323: <tr>
1.287     rillig   11324: <td>GAMEDIR_PERMS</td>
1.269     leot     11325: <td>GAMEGRP</td>
                   11326: </tr>
                   11327: <tr>
1.287     rillig   11328: <td>GAMEMODE</td>
1.269     leot     11329: <td>GAMEOWN</td>
                   11330: </tr>
                   11331: <tr>
1.287     rillig   11332: <td>GAMES_GROUP</td>
1.269     leot     11333: <td>GAMES_USER</td>
                   11334: </tr>
                   11335: <tr>
1.287     rillig   11336: <td>GCC</td>
1.269     leot     11337: <td>GCCBASE</td>
                   11338: </tr>
                   11339: <tr>
1.287     rillig   11340: <td>GCC_REQD</td>
1.269     leot     11341: <td>GCC_VERSION_SUFFIX</td>
                   11342: </tr>
                   11343: <tr>
1.287     rillig   11344: <td>GEM_BUILD</td>
1.269     leot     11345: <td>GEM_CLEANBUILD</td>
                   11346: </tr>
                   11347: <tr>
1.287     rillig   11348: <td>GEM_CLEANBUILD_EXTENSIONS</td>
1.269     leot     11349: <td>GEM_DOCDIR</td>
                   11350: </tr>
                   11351: <tr>
1.287     rillig   11352: <td>GEM_EXTSDIR</td>
1.269     leot     11353: <td>GEM_HOME</td>
                   11354: </tr>
                   11355: <tr>
1.292   ! leot     11356: <td>GEM_KEEPBUILD</td>
1.287     rillig   11357: <td>GEM_LIBDIR</td>
1.292   ! leot     11358: </tr>
        !          11359: <tr>
1.269     leot     11360: <td>GEM_NAME</td>
1.292   ! leot     11361: <td>GEM_PATH</td>
1.269     leot     11362: </tr>
                   11363: <tr>
                   11364: <td>GEM_SPECFILE</td>
1.292   ! leot     11365: <td>GENERATE_PLIST</td>
1.269     leot     11366: </tr>
                   11367: <tr>
                   11368: <td>GHOSTSCRIPT_REQD</td>
1.292   ! leot     11369: <td>GITHUB_PROJECT</td>
1.269     leot     11370: </tr>
                   11371: <tr>
                   11372: <td>GITHUB_RELEASE</td>
1.292   ! leot     11373: <td>GITHUB_TAG</td>
1.269     leot     11374: </tr>
                   11375: <tr>
                   11376: <td>GITHUB_TYPE</td>
1.292   ! leot     11377: <td>GITLAB_PROJECT</td>
        !          11378: </tr>
        !          11379: <tr>
        !          11380: <td>GITLAB_TAG</td>
        !          11381: <td>GITLAB_TYPE</td>
        !          11382: </tr>
        !          11383: <tr>
        !          11384: <td>GIT_BRANCH</td>
        !          11385: <td>GIT_ENV</td>
1.274     rillig   11386: </tr>
                   11387: <tr>
1.292   ! leot     11388: <td>GIT_EXTRACTDIR</td>
        !          11389: <td>GIT_REPO</td>
        !          11390: </tr>
        !          11391: <tr>
        !          11392: <td>GIT_REPOSITORIES</td>
        !          11393: <td>GIT_REVISION</td>
        !          11394: </tr>
        !          11395: <tr>
        !          11396: <td>GIT_TAG</td>
1.273     brook    11397: <td>GNU</td>
1.292   ! leot     11398: </tr>
        !          11399: <tr>
1.290     gutterid 11400: <td>GNU_CONFIGURE</td>
1.292   ! leot     11401: <td>GNU_CONFIGURE_INFODIR</td>
1.269     leot     11402: </tr>
                   11403: <tr>
1.290     gutterid 11404: <td>GNU_CONFIGURE_MANDIR</td>
1.292   ! leot     11405: <td>GNU_CONFIGURE_STRICT</td>
1.269     leot     11406: </tr>
                   11407: <tr>
1.290     gutterid 11408: <td>GODEP_REDIRECTS</td>
1.292   ! leot     11409: <td>GO_BUILD_PATTERN</td>
1.269     leot     11410: </tr>
                   11411: <tr>
1.290     gutterid 11412: <td>GO_DEPS</td>
1.292   ! leot     11413: <td>GO_DIST_BASE</td>
1.269     leot     11414: </tr>
                   11415: <tr>
1.290     gutterid 11416: <td>GO_MODULE_FILES</td>
1.292   ! leot     11417: <td>GO_SRCPATH</td>
1.269     leot     11418: </tr>
                   11419: <tr>
1.276     leot     11420: <td>GO_VERSION_DEFAULT</td>
1.292   ! leot     11421: <td>GROUP_SPECIFIC_PKGS</td>
1.276     leot     11422: </tr>
                   11423: <tr>
1.274     rillig   11424: <td>GRUB_NETWORK_CARDS</td>
1.292   ! leot     11425: <td>GRUB_PRESET_COMMAND</td>
1.269     leot     11426: </tr>
                   11427: <tr>
1.274     rillig   11428: <td>GRUB_SCAN_ARGS</td>
1.292   ! leot     11429: <td>GZIP</td>
1.269     leot     11430: </tr>
                   11431: <tr>
1.274     rillig   11432: <td>HASKELL_COMPILER</td>
1.292   ! leot     11433: <td>HASKELL_ENABLE_HADDOCK_DOCUMENTATION</td>
1.269     leot     11434: </tr>
                   11435: <tr>
1.274     rillig   11436: <td>HASKELL_ENABLE_LIBRARY_PROFILING</td>
1.292   ! leot     11437: <td>HASKELL_ENABLE_SHARED_LIBRARY</td>
1.269     leot     11438: </tr>
                   11439: <tr>
1.284     rillig   11440: <td>HASKELL_OPTIMIZATION_LEVEL</td>
1.292   ! leot     11441: <td>HAS_CONFIGURE</td>
1.269     leot     11442: </tr>
                   11443: <tr>
1.284     rillig   11444: <td>HEADER_TEMPLATES</td>
1.292   ! leot     11445: <td>HG_REPO</td>
        !          11446: </tr>
        !          11447: <tr>
        !          11448: <td>HG_REPOSITORIES</td>
        !          11449: <td>HG_TAG</td>
1.274     rillig   11450: </tr>
                   11451: <tr>
1.284     rillig   11452: <td>HOST_PKGTOOLS_ARGS</td>
1.290     gutterid 11453: <td>HOST_SPECIFIC_PKGS</td>
1.269     leot     11454: </tr>
                   11455: <tr>
1.284     rillig   11456: <td>HOWL_GROUP</td>
1.290     gutterid 11457: <td>HOWL_USER</td>
1.269     leot     11458: </tr>
                   11459: <tr>
1.284     rillig   11460: <td>ICCBASE</td>
1.290     gutterid 11461: <td>ICECAST_CHROOTDIR</td>
1.269     leot     11462: </tr>
                   11463: <tr>
1.284     rillig   11464: <td>ICON_THEMES</td>
1.290     gutterid 11465: <td>IDOBASE</td>
1.269     leot     11466: </tr>
                   11467: <tr>
1.284     rillig   11468: <td>IGNORE_CCACHE</td>
1.290     gutterid 11469: <td>IGNORE_INFO_DIRS</td>
1.269     leot     11470: </tr>
                   11471: <tr>
1.284     rillig   11472: <td>IGNORE_INTERACTIVE_FETCH</td>
1.290     gutterid 11473: <td>IMAKE</td>
1.269     leot     11474: </tr>
                   11475: <tr>
1.284     rillig   11476: <td>IMAKEOPTS</td>
1.290     gutterid 11477: <td>IMAKE_MAKE</td>
1.269     leot     11478: </tr>
                   11479: <tr>
1.284     rillig   11480: <td>IMAKE_MANINSTALL</td>
1.290     gutterid 11481: <td>IMAP_UW_CCLIENT_MBOX_FMT</td>
1.269     leot     11482: </tr>
                   11483: <tr>
1.284     rillig   11484: <td>IMDICTDIR</td>
1.290     gutterid 11485: <td>INCOMPAT_CURSES</td>
1.269     leot     11486: </tr>
                   11487: <tr>
1.284     rillig   11488: <td>INFO_DIR</td>
1.290     gutterid 11489: <td>INFO_FILES</td>
1.269     leot     11490: </tr>
                   11491: <tr>
1.284     rillig   11492: <td>INFO_FILES_VERBOSE</td>
1.290     gutterid 11493: <td>INFO_MSG</td>
1.269     leot     11494: </tr>
                   11495: <tr>
1.284     rillig   11496: <td>INIT_SYSTEM</td>
1.290     gutterid 11497: <td>INN_DATA_DIR</td>
1.269     leot     11498: </tr>
                   11499: <tr>
1.284     rillig   11500: <td>INN_GROUP</td>
1.290     gutterid 11501: <td>INN_USER</td>
1.269     leot     11502: </tr>
                   11503: <tr>
1.284     rillig   11504: <td>INSTALLATION_DIRS</td>
1.290     gutterid 11505: <td>INSTALLATION_DIRS_FROM_PLIST</td>
1.287     rillig   11506: </tr>
                   11507: <tr>
                   11508: <td>INSTALL_ENV</td>
1.290     gutterid 11509: <td>INSTALL_SH_OVERRIDE</td>
1.269     leot     11510: </tr>
                   11511: <tr>
1.287     rillig   11512: <td>INSTALL_SRC</td>
1.290     gutterid 11513: <td>INSTALL_TEMPLATES</td>
1.269     leot     11514: </tr>
                   11515: <tr>
1.287     rillig   11516: <td>INSTALL_UNSTRIPPED</td>
1.290     gutterid 11517: <td>IRCD_HYBRID_IRC_GROUP</td>
1.269     leot     11518: </tr>
                   11519: <tr>
1.287     rillig   11520: <td>IRCD_HYBRID_IRC_USER</td>
1.290     gutterid 11521: <td>IRCD_HYBRID_MAXCONN</td>
1.269     leot     11522: </tr>
                   11523: <tr>
1.287     rillig   11524: <td>IRCD_HYBRID_NICLEN</td>
1.290     gutterid 11525: <td>IRCD_HYBRID_SYSLOG_EVENTS</td>
1.269     leot     11526: </tr>
                   11527: <tr>
1.287     rillig   11528: <td>IRCD_HYBRID_SYSLOG_FACILITY</td>
1.290     gutterid 11529: <td>IRCD_HYBRID_TOPICLEN</td>
1.269     leot     11530: </tr>
                   11531: <tr>
1.287     rillig   11532: <td>IRIX</td>
1.290     gutterid 11533: <td>IRRD_USE_PGP</td>
1.269     leot     11534: </tr>
                   11535: <tr>
1.287     rillig   11536: <td>JABBERD_GROUP</td>
1.290     gutterid 11537: <td>JABBERD_LOGDIR</td>
1.269     leot     11538: </tr>
                   11539: <tr>
1.287     rillig   11540: <td>JABBERD_PIDDIR</td>
1.290     gutterid 11541: <td>JABBERD_SPOOLDIR</td>
1.269     leot     11542: </tr>
                   11543: <tr>
1.287     rillig   11544: <td>JABBERD_USER</td>
1.269     leot     11545: <td>JAKARTA_HOME</td>
                   11546: </tr>
                   11547: <tr>
1.292   ! leot     11548: <td>JAVA_APP_PATH</td>
        !          11549: <td>JAVA_APP_TARGETS</td>
        !          11550: </tr>
        !          11551: <tr>
1.287     rillig   11552: <td>JAVA_BINPREFIX</td>
1.290     gutterid 11553: <td>JAVA_CLASSPATH</td>
1.274     rillig   11554: </tr>
                   11555: <tr>
1.287     rillig   11556: <td>JAVA_HOME</td>
1.290     gutterid 11557: <td>JAVA_LD_LIBRARY_PATH</td>
1.269     leot     11558: </tr>
                   11559: <tr>
1.287     rillig   11560: <td>JAVA_NAME</td>
1.290     gutterid 11561: <td>JAVA_UNLIMIT</td>
1.269     leot     11562: </tr>
                   11563: <tr>
1.287     rillig   11564: <td>JAVA_WRAPPERS</td>
1.290     gutterid 11565: <td>JPEG_ACCEPTED</td>
1.269     leot     11566: </tr>
                   11567: <tr>
1.287     rillig   11568: <td>JPEG_DEFAULT</td>
1.290     gutterid 11569: <td>KERBEROS</td>
1.269     leot     11570: </tr>
                   11571: <tr>
1.287     rillig   11572: <td>KERMIT_SUID_UUCP</td>
1.290     gutterid 11573: <td>KJS_USE_PCRE</td>
1.269     leot     11574: </tr>
                   11575: <tr>
1.287     rillig   11576: <td>KNEWS_DOMAIN_FILE</td>
1.290     gutterid 11577: <td>KNEWS_DOMAIN_NAME</td>
1.269     leot     11578: </tr>
                   11579: <tr>
1.287     rillig   11580: <td>KRB5_ACCEPTED</td>
1.290     gutterid 11581: <td>KRB5_DEFAULT</td>
1.269     leot     11582: </tr>
                   11583: <tr>
1.287     rillig   11584: <td>LANGUAGES</td>
1.292   ! leot     11585: <td>LAPACK_LIBS</td>
        !          11586: </tr>
        !          11587: <tr>
1.287     rillig   11588: <td>LATEX2HTML_ICONPATH</td>
1.292   ! leot     11589: <td>LDCONFIG_ADD_CMD</td>
1.271     brook    11590: </tr>
                   11591: <tr>
1.287     rillig   11592: <td>LDCONFIG_REMOVE_CMD</td>
1.292   ! leot     11593: <td>LEAFNODE_DATA_DIR</td>
1.269     leot     11594: </tr>
                   11595: <tr>
1.287     rillig   11596: <td>LEAFNODE_GROUP</td>
1.292   ! leot     11597: <td>LEAFNODE_USER</td>
1.269     leot     11598: </tr>
                   11599: <tr>
1.287     rillig   11600: <td>LIBDVDCSS_HOMEPAGE</td>
1.292   ! leot     11601: <td>LIBDVDCSS_MASTER_SITES</td>
1.269     leot     11602: </tr>
                   11603: <tr>
1.287     rillig   11604: <td>LIBRSVG_TYPE</td>
1.292   ! leot     11605: <td>LIBTOOL</td>
1.269     leot     11606: </tr>
                   11607: <tr>
1.287     rillig   11608: <td>LIBTOOLIZE_PLIST</td>
1.292   ! leot     11609: <td>LIBTOOL_M4_OVERRIDE</td>
1.270     leot     11610: </tr>
                   11611: <tr>
1.287     rillig   11612: <td>LIBUSB_TYPE</td>
1.292   ! leot     11613: <td>LICENSE</td>
1.269     leot     11614: </tr>
                   11615: <tr>
1.287     rillig   11616: <td>LINKER_RPATH_FLAG</td>
1.292   ! leot     11617: <td>LINK_RPATH_FLAG</td>
        !          11618: </tr>
        !          11619: <tr>
        !          11620: <td>LINUX_BASE_NODEPS</td>
        !          11621: <td>LINUX_BASE_PREFERRED</td>
1.269     leot     11622: </tr>
                   11623: <tr>
1.292   ! leot     11624: <td>LINUX_BASE_REQUIRED</td>
1.290     gutterid 11625: <td>LINUX_LOCALES</td>
1.274     rillig   11626: </tr>
                   11627: <tr>
1.287     rillig   11628: <td>LOCALBASE</td>
1.290     gutterid 11629: <td>LOCALBASE_LOCKTYPE</td>
1.269     leot     11630: </tr>
                   11631: <tr>
1.287     rillig   11632: <td>LOCALPATCHES</td>
1.290     gutterid 11633: <td>LOVE_DATA</td>
1.269     leot     11634: </tr>
                   11635: <tr>
1.287     rillig   11636: <td>LOVE_GAME</td>
1.290     gutterid 11637: <td>LOVE_VERSION</td>
1.269     leot     11638: </tr>
                   11639: <tr>
1.287     rillig   11640: <td>LP64PLATFORMS</td>
1.290     gutterid 11641: <td>MACHINE_PLATFORM</td>
1.269     leot     11642: </tr>
                   11643: <tr>
1.287     rillig   11644: <td>MAILAGENT_DOMAIN</td>
1.290     gutterid 11645: <td>MAILAGENT_EMAIL</td>
1.269     leot     11646: </tr>
                   11647: <tr>
1.287     rillig   11648: <td>MAILAGENT_FQDN</td>
1.290     gutterid 11649: <td>MAILAGENT_ORGANIZATION</td>
1.269     leot     11650: </tr>
                   11651: <tr>
1.287     rillig   11652: <td>MAJORDOMO_HOMEDIR</td>
1.292   ! leot     11653: <td>MAJOR_OS_VERSION</td>
1.274     rillig   11654: </tr>
                   11655: <tr>
1.292   ! leot     11656: <td>MAKEINFO_ARGS</td>
1.274     rillig   11657: <td>MAKE_DIRS</td>
1.269     leot     11658: </tr>
                   11659: <tr>
1.292   ! leot     11660: <td>MAKE_DIRS_PERMS</td>
1.274     rillig   11661: <td>MAKE_ENV</td>
1.269     leot     11662: </tr>
                   11663: <tr>
1.292   ! leot     11664: <td>MAKE_FILE</td>
1.274     rillig   11665: <td>MAKE_FLAGS</td>
1.269     leot     11666: </tr>
                   11667: <tr>
1.292   ! leot     11668: <td>MAKE_JOBS</td>
1.274     rillig   11669: <td>MAKE_JOBS_SAFE</td>
1.269     leot     11670: </tr>
                   11671: <tr>
1.292   ! leot     11672: <td>MAKE_PROGRAM</td>
1.274     rillig   11673: <td>MANINSTALL</td>
1.269     leot     11674: </tr>
                   11675: <tr>
1.292   ! leot     11676: <td>MANZ</td>
1.274     rillig   11677: <td>MASTER_SITES</td>
1.269     leot     11678: </tr>
                   11679: <tr>
1.292   ! leot     11680: <td>MASTER_SITE_BACKUP</td>
1.287     rillig   11681: <td>MASTER_SITE_LOCAL</td>
1.269     leot     11682: </tr>
                   11683: <tr>
1.274     rillig   11684: <td>MASTER_SITE_MOZILLA</td>
1.292   ! leot     11685: <td>MASTER_SITE_OVERRIDE</td>
1.269     leot     11686: </tr>
                   11687: <tr>
1.287     rillig   11688: <td>MASTER_SITE_PERL_CPAN</td>
                   11689: <td>MASTER_SORT</td>
1.269     leot     11690: </tr>
                   11691: <tr>
1.274     rillig   11692: <td>MASTER_SORT_RANDOM</td>
1.287     rillig   11693: <td>MASTER_SORT_REGEX</td>
1.269     leot     11694: </tr>
                   11695: <tr>
1.274     rillig   11696: <td>MECAB_CHARSET</td>
1.287     rillig   11697: <td>MEDIATOMB_GROUP</td>
1.269     leot     11698: </tr>
                   11699: <tr>
1.274     rillig   11700: <td>MEDIATOMB_USER</td>
1.287     rillig   11701: <td>MIPSPROBASE</td>
1.269     leot     11702: </tr>
                   11703: <tr>
1.274     rillig   11704: <td>MIREDO_GROUP</td>
1.287     rillig   11705: <td>MIREDO_USER</td>
1.269     leot     11706: </tr>
                   11707: <tr>
1.274     rillig   11708: <td>MISSING_FEATURES</td>
1.287     rillig   11709: <td>MKDIR</td>
1.269     leot     11710: </tr>
                   11711: <tr>
1.274     rillig   11712: <td>MLDONKEY_GROUP</td>
1.287     rillig   11713: <td>MLDONKEY_HOME</td>
1.269     leot     11714: </tr>
                   11715: <tr>
1.274     rillig   11716: <td>MLDONKEY_USER</td>
1.287     rillig   11717: <td>MONOTONE_GROUP</td>
1.269     leot     11718: </tr>
                   11719: <tr>
1.274     rillig   11720: <td>MONOTONE_USER</td>
1.287     rillig   11721: <td>MOTIFBASE</td>
1.269     leot     11722: </tr>
                   11723: <tr>
1.274     rillig   11724: <td>MOTIF_TYPE</td>
1.287     rillig   11725: <td>MOTIF_TYPE_DEFAULT</td>
1.269     leot     11726: </tr>
                   11727: <tr>
1.274     rillig   11728: <td>MPI_TYPE</td>
1.287     rillig   11729: <td>MSGFMT_STRIP_MSGCTXT</td>
1.269     leot     11730: </tr>
                   11731: <tr>
1.274     rillig   11732: <td>MSGFMT_STRIP_MSGID_PLURAL</td>
1.287     rillig   11733: <td>MTOOLS_ENABLE_FLOPPYD</td>
1.269     leot     11734: </tr>
                   11735: <tr>
1.274     rillig   11736: <td>MUST</td>
1.287     rillig   11737: <td>MV</td>
1.269     leot     11738: </tr>
                   11739: <tr>
1.274     rillig   11740: <td>MYSQL_CHARSET</td>
1.287     rillig   11741: <td>MYSQL_DATADIR</td>
1.269     leot     11742: </tr>
                   11743: <tr>
1.274     rillig   11744: <td>MYSQL_EXTRA_CHARSET</td>
1.287     rillig   11745: <td>MYSQL_GROUP</td>
1.269     leot     11746: </tr>
                   11747: <tr>
1.274     rillig   11748: <td>MYSQL_PKGSRCDIR</td>
1.287     rillig   11749: <td>MYSQL_USER</td>
1.269     leot     11750: </tr>
                   11751: <tr>
1.274     rillig   11752: <td>MYSQL_VERSIONS_ACCEPTED</td>
1.287     rillig   11753: <td>MYSQL_VERSION_DEFAULT</td>
1.269     leot     11754: </tr>
                   11755: <tr>
1.274     rillig   11756: <td>NAGIOSCMD_GROUP</td>
1.287     rillig   11757: <td>NAGIOSDIR</td>
1.269     leot     11758: </tr>
                   11759: <tr>
1.274     rillig   11760: <td>NAGIOS_GROUP</td>
1.287     rillig   11761: <td>NAGIOS_USER</td>
1.269     leot     11762: </tr>
                   11763: <tr>
1.274     rillig   11764: <td>NATIVE_APPEND_ABI</td>
1.287     rillig   11765: <td>NATIVE_APPEND_ELF</td>
1.269     leot     11766: </tr>
                   11767: <tr>
1.274     rillig   11768: <td>NATIVE_EXEC_FMT</td>
1.287     rillig   11769: <td>NATIVE_MACHINE_PLATFORM</td>
1.269     leot     11770: </tr>
                   11771: <tr>
1.274     rillig   11772: <td>NATIVE_OBJECT_FMT</td>
1.287     rillig   11773: <td>NBPAX_PROGRAM_PREFIX</td>
1.269     leot     11774: </tr>
                   11775: <tr>
1.274     rillig   11776: <td>NETBSD_LOGIN_NAME</td>
1.287     rillig   11777: <td>NMH_EDITOR</td>
1.269     leot     11778: </tr>
                   11779: <tr>
1.274     rillig   11780: <td>NMH_MTA</td>
1.287     rillig   11781: <td>NMH_PAGER</td>
1.269     leot     11782: </tr>
                   11783: <tr>
1.274     rillig   11784: <td>NOLOGIN</td>
1.292   ! leot     11785: <td>NOTE</td>
1.269     leot     11786: </tr>
                   11787: <tr>
1.287     rillig   11788: <td>NOT_FOR_PLATFORM</td>
1.292   ! leot     11789: <td>NOT_PAX_ASLR_SAFE</td>
1.269     leot     11790: </tr>
                   11791: <tr>
1.287     rillig   11792: <td>NOT_PAX_MPROTECT_SAFE</td>
1.292   ! leot     11793: <td>NO_BUILD</td>
1.269     leot     11794: </tr>
                   11795: <tr>
1.287     rillig   11796: <td>NO_CHECKSUM</td>
1.292   ! leot     11797: <td>NO_CONFIGURE</td>
1.269     leot     11798: </tr>
                   11799: <tr>
1.287     rillig   11800: <td>NO_SKIP</td>
1.292   ! leot     11801: <td>NS_PREFERRED</td>
1.269     leot     11802: </tr>
                   11803: <tr>
1.287     rillig   11804: <td>NULLMAILER_GROUP</td>
1.292   ! leot     11805: <td>NULLMAILER_USER</td>
1.269     leot     11806: </tr>
                   11807: <tr>
1.287     rillig   11808: <td>OASIS</td>
1.292   ! leot     11809: <td>OASIS_BUILD_ARGS</td>
1.269     leot     11810: </tr>
                   11811: <tr>
1.287     rillig   11812: <td>OBJHOSTNAME</td>
1.292   ! leot     11813: <td>OBJMACHINE</td>
1.269     leot     11814: </tr>
                   11815: <tr>
1.287     rillig   11816: <td>OCAML_FINDLIB_DIRS</td>
1.292   ! leot     11817: <td>OCAML_FINDLIB_REGISTER</td>
1.269     leot     11818: </tr>
                   11819: <tr>
1.287     rillig   11820: <td>OCAML_FINDLIB_REGISTER_VERBOSE</td>
1.292   ! leot     11821: <td>OCAML_SITELIBDIR</td>
1.269     leot     11822: </tr>
                   11823: <tr>
1.287     rillig   11824: <td>OCAML_TOPKG_DOCDIR</td>
1.292   ! leot     11825: <td>OCAML_USE_DUNE</td>
1.269     leot     11826: </tr>
                   11827: <tr>
1.287     rillig   11828: <td>OCAML_USE_FINDLIB</td>
1.292   ! leot     11829: <td>OCAML_USE_JBUILDER</td>
1.269     leot     11830: </tr>
                   11831: <tr>
1.287     rillig   11832: <td>OCAML_USE_OASIS</td>
1.292   ! leot     11833: <td>OCAML_USE_OASIS_DYNRUN</td>
1.269     leot     11834: </tr>
                   11835: <tr>
1.287     rillig   11836: <td>OCAML_USE_OPAM</td>
1.292   ! leot     11837: <td>OCAML_USE_OPT_COMPILER</td>
1.269     leot     11838: </tr>
                   11839: <tr>
1.287     rillig   11840: <td>OCAML_USE_TOPKG</td>
1.292   ! leot     11841: <td>OMF</td>
1.269     leot     11842: </tr>
                   11843: <tr>
1.287     rillig   11844: <td>ONLY_FOR_COMPILER</td>
1.292   ! leot     11845: <td>ONLY_FOR_PLATFORM</td>
1.269     leot     11846: </tr>
                   11847: <tr>
1.287     rillig   11848: <td>OPENSSH_CHROOT</td>
1.292   ! leot     11849: <td>OPENSSH_GROUP</td>
1.269     leot     11850: </tr>
                   11851: <tr>
1.287     rillig   11852: <td>OPENSSH_USER</td>
1.292   ! leot     11853: <td>OPSYS</td>
1.269     leot     11854: </tr>
                   11855: <tr>
1.287     rillig   11856: <td>OPSYS_EMULDIR</td>
1.292   ! leot     11857: <td>OSS_TYPE</td>
1.269     leot     11858: </tr>
                   11859: <tr>
1.287     rillig   11860: <td>OSX</td>
1.292   ! leot     11861: <td>OSX_TOLERATE_SDK_SKEW</td>
        !          11862: </tr>
        !          11863: <tr>
        !          11864: <td>OS_HAVE_ALSA</td>
        !          11865: <td>OS_HAVE_RCD</td>
1.269     leot     11866: </tr>
                   11867: <tr>
1.287     rillig   11868: <td>OS_VARIANT</td>
1.292   ! leot     11869: <td>OS_VERSION</td>
1.269     leot     11870: </tr>
                   11871: <tr>
1.287     rillig   11872: <td>OTF_FONTS_DIR</td>
1.292   ! leot     11873: <td>OVERRIDE_DIRDEPTH</td>
1.269     leot     11874: </tr>
                   11875: <tr>
1.287     rillig   11876: <td>OVERRIDE_GEMSPEC</td>
1.292   ! leot     11877: <td>OVERRIDE_GNU_CONFIG_SCRIPTS</td>
1.269     leot     11878: </tr>
                   11879: <tr>
1.292   ! leot     11880: <td>OVERRIDE_ROCKSPEC</td>
1.290     gutterid 11881: <td>OWN_DIRS</td>
1.269     leot     11882: </tr>
                   11883: <tr>
1.287     rillig   11884: <td>OWN_DIRS_PERMS</td>
1.290     gutterid 11885: <td>P4GROUP</td>
1.269     leot     11886: </tr>
                   11887: <tr>
1.287     rillig   11888: <td>P4PORT</td>
1.290     gutterid 11889: <td>P4ROOT</td>
1.269     leot     11890: </tr>
                   11891: <tr>
1.287     rillig   11892: <td>P4USER</td>
1.290     gutterid 11893: <td>PACKAGES</td>
1.269     leot     11894: </tr>
                   11895: <tr>
1.287     rillig   11896: <td>PALMOS_DEFAULT_SDK</td>
1.290     gutterid 11897: <td>PAMBASE</td>
1.269     leot     11898: </tr>
                   11899: <tr>
1.287     rillig   11900: <td>PAM_DEFAULT</td>
1.290     gutterid 11901: <td>PAPERSIZE</td>
1.269     leot     11902: </tr>
                   11903: <tr>
1.287     rillig   11904: <td>PASSIVE_FETCH</td>
1.290     gutterid 11905: <td>PATCHDIR</td>
1.269     leot     11906: </tr>
                   11907: <tr>
1.287     rillig   11908: <td>PATCHFILES</td>
1.290     gutterid 11909: <td>PATCH_ARGS</td>
1.269     leot     11910: </tr>
                   11911: <tr>
1.287     rillig   11912: <td>PATCH_DEBUG</td>
1.290     gutterid 11913: <td>PATCH_DIST_ARGS</td>
1.284     rillig   11914: </tr>
                   11915: <tr>
1.287     rillig   11916: <td>PATCH_DIST_CAT</td>
1.290     gutterid 11917: <td>PATCH_DIST_STRIP</td>
1.269     leot     11918: </tr>
                   11919: <tr>
1.287     rillig   11920: <td>PATCH_FUZZ_FACTOR</td>
1.290     gutterid 11921: <td>PATCH_STRIP</td>
1.269     leot     11922: </tr>
                   11923: <tr>
1.287     rillig   11924: <td>PATH</td>
1.284     rillig   11925: <td>PCCBASE</td>
1.269     leot     11926: </tr>
                   11927: <tr>
1.292   ! leot     11928: <td>PEAR</td>
        !          11929: <td>PEAR_CHANNEL</td>
        !          11930: </tr>
        !          11931: <tr>
        !          11932: <td>PEAR_CHANNEL_ALIAS</td>
        !          11933: <td>PEAR_CHANNEL_VERSION</td>
        !          11934: </tr>
        !          11935: <tr>
1.287     rillig   11936: <td>PEAR_CMD</td>
1.290     gutterid 11937: <td>PEAR_LIB</td>
1.274     rillig   11938: </tr>
                   11939: <tr>
1.287     rillig   11940: <td>PEAR_PACKAGE_XML</td>
1.290     gutterid 11941: <td>PERL5</td>
1.274     rillig   11942: </tr>
                   11943: <tr>
1.287     rillig   11944: <td>PERL5_CONFIGURE</td>
1.290     gutterid 11945: <td>PERL5_CONFIGURE_DIRS</td>
1.269     leot     11946: </tr>
                   11947: <tr>
1.287     rillig   11948: <td>PERL5_LDFLAGS</td>
1.290     gutterid 11949: <td>PERL5_LICENSE</td>
1.269     leot     11950: </tr>
                   11951: <tr>
1.287     rillig   11952: <td>PERL5_MODULE_TYPE</td>
1.290     gutterid 11953: <td>PERL5_PACKLIST</td>
1.269     leot     11954: </tr>
                   11955: <tr>
1.287     rillig   11956: <td>PERL5_PACKLIST_DIR</td>
1.290     gutterid 11957: <td>PERL5_PERLBASE</td>
1.269     leot     11958: </tr>
                   11959: <tr>
1.287     rillig   11960: <td>PERL5_SITEBASE</td>
1.290     gutterid 11961: <td>PERL5_USE_PACKLIST</td>
1.269     leot     11962: </tr>
                   11963: <tr>
1.287     rillig   11964: <td>PERL5_VENDORBASE</td>
1.290     gutterid 11965: <td>PFCTL</td>
1.269     leot     11966: </tr>
                   11967: <tr>
1.287     rillig   11968: <td>PFVAR_H</td>
1.290     gutterid 11969: <td>PF_VERSION</td>
1.269     leot     11970: </tr>
                   11971: <tr>
1.287     rillig   11972: <td>PGGROUP</td>
1.290     gutterid 11973: <td>PGHOME</td>
1.269     leot     11974: </tr>
                   11975: <tr>
1.287     rillig   11976: <td>PGPKGSRCDIR</td>
1.290     gutterid 11977: <td>PGSQL_TYPE</td>
1.269     leot     11978: </tr>
                   11979: <tr>
1.287     rillig   11980: <td>PGSQL_VERSIONS_ACCEPTED</td>
1.290     gutterid 11981: <td>PGSQL_VERSION_DEFAULT</td>
1.269     leot     11982: </tr>
                   11983: <tr>
1.287     rillig   11984: <td>PGUSER</td>
1.290     gutterid 11985: <td>PG_LIB_EXT</td>
1.269     leot     11986: </tr>
                   11987: <tr>
1.287     rillig   11988: <td>PHP</td>
1.290     gutterid 11989: <td>PHPCOMMON_MK</td>
1.269     leot     11990: </tr>
                   11991: <tr>
1.287     rillig   11992: <td>PHPPKGSRCDIR</td>
1.290     gutterid 11993: <td>PHP_BASE_VERS</td>
1.269     leot     11994: </tr>
                   11995: <tr>
1.287     rillig   11996: <td>PHP_CHECK_INSTALLED</td>
1.290     gutterid 11997: <td>PHP_EXTENSION_DIR</td>
1.269     leot     11998: </tr>
                   11999: <tr>
1.287     rillig   12000: <td>PHP_INITIAL_TEENY</td>
1.290     gutterid 12001: <td>PHP_PKG_PREFIX</td>
1.269     leot     12002: </tr>
                   12003: <tr>
1.287     rillig   12004: <td>PHP_VERSION</td>
1.290     gutterid 12005: <td>PHP_VERSIONS_ACCEPTED</td>
1.269     leot     12006: </tr>
                   12007: <tr>
1.287     rillig   12008: <td>PHP_VERSIONS_INCOMPATIBLE</td>
1.290     gutterid 12009: <td>PHP_VERSION_DEFAULT</td>
1.269     leot     12010: </tr>
                   12011: <tr>
1.287     rillig   12012: <td>PHP_VERSION_REQD</td>
1.290     gutterid 12013: <td>PILRC_USE_GTK</td>
1.269     leot     12014: </tr>
                   12015: <tr>
1.287     rillig   12016: <td>PKGCONFIG_BASE</td>
1.290     gutterid 12017: <td>PKGCONFIG_FILE</td>
1.269     leot     12018: </tr>
                   12019: <tr>
1.287     rillig   12020: <td>PKGCONFIG_OVERRIDE</td>
1.290     gutterid 12021: <td>PKGCONFIG_OVERRIDE_STAGE</td>
1.269     leot     12022: </tr>
                   12023: <tr>
1.287     rillig   12024: <td>PKGDIR</td>
1.290     gutterid 12025: <td>PKGGNUDIR</td>
1.269     leot     12026: </tr>
                   12027: <tr>
1.287     rillig   12028: <td>PKGINFODIR</td>
1.290     gutterid 12029: <td>PKGLOCALEDIR</td>
1.269     leot     12030: </tr>
                   12031: <tr>
1.287     rillig   12032: <td>PKGMANDIR</td>
1.290     gutterid 12033: <td>PKGNAME</td>
1.269     leot     12034: </tr>
                   12035: <tr>
1.287     rillig   12036: <td>PKGNAME_REQD</td>
1.290     gutterid 12037: <td>PKGPATH</td>
1.269     leot     12038: </tr>
                   12039: <tr>
1.287     rillig   12040: <td>PKGREVISION</td>
1.292   ! leot     12041: <td>PKGSRC_BLAS_TYPES</td>
        !          12042: </tr>
        !          12043: <tr>
1.287     rillig   12044: <td>PKGSRC_CHANGES</td>
1.292   ! leot     12045: <td>PKGSRC_COMPILER</td>
1.269     leot     12046: </tr>
                   12047: <tr>
1.287     rillig   12048: <td>PKGSRC_KEEP_BIN_PKGS</td>
1.292   ! leot     12049: <td>PKGSRC_LOCKTYPE</td>
1.274     rillig   12050: </tr>
                   12051: <tr>
1.287     rillig   12052: <td>PKGSRC_MAKE_ENV</td>
1.292   ! leot     12053: <td>PKGSRC_MESSAGE_RECIPIENTS</td>
1.269     leot     12054: </tr>
                   12055: <tr>
1.287     rillig   12056: <td>PKGSRC_MKPIE</td>
1.292   ! leot     12057: <td>PKGSRC_MKREPRO</td>
1.269     leot     12058: </tr>
                   12059: <tr>
1.287     rillig   12060: <td>PKGSRC_RUN_TEST</td>
1.292   ! leot     12061: <td>PKGSRC_SETENV</td>
1.269     leot     12062: </tr>
                   12063: <tr>
1.287     rillig   12064: <td>PKGSRC_SLEEPSECS</td>
1.292   ! leot     12065: <td>PKGSRC_TODO</td>
1.269     leot     12066: </tr>
                   12067: <tr>
1.287     rillig   12068: <td>PKGSRC_USE_CTF</td>
1.292   ! leot     12069: <td>PKGSRC_USE_FORTIFY</td>
1.269     leot     12070: </tr>
                   12071: <tr>
1.287     rillig   12072: <td>PKGSRC_USE_RELRO</td>
1.292   ! leot     12073: <td>PKGSRC_USE_SSP</td>
1.269     leot     12074: </tr>
                   12075: <tr>
1.287     rillig   12076: <td>PKGSRC_USE_STACK_CHECK</td>
1.292   ! leot     12077: <td>PKGTASKS_DATAFILE</td>
1.269     leot     12078: </tr>
                   12079: <tr>
1.287     rillig   12080: <td>PKGTOOLS_ARGS</td>
1.292   ! leot     12081: <td>PKGTOOLS_ENV</td>
1.269     leot     12082: </tr>
                   12083: <tr>
1.287     rillig   12084: <td>PKG_ALTERNATIVES</td>
1.292   ! leot     12085: <td>PKG_APACHE</td>
1.269     leot     12086: </tr>
                   12087: <tr>
1.287     rillig   12088: <td>PKG_APACHE_ACCEPTED</td>
1.292   ! leot     12089: <td>PKG_APACHE_DEFAULT</td>
1.269     leot     12090: </tr>
                   12091: <tr>
1.287     rillig   12092: <td>PKG_BEST_EXISTS</td>
1.292   ! leot     12093: <td>PKG_BUILD_OPTIONS</td>
1.269     leot     12094: </tr>
                   12095: <tr>
1.287     rillig   12096: <td>PKG_COMPRESSION</td>
1.292   ! leot     12097: <td>PKG_CONFIG</td>
1.269     leot     12098: </tr>
                   12099: <tr>
1.287     rillig   12100: <td>PKG_CONFIG_PERMS</td>
1.292   ! leot     12101: <td>PKG_CREATE_USERGROUP</td>
1.269     leot     12102: </tr>
                   12103: <tr>
1.287     rillig   12104: <td>PKG_DB_TMPDIR</td>
1.292   ! leot     12105: <td>PKG_DEBUG_LEVEL</td>
1.269     leot     12106: </tr>
                   12107: <tr>
1.287     rillig   12108: <td>PKG_DEFAULT_OPTIONS</td>
1.292   ! leot     12109: <td>PKG_DESTDIR_SUPPORT</td>
1.269     leot     12110: </tr>
                   12111: <tr>
1.287     rillig   12112: <td>PKG_DEVELOPER</td>
1.292   ! leot     12113: <td>PKG_DISABLED_OPTIONS</td>
1.269     leot     12114: </tr>
                   12115: <tr>
1.287     rillig   12116: <td>PKG_FATAL_ERRORS</td>
1.292   ! leot     12117: <td>PKG_FC</td>
1.269     leot     12118: </tr>
                   12119: <tr>
1.287     rillig   12120: <td>PKG_FILELIST_CMD</td>
1.292   ! leot     12121: <td>PKG_GECOS</td>
1.269     leot     12122: </tr>
                   12123: <tr>
1.287     rillig   12124: <td>PKG_GID</td>
1.292   ! leot     12125: <td>PKG_GROUPS</td>
1.269     leot     12126: </tr>
                   12127: <tr>
1.287     rillig   12128: <td>PKG_GROUPS_VARS</td>
1.292   ! leot     12129: <td>PKG_HOME</td>
1.269     leot     12130: </tr>
                   12131: <tr>
1.287     rillig   12132: <td>PKG_INIT_SCRIPTS</td>
1.292   ! leot     12133: <td>PKG_JAVA_HOME</td>
1.269     leot     12134: </tr>
                   12135: <tr>
1.287     rillig   12136: <td>PKG_JVM</td>
1.292   ! leot     12137: <td>PKG_JVMS_ACCEPTED</td>
1.269     leot     12138: </tr>
                   12139: <tr>
1.287     rillig   12140: <td>PKG_JVM_DEFAULT</td>
1.292   ! leot     12141: <td>PKG_LEGACY_OPTIONS</td>
1.269     leot     12142: </tr>
                   12143: <tr>
1.287     rillig   12144: <td>PKG_LIBTOOL</td>
1.292   ! leot     12145: <td>PKG_OPTIONS</td>
1.269     leot     12146: </tr>
                   12147: <tr>
1.287     rillig   12148: <td>PKG_OPTIONS_DEPRECATED_WARNINGS</td>
1.292   ! leot     12149: <td>PKG_OPTIONS_LEGACY_OPTS</td>
1.269     leot     12150: </tr>
                   12151: <tr>
1.287     rillig   12152: <td>PKG_OPTIONS_LEGACY_VARS</td>
1.292   ! leot     12153: <td>PKG_OPTIONS_NONEMPTY_SETS</td>
1.269     leot     12154: </tr>
                   12155: <tr>
1.287     rillig   12156: <td>PKG_OPTIONS_OPTIONAL_GROUPS</td>
1.292   ! leot     12157: <td>PKG_OPTIONS_REQUIRED_GROUPS</td>
1.269     leot     12158: </tr>
                   12159: <tr>
1.287     rillig   12160: <td>PKG_OPTIONS_VAR</td>
1.292   ! leot     12161: <td>PKG_PHP</td>
1.269     leot     12162: </tr>
                   12163: <tr>
1.287     rillig   12164: <td>PKG_PHP_MAJOR_VERS</td>
1.292   ! leot     12165: <td>PKG_PHP_VERSION</td>
1.269     leot     12166: </tr>
                   12167: <tr>
1.287     rillig   12168: <td>PKG_RCD_SCRIPTS</td>
1.292   ! leot     12169: <td>PKG_REFCOUNT_DBDIR</td>
1.269     leot     12170: </tr>
                   12171: <tr>
1.287     rillig   12172: <td>PKG_REGISTER_SHELLS</td>
1.292   ! leot     12173: <td>PKG_RESUME_TRANSFERS</td>
1.269     leot     12174: </tr>
                   12175: <tr>
1.287     rillig   12176: <td>PKG_SHELL</td>
1.292   ! leot     12177: <td>PKG_SUGGESTED_OPTIONS</td>
1.269     leot     12178: </tr>
                   12179: <tr>
1.287     rillig   12180: <td>PKG_SUPPORTED_OPTIONS</td>
1.292   ! leot     12181: <td>PKG_SYSCONFBASE</td>
1.269     leot     12182: </tr>
                   12183: <tr>
1.287     rillig   12184: <td>PKG_SYSCONFBASEDIR</td>
1.292   ! leot     12185: <td>PKG_SYSCONFDIR</td>
1.269     leot     12186: </tr>
                   12187: <tr>
1.287     rillig   12188: <td>PKG_SYSCONFDIR_PERMS</td>
1.292   ! leot     12189: <td>PKG_SYSCONFSUBDIR</td>
1.269     leot     12190: </tr>
                   12191: <tr>
1.287     rillig   12192: <td>PKG_SYSCONFVAR</td>
1.292   ! leot     12193: <td>PKG_TOOLS_BIN</td>
1.269     leot     12194: </tr>
                   12195: <tr>
1.287     rillig   12196: <td>PKG_UID</td>
1.292   ! leot     12197: <td>PKG_UPDATE_FONTS_DB</td>
1.269     leot     12198: </tr>
                   12199: <tr>
1.287     rillig   12200: <td>PKG_USERS</td>
1.292   ! leot     12201: <td>PKG_USERS_VARS</td>
1.269     leot     12202: </tr>
                   12203: <tr>
1.287     rillig   12204: <td>PKG_VERBOSE</td>
1.292   ! leot     12205: <td>PLIST</td>
1.269     leot     12206: </tr>
                   12207: <tr>
1.287     rillig   12208: <td>PLIST_AWK</td>
1.292   ! leot     12209: <td>PLIST_AWK_ENV</td>
1.269     leot     12210: </tr>
                   12211: <tr>
1.287     rillig   12212: <td>PLIST_SRC</td>
1.292   ! leot     12213: <td>PLIST_SUBST</td>
1.269     leot     12214: </tr>
                   12215: <tr>
1.287     rillig   12216: <td>PLIST_TYPE</td>
1.292   ! leot     12217: <td>PLIST_VARS</td>
1.269     leot     12218: </tr>
                   12219: <tr>
1.287     rillig   12220: <td>POPTOP_USE_MPPE</td>
1.292   ! leot     12221: <td>POSSIBLE_GFORTRAN_VERSION</td>
1.269     leot     12222: </tr>
                   12223: <tr>
1.284     rillig   12224: <td>POST_FETCH_HOOK</td>
1.292   ! leot     12225: <td>PREFER</td>
1.269     leot     12226: </tr>
                   12227: <tr>
1.284     rillig   12228: <td>PREFER_NATIVE</td>
1.292   ! leot     12229: <td>PREFER_NATIVE_PTHREADS</td>
1.269     leot     12230: </tr>
                   12231: <tr>
1.284     rillig   12232: <td>PREFER_PKGSRC</td>
1.292   ! leot     12233: <td>PREFIX</td>
1.269     leot     12234: </tr>
                   12235: <tr>
1.284     rillig   12236: <td>PREPEND_PATH</td>
1.292   ! leot     12237: <td>PRE_ROOT_CMD</td>
1.269     leot     12238: </tr>
                   12239: <tr>
1.284     rillig   12240: <td>PRIVILEGED_STAGES</td>
1.292   ! leot     12241: <td>PS</td>
1.269     leot     12242: </tr>
                   12243: <tr>
1.284     rillig   12244: <td>PTHREAD_AUTO_VARS</td>
1.292   ! leot     12245: <td>PTHREAD_CFLAGS</td>
1.269     leot     12246: </tr>
                   12247: <tr>
1.284     rillig   12248: <td>PTHREAD_LDFLAGS</td>
1.292   ! leot     12249: <td>PTHREAD_LIBS</td>
1.269     leot     12250: </tr>
                   12251: <tr>
1.284     rillig   12252: <td>PTHREAD_OPTS</td>
1.292   ! leot     12253: <td>PTHREAD_TYPE</td>
1.269     leot     12254: </tr>
                   12255: <tr>
1.284     rillig   12256: <td>PVM_SSH</td>
1.292   ! leot     12257: <td>PYPKGPREFIX</td>
1.269     leot     12258: </tr>
                   12259: <tr>
1.284     rillig   12260: <td>PYTHON_FOR_BUILD_ONLY</td>
1.292   ! leot     12261: <td>PYTHON_SELF_CONFLICT</td>
1.269     leot     12262: </tr>
                   12263: <tr>
1.284     rillig   12264: <td>PYTHON_VERSIONED_DEPENDENCIES</td>
1.292   ! leot     12265: <td>PYTHON_VERSIONS_ACCEPTED</td>
1.269     leot     12266: </tr>
                   12267: <tr>
1.284     rillig   12268: <td>PYTHON_VERSIONS_INCOMPATIBLE</td>
1.292   ! leot     12269: <td>PYTHON_VERSION_DEFAULT</td>
1.269     leot     12270: </tr>
                   12271: <tr>
1.284     rillig   12272: <td>PYTHON_VERSION_REQD</td>
1.292   ! leot     12273: <td>PYVERSSUFFIX</td>
1.269     leot     12274: </tr>
                   12275: <tr>
1.284     rillig   12276: <td>PY_NO_EGG</td>
1.292   ! leot     12277: <td>QMAILDIR</td>
1.269     leot     12278: </tr>
                   12279: <tr>
1.284     rillig   12280: <td>QMAIL_ALIAS_USER</td>
1.292   ! leot     12281: <td>QMAIL_DAEMON_USER</td>
1.269     leot     12282: </tr>
                   12283: <tr>
1.284     rillig   12284: <td>QMAIL_LOG_USER</td>
1.292   ! leot     12285: <td>QMAIL_NOFILES_GROUP</td>
1.269     leot     12286: </tr>
                   12287: <tr>
1.284     rillig   12288: <td>QMAIL_PASSWD_USER</td>
1.292   ! leot     12289: <td>QMAIL_QMAIL_GROUP</td>
1.269     leot     12290: </tr>
                   12291: <tr>
1.284     rillig   12292: <td>QMAIL_QUEUE_DIR</td>
1.292   ! leot     12293: <td>QMAIL_QUEUE_EXTRA</td>
1.269     leot     12294: </tr>
                   12295: <tr>
1.284     rillig   12296: <td>QMAIL_QUEUE_USER</td>
1.292   ! leot     12297: <td>QMAIL_REMOTE_USER</td>
1.269     leot     12298: </tr>
                   12299: <tr>
1.284     rillig   12300: <td>QMAIL_ROOT_USER</td>
1.292   ! leot     12301: <td>QMAIL_SEND_USER</td>
1.269     leot     12302: </tr>
                   12303: <tr>
1.284     rillig   12304: <td>QPOPPER_FAC</td>
1.292   ! leot     12305: <td>QPOPPER_SPOOL_DIR</td>
1.269     leot     12306: </tr>
                   12307: <tr>
1.284     rillig   12308: <td>QPOPPER_USER</td>
1.292   ! leot     12309: <td>RAKE_NAME</td>
1.269     leot     12310: </tr>
                   12311: <tr>
1.284     rillig   12312: <td>RASMOL_DEPTH</td>
1.292   ! leot     12313: <td>RCD_DIR</td>
1.269     leot     12314: </tr>
                   12315: <tr>
1.292   ! leot     12316: <td>RCD_ORDER</td>
1.289     leot     12317: <td>RCD_SCRIPTS</td>
1.292   ! leot     12318: </tr>
        !          12319: <tr>
1.284     rillig   12320: <td>RCD_SCRIPTS_DIR</td>
1.292   ! leot     12321: <td>RCD_SCRIPTS_EXAMPLEDIR</td>
1.269     leot     12322: </tr>
                   12323: <tr>
1.284     rillig   12324: <td>RCD_SCRIPTS_MODE</td>
1.292   ! leot     12325: <td>RCD_SCRIPTS_SHELL</td>
1.269     leot     12326: </tr>
                   12327: <tr>
1.284     rillig   12328: <td>RCD_SCRIPT_SRC</td>
1.292   ! leot     12329: <td>RCD_SUBR</td>
1.269     leot     12330: </tr>
                   12331: <tr>
1.284     rillig   12332: <td>RDOC</td>
1.290     gutterid 12333: <td>READLINE_DEFAULT</td>
1.269     leot     12334: </tr>
                   12335: <tr>
1.284     rillig   12336: <td>READLINE_TYPE</td>
1.290     gutterid 12337: <td>REAL_ROOT_GROUP</td>
1.269     leot     12338: </tr>
                   12339: <tr>
1.284     rillig   12340: <td>REAL_ROOT_USER</td>
1.290     gutterid 12341: <td>RECURSIVE_MAKE</td>
1.269     leot     12342: </tr>
                   12343: <tr>
1.284     rillig   12344: <td>RELAY_CTRL_DIR</td>
1.290     gutterid 12345: <td>REPLACE_AWK</td>
1.269     leot     12346: </tr>
                   12347: <tr>
1.284     rillig   12348: <td>REPLACE_BASH</td>
1.290     gutterid 12349: <td>REPLACE_CSH</td>
1.269     leot     12350: </tr>
                   12351: <tr>
1.284     rillig   12352: <td>REPLACE_KSH</td>
1.290     gutterid 12353: <td>REPLACE_PERL</td>
1.269     leot     12354: </tr>
                   12355: <tr>
1.284     rillig   12356: <td>REPLACE_PERL6</td>
1.290     gutterid 12357: <td>REPLACE_PHP</td>
1.269     leot     12358: </tr>
                   12359: <tr>
1.284     rillig   12360: <td>REPLACE_PYTHON</td>
1.290     gutterid 12361: <td>REPLACE_RUBY</td>
1.281     leot     12362: </tr>
                   12363: <tr>
1.284     rillig   12364: <td>REPLACE_RUBY_DIRS</td>
1.290     gutterid 12365: <td>REPLACE_RUBY_PAT</td>
1.269     leot     12366: </tr>
                   12367: <tr>
1.284     rillig   12368: <td>REPLACE_SH</td>
1.290     gutterid 12369: <td>REPLACE_TEXLUA</td>
1.269     leot     12370: </tr>
                   12371: <tr>
1.284     rillig   12372: <td>REQD_DIRS</td>
1.290     gutterid 12373: <td>REQD_DIRS_PERMS</td>
1.269     leot     12374: </tr>
                   12375: <tr>
1.284     rillig   12376: <td>REQD_FILES</td>
1.290     gutterid 12377: <td>REQD_FILES_MODE</td>
1.269     leot     12378: </tr>
                   12379: <tr>
1.284     rillig   12380: <td>REQD_FILES_PERMS</td>
1.290     gutterid 12381: <td>RESOLV_AUTO_VARS</td>
1.269     leot     12382: </tr>
                   12383: <tr>
1.284     rillig   12384: <td>RESOLV_LDFLAGS</td>
1.290     gutterid 12385: <td>RESOLV_LIBS</td>
1.269     leot     12386: </tr>
                   12387: <tr>
1.284     rillig   12388: <td>RM</td>
1.292   ! leot     12389: <td>ROCKSPEC_NAME</td>
        !          12390: </tr>
        !          12391: <tr>
        !          12392: <td>ROCKSPEC_SPECFILE</td>
1.290     gutterid 12393: <td>ROOT_CMD</td>
1.269     leot     12394: </tr>
                   12395: <tr>
1.284     rillig   12396: <td>ROOT_GROUP</td>
1.290     gutterid 12397: <td>ROOT_USER</td>
1.274     rillig   12398: </tr>
                   12399: <tr>
1.284     rillig   12400: <td>RPCGEN</td>
1.290     gutterid 12401: <td>RPM</td>
1.269     leot     12402: </tr>
                   12403: <tr>
1.284     rillig   12404: <td>RPM2PKG_PLIST</td>
1.290     gutterid 12405: <td>RPM2PKG_PREFIX</td>
1.269     leot     12406: </tr>
                   12407: <tr>
1.284     rillig   12408: <td>RPM2PKG_STAGE</td>
1.290     gutterid 12409: <td>RPM2PKG_STRIP</td>
1.269     leot     12410: </tr>
                   12411: <tr>
1.284     rillig   12412: <td>RPM2PKG_SUBPREFIX</td>
1.290     gutterid 12413: <td>RPMFILES</td>
1.269     leot     12414: </tr>
                   12415: <tr>
1.284     rillig   12416: <td>RPMIGNOREPATH</td>
1.290     gutterid 12417: <td>RPM_DB_PREFIX</td>
1.269     leot     12418: </tr>
                   12419: <tr>
1.284     rillig   12420: <td>RSSH_CVS_PATH</td>
1.290     gutterid 12421: <td>RSSH_RDIST_PATH</td>
1.269     leot     12422: </tr>
                   12423: <tr>
1.284     rillig   12424: <td>RSSH_RSYNC_PATH</td>
1.290     gutterid 12425: <td>RSSH_SCP_PATH</td>
1.269     leot     12426: </tr>
                   12427: <tr>
1.284     rillig   12428: <td>RSSH_SFTP_SERVER_PATH</td>
1.290     gutterid 12429: <td>RUBY</td>
1.269     leot     12430: </tr>
                   12431: <tr>
1.284     rillig   12432: <td>RUBYGEM</td>
1.290     gutterid 12433: <td>RUBYGEM_NAME</td>
1.269     leot     12434: </tr>
                   12435: <tr>
1.284     rillig   12436: <td>RUBYGEM_OPTIONS</td>
1.290     gutterid 12437: <td>RUBY_ABI_VERSION</td>
1.269     leot     12438: </tr>
                   12439: <tr>
1.284     rillig   12440: <td>RUBY_ARCH</td>
1.290     gutterid 12441: <td>RUBY_ARCHINC</td>
1.269     leot     12442: </tr>
                   12443: <tr>
1.284     rillig   12444: <td>RUBY_ARCHLIB</td>
1.290     gutterid 12445: <td>RUBY_BASE</td>
1.269     leot     12446: </tr>
                   12447: <tr>
1.284     rillig   12448: <td>RUBY_BASERIDIR</td>
1.290     gutterid 12449: <td>RUBY_BUILD_DOCUMENT</td>
1.269     leot     12450: </tr>
                   12451: <tr>
1.284     rillig   12452: <td>RUBY_DLEXT</td>
1.290     gutterid 12453: <td>RUBY_DOC</td>
1.269     leot     12454: </tr>
                   12455: <tr>
1.284     rillig   12456: <td>RUBY_DYNAMIC_DIRS</td>
1.290     gutterid 12457: <td>RUBY_EG</td>
1.269     leot     12458: </tr>
                   12459: <tr>
1.284     rillig   12460: <td>RUBY_ENCODING_ARG</td>
1.290     gutterid 12461: <td>RUBY_EXTCONF</td>
1.269     leot     12462: </tr>
                   12463: <tr>
1.284     rillig   12464: <td>RUBY_EXTCONF_CHECK</td>
1.290     gutterid 12465: <td>RUBY_EXTCONF_DEBUG</td>
1.269     leot     12466: </tr>
                   12467: <tr>
1.284     rillig   12468: <td>RUBY_EXTCONF_MAKEFILE</td>
1.290     gutterid 12469: <td>RUBY_GEM_BASE</td>
1.269     leot     12470: </tr>
                   12471: <tr>
1.284     rillig   12472: <td>RUBY_INC</td>
1.290     gutterid 12473: <td>RUBY_LIB</td>
1.269     leot     12474: </tr>
                   12475: <tr>
1.284     rillig   12476: <td>RUBY_LIB_BASE</td>
1.290     gutterid 12477: <td>RUBY_NAME</td>
1.269     leot     12478: </tr>
                   12479: <tr>
1.284     rillig   12480: <td>RUBY_NOVERSION</td>
1.290     gutterid 12481: <td>RUBY_PKGPREFIX</td>
1.269     leot     12482: </tr>
                   12483: <tr>
1.284     rillig   12484: <td>RUBY_RAILS</td>
1.290     gutterid 12485: <td>RUBY_RAILS51_VERSION</td>
1.269     leot     12486: </tr>
                   12487: <tr>
1.287     rillig   12488: <td>RUBY_RAILS52_VERSION</td>
1.290     gutterid 12489: <td>RUBY_RAILS60_VERSION</td>
1.269     leot     12490: </tr>
                   12491: <tr>
1.284     rillig   12492: <td>RUBY_RAILS_ACCEPTED</td>
1.290     gutterid 12493: <td>RUBY_RAILS_DEFAULT</td>
1.289     leot     12494: </tr>
                   12495: <tr>
                   12496: <td>RUBY_RAILS_REQD</td>
1.290     gutterid 12497: <td>RUBY_RAILS_STRICT_DEP</td>
1.269     leot     12498: </tr>
                   12499: <tr>
1.289     leot     12500: <td>RUBY_RIDIR</td>
1.290     gutterid 12501: <td>RUBY_SETUP</td>
1.269     leot     12502: </tr>
                   12503: <tr>
1.289     leot     12504: <td>RUBY_SHLIB</td>
1.290     gutterid 12505: <td>RUBY_SHLIBALIAS</td>
1.269     leot     12506: </tr>
                   12507: <tr>
1.289     leot     12508: <td>RUBY_SHLIBVER</td>
1.290     gutterid 12509: <td>RUBY_SIMPLE_INSTALL</td>
1.269     leot     12510: </tr>
                   12511: <tr>
1.289     leot     12512: <td>RUBY_SITEARCHLIB</td>
1.290     gutterid 12513: <td>RUBY_SITELIB</td>
1.269     leot     12514: </tr>
                   12515: <tr>
1.289     leot     12516: <td>RUBY_SITELIB_BASE</td>
1.290     gutterid 12517: <td>RUBY_SITERIDIR</td>
1.269     leot     12518: </tr>
                   12519: <tr>
1.289     leot     12520: <td>RUBY_SLEXT</td>
1.290     gutterid 12521: <td>RUBY_SRCDIR</td>
1.269     leot     12522: </tr>
                   12523: <tr>
1.289     leot     12524: <td>RUBY_STATICLIB</td>
1.290     gutterid 12525: <td>RUBY_SUFFIX</td>
1.269     leot     12526: </tr>
                   12527: <tr>
1.289     leot     12528: <td>RUBY_SYSRIDIR</td>
1.290     gutterid 12529: <td>RUBY_USE_PTHREAD</td>
1.269     leot     12530: </tr>
                   12531: <tr>
1.289     leot     12532: <td>RUBY_VENDORARCHLIB</td>
1.290     gutterid 12533: <td>RUBY_VENDORLIB</td>
1.269     leot     12534: </tr>
                   12535: <tr>
1.289     leot     12536: <td>RUBY_VENDORLIB_BASE</td>
1.290     gutterid 12537: <td>RUBY_VER</td>
1.269     leot     12538: </tr>
                   12539: <tr>
1.289     leot     12540: <td>RUBY_VERSION</td>
1.290     gutterid 12541: <td>RUBY_VERSIONS_ACCEPTED</td>
1.269     leot     12542: </tr>
                   12543: <tr>
1.289     leot     12544: <td>RUBY_VERSIONS_INCOMPATIBLE</td>
1.290     gutterid 12545: <td>RUBY_VERSION_DEFAULT</td>
1.269     leot     12546: </tr>
                   12547: <tr>
1.287     rillig   12548: <td>RUBY_VERSION_REQD</td>
1.290     gutterid 12549: <td>RUBY_VER_DIR</td>
1.269     leot     12550: </tr>
                   12551: <tr>
1.287     rillig   12552: <td>RUN</td>
1.290     gutterid 12553: <td>RUN_LDCONFIG</td>
1.269     leot     12554: </tr>
                   12555: <tr>
1.287     rillig   12556: <td>SAWFISH_THEMES</td>
1.290     gutterid 12557: <td>SCO</td>
1.269     leot     12558: </tr>
                   12559: <tr>
1.287     rillig   12560: <td>SCREWS_GROUP</td>
1.290     gutterid 12561: <td>SCREWS_USER</td>
1.269     leot     12562: </tr>
                   12563: <tr>
1.287     rillig   12564: <td>SCRIPTS_ENV</td>
1.290     gutterid 12565: <td>SCROLLKEEPER_DATADIR</td>
1.269     leot     12566: </tr>
                   12567: <tr>
1.287     rillig   12568: <td>SCROLLKEEPER_REBUILDDB</td>
1.290     gutterid 12569: <td>SCROLLKEEPER_UPDATEDB</td>
1.269     leot     12570: </tr>
                   12571: <tr>
1.287     rillig   12572: <td>SDIST_PAWD</td>
1.290     gutterid 12573: <td>SERIAL_DEVICES</td>
1.269     leot     12574: </tr>
                   12575: <tr>
1.287     rillig   12576: <td>SETGIDGAME</td>
1.290     gutterid 12577: <td>SETGID_GAMES_PERMS</td>
1.269     leot     12578: </tr>
                   12579: <tr>
1.287     rillig   12580: <td>SETUID_ROOT_PERMS</td>
1.290     gutterid 12581: <td>SH</td>
1.269     leot     12582: </tr>
                   12583: <tr>
1.287     rillig   12584: <td>SHLIB</td>
1.292   ! leot     12585: <td>SHORTNAME</td>
        !          12586: </tr>
        !          12587: <tr>
1.287     rillig   12588: <td>SIGN_PACKAGES</td>
1.292   ! leot     12589: <td>SILC_CLIENT_WITH_PERL</td>
1.269     leot     12590: </tr>
                   12591: <tr>
1.287     rillig   12592: <td>SITE_SPECIFIC_PKGS</td>
1.292   ! leot     12593: <td>SKIP_DEPENDS</td>
1.269     leot     12594: </tr>
                   12595: <tr>
1.287     rillig   12596: <td>SMF_INSTANCES</td>
1.292   ! leot     12597: <td>SMF_MANIFEST</td>
1.274     rillig   12598: </tr>
                   12599: <tr>
1.287     rillig   12600: <td>SMF_METHODS</td>
1.292   ! leot     12601: <td>SMF_METHOD_SHELL</td>
1.269     leot     12602: </tr>
                   12603: <tr>
1.287     rillig   12604: <td>SMF_METHOD_SRC</td>
1.292   ! leot     12605: <td>SMF_NAME</td>
1.269     leot     12606: </tr>
                   12607: <tr>
1.287     rillig   12608: <td>SMF_PREFIX</td>
1.292   ! leot     12609: <td>SMF_SRCDIR</td>
1.269     leot     12610: </tr>
                   12611: <tr>
1.287     rillig   12612: <td>SNIPROXY_GROUP</td>
1.292   ! leot     12613: <td>SNIPROXY_USER</td>
1.269     leot     12614: </tr>
                   12615: <tr>
1.287     rillig   12616: <td>SOURCE_BUFFSIZE</td>
1.292   ! leot     12617: <td>SPECIAL_PERMS</td>
1.269     leot     12618: </tr>
                   12619: <tr>
1.287     rillig   12620: <td>SPECIFIC_PKGS</td>
1.292   ! leot     12621: <td>SSH_SUID</td>
1.269     leot     12622: </tr>
                   12623: <tr>
1.287     rillig   12624: <td>SSP_SUPPORTED</td>
1.292   ! leot     12625: <td>SSYNC_PAWD</td>
1.269     leot     12626: </tr>
                   12627: <tr>
1.287     rillig   12628: <td>STEP_MSG</td>
1.292   ! leot     12629: <td>STRIP</td>
1.269     leot     12630: </tr>
                   12631: <tr>
1.287     rillig   12632: <td>STRIP_DBG</td>
1.292   ! leot     12633: <td>STRIP_DEBUG</td>
1.269     leot     12634: </tr>
                   12635: <tr>
1.287     rillig   12636: <td>STRIP_DEBUG_SUPPORTED</td>
1.292   ! leot     12637: <td>STRIP_FILES_SKIP</td>
1.269     leot     12638: </tr>
                   12639: <tr>
1.287     rillig   12640: <td>SU</td>
1.292   ! leot     12641: <td>SUBDIR</td>
1.269     leot     12642: </tr>
                   12643: <tr>
1.289     leot     12644: <td>SUBST</td>
1.292   ! leot     12645: <td>SUBST_CLASSES</td>
1.289     leot     12646: </tr>
                   12647: <tr>
                   12648: <td>SUBST_FILES</td>
1.292   ! leot     12649: <td>SUBST_FILTER_CMD</td>
1.269     leot     12650: </tr>
                   12651: <tr>
1.289     leot     12652: <td>SUBST_MESSAGE</td>
1.292   ! leot     12653: <td>SUBST_NOOP_OK</td>
1.269     leot     12654: </tr>
                   12655: <tr>
1.287     rillig   12656: <td>SUBST_SED</td>
1.292   ! leot     12657: <td>SUBST_SHOW_DIFF</td>
1.269     leot     12658: </tr>
                   12659: <tr>
1.287     rillig   12660: <td>SUBST_SKIP_TEXT_CHECK</td>
1.292   ! leot     12661: <td>SUBST_STAGE</td>
1.269     leot     12662: </tr>
                   12663: <tr>
1.287     rillig   12664: <td>SUBST_VARS</td>
1.292   ! leot     12665: <td>SUNWSPROBASE</td>
1.269     leot     12666: </tr>
                   12667: <tr>
1.287     rillig   12668: <td>SUSE_PREFER</td>
1.292   ! leot     12669: <td>SU_CMD</td>
        !          12670: </tr>
        !          12671: <tr>
        !          12672: <td>SVN_EXTRACTDIR</td>
        !          12673: <td>SVN_REPO</td>
        !          12674: </tr>
        !          12675: <tr>
        !          12676: <td>SVN_REPOSITORIES</td>
        !          12677: <td>SVN_REVISION</td>
1.269     leot     12678: </tr>
                   12679: <tr>
1.287     rillig   12680: <td>TERMCAP_TYPE</td>
1.292   ! leot     12681: <td>TERMINFO_DEFAULT</td>
1.274     rillig   12682: </tr>
                   12683: <tr>
1.287     rillig   12684: <td>TERMINFO_TYPE</td>
1.292   ! leot     12685: <td>TEST</td>
1.269     leot     12686: </tr>
                   12687: <tr>
1.287     rillig   12688: <td>TEST_DEPENDS</td>
1.292   ! leot     12689: <td>TEST_DIRS</td>
1.269     leot     12690: </tr>
                   12691: <tr>
1.287     rillig   12692: <td>TEST_ENV</td>
1.292   ! leot     12693: <td>TEST_ENV_SHELL</td>
1.269     leot     12694: </tr>
                   12695: <tr>
1.284     rillig   12696: <td>TEST_MAKE_CMD</td>
1.292   ! leot     12697: <td>TEST_MAKE_FLAGS</td>
1.269     leot     12698: </tr>
                   12699: <tr>
1.284     rillig   12700: <td>TEST_TARGET</td>
1.292   ! leot     12701: <td>TEXLIVE_IGNORE_PATTERNS</td>
1.269     leot     12702: </tr>
                   12703: <tr>
1.284     rillig   12704: <td>TEXLIVE_REV</td>
1.292   ! leot     12705: <td>TEXLIVE_UNVERSIONED</td>
1.269     leot     12706: </tr>
                   12707: <tr>
1.284     rillig   12708: <td>TEXMFSITE</td>
1.292   ! leot     12709: <td>TEX_FORMATS</td>
1.269     leot     12710: </tr>
                   12711: <tr>
1.284     rillig   12712: <td>TEX_HYPHEN_DAT</td>
1.292   ! leot     12713: <td>TEX_HYPHEN_DEF</td>
1.269     leot     12714: </tr>
                   12715: <tr>
1.284     rillig   12716: <td>TEX_TEXMF_DIRS</td>
1.292   ! leot     12717: <td>THTTPD_LOG_FACILITY</td>
1.269     leot     12718: </tr>
                   12719: <tr>
1.284     rillig   12720: <td>TO</td>
1.292   ! leot     12721: <td>TOOLS_ALIASES</td>
1.269     leot     12722: </tr>
                   12723: <tr>
1.284     rillig   12724: <td>TOOLS_ARGS</td>
1.292   ! leot     12725: <td>TOOLS_BROKEN</td>
1.269     leot     12726: </tr>
                   12727: <tr>
1.284     rillig   12728: <td>TOOLS_CMD</td>
1.292   ! leot     12729: <td>TOOLS_CREATE</td>
1.269     leot     12730: </tr>
                   12731: <tr>
1.284     rillig   12732: <td>TOOLS_DIR</td>
1.292   ! leot     12733: <td>TOOLS_FAIL</td>
1.269     leot     12734: </tr>
                   12735: <tr>
1.284     rillig   12736: <td>TOOLS_GNU_MISSING</td>
1.292   ! leot     12737: <td>TOOLS_LDCONFIG</td>
1.269     leot     12738: </tr>
                   12739: <tr>
1.284     rillig   12740: <td>TOOLS_NOOP</td>
1.292   ! leot     12741: <td>TOOLS_PATH</td>
1.269     leot     12742: </tr>
                   12743: <tr>
1.284     rillig   12744: <td>TOOLS_SCRIPT</td>
1.292   ! leot     12745: <td>TOOL_DEPENDS</td>
1.269     leot     12746: </tr>
                   12747: <tr>
1.292   ! leot     12748: <td>TTF_FONTDIR</td>
1.290     gutterid 12749: <td>TTF_FONTS_DIR</td>
1.269     leot     12750: </tr>
                   12751: <tr>
1.284     rillig   12752: <td>TYPE</td>
1.290     gutterid 12753: <td>UAC_REQD_EXECS</td>
1.269     leot     12754: </tr>
                   12755: <tr>
1.284     rillig   12756: <td>UCSPI_SSL_GROUP</td>
1.290     gutterid 12757: <td>UCSPI_SSL_USER</td>
1.269     leot     12758: </tr>
                   12759: <tr>
1.284     rillig   12760: <td>UNLIMIT_RESOURCES</td>
1.290     gutterid 12761: <td>UNPRIVILEGED</td>
1.269     leot     12762: </tr>
                   12763: <tr>
1.284     rillig   12764: <td>UNPRIVILEGED_GROUP</td>
1.290     gutterid 12765: <td>UNPRIVILEGED_GROUPS</td>
1.269     leot     12766: </tr>
                   12767: <tr>
1.284     rillig   12768: <td>UNPRIVILEGED_USER</td>
1.290     gutterid 12769: <td>UNWRAP_FILES</td>
1.269     leot     12770: </tr>
                   12771: <tr>
1.284     rillig   12772: <td>UNWRAP_PATTERNS</td>
1.290     gutterid 12773: <td>UPDATE_GEMSPEC</td>
1.269     leot     12774: </tr>
                   12775: <tr>
1.284     rillig   12776: <td>UPDATE_TARGET</td>
1.290     gutterid 12777: <td>URI</td>
1.269     leot     12778: </tr>
                   12779: <tr>
1.290     gutterid 12780: <td>USERGROUP_PHASE</td>
1.292   ! leot     12781: <td>USERPPP_GROUP</td>
1.269     leot     12782: </tr>
                   12783: <tr>
1.290     gutterid 12784: <td>USER_SPECIFIC_PKGS</td>
1.292   ! leot     12785: <td>USE_ABI_DEPENDS</td>
1.269     leot     12786: </tr>
                   12787: <tr>
1.290     gutterid 12788: <td>USE_APR</td>
1.292   ! leot     12789: <td>USE_BSD_MAKEFILE</td>
1.269     leot     12790: </tr>
                   12791: <tr>
1.290     gutterid 12792: <td>USE_BUILTIN</td>
1.292   ! leot     12793: <td>USE_CROSS_COMPILE</td>
1.269     leot     12794: </tr>
                   12795: <tr>
1.290     gutterid 12796: <td>USE_CURSES</td>
1.292   ! leot     12797: <td>USE_CWRAPPERS</td>
1.269     leot     12798: </tr>
                   12799: <tr>
1.290     gutterid 12800: <td>USE_DB185</td>
1.292   ! leot     12801: <td>USE_FEATURES</td>
1.269     leot     12802: </tr>
                   12803: <tr>
1.290     gutterid 12804: <td>USE_GAMESGROUP</td>
1.292   ! leot     12805: <td>USE_GCC_RUNTIME</td>
1.269     leot     12806: </tr>
                   12807: <tr>
1.290     gutterid 12808: <td>USE_IMAKE</td>
1.292   ! leot     12809: <td>USE_JAVA</td>
1.269     leot     12810: </tr>
                   12811: <tr>
1.290     gutterid 12812: <td>USE_JAVA2</td>
1.292   ! leot     12813: <td>USE_LANGUAGES</td>
1.269     leot     12814: </tr>
                   12815: <tr>
1.290     gutterid 12816: <td>USE_LIBTOOL</td>
1.292   ! leot     12817: <td>USE_NATIVE_GCC</td>
1.269     leot     12818: </tr>
                   12819: <tr>
1.290     gutterid 12820: <td>USE_NETBSD_REPO</td>
1.292   ! leot     12821: <td>USE_PKGSRC_GCC</td>
1.269     leot     12822: </tr>
                   12823: <tr>
1.290     gutterid 12824: <td>USE_PKGSRC_GCC_RUNTIME</td>
1.292   ! leot     12825: <td>USE_PKGTASKS</td>
1.269     leot     12826: </tr>
                   12827: <tr>
1.290     gutterid 12828: <td>USE_PKG_ADMIN_DIGEST</td>
1.292   ! leot     12829: <td>USE_RUBY_EXTCONF</td>
1.269     leot     12830: </tr>
                   12831: <tr>
1.290     gutterid 12832: <td>USE_RUBY_INSTALL</td>
1.292   ! leot     12833: <td>USE_RUBY_SETUP</td>
1.269     leot     12834: </tr>
                   12835: <tr>
1.290     gutterid 12836: <td>USE_RUBY_SETUP_PKG</td>
1.292   ! leot     12837: <td>USE_TOOLS</td>
1.269     leot     12838: </tr>
                   12839: <tr>
1.290     gutterid 12840: <td>UUCP_GROUP</td>
1.292   ! leot     12841: <td>UUCP_USER</td>
1.269     leot     12842: </tr>
                   12843: <tr>
1.290     gutterid 12844: <td>VARBASE</td>
1.292   ! leot     12845: <td>VARNAME</td>
1.269     leot     12846: </tr>
                   12847: <tr>
1.290     gutterid 12848: <td>VIM_EXTRA_OPTS</td>
1.292   ! leot     12849: <td>WARNING_MSG</td>
1.269     leot     12850: </tr>
                   12851: <tr>
1.290     gutterid 12852: <td>WCALC_CGIDIR</td>
1.292   ! leot     12853: <td>WCALC_CGIPATH</td>
1.269     leot     12854: </tr>
                   12855: <tr>
1.290     gutterid 12856: <td>WCALC_HTMLDIR</td>
1.292   ! leot     12857: <td>WCALC_HTMLPATH</td>
1.269     leot     12858: </tr>
                   12859: <tr>
1.290     gutterid 12860: <td>WDM_MANAGERS</td>
1.292   ! leot     12861: <td>WRAPPER_REORDER_CMDS</td>
1.269     leot     12862: </tr>
                   12863: <tr>
1.290     gutterid 12864: <td>WRKDIR</td>
1.292   ! leot     12865: <td>WRKDIR_BASENAME</td>
1.269     leot     12866: </tr>
                   12867: <tr>
1.290     gutterid 12868: <td>WRKDIR_LOCKTYPE</td>
1.292   ! leot     12869: <td>WRKLOG</td>
1.269     leot     12870: </tr>
                   12871: <tr>
1.290     gutterid 12872: <td>WRKOBJDIR</td>
1.292   ! leot     12873: <td>WRKSRC</td>
1.269     leot     12874: </tr>
                   12875: <tr>
1.290     gutterid 12876: <td>X10_PORT</td>
1.292   ! leot     12877: <td>X11</td>
1.269     leot     12878: </tr>
                   12879: <tr>
1.290     gutterid 12880: <td>X11BASE</td>
1.292   ! leot     12881: <td>X11_PKGSRCDIR</td>
1.269     leot     12882: </tr>
                   12883: <tr>
1.290     gutterid 12884: <td>X11_TYPE</td>
1.292   ! leot     12885: <td>X509_CERTIFICATE</td>
1.269     leot     12886: </tr>
                   12887: <tr>
1.290     gutterid 12888: <td>X509_KEY</td>
1.292   ! leot     12889: <td>XAW_TYPE</td>
1.269     leot     12890: </tr>
                   12891: <tr>
1.290     gutterid 12892: <td>XLOCK_DEFAULT_MODE</td>
1.292   ! leot     12893: <td>XMKMF_FLAGS</td>
1.269     leot     12894: </tr>
                   12895: <tr>
1.287     rillig   12896: <td>XXX</td>
1.292   ! leot     12897: <td>XXXX</td>
1.269     leot     12898: </tr>
                   12899: <tr>
1.287     rillig   12900: <td>YES</td>
1.292   ! leot     12901: <td>ZSH_STATIC</td>
1.274     rillig   12902: </tr>
                   12903: <tr>
1.289     leot     12904: <td>__stdc__</td>
1.292   ! leot     12905: <td>_vargroups</td>
1.269     leot     12906: </tr>
                   12907: <tr>
1.289     leot     12908: <td>accept</td>
1.292   ! leot     12909: <td>acquire-localbase-lock</td>
1.289     leot     12910: </tr>
                   12911: <tr>
                   12912: <td>acquire-lock</td>
1.292   ! leot     12913: <td>add</td>
1.269     leot     12914: </tr>
                   12915: <tr>
1.289     leot     12916: <td>administrator</td>
1.292   ! leot     12917: <td>alloca</td>
1.269     leot     12918: </tr>
                   12919: <tr>
1.274     rillig   12920: <td>alternatives</td>
1.292   ! leot     12921: <td>aslr</td>
1.289     leot     12922: </tr>
                   12923: <tr>
                   12924: <td>asprintf</td>
1.292   ! leot     12925: <td>atlas</td>
1.269     leot     12926: </tr>
                   12927: <tr>
1.289     leot     12928: <td>autoconf</td>
1.290     gutterid 12929: <td>automake</td>
1.269     leot     12930: </tr>
                   12931: <tr>
1.289     leot     12932: <td>autoreconf</td>
1.290     gutterid 12933: <td>awk</td>
1.269     leot     12934: </tr>
                   12935: <tr>
1.289     leot     12936: <td>bash</td>
1.290     gutterid 12937: <td>big-endian</td>
1.271     brook    12938: </tr>
                   12939: <tr>
1.289     leot     12940: <td>bin-install</td>
1.290     gutterid 12941: <td>bind</td>
1.269     leot     12942: </tr>
                   12943: <tr>
1.287     rillig   12944: <td>binpkg-list</td>
1.292   ! leot     12945: <td>blas</td>
        !          12946: </tr>
        !          12947: <tr>
1.287     rillig   12948: <td>bootstrap-depends</td>
1.292   ! leot     12949: <td>broken</td>
1.274     rillig   12950: </tr>
                   12951: <tr>
1.287     rillig   12952: <td>broken_on_platform</td>
1.292   ! leot     12953: <td>bsd</td>
1.269     leot     12954: </tr>
                   12955: <tr>
1.289     leot     12956: <td>bsd.prog.mk</td>
1.292   ! leot     12957: <td>build</td>
1.289     leot     12958: </tr>
                   12959: <tr>
1.287     rillig   12960: <td>build-env</td>
1.292   ! leot     12961: <td>buildlink-directories</td>
1.269     leot     12962: </tr>
                   12963: <tr>
1.287     rillig   12964: <td>buildlink-oss-soundcard-h</td>
1.292   ! leot     12965: <td>c</td>
1.269     leot     12966: </tr>
                   12967: <tr>
1.287     rillig   12968: <td>c++</td>
1.292   ! leot     12969: <td>ccache</td>
1.269     leot     12970: </tr>
                   12971: <tr>
1.287     rillig   12972: <td>cce</td>
1.292   ! leot     12973: <td>cdefs</td>
1.269     leot     12974: </tr>
                   12975: <tr>
1.289     leot     12976: <td>ceil</td>
1.292   ! leot     12977: <td>changes</td>
1.289     leot     12978: </tr>
                   12979: <tr>
                   12980: <td>changes-entry</td>
1.292   ! leot     12981: <td>changes-entry-noupdate</td>
1.269     leot     12982: </tr>
                   12983: <tr>
1.289     leot     12984: <td>check</td>
1.292   ! leot     12985: <td>check-clean</td>
1.269     leot     12986: </tr>
                   12987: <tr>
1.289     leot     12988: <td>check-files</td>
1.292   ! leot     12989: <td>check-files-clean</td>
1.269     leot     12990: </tr>
                   12991: <tr>
1.289     leot     12992: <td>check-vulnerable</td>
1.292   ! leot     12993: <td>checksum</td>
1.269     leot     12994: </tr>
                   12995: <tr>
1.289     leot     12996: <td>checksum-phase</td>
1.292   ! leot     12997: <td>clean</td>
1.269     leot     12998: </tr>
                   12999: <tr>
1.289     leot     13000: <td>clean-depends</td>
1.292   ! leot     13001: <td>cleandir</td>
1.269     leot     13002: </tr>
                   13003: <tr>
1.289     leot     13004: <td>commit</td>
1.292   ! leot     13005: <td>commit-changes-entry</td>
1.269     leot     13006: </tr>
                   13007: <tr>
1.289     leot     13008: <td>compact</td>
1.292   ! leot     13009: <td>compiler</td>
1.269     leot     13010: </tr>
                   13011: <tr>
1.289     leot     13012: <td>conf</td>
1.292   ! leot     13013: <td>config.guess</td>
1.269     leot     13014: </tr>
                   13015: <tr>
1.289     leot     13016: <td>config.sub</td>
1.292   ! leot     13017: <td>configuration</td>
1.269     leot     13018: </tr>
                   13019: <tr>
1.289     leot     13020: <td>configure</td>
1.292   ! leot     13021: <td>configure-env</td>
1.269     leot     13022: </tr>
                   13023: <tr>
1.289     leot     13024: <td>configure-help</td>
1.292   ! leot     13025: <td>configure_args</td>
1.269     leot     13026: </tr>
                   13027: <tr>
1.289     leot     13028: <td>connect</td>
1.292   ! leot     13029: <td>cos</td>
1.269     leot     13030: </tr>
                   13031: <tr>
1.281     leot     13032: <td>cputime</td>
1.292   ! leot     13033: <td>create-usergroup</td>
1.289     leot     13034: </tr>
                   13035: <tr>
                   13036: <td>csh</td>
1.292   ! leot     13037: <td>ctf</td>
1.269     leot     13038: </tr>
                   13039: <tr>
1.292   ! leot     13040: <td>cvs</td>
1.290     gutterid 13041: <td>debug</td>
1.269     leot     13042: </tr>
                   13043: <tr>
1.289     leot     13044: <td>declaration</td>
1.290     gutterid 13045: <td>declare</td>
1.269     leot     13046: </tr>
                   13047: <tr>
1.289     leot     13048: <td>defined</td>
1.290     gutterid 13049: <td>depend</td>
1.269     leot     13050: </tr>
                   13051: <tr>
1.289     leot     13052: <td>dependencies</td>
1.290     gutterid 13053: <td>depends</td>
1.269     leot     13054: </tr>
                   13055: <tr>
1.289     leot     13056: <td>depends-checksum</td>
1.290     gutterid 13057: <td>depends-fetch</td>
1.269     leot     13058: </tr>
                   13059: <tr>
1.289     leot     13060: <td>deps</td>
1.290     gutterid 13061: <td>describe</td>
1.269     leot     13062: </tr>
                   13063: <tr>
1.289     leot     13064: <td>destdir</td>
1.290     gutterid 13065: <td>disable</td>
1.269     leot     13066: </tr>
                   13067: <tr>
1.289     leot     13068: <td>distclean</td>
1.290     gutterid 13069: <td>distinfo</td>
1.277     rillig   13070: </tr>
                   13071: <tr>
1.289     leot     13072: <td>dl</td>
1.290     gutterid 13073: <td>dlopen</td>
1.269     leot     13074: </tr>
                   13075: <tr>
1.289     leot     13076: <td>do-build</td>
1.290     gutterid 13077: <td>do-buildlink</td>
1.269     leot     13078: </tr>
                   13079: <tr>
1.289     leot     13080: <td>do-clean</td>
1.290     gutterid 13081: <td>do-configure</td>
1.269     leot     13082: </tr>
                   13083: <tr>
1.289     leot     13084: <td>do-configure-post-hook</td>
1.290     gutterid 13085: <td>do-extract</td>
1.285     rillig   13086: </tr>
                   13087: <tr>
1.289     leot     13088: <td>do-fetch</td>
1.292   ! leot     13089: <td>do-install</td>
        !          13090: </tr>
        !          13091: <tr>
1.289     leot     13092: <td>emul</td>
1.292   ! leot     13093: <td>emul-distinfo</td>
1.289     leot     13094: </tr>
                   13095: <tr>
                   13096: <td>emul-fetch</td>
1.292   ! leot     13097: <td>emulation</td>
1.269     leot     13098: </tr>
                   13099: <tr>
1.289     leot     13100: <td>emulator</td>
1.292   ! leot     13101: <td>enable</td>
1.274     rillig   13102: </tr>
                   13103: <tr>
1.289     leot     13104: <td>endian</td>
1.292   ! leot     13105: <td>endif</td>
1.269     leot     13106: </tr>
                   13107: <tr>
1.285     rillig   13108: <td>enomem</td>
1.290     gutterid 13109: <td>err</td>
1.269     leot     13110: </tr>
                   13111: <tr>
1.285     rillig   13112: <td>errx</td>
1.290     gutterid 13113: <td>etc</td>
1.269     leot     13114: </tr>
                   13115: <tr>
1.289     leot     13116: <td>exp</td>
1.290     gutterid 13117: <td>extract-rpm</td>
1.289     leot     13118: </tr>
                   13119: <tr>
                   13120: <td>fabs</td>
1.290     gutterid 13121: <td>feature</td>
1.269     leot     13122: </tr>
                   13123: <tr>
1.274     rillig   13124: <td>features</td>
1.290     gutterid 13125: <td>fetch</td>
1.269     leot     13126: </tr>
                   13127: <tr>
1.274     rillig   13128: <td>fetch-list</td>
1.290     gutterid 13129: <td>follows</td>
1.269     leot     13130: </tr>
                   13131: <tr>
1.274     rillig   13132: <td>forbids</td>
1.290     gutterid 13133: <td>form</td>
1.269     leot     13134: </tr>
                   13135: <tr>
1.274     rillig   13136: <td>format</td>
1.290     gutterid 13137: <td>fortify</td>
1.269     leot     13138: </tr>
                   13139: <tr>
1.274     rillig   13140: <td>fortify_source</td>
1.292   ! leot     13141: <td>fossil</td>
        !          13142: </tr>
        !          13143: <tr>
1.270     leot     13144: <td>friend</td>
1.292   ! leot     13145: <td>fts</td>
1.269     leot     13146: </tr>
                   13147: <tr>
1.285     rillig   13148: <td>fts_close</td>
1.292   ! leot     13149: <td>fts_open</td>
1.269     leot     13150: </tr>
                   13151: <tr>
1.285     rillig   13152: <td>fts_read</td>
1.292   ! leot     13153: <td>fts_set</td>
1.269     leot     13154: </tr>
                   13155: <tr>
1.289     leot     13156: <td>gcc</td>
1.292   ! leot     13157: <td>gethostbyaddr</td>
1.289     leot     13158: </tr>
                   13159: <tr>
                   13160: <td>gethostbyname</td>
1.292   ! leot     13161: <td>gethostbyname2</td>
1.269     leot     13162: </tr>
                   13163: <tr>
1.285     rillig   13164: <td>getopt_long</td>
1.292   ! leot     13165: <td>getprogname</td>
1.269     leot     13166: </tr>
                   13167: <tr>
1.289     leot     13168: <td>getservbyname</td>
1.292   ! leot     13169: <td>getservbyport</td>
1.289     leot     13170: </tr>
                   13171: <tr>
                   13172: <td>getservent</td>
1.292   ! leot     13173: <td>gettext</td>
1.289     leot     13174: </tr>
                   13175: <tr>
1.292   ! leot     13176: <td>git</td>
1.290     gutterid 13177: <td>github</td>
1.269     leot     13178: </tr>
                   13179: <tr>
1.292   ! leot     13180: <td>gitlab</td>
1.289     leot     13181: <td>glob</td>
1.292   ! leot     13182: </tr>
        !          13183: <tr>
1.290     gutterid 13184: <td>gnu</td>
1.292   ! leot     13185: <td>gnu_configure_strict</td>
1.274     rillig   13186: </tr>
                   13187: <tr>
1.290     gutterid 13188: <td>go</td>
1.292   ! leot     13189: <td>go-deps</td>
1.269     leot     13190: </tr>
                   13191: <tr>
1.290     gutterid 13192: <td>golang</td>
1.292   ! leot     13193: <td>guess-license</td>
1.269     leot     13194: </tr>
                   13195: <tr>
1.290     gutterid 13196: <td>hashbang</td>
1.292   ! leot     13197: <td>heimdal</td>
1.269     leot     13198: </tr>
                   13199: <tr>
1.285     rillig   13200: <td>help</td>
1.292   ! leot     13201: <td>hg</td>
1.269     leot     13202: </tr>
                   13203: <tr>
1.285     rillig   13204: <td>imake</td>
1.289     leot     13205: <td>increment</td>
1.269     leot     13206: </tr>
                   13207: <tr>
1.289     leot     13208: <td>inet_aton</td>
1.285     rillig   13209: <td>interp</td>
1.269     leot     13210: </tr>
                   13211: <tr>
1.270     leot     13212: <td>interpreter</td>
1.285     rillig   13213: <td>intl</td>
1.269     leot     13214: </tr>
                   13215: <tr>
1.270     leot     13216: <td>iso</td>
1.285     rillig   13217: <td>kerberos</td>
1.269     leot     13218: </tr>
                   13219: <tr>
1.270     leot     13220: <td>krb</td>
1.285     rillig   13221: <td>krb5</td>
1.269     leot     13222: </tr>
                   13223: <tr>
1.270     leot     13224: <td>ksh</td>
1.292   ! leot     13225: <td>lapack</td>
        !          13226: </tr>
        !          13227: <tr>
1.290     gutterid 13228: <td>latex</td>
1.292   ! leot     13229: <td>libintl_bindtextdomain</td>
1.269     leot     13230: </tr>
                   13231: <tr>
1.290     gutterid 13232: <td>libintl_gettext</td>
1.292   ! leot     13233: <td>libintl_textdomain</td>
1.289     leot     13234: </tr>
                   13235: <tr>
1.290     gutterid 13236: <td>libnbcompat</td>
1.292   ! leot     13237: <td>libs</td>
1.274     rillig   13238: </tr>
                   13239: <tr>
1.290     gutterid 13240: <td>libtool</td>
1.292   ! leot     13241: <td>licence</td>
1.271     brook    13242: </tr>
                   13243: <tr>
1.290     gutterid 13244: <td>license</td>
1.292   ! leot     13245: <td>lintl</td>
1.269     leot     13246: </tr>
                   13247: <tr>
1.290     gutterid 13248: <td>little-endian</td>
1.292   ! leot     13249: <td>lock</td>
1.269     leot     13250: </tr>
                   13251: <tr>
1.290     gutterid 13252: <td>locking</td>
1.292   ! leot     13253: <td>lvalue</td>
1.269     leot     13254: </tr>
                   13255: <tr>
1.290     gutterid 13256: <td>make</td>
1.292   ! leot     13257: <td>makesum</td>
1.269     leot     13258: </tr>
                   13259: <tr>
1.289     leot     13260: <td>memory</td>
1.292   ! leot     13261: <td>mercurial</td>
1.269     leot     13262: </tr>
                   13263: <tr>
1.289     leot     13264: <td>meta</td>
1.273     brook    13265: <td>meta-package</td>
1.269     leot     13266: </tr>
                   13267: <tr>
1.289     leot     13268: <td>meta_package</td>
1.273     brook    13269: <td>mit-krb5</td>
1.269     leot     13270: </tr>
                   13271: <tr>
1.289     leot     13272: <td>mk.conf</td>
1.292   ! leot     13273: <td>mkl</td>
        !          13274: </tr>
        !          13275: <tr>
1.290     gutterid 13276: <td>mount</td>
1.292   ! leot     13277: <td>mprotect</td>
1.274     rillig   13278: </tr>
                   13279: <tr>
1.290     gutterid 13280: <td>mremap</td>
1.292   ! leot     13281: <td>nb</td>
1.269     leot     13282: </tr>
                   13283: <tr>
1.290     gutterid 13284: <td>nbcompat</td>
1.292   ! leot     13285: <td>obstack</td>
1.269     leot     13286: </tr>
                   13287: <tr>
1.290     gutterid 13288: <td>obstack_ptr_grow</td>
1.292   ! leot     13289: <td>occurs</td>
1.269     leot     13290: </tr>
                   13291: <tr>
1.274     rillig   13292: <td>only</td>
1.292   ! leot     13293: <td>openblas</td>
1.269     leot     13294: </tr>
                   13295: <tr>
1.273     brook    13296: <td>options</td>
1.285     rillig   13297: <td>options.mk</td>
1.269     leot     13298: </tr>
                   13299: <tr>
1.273     brook    13300: <td>order</td>
1.285     rillig   13301: <td>override</td>
1.271     brook    13302: </tr>
                   13303: <tr>
1.273     brook    13304: <td>override-intltool</td>
1.285     rillig   13305: <td>override-message-intltool</td>
1.269     leot     13306: </tr>
                   13307: <tr>
1.273     brook    13308: <td>package</td>
1.285     rillig   13309: <td>parallel</td>
1.269     leot     13310: </tr>
                   13311: <tr>
1.285     rillig   13312: <td>path</td>
1.289     leot     13313: <td>pax</td>
1.269     leot     13314: </tr>
                   13315: <tr>
1.285     rillig   13316: <td>paxctl</td>
1.289     leot     13317: <td>pbulk-index</td>
1.269     leot     13318: </tr>
                   13319: <tr>
1.285     rillig   13320: <td>pc</td>
1.289     leot     13321: <td>perl</td>
1.269     leot     13322: </tr>
                   13323: <tr>
1.285     rillig   13324: <td>perl5</td>
1.289     leot     13325: <td>perms</td>
1.269     leot     13326: </tr>
                   13327: <tr>
1.285     rillig   13328: <td>php</td>
1.289     leot     13329: <td>pkg-build-options</td>
1.269     leot     13330: </tr>
                   13331: <tr>
1.285     rillig   13332: <td>pkg-config</td>
1.289     leot     13333: <td>pkg_build_options</td>
1.269     leot     13334: </tr>
                   13335: <tr>
1.285     rillig   13336: <td>platform</td>
1.289     leot     13337: <td>plist</td>
1.269     leot     13338: </tr>
                   13339: <tr>
1.285     rillig   13340: <td>post-extract</td>
1.289     leot     13341: <td>post-fetch</td>
1.269     leot     13342: </tr>
                   13343: <tr>
1.285     rillig   13344: <td>post-wrapper</td>
1.289     leot     13345: <td>pre-build-checks-hook</td>
1.269     leot     13346: </tr>
                   13347: <tr>
1.273     brook    13348: <td>pre-configure</td>
1.289     leot     13349: <td>pre-configure-checks-hook</td>
                   13350: </tr>
                   13351: <tr>
1.285     rillig   13352: <td>pre-extract</td>
1.289     leot     13353: <td>pre-fetch</td>
1.269     leot     13354: </tr>
                   13355: <tr>
1.285     rillig   13356: <td>print-go-deps</td>
1.289     leot     13357: <td>print-plist</td>
1.269     leot     13358: </tr>
                   13359: <tr>
1.285     rillig   13360: <td>print-summary-data</td>
1.289     leot     13361: <td>privileged-install-hook</td>
1.269     leot     13362: </tr>
                   13363: <tr>
1.285     rillig   13364: <td>pypi</td>
1.289     leot     13365: <td>python</td>
1.269     leot     13366: </tr>
                   13367: <tr>
1.285     rillig   13368: <td>readme-all</td>
1.289     leot     13369: <td>recv</td>
1.269     leot     13370: </tr>
                   13371: <tr>
1.289     leot     13372: <td>recvfrom</td>
1.273     brook    13373: <td>regcomp</td>
1.289     leot     13374: </tr>
                   13375: <tr>
                   13376: <td>release-localbase-lock</td>
                   13377: <td>release-lock</td>
                   13378: </tr>
                   13379: <tr>
1.285     rillig   13380: <td>relro</td>
1.289     leot     13381: <td>rename</td>
1.269     leot     13382: </tr>
                   13383: <tr>
1.285     rillig   13384: <td>reorder</td>
1.289     leot     13385: <td>replace</td>
1.269     leot     13386: </tr>
                   13387: <tr>
1.285     rillig   13388: <td>replace_interpreter</td>
1.289     leot     13389: <td>reproducible</td>
1.269     leot     13390: </tr>
                   13391: <tr>
1.285     rillig   13392: <td>resolv</td>
1.289     leot     13393: <td>root</td>
1.269     leot     13394: </tr>
                   13395: <tr>
1.285     rillig   13396: <td>ruby</td>
1.289     leot     13397: <td>send</td>
                   13398: </tr>
                   13399: <tr>
                   13400: <td>sendfile</td>
                   13401: <td>sendto</td>
1.269     leot     13402: </tr>
                   13403: <tr>
1.273     brook    13404: <td>setenv</td>
1.285     rillig   13405: <td>setgid</td>
1.269     leot     13406: </tr>
                   13407: <tr>
1.273     brook    13408: <td>setprogname</td>
1.285     rillig   13409: <td>setuid</td>
1.269     leot     13410: </tr>
                   13411: <tr>
1.273     brook    13412: <td>sh</td>
1.285     rillig   13413: <td>show</td>
1.269     leot     13414: </tr>
                   13415: <tr>
1.273     brook    13416: <td>show-all</td>
1.285     rillig   13417: <td>show-build-defs</td>
1.269     leot     13418: </tr>
                   13419: <tr>
1.273     brook    13420: <td>show-depends</td>
1.285     rillig   13421: <td>show-deps</td>
1.269     leot     13422: </tr>
                   13423: <tr>
1.273     brook    13424: <td>show-distfiles</td>
1.285     rillig   13425: <td>show-downlevel</td>
1.269     leot     13426: </tr>
                   13427: <tr>
1.273     brook    13428: <td>show-subdir-var</td>
1.285     rillig   13429: <td>show-tools</td>
1.269     leot     13430: </tr>
                   13431: <tr>
1.273     brook    13432: <td>show-var</td>
1.285     rillig   13433: <td>show-vars</td>
1.269     leot     13434: </tr>
                   13435: <tr>
1.273     brook    13436: <td>snprintf</td>
1.289     leot     13437: <td>socket</td>
                   13438: </tr>
                   13439: <tr>
1.285     rillig   13440: <td>ssp</td>
1.289     leot     13441: <td>st_mode</td>
1.269     leot     13442: </tr>
                   13443: <tr>
1.285     rillig   13444: <td>stage-install</td>
1.289     leot     13445: <td>strcasestr</td>
1.269     leot     13446: </tr>
                   13447: <tr>
1.277     rillig   13448: <td>strict</td>
1.285     rillig   13449: <td>strip</td>
1.277     rillig   13450: </tr>
                   13451: <tr>
1.289     leot     13452: <td>strndup</td>
1.276     leot     13453: <td>strnlen</td>
1.269     leot     13454: </tr>
                   13455: <tr>
1.289     leot     13456: <td>strsep</td>
1.276     leot     13457: <td>subst</td>
1.289     leot     13458: </tr>
                   13459: <tr>
                   13460: <td>substitutions</td>
1.292   ! leot     13461: <td>subversion</td>
        !          13462: </tr>
        !          13463: <tr>
1.290     gutterid 13464: <td>sun</td>
1.292   ! leot     13465: <td>sunpro</td>
1.269     leot     13466: </tr>
                   13467: <tr>
1.276     leot     13468: <td>sunwspro</td>
1.292   ! leot     13469: <td>svn</td>
1.269     leot     13470: </tr>
                   13471: <tr>
1.276     leot     13472: <td>symlink</td>
1.285     rillig   13473: <td>test</td>
1.269     leot     13474: </tr>
                   13475: <tr>
1.289     leot     13476: <td>test-env</td>
1.270     leot     13477: <td>tex</td>
1.269     leot     13478: </tr>
                   13479: <tr>
1.289     leot     13480: <td>texlive</td>
1.270     leot     13481: <td>tmp</td>
1.269     leot     13482: </tr>
                   13483: <tr>
1.289     leot     13484: <td>tool</td>
1.270     leot     13485: <td>tools</td>
1.269     leot     13486: </tr>
                   13487: <tr>
1.289     leot     13488: <td>tools-libtool-m4-override</td>
1.270     leot     13489: <td>type</td>
1.269     leot     13490: </tr>
                   13491: <tr>
1.289     leot     13492: <td>ulimit</td>
1.270     leot     13493: <td>undefined</td>
1.269     leot     13494: </tr>
                   13495: <tr>
1.289     leot     13496: <td>undo-replace</td>
1.270     leot     13497: <td>unlimit</td>
1.269     leot     13498: </tr>
                   13499: <tr>
1.289     leot     13500: <td>unprivileged</td>
1.270     leot     13501: <td>unprivileged-install-hook</td>
1.269     leot     13502: </tr>
                   13503: <tr>
1.289     leot     13504: <td>unstripped</td>
1.270     leot     13505: <td>update</td>
1.269     leot     13506: </tr>
                   13507: <tr>
1.289     leot     13508: <td>upload</td>
1.270     leot     13509: <td>upload-distfiles</td>
1.269     leot     13510: </tr>
                   13511: <tr>
1.270     leot     13512: <td>use_tools</td>
1.285     rillig   13513: <td>user</td>
1.269     leot     13514: </tr>
                   13515: <tr>
1.270     leot     13516: <td>utimes</td>
1.285     rillig   13517: <td>vasprintf</td>
1.269     leot     13518: </tr>
                   13519: <tr>
1.270     leot     13520: <td>verbose</td>
1.285     rillig   13521: <td>vsnprintf</td>
1.269     leot     13522: </tr>
                   13523: <tr>
1.270     leot     13524: <td>warn</td>
1.285     rillig   13525: <td>warning</td>
1.269     leot     13526: </tr>
                   13527: <tr>
1.270     leot     13528: <td>warnings</td>
1.285     rillig   13529: <td>warnx</td>
1.269     leot     13530: </tr>
                   13531: <tr>
1.289     leot     13532: <td>wattr_off</td>
                   13533: <td>wattr_on</td>
1.269     leot     13534: </tr>
                   13535: <tr>
1.289     leot     13536: <td>work</td>
1.270     leot     13537: <td>wrapper</td>
1.269     leot     13538: </tr>
                   13539: <tr>
1.289     leot     13540: <td>wrkdir</td>
1.285     rillig   13541: <td> </td>
1.269     leot     13542: </tr>
                   13543: </table>
1.267     rillig   13544: </div>
                   13545: <div class="appendix">
                   13546: <div class="titlepage"><div><div><h1 class="title">
                   13547: <a name="editing"></a>Appendix E. Editing guidelines for the pkgsrc guide</h1></div></div></div>
1.75      rillig   13548: <div class="toc">
                   13549: <p><b>Table of Contents</b></p>
1.210     leot     13550: <dl class="toc">
1.267     rillig   13551: <dt><span class="sect1"><a href="#targets">E.1. Make targets</a></span></dt>
                   13552: <dt><span class="sect1"><a href="#procedure">E.2. Procedure</a></span></dt>
1.75      rillig   13553: </dl>
                   13554: </div>
1.79      rillig   13555: <p>This section contains information on editing the pkgsrc
                   13556:        guide itself.</p>
1.148     asau     13557: <div class="sect1">
1.75      rillig   13558: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   13559: <a name="targets"></a>E.1. Make targets</h2></div></div></div>
1.79      rillig   13560: <p>The pkgsrc guide's source code is stored in
                   13561:        <code class="filename">pkgsrc/doc/guide/files</code>, and several files
                   13562:        are created from it:</p>
1.148     asau     13563: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.128     wiz      13564: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
                   13565: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
1.289     leot     13566: <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>
                   13567: <li class="listitem"><p><a class="ulink" href="https://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf" target="_top">https://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf</a>:
1.79      rillig   13568:        The PDF version of the pkgsrc guide.</p></li>
1.289     leot     13569: <li class="listitem"><p><a class="ulink" href="https://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps" target="_top">https://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps</a>:
1.79      rillig   13570:        PostScript version of the pkgsrc guide.</p></li>
1.75      rillig   13571: </ul></div>
                   13572: </div>
1.148     asau     13573: <div class="sect1">
1.75      rillig   13574: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.267     rillig   13575: <a name="procedure"></a>E.2. Procedure</h2></div></div></div>
1.79      rillig   13576: <p>The procedure to edit the pkgsrc guide is:</p>
1.128     wiz      13577: <div class="procedure"><ol class="procedure" type="1">
1.148     asau     13578: <li class="step"><p>Make sure you have the packages needed to
1.83      wiz      13579:        regenerate the pkgsrc guide (and other XML-based NetBSD
1.151     obache   13580:        documentation) installed. These are automatically installed when
1.250     leot     13581:        you install the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/pkgsrc-guide-tools/README.html" target="_top"><code class="filename">meta-pkgs/pkgsrc-guide-tools</code></a> package.</p></li>
1.148     asau     13582: <li class="step"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.79      rillig   13583:        right directory. All further steps will take place
                   13584:        here.</p></li>
1.148     asau     13585: <li class="step"><p>Edit the XML file(s) in
1.79      rillig   13586:        <code class="filename">files/</code>.</p></li>
1.148     asau     13587: <li class="step"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.79      rillig   13588:        guide for valid XML and to build the final output files. If you
                   13589:        get any errors at this stage, you can just edit the files, as
                   13590:        there are only symbolic links in the working directory, pointing
                   13591:        to the files in <code class="filename">files/</code>.</p></li>
1.148     asau     13592: <li class="step"><p><span class="command"><strong>(cd files &amp;&amp; cvs
1.79      rillig   13593:        commit)</strong></span></p></li>
1.148     asau     13594: <li class="step"><p>Run <span class="command"><strong>bmake clean &amp;&amp; bmake</strong></span> to
1.79      rillig   13595:        regenerate the output files with the proper RCS
                   13596:        Ids.</p></li>
1.148     asau     13597: <li class="step">
1.110     hubertf  13598: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.91      rillig   13599:        commit the files in both <code class="filename">pkgsrc/doc</code> and
                   13600:        <code class="filename">htdocs</code>.</p>
1.148     asau     13601: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.91      rillig   13602: <h3 class="title">Note</h3>
                   13603: <p>If you have added, removed or renamed some chapters,
1.110     hubertf  13604:        you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
                   13605:        <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.91      rillig   13606:        directory.</p>
                   13607: </div>
                   13608: </li>
1.79      rillig   13609: </ol></div>
1.75      rillig   13610: </div>
                   13611: </div>
                   13612: </div></body>
1.1       grant    13613: </html>

CVSweb <webmaster@jp.NetBSD.org>