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

1.1       dsieger     1: <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
                      2: <html>
                      3: <head>
                      4: <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1">
                      5: <title>The pkgsrc guide</title>
1.25      spz         6: <link rel="stylesheet" type="text/css" href="/global.css">
1.1       dsieger     7: <meta name="generator" content="DocBook XSL Stylesheets VX.X.X">
                      8: <meta name="description" content="pkgsrc is a centralized package management system for Unix-like operating systems. This guide provides information for users and developers of pkgsrc. It covers installation of binary and source packages, creation of binary and source packages and a high-level overview about the infrastructure.">
                      9: </head>
1.41      asau       10: <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF"><div class="book">
1.1       dsieger    11: <div class="titlepage">
                     12: <div>
                     13: <div><h1 class="title">
                     14: <a name="the-pkgsrc-guide"></a>The pkgsrc guide</h1></div>
                     15: <div><h2 class="subtitle">Documentation on the NetBSD packages system</h2></div>
                     16: <div><div class="authorgroup">
                     17: <div class="author">
                     18: <h3 class="author">
                     19: <span class="firstname">Alistair</span> <span class="surname">Crooks</span>
                     20: </h3>
1.10      hubertf    21: <div class="affiliation"><div class="address"><p><code class="email">&lt;<a class="email" href="mailto:agc@NetBSD.org">agc@NetBSD.org</a>&gt;</code></p></div></div>
1.1       dsieger    22: </div>
                     23: <div class="author">
                     24: <h3 class="author">
                     25: <span class="firstname">Hubert</span> <span class="surname">Feyrer</span>
                     26: </h3>
1.10      hubertf    27: <div class="affiliation"><div class="address"><p><code class="email">&lt;<a class="email" href="mailto:hubertf@NetBSD.org">hubertf@NetBSD.org</a>&gt;</code></p></div></div>
1.1       dsieger    28: </div>
                     29: <h3 class="corpauthor">
                     30:         The pkgsrc Developers
                     31:       </h3>
                     32: </div></div>
1.166     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.41      asau       35: <div><div class="abstract">
1.1       dsieger    36: <p class="title"><b>Abstract</b></p>
                     37: <p>pkgsrc is a centralized package management system for
                     38:        Unix-like operating systems. This guide provides information for
                     39:        users and developers of pkgsrc. It covers installation of binary
                     40:        and source packages, creation of binary and source packages and
                     41:        a high-level overview about the infrastructure.</p>
                     42: </div></div>
                     43: </div>
                     44: <hr>
                     45: </div>
                     46: <div class="toc">
                     47: <p><b>Table of Contents</b></p>
1.100     leot       48: <dl class="toc">
1.1       dsieger    49: <dt><span class="chapter"><a href="#introduction">1. What is pkgsrc?</a></span></dt>
                     50: <dd><dl>
                     51: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
                     52: <dd><dl>
                     53: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
                     54: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
                     55: </dl></dd>
                     56: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
                     57: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
                     58: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
                     59: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
                     60: </dl></dd>
                     61: <dt><span class="part"><a href="#users-guide">I. The pkgsrc user's guide</a></span></dt>
                     62: <dd><dl>
1.154     rillig     63: <dt><span class="chapter"><a href="#help-user">2. Getting help</a></span></dt>
                     64: <dt><span class="chapter"><a href="#getting">3. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
1.1       dsieger    65: <dd><dl>
1.154     rillig     66: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.1       dsieger    67: <dd><dl>
1.154     rillig     68: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
                     69: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.1       dsieger    70: </dl></dd>
1.154     rillig     71: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.1       dsieger    72: <dd><dl>
1.154     rillig     73: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
                     74: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.1       dsieger    75: </dl></dd>
                     76: </dl></dd>
1.154     rillig     77: <dt><span class="chapter"><a href="#platforms">4. Using pkgsrc on systems other than NetBSD</a></span></dt>
1.1       dsieger    78: <dd><dl>
1.154     rillig     79: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
                     80: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.1       dsieger    81: </dl></dd>
1.154     rillig     82: <dt><span class="chapter"><a href="#using">5. Using pkgsrc</a></span></dt>
1.1       dsieger    83: <dd><dl>
1.154     rillig     84: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.1       dsieger    85: <dd><dl>
1.154     rillig     86: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
                     87: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
                     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.1       dsieger    93: </dl></dd>
1.154     rillig     94: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1.1       dsieger    95: <dd><dl>
1.154     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.1       dsieger    99: </dl></dd>
                    100: </dl></dd>
1.154     rillig    101: <dt><span class="chapter"><a href="#configuring">6. Configuring pkgsrc</a></span></dt>
1.1       dsieger   102: <dd><dl>
1.154     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.1       dsieger   107: <dd><dl>
1.154     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.1       dsieger   111: </dl></dd>
1.154     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.1       dsieger   114: </dl></dd>
1.154     rillig    115: <dt><span class="chapter"><a href="#binary">7. Creating binary packages</a></span></dt>
1.1       dsieger   116: <dd><dl>
1.154     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.6       rillig    119: </dl></dd>
1.154     rillig    120: <dt><span class="chapter"><a href="#bulk">8. Creating binary packages for everything in pkgsrc (bulk
1.6       rillig    121: builds)</a></span></dt>
1.1       dsieger   122: <dd><dl>
1.154     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.23      wiz       147: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</a></span></dt>
1.154     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.1       dsieger   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.154     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.1       dsieger   161: <dd><dl>
1.154     rillig    162: <dt><span class="sect1"><a href="#creating.common">12.1. Common types of packages</a></span></dt>
1.1       dsieger   163: <dd><dl>
1.154     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.160     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.1       dsieger   168: </dl></dd>
1.154     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.6       rillig    171: </dl></dd>
1.154     rillig    172: <dt><span class="chapter"><a href="#components">13. Package components - files, directories and contents</a></span></dt>
1.6       rillig    173: <dd><dl>
1.154     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.6       rillig    177: <dd><dl>
1.154     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.6       rillig    183: </dl></dd>
1.154     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.6       rillig    186: <dd><dl>
1.154     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.6       rillig    190: </dl></dd>
1.154     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.6       rillig    193: </dl></dd>
1.154     rillig    194: <dt><span class="chapter"><a href="#makefile">14. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.6       rillig    195: <dd><dl>
1.154     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.6       rillig    200: <dd><dl>
1.154     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.6       rillig    205: </dl></dd>
                    206: </dl></dd>
1.154     rillig    207: <dt><span class="chapter"><a href="#plist">15. PLIST issues</a></span></dt>
1.6       rillig    208: <dd><dl>
1.154     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.6       rillig    218: </dl></dd>
1.154     rillig    219: <dt><span class="chapter"><a href="#buildlink">16. Buildlink methodology</a></span></dt>
1.6       rillig    220: <dd><dl>
1.154     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.6       rillig    223: <dd><dl>
1.154     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.26      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.6       rillig    230: </dl></dd>
1.154     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.6       rillig    232: <dd><dl>
1.154     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.6       rillig    235: </dl></dd>
                    236: </dl></dd>
1.154     rillig    237: <dt><span class="chapter"><a href="#pkginstall">17. The pkginstall framework</a></span></dt>
1.6       rillig    238: <dd><dl>
1.154     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>
                    336: <dt><span class="sect2"><a href="#undefined-reference">21.5.3. Undefined reference to <span class="quote">&#8220;<span class="quote">...</span>&#8221;</span></a></span></dt>
                    337: <dt><span class="sect2"><a href="#out-of-memory">21.5.4. Running out of memory</a></span></dt>
                    338: </dl></dd>
                    339: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                    340: <dd><dl>
                    341: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
                    342: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
                    343: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
                    344: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
                    345: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
                    346: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing perl modules</a></span></dt>
                    347: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
                    348: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
                    349: <dt><span class="sect2"><a href="#gconf-data-files">21.6.9. Packages installing GConf data files</a></span></dt>
                    350: <dt><span class="sect2"><a href="#scrollkeeper-data-files">21.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
                    351: <dt><span class="sect2"><a href="#x11-fonts">21.6.11. Packages installing X11 fonts</a></span></dt>
                    352: <dt><span class="sect2"><a href="#gtk2-modules">21.6.12. Packages installing GTK2 modules</a></span></dt>
                    353: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.13. Packages installing SGML or XML data</a></span></dt>
                    354: <dt><span class="sect2"><a href="#mime-database">21.6.14. Packages installing extensions to the MIME database</a></span></dt>
                    355: <dt><span class="sect2"><a href="#intltool">21.6.15. Packages using intltool</a></span></dt>
                    356: <dt><span class="sect2"><a href="#startup-scripts">21.6.16. Packages installing startup scripts</a></span></dt>
                    357: <dt><span class="sect2"><a href="#tex-packages">21.6.17. Packages installing TeX modules</a></span></dt>
                    358: <dt><span class="sect2"><a href="#emulation-packages">21.6.18. Packages supporting running binaries in
1.1       dsieger   359:     emulation</a></span></dt>
1.154     rillig    360: <dt><span class="sect2"><a href="#hicolor-theme">21.6.19. Packages installing hicolor theme icons</a></span></dt>
                    361: <dt><span class="sect2"><a href="#desktop-files">21.6.20. Packages installing desktop files</a></span></dt>
1.1       dsieger   362: </dl></dd>
1.154     rillig    363: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.1       dsieger   364: </dl></dd>
1.154     rillig    365: <dt><span class="chapter"><a href="#debug">22. Debugging</a></span></dt>
                    366: <dt><span class="chapter"><a href="#submit">23. Submitting and Committing</a></span></dt>
1.1       dsieger   367: <dd><dl>
1.154     rillig    368: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
                    369: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                    370: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
                    371: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
                    372: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
                    373: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
                    374: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
                    375: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
                    376: </dl></dd>
                    377: <dt><span class="chapter"><a href="#devfaq">24. Frequently Asked Questions</a></span></dt>
                    378: <dt><span class="chapter"><a href="#gnome">25. GNOME packaging and porting</a></span></dt>
                    379: <dd><dl>
                    380: <dt><span class="sect1"><a href="#meta-packages">25.1. Meta packages</a></span></dt>
                    381: <dt><span class="sect1"><a href="#new-package">25.2. Packaging a GNOME application</a></span></dt>
                    382: <dt><span class="sect1"><a href="#full-update">25.3. Updating GNOME to a newer version</a></span></dt>
                    383: <dt><span class="sect1"><a href="#patching">25.4. Patching guidelines</a></span></dt>
1.1       dsieger   384: </dl></dd>
                    385: </dl></dd>
                    386: <dt><span class="part"><a href="#infrastructure">III. The pkgsrc infrastructure internals</a></span></dt>
                    387: <dd><dl>
1.154     rillig    388: <dt><span class="chapter"><a href="#infr.design">26. Design of the pkgsrc infrastructure</a></span></dt>
1.1       dsieger   389: <dd><dl>
1.154     rillig    390: <dt><span class="sect1"><a href="#infr.vardef">26.1. The meaning of variable definitions</a></span></dt>
                    391: <dt><span class="sect1"><a href="#infr.vardef.problems">26.2. Avoiding problems before they arise</a></span></dt>
                    392: <dt><span class="sect1"><a href="#infr.var">26.3. Variable evaluation</a></span></dt>
1.1       dsieger   393: <dd><dl>
1.154     rillig    394: <dt><span class="sect2"><a href="#infr.var.load">26.3.1. At load time</a></span></dt>
                    395: <dt><span class="sect2"><a href="#infr.var.run">26.3.2. At runtime</a></span></dt>
1.1       dsieger   396: </dl></dd>
1.154     rillig    397: <dt><span class="sect1"><a href="#infr.varspec">26.4. How can variables be specified?</a></span></dt>
                    398: <dt><span class="sect1"><a href="#infr.design.intf">26.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1       dsieger   399: <dd><dl>
1.154     rillig    400: <dt><span class="sect2"><a href="#infr.design.intf.proc">26.5.1. Procedures with parameters</a></span></dt>
                    401: <dt><span class="sect2"><a href="#infr.design.intf.action">26.5.2. Actions taken on behalf of parameters</a></span></dt>
1.1       dsieger   402: </dl></dd>
1.154     rillig    403: <dt><span class="sect1"><a href="#infr.order">26.6. The order in which files are loaded</a></span></dt>
1.1       dsieger   404: <dd><dl>
1.154     rillig    405: <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>
                    406: <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.1       dsieger   407: </dl></dd>
                    408: </dl></dd>
1.154     rillig    409: <dt><span class="chapter"><a href="#regression">27. Regression tests</a></span></dt>
1.1       dsieger   410: <dd><dl>
1.154     rillig    411: <dt><span class="sect1"><a href="#regression.run">27.1. Running the regression tests</a></span></dt>
                    412: <dt><span class="sect1"><a href="#regression.new">27.2. Adding a new regression test</a></span></dt>
1.1       dsieger   413: <dd><dl>
1.154     rillig    414: <dt><span class="sect2"><a href="#regression.fun.override">27.2.1. Overridable functions</a></span></dt>
                    415: <dt><span class="sect2"><a href="#regression.fun.helper">27.2.2. Helper functions</a></span></dt>
1.1       dsieger   416: </dl></dd>
                    417: </dl></dd>
1.154     rillig    418: <dt><span class="chapter"><a href="#porting">28. Porting pkgsrc</a></span></dt>
                    419: <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.1       dsieger   420: </dl></dd>
                    421: <dt><span class="appendix"><a href="#examples">A. A simple example package: bison</a></span></dt>
                    422: <dd><dl>
                    423: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
                    424: <dd><dl>
                    425: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
                    426: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
                    427: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.23      wiz       428: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span></a></span></dt>
1.1       dsieger   429: </dl></dd>
                    430: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
                    431: </dl></dd>
                    432: <dt><span class="appendix"><a href="#logs">B. Build logs</a></span></dt>
                    433: <dd><dl>
                    434: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
                    435: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
                    436: </dl></dd>
                    437: <dt><span class="appendix"><a href="#ftp-layout">C. Directory layout of the pkgsrc FTP server</a></span></dt>
                    438: <dd><dl>
1.23      wiz       439: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
                    440: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
                    441: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
                    442: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
                    443: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
1.148     leot      444: <code class="filename">stable</code>,
1.23      wiz       445: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1       dsieger   446: source packages</a></span></dt>
                    447: </dl></dd>
1.154     rillig    448: <dt><span class="appendix"><a href="#help-topics">D. Help topics</a></span></dt>
                    449: <dt><span class="appendix"><a href="#editing">E. Editing guidelines for the pkgsrc guide</a></span></dt>
1.1       dsieger   450: <dd><dl>
1.154     rillig    451: <dt><span class="sect1"><a href="#targets">E.1. Make targets</a></span></dt>
                    452: <dt><span class="sect1"><a href="#procedure">E.2. Procedure</a></span></dt>
1.1       dsieger   453: </dl></dd>
                    454: </dl>
                    455: </div>
                    456: <div class="list-of-tables">
                    457: <p><b>List of Tables</b></p>
                    458: <dl>
                    459: <dt>1.1. <a href="#supported-platforms">Platforms supported by pkgsrc</a>
                    460: </dt>
1.154     rillig    461: <dt>13.1. <a href="#patch-examples">Patching examples</a>
1.1       dsieger   462: </dt>
1.154     rillig    463: <dt>25.1. <a href="#plist-handling">PLIST handling for GNOME packages</a>
1.1       dsieger   464: </dt>
                    465: </dl>
                    466: </div>
1.41      asau      467: <div class="chapter">
                    468: <div class="titlepage"><div><div><h1 class="title">
                    469: <a name="introduction"></a>Chapter 1. What is pkgsrc?</h1></div></div></div>
1.1       dsieger   470: <div class="toc">
                    471: <p><b>Table of Contents</b></p>
1.100     leot      472: <dl class="toc">
1.1       dsieger   473: <dt><span class="sect1"><a href="#introduction-section">1.1. Introduction</a></span></dt>
                    474: <dd><dl>
                    475: <dt><span class="sect2"><a href="#why-pkgsrc">1.1.1. Why pkgsrc?</a></span></dt>
                    476: <dt><span class="sect2"><a href="#intro.platforms">1.1.2. Supported platforms</a></span></dt>
                    477: </dl></dd>
                    478: <dt><span class="sect1"><a href="#overview">1.2. Overview</a></span></dt>
                    479: <dt><span class="sect1"><a href="#terminology">1.3. Terminology</a></span></dt>
                    480: <dd><dl><dt><span class="sect2"><a href="#term.roles">1.3.1. Roles involved in pkgsrc</a></span></dt></dl></dd>
                    481: <dt><span class="sect1"><a href="#typography">1.4. Typography</a></span></dt>
                    482: </dl>
                    483: </div>
1.41      asau      484: <div class="sect1">
1.1       dsieger   485: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    486: <a name="introduction-section"></a>1.1. Introduction</h2></div></div></div>
                    487: <p>There is a lot of software freely available for Unix-based
                    488: systems, which is usually available in form of the source code. Before
                    489: such software can be used, it needs to be configured to the local
                    490: system, compiled and installed, and this is exactly what The NetBSD
                    491: Packages Collection (pkgsrc) does. pkgsrc also has some basic commands
                    492: to handle binary packages, so that not every user has to build the
                    493: packages for himself, which is a time-costly task.</p>
                    494: <p>pkgsrc currently contains several thousand packages,
                    495:       including:</p>
1.41      asau      496: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.137     leot      497: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/apache24/README.html" target="_top"><code class="filename">www/apache24</code></a> - The Apache
1.1       dsieger   498:          web server</p></li>
1.137     leot      499: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a> - The Firefox
1.1       dsieger   500:          web browser</p></li>
1.137     leot      501: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome/README.html" target="_top"><code class="filename">meta-pkgs/gnome</code></a> - The GNOME
1.1       dsieger   502:          Desktop Environment</p></li>
1.137     leot      503: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde4/README.html" target="_top"><code class="filename">meta-pkgs/kde4</code></a> - The K
1.1       dsieger   504:          Desktop Environment</p></li>
                    505: </ul></div>
1.108     rillig    506: <p>&#8230; just to name a few.</p>
1.1       dsieger   507: <p>pkgsrc has built-in support for handling varying dependencies,
                    508:       such as pthreads and X11, and extended features such as IPv6 support on
                    509:       a range of platforms.</p>
1.41      asau      510: <div class="sect2">
1.1       dsieger   511: <div class="titlepage"><div><div><h3 class="title">
                    512: <a name="why-pkgsrc"></a>1.1.1. Why pkgsrc?</h3></div></div></div>
                    513: <p>
                    514: pkgsrc provides the following key features:
                    515: </p>
1.41      asau      516: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz       517: <li class="listitem"><p>Easy building of software from source as well as the creation
1.1       dsieger   518:   and installation of binary packages. The source and latest
                    519:   patches are retrieved from a master or mirror download site, checksum
                    520:   verified, then built on your system. Support for binary-only
                    521:   distributions is available for both native platforms and NetBSD
                    522:   emulated platforms.</p></li>
1.23      wiz       523: <li class="listitem"><p>All packages are installed in a consistent directory tree,
1.1       dsieger   524:   including binaries, libraries, man pages and other
                    525:   documentation.</p></li>
1.104     sevan     526: <li class="listitem"><p>Tracking of package dependencies automatically, including when
                    527:   performing updates, to ensure required packages are installed. The
                    528:   configuration files of various packages are handled automatically during
                    529:   updates, so local changes are preserved.</p></li>
1.23      wiz       530: <li class="listitem"><p>Like NetBSD, pkgsrc is designed with portability in mind and
1.1       dsieger   531:   consists of highly portable code. This allows the greatest speed of
1.25      spz       532:   development when porting to a new platform. This portability also
1.1       dsieger   533:   ensures that pkgsrc is <span class="emphasis"><em>consistent across all
                    534:   platforms</em></span>.</p></li>
1.23      wiz       535: <li class="listitem"><p>The installation prefix, acceptable software licenses,
1.1       dsieger   536:   international encryption requirements and build-time options for a
                    537:   large number of packages are all set in a simple, central
                    538:   configuration file.</p></li>
1.23      wiz       539: <li class="listitem"><p>The entire source (not including the distribution files) is
1.1       dsieger   540:   freely available under a BSD license, so you may extend and adapt
                    541:   pkgsrc to your needs. Support for local packages and patches is
                    542:   available right out of the box, so you can configure it specifically
                    543:   for your environment.</p></li>
                    544: </ul></div>
                    545: <p>The following principles are basic to pkgsrc:</p>
1.41      asau      546: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz       547: <li class="listitem"><p><span class="quote">&#8220;<span class="quote">It should only work if it's right.</span>&#8221;</span>
1.14      jmcneill  548: &mdash; That means, if a package contains bugs, it's better to find
1.1       dsieger   549: them and to complain about them rather than to just install the package
                    550: and hope that it works. There are numerous checks in pkgsrc that try to
1.137     leot      551: find such bugs: Static analysis tools (<a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>), build-time checks (portability
1.1       dsieger   552: of shell scripts), and post-installation checks (installed files,
                    553: references to shared libraries, script interpreters).</p></li>
1.23      wiz       554: <li class="listitem"><p><span class="quote">&#8220;<span class="quote">If it works, it should work everywhere</span>&#8221;</span>
1.14      jmcneill  555: &mdash; Like NetBSD has been ported to many hardware architectures,
1.1       dsieger   556: pkgsrc has been ported to many operating systems. Care is taken that
                    557: packages behave the same on all platforms.</p></li>
                    558: </ul></div>
                    559: </div>
1.41      asau      560: <div class="sect2">
1.1       dsieger   561: <div class="titlepage"><div><div><h3 class="title">
                    562: <a name="intro.platforms"></a>1.1.2. Supported platforms</h3></div></div></div>
                    563: <p>pkgsrc consists of both a source distribution and a binary
                    564: distribution for these operating systems. After retrieving the required
                    565: source or binaries, you can be up and running with pkgsrc in just
                    566: minutes!</p>
                    567: <p>pkgsrc was derived from FreeBSD's ports system, and
                    568:       initially developed for NetBSD only. Since then, pkgsrc has
                    569:       grown a lot, and now supports the following platforms:</p>
                    570: <div class="table">
                    571: <a name="supported-platforms"></a><p class="title"><b>Table 1.1. Platforms supported by pkgsrc</b></p>
1.106     tnn       572: <div class="table-contents"><table class="table" summary="Platforms supported by pkgsrc" border="1">
1.1       dsieger   573: <colgroup>
                    574: <col>
                    575: <col>
1.92      sevan     576: <col>
1.1       dsieger   577: </colgroup>
                    578: <thead><tr>
                    579: <th>Platform</th>
                    580: <th>Date Support Added</th>
1.92      sevan     581: <th>Notes</th>
1.1       dsieger   582: </tr></thead>
                    583: <tbody>
                    584: <tr>
1.10      hubertf   585: <td><a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a></td>
1.1       dsieger   586: <td align="center">Aug 1997</td>
1.92      sevan     587: <td class="auto-generated"> </td>
1.1       dsieger   588: </tr>
                    589: <tr>
1.10      hubertf   590: <td><a class="ulink" href="http://wwws.sun.com/software/solaris/" target="_top">Solaris</a></td>
1.1       dsieger   591: <td align="center">Mar 1999</td>
1.151     sevan     592: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Solaris" target="_top">README.Solaris</a></td>
1.1       dsieger   593: </tr>
                    594: <tr>
1.10      hubertf   595: <td><a class="ulink" href="http://www.kernel.org/" target="_top">Linux</a></td>
1.1       dsieger   596: <td align="center">Jun 1999</td>
1.151     sevan     597: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Linux" target="_top">README.Linux</a></td>
1.1       dsieger   598: </tr>
                    599: <tr>
                    600: <td>
1.118     sevan     601:           <a class="ulink" href="https://developer.apple.com/macos/" target="_top">Darwin / Mac OS X / OS X / macOS</a>
1.1       dsieger   602:         </td>
                    603: <td align="center">Oct 2001</td>
1.151     sevan     604: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.MacOSX" target="_top">README.MacOSX</a></td>
1.1       dsieger   605: </tr>
                    606: <tr>
1.10      hubertf   607: <td><a class="ulink" href="http://www.freebsd.org/" target="_top">FreeBSD</a></td>
1.1       dsieger   608: <td align="center">Nov 2002</td>
1.151     sevan     609: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.FreeBSD" target="_top">README.FreeBSD</a></td>
1.1       dsieger   610: </tr>
                    611: <tr>
1.10      hubertf   612: <td><a class="ulink" href="http://www.openbsd.org/" target="_top">OpenBSD</a></td>
1.1       dsieger   613: <td align="center">Nov 2002</td>
1.151     sevan     614: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.OpenBSD" target="_top">README.OpenBSD</a></td>
1.1       dsieger   615: </tr>
                    616: <tr>
1.10      hubertf   617: <td><a class="ulink" href="http://www.sgi.com/software/irix/" target="_top">IRIX</a></td>
1.1       dsieger   618: <td align="center">Dec 2002</td>
1.92      sevan     619: <td>
1.151     sevan     620:        <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.IRIX" target="_top">README.IRIX</a>
                    621:        <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.IRIX5.3" target="_top">README.IRIX5.3</a>
1.92      sevan     622:        </td>
1.1       dsieger   623: </tr>
                    624: <tr>
                    625: <td>BSD/OS</td>
                    626: <td align="center">Dec 2003</td>
1.92      sevan     627: <td class="auto-generated"> </td>
1.1       dsieger   628: </tr>
                    629: <tr>
1.10      hubertf   630: <td><a class="ulink" href="http://www-1.ibm.com/servers/aix/" target="_top">AIX</a></td>
1.1       dsieger   631: <td align="center">Dec 2003</td>
1.151     sevan     632: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.AIX" target="_top">README.AIX</a></td>
1.1       dsieger   633: </tr>
                    634: <tr>
                    635: <td>
1.10      hubertf   636:           <a class="ulink" href="http://www.microsoft.com/windows/sfu/" target="_top">Interix</a>
1.1       dsieger   637:           (Microsoft Windows Services for Unix)
                    638:         </td>
                    639: <td align="center">Mar 2004</td>
1.151     sevan     640: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Interix" target="_top">README.Interix</a></td>
1.1       dsieger   641: </tr>
                    642: <tr>
1.10      hubertf   643: <td><a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFlyBSD</a></td>
1.1       dsieger   644: <td align="center">Oct 2004</td>
1.92      sevan     645: <td class="auto-generated"> </td>
1.1       dsieger   646: </tr>
                    647: <tr>
1.10      hubertf   648: <td><a class="ulink" href="http://www.tru64.org/" target="_top">OSF/1</a></td>
1.1       dsieger   649: <td align="center">Nov 2004</td>
1.151     sevan     650: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.OSF1" target="_top">README.OSF1</a></td>
1.1       dsieger   651: </tr>
                    652: <tr>
1.10      hubertf   653: <td><a class="ulink" href="http://www.hp.com/products1/unix/" target="_top">HP-UX</a></td>
1.1       dsieger   654: <td align="center">Apr 2007</td>
1.151     sevan     655: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.HPUX" target="_top">README.HPUX</a></td>
1.1       dsieger   656: </tr>
1.23      wiz       657: <tr>
                    658: <td><a class="ulink" href="http://www.haiku-os.org/" target="_top">Haiku</a></td>
                    659: <td align="center">Sep 2010</td>
1.151     sevan     660: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Haiku" target="_top">README.Haiku</a></td>
1.23      wiz       661: </tr>
1.45      obache    662: <tr>
                    663: <td><a class="ulink" href="http://www.mirbsd.org/" target="_top">MirBSD</a></td>
1.57      bsiegert  664: <td align="center">Jan 2011</td>
1.92      sevan     665: <td class="auto-generated"> </td>
1.45      obache    666: </tr>
                    667: <tr>
                    668: <td><a class="ulink" href="http://www.minix3.org/" target="_top">Minix3</a></td>
                    669: <td align="center">Nov 2011</td>
1.151     sevan     670: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Minix3" target="_top">README.Minix3</a></td>
1.45      obache    671: </tr>
                    672: <tr>
                    673: <td><a class="ulink" href="http://cygwin.com/" target="_top">Cygwin</a></td>
                    674: <td align="center">Mar 2013</td>
1.151     sevan     675: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Cygwin" target="_top">README.Cygwin</a></td>
1.45      obache    676: </tr>
1.58      ryoon     677: <tr>
                    678: <td><a class="ulink" href="http://www.debian.org/ports/kfreebsd-gnu/" target="_top">GNU/kFreeBSD</a></td>
                    679: <td align="center">Jul 2013</td>
1.151     sevan     680: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.GNUkFreeBSD" target="_top">README.GNUkFreeBSD</a></td>
1.58      ryoon     681: </tr>
1.104     sevan     682: <tr>
                    683: <td><a class="ulink" href="http://www.bitrig.org/" target="_top">Bitrig</a></td>
                    684: <td align="center">Jun 2014</td>
1.151     sevan     685: <td><a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/bootstrap/README.Bitrig" target="_top">README.Bitrig</a></td>
1.104     sevan     686: </tr>
1.1       dsieger   687: </tbody>
                    688: </table></div>
                    689: </div>
                    690: <br class="table-break">
                    691: </div>
                    692: </div>
1.41      asau      693: <div class="sect1">
1.1       dsieger   694: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    695: <a name="overview"></a>1.2. Overview</h2></div></div></div>
                    696: <p>This document is divided into three parts. The first,
1.10      hubertf   697:        <a class="link" href="#users-guide" title="Part I. The pkgsrc user's guide">The pkgsrc user's guide</a>,
1.1       dsieger   698:        describes how one can use one of the packages in the Package
                    699:        Collection, either by installing a precompiled binary package,
                    700:        or by building one's own copy using the NetBSD package system.
1.10      hubertf   701:        The second part, <a class="link" href="#developers-guide" title="Part II. The pkgsrc developer's guide">The pkgsrc developer's guide</a>, explains how to prepare a
1.1       dsieger   702:        package so it can be easily built by other NetBSD users without
                    703:        knowing about the package's building details. The third part,
1.10      hubertf   704:        <a class="link" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">The pkgsrc infrastructure internals</a>
1.1       dsieger   705:        is intended for those who want to understand how pkgsrc is
                    706:        implemented.</p>
                    707: <p>This document is available in various formats:
1.10      hubertf   708:        <span class="simplelist"><a class="ulink" href="index.html" target="_top">HTML</a>, <a class="ulink" href="pkgsrc.pdf" target="_top">PDF</a>, <a class="ulink" href="pkgsrc.ps" target="_top">PS</a>, <a class="ulink" href="pkgsrc.txt" target="_top">TXT</a></span>.</p>
1.1       dsieger   709: </div>
1.41      asau      710: <div class="sect1">
1.1       dsieger   711: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    712: <a name="terminology"></a>1.3. Terminology</h2></div></div></div>
1.23      wiz       713: <p>There has been a lot of talk about <span class="quote">&#8220;<span class="quote">ports</span>&#8221;</span>,
                    714:       <span class="quote">&#8220;<span class="quote">packages</span>&#8221;</span>, etc. so far. Here is a description of all the
1.1       dsieger   715:       terminology used within this document.</p>
1.41      asau      716: <div class="variablelist"><dl class="variablelist">
1.1       dsieger   717: <dt><span class="term">Package</span></dt>
                    718: <dd><p>A set of files and building instructions
                    719:            that describe what's necessary
                    720:            to build a certain piece of software using
                    721:             pkgsrc. Packages are traditionally stored under
1.123     wiz       722:            <code class="filename">/usr/pkgsrc</code>,
                    723:            but may be stored in any location,
                    724:            referred to as <code class="varname">PKGSRCDIR</code>.</p></dd>
1.1       dsieger   725: <dt><span class="term">The NetBSD package system</span></dt>
1.23      wiz       726: <dd><p>This is the former name of <span class="quote">&#8220;<span class="quote">pkgsrc</span>&#8221;</span>.  It
1.1       dsieger   727:          is part of the NetBSD operating system and can be bootstrapped
                    728:          to run on non-NetBSD operating systems as well.  It handles
                    729:          building (compiling), installing, and removing of
                    730:          packages.</p></dd>
                    731: <dt><span class="term">Distfile</span></dt>
                    732: <dd><p>This term describes the file or files that are
                    733:            provided by the author of the piece of software to
                    734:            distribute his work. All the changes necessary to build on
                    735:            NetBSD are reflected in the corresponding package. Usually
                    736:            the distfile is in the form of a compressed tar-archive,
                    737:            but other types are possible, too. Distfiles are usually
                    738:            stored below
                    739:            <code class="filename">/usr/pkgsrc/distfiles</code>.</p></dd>
                    740: <dt><span class="term">Port</span></dt>
                    741: <dd><p>This is the term used by FreeBSD and OpenBSD people
                    742:            for what we call a package.
1.23      wiz       743:            In NetBSD terminology, <span class="quote">&#8220;<span class="quote">port</span>&#8221;</span> refers to a different
1.1       dsieger   744:            architecture.</p></dd>
                    745: <dt><span class="term">Precompiled/binary package</span></dt>
                    746: <dd>
                    747: <p>A set of binaries built with pkgsrc from a distfile
                    748:            and stuffed together in a single <code class="filename">.tgz</code>
                    749:            file so it can be installed on machines of the same
                    750:            machine architecture without the need to
                    751:            recompile. Packages are usually generated in
                    752:            <code class="filename">/usr/pkgsrc/packages</code>; there is also
1.25      spz       753:            an archive on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/packages/" target="_top">ftp.NetBSD.org</a>.</p>
1.23      wiz       754: <p>Sometimes, this is referred to by the term <span class="quote">&#8220;<span class="quote">package</span>&#8221;</span> too,
1.1       dsieger   755:            especially in the context of precompiled packages.</p>
                    756: </dd>
                    757: <dt><span class="term">Program</span></dt>
                    758: <dd><p>The piece of software to be installed which will be
                    759:          constructed from all the files in the distfile by the
                    760:          actions defined in the corresponding package.</p></dd>
                    761: </dl></div>
1.41      asau      762: <div class="sect2">
1.1       dsieger   763: <div class="titlepage"><div><div><h3 class="title">
                    764: <a name="term.roles"></a>1.3.1. Roles involved in pkgsrc</h3></div></div></div>
1.41      asau      765: <div class="variablelist"><dl class="variablelist">
1.1       dsieger   766: <dt><span class="term">pkgsrc users</span></dt>
                    767: <dd>
                    768: <p>The
                    769:        pkgsrc users are people who use the packages provided by pkgsrc.
                    770:        Typically they are system administrators. The people using the
1.23      wiz       771:        software that is inside the packages (maybe called <span class="quote">&#8220;<span class="quote">end
                    772:        users</span>&#8221;</span>) are not covered by the pkgsrc guide.</p>
1.1       dsieger   773: <p>There are two kinds of pkgsrc users: Some only want to
                    774:        install pre-built binary packages. Others build the pkgsrc
                    775:        packages from source, either for installing them directly or for
1.10      hubertf   776:        building binary packages themselves. For pkgsrc users <a class="xref" href="#users-guide" title="Part I. The pkgsrc user's guide">Part I, &#8220;The pkgsrc user's guide&#8221;</a> should provide all necessary
1.1       dsieger   777:        documentation.</p>
                    778: </dd>
                    779: <dt><span class="term">package maintainers</span></dt>
                    780: <dd><p>A
1.10      hubertf   781:        package maintainer creates packages as described in <a class="xref" href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, &#8220;The pkgsrc developer's guide&#8221;</a>.</p></dd>
1.1       dsieger   782: <dt><span class="term">infrastructure developers</span></dt>
                    783: <dd><p>These people are involved in all those files
                    784:        that live in the <code class="filename">mk/</code> directory and below.
1.10      hubertf   785:        Only these people should need to read through <a class="xref" href="#infrastructure" title="Part III. The pkgsrc infrastructure internals">Part III, &#8220;The pkgsrc infrastructure internals&#8221;</a>, though others might be curious,
1.1       dsieger   786:        too.</p></dd>
                    787: </dl></div>
                    788: </div>
                    789: </div>
1.41      asau      790: <div class="sect1">
1.1       dsieger   791: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                    792: <a name="typography"></a>1.4. Typography</h2></div></div></div>
                    793: <p>When giving examples for commands, shell prompts are used to
                    794:       show if the command should/can be issued as root, or if
1.23      wiz       795:       <span class="quote">&#8220;<span class="quote">normal</span>&#8221;</span> user privileges are sufficient. We use a
1.115     sevan     796:       <code class="prompt">#</code> for root's shell prompt, a <code class="prompt">%</code> for users'
                    797:       shell prompt, assuming they use the C-shell or tcsh and a <code class="prompt">$</code> for
                    798:       bourne shell and derivatives.</p>
1.1       dsieger   799: </div>
                    800: </div>
1.41      asau      801: <div class="part">
1.1       dsieger   802: <div class="titlepage"><div><div><h1 class="title">
                    803: <a name="users-guide"></a>Part I. The pkgsrc user's guide</h1></div></div></div>
                    804: <div class="toc">
                    805: <p><b>Table of Contents</b></p>
1.100     leot      806: <dl class="toc">
1.154     rillig    807: <dt><span class="chapter"><a href="#help-user">2. Getting help</a></span></dt>
                    808: <dt><span class="chapter"><a href="#getting">3. Where to get pkgsrc and how to keep it up-to-date</a></span></dt>
1.1       dsieger   809: <dd><dl>
1.154     rillig    810: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.1       dsieger   811: <dd><dl>
1.154     rillig    812: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
                    813: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.1       dsieger   814: </dl></dd>
1.154     rillig    815: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.1       dsieger   816: <dd><dl>
1.154     rillig    817: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
                    818: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.1       dsieger   819: </dl></dd>
                    820: </dl></dd>
1.154     rillig    821: <dt><span class="chapter"><a href="#platforms">4. Using pkgsrc on systems other than NetBSD</a></span></dt>
1.1       dsieger   822: <dd><dl>
1.154     rillig    823: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
                    824: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.1       dsieger   825: </dl></dd>
1.154     rillig    826: <dt><span class="chapter"><a href="#using">5. Using pkgsrc</a></span></dt>
1.1       dsieger   827: <dd><dl>
1.154     rillig    828: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.1       dsieger   829: <dd><dl>
1.154     rillig    830: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
                    831: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
                    832: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.3. Deinstalling packages</a></span></dt>
                    833: <dt><span class="sect2"><a href="#using.pkg_info">5.1.4. Getting information about installed packages</a></span></dt>
                    834: <dt><span class="sect2"><a href="#vulnerabilities">5.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                    835: <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>
                    836: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.7. Other administrative functions</a></span></dt>
1.1       dsieger   837: </dl></dd>
1.154     rillig    838: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
1.1       dsieger   839: <dd><dl>
1.154     rillig    840: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
                    841: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
                    842: <dt><span class="sect2"><a href="#how-to-build-and-install">5.2.3. How to build and install</a></span></dt>
1.1       dsieger   843: </dl></dd>
                    844: </dl></dd>
1.154     rillig    845: <dt><span class="chapter"><a href="#configuring">6. Configuring pkgsrc</a></span></dt>
1.1       dsieger   846: <dd><dl>
1.154     rillig    847: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
                    848: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
                    849: <dt><span class="sect1"><a href="#variables-affecting-installation">6.3. Variables affecting the installation process</a></span></dt>
                    850: <dt><span class="sect1"><a href="#conf.compiler">6.4. Selecting and configuring the compiler</a></span></dt>
1.1       dsieger   851: <dd><dl>
1.154     rillig    852: <dt><span class="sect2"><a href="#selecting-the-compiler">6.4.1. Selecting the compiler</a></span></dt>
                    853: <dt><span class="sect2"><a href="#conf.cflags">6.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                    854: <dt><span class="sect2"><a href="#conf.ldflags">6.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.1       dsieger   855: </dl></dd>
1.154     rillig    856: <dt><span class="sect1"><a href="#developer-advanced-settings">6.5. Developer/advanced settings</a></span></dt>
                    857: <dt><span class="sect1"><a href="#selecting-build-options">6.6. Selecting Build Options</a></span></dt>
1.1       dsieger   858: </dl></dd>
1.154     rillig    859: <dt><span class="chapter"><a href="#binary">7. Creating binary packages</a></span></dt>
1.1       dsieger   860: <dd><dl>
1.154     rillig    861: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
                    862: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">7.2. Settings for creation of binary packages</a></span></dt>
1.6       rillig    863: </dl></dd>
1.154     rillig    864: <dt><span class="chapter"><a href="#bulk">8. Creating binary packages for everything in pkgsrc (bulk
1.6       rillig    865: builds)</a></span></dt>
1.1       dsieger   866: <dd><dl>
1.154     rillig    867: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
                    868: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a pbulk-style bulk build</a></span></dt>
                    869: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
                    870: <dt><span class="sect1"><a href="#bulk.req">8.3. Requirements of a full bulk build</a></span></dt>
                    871: <dt><span class="sect1"><a href="#creating-cdroms">8.4. Creating a multiple CD-ROM packages collection</a></span></dt>
                    872: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.4.1. Example of cdpack</a></span></dt></dl></dd>
                    873: </dl></dd>
                    874: <dt><span class="chapter"><a href="#files">9. Directory layout of the installed files</a></span></dt>
                    875: <dd><dl>
                    876: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
                    877: <dt><span class="sect1"><a href="#files.varbase">9.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
                    878: </dl></dd>
                    879: <dt><span class="chapter"><a href="#faq">10. Frequently Asked Questions</a></span></dt>
                    880: <dd><dl>
                    881: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                    882: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
                    883: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
                    884: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
                    885: <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>
                    886: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
                    887: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
                    888: <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>
                    889: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
                    890: <dt><span class="sect1"><a href="#tmac.andoc-missing">10.10. What does <span class="quote">&#8220;<span class="quote">Don't know how to make
1.23      wiz       891: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</a></span></dt>
1.154     rillig    892: <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>
                    893: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' with pkgsrc</a></span></dt>
                    894: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
                    895: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
                    896: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
                    897: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build.  What shall I do?</a></span></dt>
                    898: <dt><span class="sect1"><a href="#faq.rcs-conflicts">10.17. What does <span class="quote">&#8220;<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>&#8221;</span> mean?</a></span></dt>
1.1       dsieger   899: </dl></dd>
                    900: </dl>
                    901: </div>
1.41      asau      902: <div class="chapter">
1.1       dsieger   903: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig    904: <a name="help-user"></a>Chapter 2. Getting help</h2></div></div></div>
                    905: <p>
                    906:        To get help when using pkgsrc, the definitive source is this
                    907:        document, the pkgsrc guide. If you don't find anything here,
                    908:        there are alternatives:
                    909: </p>
                    910: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                    911: <li class="listitem">
                    912: <p>
                    913:        The built-in pkgsrc help, which is available after bootstrapping
                    914:        pkgsrc. Run <span class="command"><strong>bmake help topic=&#8230;</strong></span> to get
                    915:        help for any topic, such as a variable name like
                    916:        <code class="varname">BUILD_DEFS</code>, a make target like
                    917:        <span class="command"><strong>do-build</strong></span>, a missing C or C++ function like
                    918:        <span class="command"><strong>strcasecmp</strong></span> or any other topic.</p>
                    919: <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>
                    920: </li>
                    921: <li class="listitem"><p>
1.163     rillig    922:        To see the value of a single variable, run <span class="command"><strong>bmake
                    923:        show-var VARNAME=<em class="replaceable"><code>X</code></em></strong></span>.
                    924: </p></li>
                    925: <li class="listitem"><p>
                    926:        To see the values of the most common variables, run
                    927:        <span class="command"><strong>bmake show-all</strong></span>. These variables are grouped by
                    928:        topic. To see the variables for a single topic, run
                    929:        <span class="command"><strong>bmake
                    930:        show-all-<em class="replaceable"><code>topic</code></em></strong></span>, for example
                    931:        <span class="command"><strong>bmake show-all-fetch</strong></span>.
                    932: </p></li>
                    933: <li class="listitem"><p>
1.154     rillig    934:        The pkgsrc-users mailing list, to which
                    935:        <a class="ulink" href="https://www.NetBSD.org/mailinglists/#pkgsrc-users" target="_top">you
                    936:        can subscribe</a> and then <a class="ulink" href="mailto:pkgsrc-users@NetBSD.org" target="_top">ask your
                    937:        questions</a>.</p></li>
                    938: <li class="listitem"><p>The #pkgsrc IRC channel, which is accessible
                    939:        <a class="ulink" href="https://webchat.freenode.net/" target="_top">via a web browser</a>
                    940:        or by using a specialized chat program such as
                    941:        <a class="ulink" href="http://xchat.org/" target="_top">XChat</a>.
                    942:        Pick any user name and join the channel #pkgsrc.</p></li>
                    943: </ul></div>
                    944: </div>
                    945: <div class="chapter">
                    946: <div class="titlepage"><div><div><h2 class="title">
                    947: <a name="getting"></a>Chapter 3. Where to get pkgsrc and how to keep it up-to-date</h2></div></div></div>
1.1       dsieger   948: <div class="toc">
                    949: <p><b>Table of Contents</b></p>
1.100     leot      950: <dl class="toc">
1.154     rillig    951: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.1       dsieger   952: <dd><dl>
1.154     rillig    953: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
                    954: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.1       dsieger   955: </dl></dd>
1.154     rillig    956: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.1       dsieger   957: <dd><dl>
1.154     rillig    958: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
                    959: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.1       dsieger   960: </dl></dd>
                    961: </dl>
                    962: </div>
                    963: <p>Before you download and extract the files, you need to decide
                    964: where you want to extract them. When using pkgsrc as root user, pkgsrc
                    965: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
                    966: free to install the sources and binary packages wherever you want in
                    967: your filesystem, provided that the pathname does not contain white-space
                    968: or other characters that are interpreted specially by the shell and some
                    969: other programs. A safe bet is to use only letters, digits, underscores
                    970: and dashes.</p>
1.41      asau      971: <div class="sect1">
1.1       dsieger   972: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig    973: <a name="getting-first"></a>3.1. Getting pkgsrc for the first time</h2></div></div></div>
1.1       dsieger   974: <p>Before you download any pkgsrc files, you should decide
                    975:        whether you want the <span class="emphasis"><em>current</em></span> branch or the
                    976:        <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
                    977:        quarterly basis from the current branch and only gets modified
                    978:        for security updates. The names of the stable branches are built
                    979:        from the year and the quarter, for example
1.167   ! leot      980:        <code class="literal">2019Q4</code>.</p>
1.1       dsieger   981: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
1.23      wiz       982:        want to download pkgsrc. You can get it as a tar file or via CVS.
                    983:        Both ways are described here.</p>
1.51      asau      984: <p>Note that tar archive contains CVS working copy.
                    985:        Thus you can switch to using CVS at any later time.</p>
1.41      asau      986: <div class="sect2">
1.1       dsieger   987: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig    988: <a name="getting-via-tar"></a>3.1.1. As tar archive</h3></div></div></div>
1.1       dsieger   989: <p>The primary download location for all pkgsrc files is
1.151     sevan     990:        <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/" target="_top">https://cdn.NetBSD.org/pub/pkgsrc/</a> or
1.51      asau      991:        <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>
                    992:        (it points to the same location).
                    993:        There are a number of subdirectories for different purposes,
                    994:        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>
                    995: <p>The tar archive for the current branch is in the directory
1.151     sevan     996:        <code class="filename">current</code> and is called <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.
1.118     sevan     997:        It is autogenerated weekly.</p>
1.51      asau      998: <p>To save download time we provide bzip2- and
                    999:        xz-compressed archives which are published at
1.151     sevan    1000:        <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.bz2" target="_top"><code class="filename">pkgsrc.tar.bz2</code></a>
1.51      asau     1001:        and
1.151     sevan    1002:        <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.xz" target="_top"><code class="filename">pkgsrc.tar.xz</code></a>
1.51      asau     1003:        respectively.
                   1004:        </p>
                   1005: <p>You can fetch the same files using FTP.</p>
1.167   ! leot     1006: <p>The tar file for the stable branch 2019Q4 is in the
        !          1007:        directory <code class="filename">pkgsrc-2019Q4</code> and is also called <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/pkgsrc-2019Q4/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.</p>
1.136     leot     1008: <p>To download the latest pkgsrc stable tarball, run:</p>
1.12      weinem   1009: <pre class="screen">
1.167   ! leot     1010: <code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2019Q4/pkgsrc.tar.gz</code></strong></pre>
1.78      snj      1011: <p>If you prefer, you can also fetch it using "wget", "curl",
1.51      asau     1012:        or your web browser.</p>
1.12      weinem   1013: <p>Then, extract it with:</p>
1.78      snj      1014: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf pkgsrc.tar.gz -C /usr</code></strong></pre>
1.12      weinem   1015: <p>This will create the directory <code class="filename">pkgsrc/</code>
                   1016:        in <code class="filename">/usr/</code> and all the package source will be 
                   1017:        stored under <code class="filename">/usr/pkgsrc/</code>.</p>
                   1018: <p>To download pkgsrc-current, run:</p>
                   1019: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz</code></strong></pre>
1.1       dsieger  1020: </div>
1.41      asau     1021: <div class="sect2">
1.1       dsieger  1022: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   1023: <a name="getting-via-cvs"></a>3.1.2. Via anonymous CVS</h3></div></div></div>
1.23      wiz      1024: <p>To fetch a specific pkgsrc stable branch, run:</p>
1.167   ! leot     1025: <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-2019Q4 -P pkgsrc</code></strong>
1.23      wiz      1026: </pre>
                   1027: <p>This will create the directory <code class="filename">pkgsrc/</code> 
                   1028:        in your <code class="filename">/usr/</code> directory and all the package source 
                   1029:        will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
                   1030: <p>To fetch the pkgsrc current branch, run:</p>
1.39      wiz      1031: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr &amp;&amp; cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.1       dsieger  1032: </pre>
1.78      snj      1033: <p>Refer to the <a class="ulink" href="http://www.NetBSD.org/mirrors/#anoncvs" target="_top">list of available mirrors</a> to choose a faster CVS mirror, if needed.</p>
1.23      wiz      1034: <p>If you get error messages from <code class="literal">rsh</code>, you need to set CVS_RSH variable. E.g.:</p>
1.39      wiz      1035: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr &amp;&amp; env CVS_RSH=ssh cvs -q -z2 -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.23      wiz      1036: </pre>
                   1037: <p>Refer to documentation on your command shell how to set CVS_RSH=ssh permanently.
                   1038:        For Bourne shells, you can set it in your <code class="filename">.profile</code>
                   1039:        or better globally in <code class="filename">/etc/profile</code>:</p>
                   1040: <pre class="programlisting">
                   1041: # set CVS remote shell command
                   1042: CVS_RSH=ssh
                   1043: export CVS_RSH
                   1044: </pre>
                   1045: <p>By default, CVS doesn't do things like most people would expect it to do.
                   1046:        But there is a way to convince CVS, by creating a file called <code class="filename">.cvsrc</code>
                   1047:        in your home directory and saving the following lines to it.
                   1048:        This file will save you lots of headache and some bug reports, so we strongly recommend it.
                   1049:        You can find an explanation of this file in the CVS documentation.</p>
1.2       rillig   1050: <pre class="programlisting">
                   1051: # recommended CVS configuration file from the pkgsrc guide
1.155     sevan    1052: cvs -q
1.2       rillig   1053: checkout -P
1.4       rillig   1054: update -dP
                   1055: diff -upN
1.2       rillig   1056: rdiff -u
1.23      wiz      1057: release -d
1.2       rillig   1058: </pre>
1.1       dsieger  1059: </div>
                   1060: </div>
1.41      asau     1061: <div class="sect1">
1.1       dsieger  1062: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   1063: <a name="uptodate"></a>3.2. Keeping pkgsrc up-to-date</h2></div></div></div>
1.1       dsieger  1064: <p>The preferred way to keep pkgsrc up-to-date is via CVS
                   1065:        (which also works if you have first installed it via a tar
                   1066:        file). It saves bandwidth and hard disk activity, compared to
                   1067:        downloading the tar file again.</p>
1.41      asau     1068: <div class="sect2">
1.1       dsieger  1069: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   1070: <a name="uptodate-tar"></a>3.2.1. Via tar files</h3></div></div></div>
1.41      asau     1071: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  1072: <h3 class="title">Warning</h3>
                   1073: <p>When updating from a tar file, you first need to
                   1074:        completely remove the old pkgsrc directory. Otherwise those
                   1075:        files that have been removed from pkgsrc in the mean time will
                   1076:        not be removed on your local disk, resulting in inconsistencies.
                   1077:        When removing the old files, any changes that you have done to
                   1078:        the pkgsrc files will be lost after updating. Therefore updating
                   1079:        via CVS is strongly recommended.</p>
                   1080: </div>
                   1081: <p>Note that by default the distfiles and the binary packages
                   1082:        are saved in the pkgsrc tree, so don't forget to rescue them
1.78      snj      1083:        before updating. You can also configure pkgsrc to store distfiles
                   1084:         and packages in directories outside the pkgsrc tree by setting the
1.1       dsieger  1085:        <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.154     rillig   1086:        variables. See <a class="xref" href="#configuring" title="Chapter 6. Configuring pkgsrc">Chapter 6, <i>Configuring pkgsrc</i></a> for the details.</p>
1.1       dsieger  1087: <p>To update pkgsrc from a tar file, download the tar file as
                   1088:        explained above. Then, make sure that you have not made any
                   1089:        changes to the files in the pkgsrc directory. Remove the pkgsrc
                   1090:        directory and extract the new tar file. Done.</p>
                   1091: </div>
1.41      asau     1092: <div class="sect2">
1.1       dsieger  1093: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   1094: <a name="uptodate-cvs"></a>3.2.2. Via CVS</h3></div></div></div>
1.25      spz      1095: <p>To update pkgsrc via CVS, change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
                   1096: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc &amp;&amp; cvs update -dP</code></strong>
                   1097: </pre>
                   1098: <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>
                   1099: <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>
                   1100: </pre>
1.41      asau     1101: <div class="sect3">
1.1       dsieger  1102: <div class="titlepage"><div><div><h4 class="title">
1.154     rillig   1103: <a name="uptodate-cvs-switch"></a>3.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1.1       dsieger  1104: <p>When updating pkgsrc, the CVS program keeps track of the
                   1105:        branch you selected. But if you, for whatever reason, want to
                   1106:        switch from the stable branch to the current one, you can do it
1.23      wiz      1107:        by adding the option <span class="quote">&#8220;<span class="quote">-A</span>&#8221;</span> after the
                   1108:        <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> keyword. To switch from the current branch
1.1       dsieger  1109:        back to the stable branch, add the
1.167   ! leot     1110:        <span class="quote">&#8220;<span class="quote">-rpkgsrc-2019Q4</span>&#8221;</span> option.</p>
1.1       dsieger  1111: </div>
1.41      asau     1112: <div class="sect3">
1.1       dsieger  1113: <div class="titlepage"><div><div><h4 class="title">
1.154     rillig   1114: <a name="uptodate-cvs-changes"></a>3.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1.1       dsieger  1115: <p>When you update pkgsrc, the CVS program will only touch
                   1116:        those files that are registered in the CVS repository. That
                   1117:        means that any packages that you created on your own will stay
                   1118:        unmodified. If you change files that are managed by CVS, later
                   1119:        updates will try to merge your changes with those that have been
                   1120:        done by others. See the CVS manual, chapter
1.23      wiz      1121:        <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> for details.</p>
1.1       dsieger  1122: </div>
                   1123: </div>
                   1124: </div>
                   1125: </div>
1.41      asau     1126: <div class="chapter">
1.1       dsieger  1127: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   1128: <a name="platforms"></a>Chapter 4. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1.1       dsieger  1129: <div class="toc">
                   1130: <p><b>Table of Contents</b></p>
1.100     leot     1131: <dl class="toc">
1.154     rillig   1132: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
                   1133: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.1       dsieger  1134: </dl>
                   1135: </div>
1.41      asau     1136: <div class="sect1">
1.1       dsieger  1137: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   1138: <a name="binarydist"></a>4.1. Binary distribution</h2></div></div></div>
                   1139: <p>See <a class="xref" href="#using-pkg" title="5.1. Using binary packages">Section 5.1, &#8220;Using binary packages&#8221;</a>.</p>
1.1       dsieger  1140: </div>
1.41      asau     1141: <div class="sect1">
1.1       dsieger  1142: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   1143: <a name="bootstrapping-pkgsrc"></a>4.2. Bootstrapping pkgsrc</h2></div></div></div>
1.43      asau     1144: <p>pkgsrc can be bootstrapped for use in two different modes:
                   1145:     privileged and unprivileged one. In unprivileged mode in contrast
1.44      asau     1146:     to privileged one all programs are installed under one particular user
1.43      asau     1147:     and cannot utilise privileged operations (packages don't create
                   1148:     special users and all special file permissions like setuid are ignored).
                   1149:     </p>
1.1       dsieger  1150: <p>Installing the bootstrap kit from source should be as simple as:</p>
                   1151: <pre class="screen">
1.60      asau     1152: <code class="prompt">#</code> <strong class="userinput"><code>env CVS_RSH=ssh cvs -d anoncvs@anoncvs.NetBSD.org:/cvsroot checkout -P pkgsrc</code></strong>
1.1       dsieger  1153: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
                   1154: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
                   1155:     </pre>
1.43      asau     1156: <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>
                   1157: <p>By default, in privileged mode pkgsrc uses
                   1158:     <code class="filename">/usr/pkg</code> for <span class="emphasis"><em>prefix</em></span>
                   1159:     where programs will be installed in,
1.118     sevan    1160:     and <code class="filename">/usr/pkg/pkgdb</code> for the package database
1.43      asau     1161:     directory where pkgsrc will do its internal bookkeeping,
                   1162:     <code class="filename">/var</code> is used as <span class="emphasis"><em>varbase</em></span>,
                   1163:     where packages install their persistent data.
                   1164:     In unprivileged mode pkgsrc uses
                   1165:     <code class="filename">~/pkg</code> for <span class="emphasis"><em>prefix</em></span>,
1.118     sevan    1166:     <code class="filename">~/pkg/pkgdb</code> for the package database,
1.43      asau     1167:     and <code class="filename">~/pkg/var</code> for <span class="emphasis"><em>varbase</em></span>.
                   1168:     </p>
                   1169: <p>You can change default layout using command-line arguments.
                   1170:     Run <span class="quote">&#8220;<span class="quote">./bootstrap --help</span>&#8221;</span> to get details.
                   1171:     </p>
1.41      asau     1172: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  1173: <h3 class="title">Note</h3>
1.10      hubertf  1174: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
                   1175:       Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
                   1176:       For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.23      wiz      1177:       instead of <span class="quote">&#8220;<span class="quote">make</span>&#8221;</span>.</p>
1.1       dsieger  1178: </div>
1.43      asau     1179: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1180: <h3 class="title">Note</h3>
                   1181: <p>It is possible to bootstrap multiple instances of pkgsrc
                   1182:       using non-intersecting directories. Use <span class="command"><strong>bmake</strong></span>
                   1183:       corresponding to the installation you're working with to build
                   1184:       and install packages.
                   1185:       </p>
                   1186: </div>
1.1       dsieger  1187: </div>
                   1188: </div>
1.41      asau     1189: <div class="chapter">
1.1       dsieger  1190: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   1191: <a name="using"></a>Chapter 5. Using pkgsrc</h2></div></div></div>
1.1       dsieger  1192: <div class="toc">
                   1193: <p><b>Table of Contents</b></p>
1.100     leot     1194: <dl class="toc">
1.154     rillig   1195: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.1       dsieger  1196: <dd><dl>
1.154     rillig   1197: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
                   1198: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
                   1199: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.3. Deinstalling packages</a></span></dt>
                   1200: <dt><span class="sect2"><a href="#using.pkg_info">5.1.4. Getting information about installed packages</a></span></dt>
                   1201: <dt><span class="sect2"><a href="#vulnerabilities">5.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                   1202: <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>
                   1203: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.7. Other administrative functions</a></span></dt>
                   1204: </dl></dd>
                   1205: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
                   1206: <dd><dl>
                   1207: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
                   1208: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
                   1209: <dt><span class="sect2"><a href="#how-to-build-and-install">5.2.3. How to build and install</a></span></dt>
1.1       dsieger  1210: </dl></dd>
                   1211: </dl>
                   1212: </div>
                   1213: <p>Basically, there are two ways of using pkgsrc. The first
                   1214: is to only install the package tools and to use binary packages
1.23      wiz      1215: that someone else has prepared. This is the <span class="quote">&#8220;<span class="quote">pkg</span>&#8221;</span>
                   1216: in pkgsrc. The second way is to install the <span class="quote">&#8220;<span class="quote">src</span>&#8221;</span>
1.1       dsieger  1217: of pkgsrc, too. Then you are able to build your own packages,
                   1218: and you can still use binary packages from someone else.</p>
1.41      asau     1219: <div class="sect1">
1.1       dsieger  1220: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   1221: <a name="using-pkg"></a>5.1. Using binary packages</h2></div></div></div>
1.151     sevan    1222: <p>On the <a class="ulink" href="https://cdn.NetBSD.org/" target="_top">cdn.NetBSD.org</a>
                   1223:   site and mirrors, there are collections of binary packages,
1.9       rillig   1224:   ready to be installed. These binary packages have been built using the
                   1225:   default settings for the directories, that is:</p>
1.41      asau     1226: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      1227: <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>
                   1228: <li class="listitem"><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
                   1229: <li class="listitem"><p><code class="filename">/var</code> for <code class="varname">VARBASE</code>, where those files are installed that may change after installation.</p></li>
1.9       rillig   1230: </ul></div>
                   1231: <p>If you cannot use these directories for whatever reasons (maybe
                   1232:   because you're not root), you cannot use these binary packages, but
1.154     rillig   1233:   have to build the packages yourself, which is explained in <a class="xref" href="#bootstrapping-pkgsrc" title="4.2. Bootstrapping pkgsrc">Section 4.2, &#8220;Bootstrapping pkgsrc&#8221;</a>.</p>
1.41      asau     1234: <div class="sect2">
1.1       dsieger  1235: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   1236: <a name="finding-binary-packages"></a>5.1.1. Finding binary packages</h3></div></div></div>
1.5       weinem   1237: <p>To install binary packages, you first need to know from where
                   1238:     to get them. The first place where you should look is on the main
1.151     sevan    1239:     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.5       weinem   1240: <p>This directory contains binary packages for multiple
                   1241:     platforms. First, select your operating system. (Ignore the
                   1242:     directories with version numbers attached to it, they just exist for
                   1243:     legacy reasons.) Then, select your hardware architecture, and in the
1.23      wiz      1244:     third step, the OS version and the <span class="quote">&#8220;<span class="quote">version</span>&#8221;</span> of pkgsrc.</p>
1.9       rillig   1245: <p>In this directory, you often find a file called
                   1246:     <code class="filename">bootstrap.tar.gz</code> which contains the package
                   1247:     management tools. If the file is missing, it is likely that your
                   1248:     operating system already provides those tools. Download the file and
                   1249:     extract it in the <code class="filename">/</code> directory. It will create
                   1250:     the directories <code class="filename">/usr/pkg</code> (containing the tools
1.118     sevan    1251:     for managing binary packages and the database of installed packages).</p>
1.1       dsieger  1252: </div>
1.41      asau     1253: <div class="sect2">
1.1       dsieger  1254: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   1255: <a name="installing-binary-packages"></a>5.1.2. Installing binary packages</h3></div></div></div>
1.9       rillig   1256: <p>In the directory from the last section, there is a
1.85      wiz      1257:     subdirectory called <code class="filename">All/</code>, which contains all the
1.9       rillig   1258:     binary packages that are available for the platform, excluding those
                   1259:     that may not be distributed via FTP or CDROM (depending on which
1.23      wiz      1260:     medium you are using).</p>
1.9       rillig   1261: <p>To install packages directly from an FTP or HTTP server, run
                   1262:     the following commands in a Bourne-compatible shell (be sure to
1.10      hubertf  1263:     <span class="command"><strong>su</strong></span> to root first):</p>
1.9       rillig   1264: <pre class="screen">
                   1265: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:$PATH"</code></strong>
1.151     sevan    1266: <code class="prompt">#</code> <strong class="userinput"><code>PKG_PATH="http://cdn.NetBSD.org/pub/pkgsrc/packages/<em class="replaceable"><code>OPSYS</code></em>/<em class="replaceable"><code>ARCH</code></em>/<em class="replaceable"><code>VERSIONS</code></em>/All/"</code></strong>
1.9       rillig   1267: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
                   1268: </pre>
                   1269: <p>Instead of URLs, you can also use local paths, for example if
                   1270:     you are installing from a set of CDROMs, DVDs or an NFS-mounted
                   1271:     repository. If you want to install packages from multiple sources,
                   1272:     you can separate them by a semicolon in
                   1273:     <code class="varname">PKG_PATH</code>.</p>
                   1274: <p>After these preparations, installing a package is very
                   1275:     easy:</p>
                   1276: <pre class="screen">
1.118     sevan    1277: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add libreoffice</code></strong>
                   1278: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add ap24-php71-*</code></strong>
1.9       rillig   1279: </pre>
1.1       dsieger  1280: <p>Note that any prerequisite packages needed to run the
                   1281:     package in question will be installed, too, assuming they are
                   1282:     present where you install from.</p>
1.23      wiz      1283: <p>Adding packages might install vulnerable packages.
                   1284:     Thus you should run <span class="command"><strong>pkg_admin audit</strong></span>
1.14      jmcneill 1285:     regularly, especially after installing new packages, and verify
                   1286:     that the vulnerabilities are acceptable for your configuration.</p>
1.1       dsieger  1287: <p>After you've installed packages, be sure to have
                   1288:     <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
                   1289:     <code class="varname">PATH</code> so you can actually start the just
                   1290:     installed program.</p>
                   1291: </div>
1.41      asau     1292: <div class="sect2">
1.1       dsieger  1293: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   1294: <a name="using.pkg_delete"></a>5.1.3. Deinstalling packages</h3></div></div></div>
1.1       dsieger  1295: <p>To deinstall a package, it does not matter whether it was
                   1296:     installed from source code or from a binary package. The
1.10      hubertf  1297:     <span class="command"><strong>pkg_delete</strong></span> command does not know it anyway.
                   1298:     To delete a package, you can just run <span class="command"><strong>pkg_delete
1.1       dsieger  1299:     <em class="replaceable"><code>package-name</code></em></strong></span>. The package
                   1300:     name can be given with or without version number. Wildcards can
                   1301:     also be used to deinstall a set of packages, for example
                   1302:     <code class="literal">*emacs*</code>. Be sure to include them in quotes,
                   1303:     so that the shell does not expand them before
                   1304:     <code class="literal">pkg_delete</code> sees them.</p>
                   1305: <p>The <code class="option">-r</code> option is very powerful: it
                   1306:     removes all the packages that require the package in question
                   1307:     and then removes the package itself. For example:
                   1308: 
                   1309:     </p>
                   1310: <pre class="screen">
                   1311: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
                   1312:     </pre>
                   1313: <p>
                   1314: 
                   1315:     will remove jpeg and all the packages that used it; this allows
                   1316:     upgrading the jpeg package.</p>
                   1317: </div>
1.41      asau     1318: <div class="sect2">
1.1       dsieger  1319: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   1320: <a name="using.pkg_info"></a>5.1.4. Getting information about installed packages</h3></div></div></div>
1.10      hubertf  1321: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.1       dsieger  1322:     installed packages or binary package files.</p>
                   1323: </div>
1.41      asau     1324: <div class="sect2">
1.1       dsieger  1325: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   1326: <a name="vulnerabilities"></a>5.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1.1       dsieger  1327: <p>
1.164     leot     1328:       The pkgsrc Security Team and Packages Groups maintain a list of
1.1       dsieger  1329:       known security vulnerabilities to packages which are (or have been)
                   1330:       included in pkgsrc.  The list is available from the NetBSD
1.165     leot     1331:       FTP site at <a class="ulink" href="http://ftp.NetBSD.org/pub/NetBSD/packages/vulns/pkg-vulnerabilities" target="_top">http://ftp.NetBSD.org/pub/NetBSD/packages/vulns/pkg-vulnerabilities</a>.
1.1       dsieger  1332:     </p>
                   1333: <p>
1.22      jakllsch 1334:       Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.1       dsieger  1335:       this list can be downloaded
                   1336:       automatically, and a security audit of all packages installed on a system
                   1337:       can take place.
                   1338:     </p>
                   1339: <p>
1.22      jakllsch 1340:       There are two components to auditing.  The first
                   1341:       step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
                   1342:       is for downloading
1.1       dsieger  1343:       the list of vulnerabilities from the NetBSD FTP site.  The second
1.22      jakllsch 1344:       step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.1       dsieger  1345:       installed packages are vulnerable.  If a package is vulnerable, you
                   1346:       will see output similar to the following:
                   1347:     </p>
                   1348: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
                   1349:     http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
                   1350: <p>
1.22      jakllsch 1351:       You may wish to have the
1.151     sevan    1352:       <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.22      jakllsch 1353:       file downloaded daily so that
                   1354:       it remains current.  This may be done by adding an appropriate entry
1.167   ! leot     1355:       to the root users <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?crontab+5.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">crontab</span>(5)</span></a> entry.  For example the entry
1.22      jakllsch 1356:       </p>
                   1357: <pre class="screen">
1.121     sevan    1358: # Download vulnerabilities file
1.118     sevan    1359: 0 3 * * * /usr/pkg/sbin/pkg_admin fetch-pkg-vulnerabilities &gt;/dev/null 2&gt;&amp;1
1.121     sevan    1360: # Audit the installed packages and email results to root
                   1361: 9 3 * * * /usr/pkg/sbin/pkg_admin audit |mail -s "Installed package audit result" \
                   1362:            root &gt;/dev/null 2&gt;&amp;1
1.22      jakllsch 1363:       </pre>
                   1364: <p>
1.118     sevan    1365:       will update the vulnerability list every day at 3AM, followed by an audit
                   1366:       at 3:09AM. The result of the audit are then emailed to root.
1.22      jakllsch 1367: 
1.118     sevan    1368:       On NetBSD this may be accomplished instead by adding the following
                   1369:       line to <code class="filename">/etc/daily.conf</code>:
                   1370:       </p>
                   1371: <pre class="screen">
                   1372: fetch_pkg_vulnerabilities=YES
                   1373:       </pre>
                   1374: <p>
                   1375:       to fetch the vulnerability list from the daily security script. The system
                   1376:       is set to audit the packages by default but can be set explicitly, if
1.123     wiz      1377:       desired (not required), by adding the following line to
1.118     sevan    1378: <code class="filename">/etc/security.conf</code>:
1.22      jakllsch 1379:       </p>
                   1380: <pre class="screen">
1.118     sevan    1381: check_pkg_vulnerabilities=YES
1.22      jakllsch 1382:       </pre>
                   1383: <p>
1.167   ! leot     1384:       see <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?daily.conf+5.i386+NetBSD-8.1"><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-8.1"><span class="citerefentry"><span class="refentrytitle">security.conf</span>(5)</span></a> for more details.
1.1       dsieger  1385:     </p>
                   1386: </div>
1.41      asau     1387: <div class="sect2">
1.1       dsieger  1388: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   1389: <a name="pkg_versions"></a>5.1.6. Finding if newer versions of your installed packages are in pkgsrc</h3></div></div></div>
1.1       dsieger  1390: <p>
1.137     leot     1391:       Install <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/lintpkgsrc/README.html" target="_top"><code class="filename">pkgtools/lintpkgsrc</code></a> and run
1.23      wiz      1392:       <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">&#8220;<span class="quote">-i</span>&#8221;</span>
1.1       dsieger  1393:       argument to check if your packages are up-to-date, e.g.
                   1394:     </p>
                   1395: <pre class="screen">
                   1396: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
                   1397: ...
                   1398: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
                   1399:     </pre>
1.10      hubertf  1400: <p>You can then use <span class="command"><strong>make update</strong></span> to update the
1.1       dsieger  1401:     package on your system and rebuild any dependencies.
                   1402:     </p>
                   1403: </div>
1.41      asau     1404: <div class="sect2">
1.1       dsieger  1405: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   1406: <a name="using.pkg_admin"></a>5.1.7. Other administrative functions</h3></div></div></div>
1.10      hubertf  1407: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.1       dsieger  1408:     administrative functions on the package system.</p>
                   1409: </div>
                   1410: </div>
1.41      asau     1411: <div class="sect1">
1.1       dsieger  1412: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   1413: <a name="building-packages-from-source"></a>5.2. Building packages from source</h2></div></div></div>
1.1       dsieger  1414: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
                   1415:   directory now contains a set of packages, organized into
                   1416:   categories. You can browse the online index of packages, or run
1.10      hubertf  1417:   <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.1       dsieger  1418:   directory to build local <code class="filename">README.html</code> files for
1.137     leot     1419:   all packages, viewable with any web browser such as <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/lynx/README.html" target="_top"><code class="filename">www/lynx</code></a> or <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/www/firefox/README.html" target="_top"><code class="filename">www/firefox</code></a>.</p>
1.1       dsieger  1420: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
                   1421:   is <code class="filename">/usr/pkg</code>. If you wish to change this, you
                   1422:   should do so by setting <code class="varname">LOCALBASE</code> in
1.10      hubertf  1423:   <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.1       dsieger  1424:   different <code class="varname">LOCALBASE</code> definitions on the same
                   1425:   system (inside a chroot is an exception). </p>
                   1426: <p>The rest of this chapter assumes that the package is already
1.10      hubertf  1427:   in pkgsrc. If it is not, see <a class="xref" href="#developers-guide" title="Part II. The pkgsrc developer's guide">Part II, &#8220;The pkgsrc developer's guide&#8221;</a> for
1.1       dsieger  1428:   instructions how to create your own packages.</p>
1.41      asau     1429: <div class="sect2">
1.1       dsieger  1430: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   1431: <a name="requirements"></a>5.2.1. Requirements</h3></div></div></div>
1.1       dsieger  1432: <p>To build packages from source, you need a working C
                   1433:     compiler. On NetBSD, you need to install the
1.23      wiz      1434:     <span class="quote">&#8220;<span class="quote">comp</span>&#8221;</span> and the <span class="quote">&#8220;<span class="quote">text</span>&#8221;</span> distribution
1.1       dsieger  1435:     sets. If you want to build X11-related packages, the
1.23      wiz      1436:     <span class="quote">&#8220;<span class="quote">xbase</span>&#8221;</span> and <span class="quote">&#8220;<span class="quote">xcomp</span>&#8221;</span> distribution
1.1       dsieger  1437:     sets are required, too.</p>
                   1438: </div>
1.41      asau     1439: <div class="sect2">
1.1       dsieger  1440: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   1441: <a name="fetching-distfiles"></a>5.2.2. Fetching distfiles</h3></div></div></div>
1.1       dsieger  1442: <p>The first step for building a package is downloading the
                   1443:     distfiles (i.e. the unmodified source). If they have not yet been
                   1444:     downloaded, pkgsrc will fetch them automatically.</p>
                   1445: <p>If you have all files that you need in the
                   1446:     <code class="filename">distfiles</code> directory,
                   1447:     you don't need to connect. If the distfiles are on CD-ROM, you can
                   1448:     mount the CD-ROM on <code class="filename">/cdrom</code> and add:
                   1449:     </p>
                   1450: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
                   1451: <p>
1.10      hubertf  1452:     to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1       dsieger  1453: <p>By default a list of distribution sites will be randomly
                   1454:     intermixed to prevent huge load on servers which holding popular
                   1455:     packages (for example, SourceForge.net mirrors). Thus, every
                   1456:     time when you need to fetch yet another distfile all the mirrors
                   1457:     will be tried in new (random) order. You can turn this feature
                   1458:     off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
                   1459:     <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
                   1460: <p>You can overwrite some of the major distribution sites to
                   1461:     fit to sites that are close to your own.  By setting one or two
                   1462:     variables you can modify the order in which the master sites are
                   1463:     accessed.  <code class="varname">MASTER_SORT</code> contains a whitespace
                   1464:     delimited list of domain suffixes.
                   1465:     <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
                   1466:     contains a whitespace delimited list of regular expressions.  It
                   1467:     has higher priority than <code class="varname">MASTER_SORT</code>.  Have a
                   1468:     look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
                   1469:     some examples.  This may save some of your bandwidth and
                   1470:     time.</p>
                   1471: <p>You can change these settings either in your shell's environment, or,
                   1472:     if you want to keep the settings, by editing the
1.10      hubertf  1473:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.1       dsieger  1474:     and adding the definitions there.</p>
                   1475: <p>
                   1476:       If a package depends on many other packages (such as
1.137     leot     1477:       <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/kde4/README.html" target="_top"><code class="filename">meta-pkgs/kde4</code></a>), the build process may
1.1       dsieger  1478:       alternate between periods of
                   1479:       downloading source, and compiling. To ensure you have all the source
                   1480:       downloaded initially you can run the command:
                   1481:       </p>
                   1482: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
                   1483: <p>
                   1484:       which will output and run a set of shell commands to fetch the
                   1485:       necessary files into the <code class="filename">distfiles</code> directory.  You can
                   1486:       also choose to download the files manually.
                   1487:     </p>
                   1488: </div>
1.41      asau     1489: <div class="sect2">
1.1       dsieger  1490: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   1491: <a name="how-to-build-and-install"></a>5.2.3. How to build and install</h3></div></div></div>
1.1       dsieger  1492: <p>
                   1493:       Once the software has downloaded, any patches will be applied, then it
                   1494:       will be compiled for you. This may take some time depending on your
                   1495:       computer, and how many other packages the software depends on and their
                   1496:       compile time.
                   1497:     </p>
1.41      asau     1498: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  1499: <h3 class="title">Note</h3>
                   1500: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.10      hubertf  1501:     use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.23      wiz      1502:     <span class="quote">&#8220;<span class="quote">make</span>&#8221;</span> in the examples in this guide.</p>
1.1       dsieger  1503: </div>
                   1504: <p>For example, type</p>
                   1505: <pre class="screen">
                   1506: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
                   1507: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   1508:     </pre>
                   1509: <p>at the shell prompt to build the various components of the
                   1510:     package.</p>
                   1511: <p>The next stage is to actually install the newly compiled
                   1512:     program onto your system. Do this by entering:
                   1513: 
                   1514:     </p>
                   1515: <pre class="screen">
                   1516: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
                   1517:     </pre>
                   1518: <p>
                   1519: 
                   1520:     while you are still in the directory for whatever package you
                   1521:     are installing.</p>
                   1522: <p>Installing the package on your system may require you to
                   1523:     be root.  However, pkgsrc has a
                   1524:     <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
                   1525:     to only become root for the actual installation step.</p>
                   1526: <p>That's it, the software should now be installed and setup for use.
                   1527:     You can now enter:
                   1528: 
                   1529:     </p>
                   1530: <pre class="screen">
                   1531: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
                   1532:     </pre>
                   1533: <p>
                   1534: 
                   1535:     to remove the compiled files in the work directory, as you shouldn't need
                   1536:     them any more. If other packages were also added to your system
                   1537:     (dependencies) to allow your program to compile, you can tidy these up
                   1538:     also with the command:</p>
                   1539: <pre class="screen">
                   1540: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
                   1541:     </pre>
                   1542: <p>Taking the figlet utility as an example, we can install it on our
1.10      hubertf  1543:     system by building as shown in <a class="xref" href="#logs" title="Appendix B. Build logs">Appendix B, <i>Build logs</i></a>.</p>
1.1       dsieger  1544: <p>The program is installed under the default root of the
                   1545:     packages tree - <code class="filename">/usr/pkg</code>. Should this not
                   1546:     conform to your tastes, set the <code class="varname">LOCALBASE</code>
                   1547:     variable in your environment, and it will use that value as the
                   1548:     root of your packages tree. So, to use
                   1549:     <code class="filename">/usr/local</code>, set
                   1550:     <code class="varname">LOCALBASE=/usr/local</code> in your environment.
                   1551:     Please note that you should use a directory which is dedicated to
                   1552:     packages and not shared with other programs (i.e., do not try and
                   1553:     use <code class="varname">LOCALBASE=/usr</code>).  Also, you should not try
                   1554:     to add any of your own files or directories (such as
                   1555:     <code class="filename">src/</code>, <code class="filename">obj/</code>, or
                   1556:     <code class="filename">pkgsrc/</code>) below the
                   1557:     <code class="varname">LOCALBASE</code> tree.  This is to prevent possible
                   1558:     conflicts between programs and other files installed by the
                   1559:     package system and whatever else may have been installed
                   1560:     there.</p>
1.10      hubertf  1561: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1       dsieger  1562:     alter some configuration options at build time.  Have a look at
                   1563:     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
                   1564:     of what will be set there by default.  Environment variables such
                   1565:     as <code class="varname">LOCALBASE</code> can be set in
1.10      hubertf  1566:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.1       dsieger  1567:     set them each time you want to use pkgsrc.</p>
1.23      wiz      1568: <p>Occasionally, people want to <span class="quote">&#8220;<span class="quote">look under the
                   1569:     covers</span>&#8221;</span> to see what is going on when a package is building
1.1       dsieger  1570:     or being installed. This may be for debugging purposes, or out of
                   1571:     simple curiosity. A number of utility values have been added to
                   1572:     help with this.</p>
1.23      wiz      1573: <div class="orderedlist"><ol class="orderedlist" type="1">
                   1574: <li class="listitem">
1.167   ! leot     1575: <p>If you invoke the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> command with
1.1       dsieger  1576:        <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
                   1577:        information will be displayed. For example,</p>
                   1578: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
                   1579: <p>will show all the commands that are invoked, up to and
1.23      wiz      1580:        including the <span class="quote">&#8220;<span class="quote">patch</span>&#8221;</span> stage.</p>
1.1       dsieger  1581: </li>
1.23      wiz      1582: <li class="listitem">
1.167   ! leot     1583: <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-8.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.1       dsieger  1584:        definition, then the <code class="varname">VARNAME</code> definition
                   1585:        should be used, in conjunction with the show-var
1.167   ! leot     1586:        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-8.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>
1.1       dsieger  1587:        variable <code class="varname">LOCALBASE</code>:</p>
                   1588: <pre class="screen">
                   1589: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
                   1590: /usr/pkg
                   1591: <code class="prompt">%</code>
                   1592:        </pre>
                   1593: </li>
                   1594: </ol></div>
                   1595: <p>If you want to install a binary package that you've either
                   1596:     created yourself (see next section), that you put into
                   1597:     pkgsrc/packages manually or that is located on a remote FTP
                   1598:     server, you can use the "bin-install" target. This target will
1.167   ! leot     1599:     install a binary package - if available - via <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>,
1.10      hubertf  1600:     else do a <span class="command"><strong>make package</strong></span>.  The list of remote FTP
1.1       dsieger  1601:     sites searched is kept in the variable
                   1602:     <code class="varname">BINPKG_SITES</code>, which defaults to
1.167   ! leot     1603:     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-8.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>
1.1       dsieger  1604:     can be put into <code class="varname">BIN_INSTALL_FLAGS</code>.  See
                   1605:     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
                   1606:     details.</p>
                   1607: <p>A final word of warning: If you set up a system that has a
                   1608:     non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
                   1609:     set that before any packages are installed, as you cannot use
                   1610:     several directories for the same purpose. Doing so will result in
                   1611:     pkgsrc not being able to properly detect your installed packages,
                   1612:     and fail miserably. Note also that precompiled binary packages are
                   1613:     usually built with the default <code class="varname">LOCALBASE</code> of
                   1614:     <code class="filename">/usr/pkg</code>, and that you should
                   1615:     <span class="emphasis"><em>not</em></span> install any if you use a non-standard
                   1616:     <code class="varname">LOCALBASE</code>.</p>
                   1617: </div>
                   1618: </div>
                   1619: </div>
1.41      asau     1620: <div class="chapter">
1.1       dsieger  1621: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   1622: <a name="configuring"></a>Chapter 6. Configuring pkgsrc</h2></div></div></div>
1.1       dsieger  1623: <div class="toc">
                   1624: <p><b>Table of Contents</b></p>
1.100     leot     1625: <dl class="toc">
1.154     rillig   1626: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
                   1627: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
                   1628: <dt><span class="sect1"><a href="#variables-affecting-installation">6.3. Variables affecting the installation process</a></span></dt>
                   1629: <dt><span class="sect1"><a href="#conf.compiler">6.4. Selecting and configuring the compiler</a></span></dt>
                   1630: <dd><dl>
                   1631: <dt><span class="sect2"><a href="#selecting-the-compiler">6.4.1. Selecting the compiler</a></span></dt>
                   1632: <dt><span class="sect2"><a href="#conf.cflags">6.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                   1633: <dt><span class="sect2"><a href="#conf.ldflags">6.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</a></span></dt>
1.1       dsieger  1634: </dl></dd>
1.154     rillig   1635: <dt><span class="sect1"><a href="#developer-advanced-settings">6.5. Developer/advanced settings</a></span></dt>
                   1636: <dt><span class="sect1"><a href="#selecting-build-options">6.6. Selecting Build Options</a></span></dt>
1.1       dsieger  1637: </dl>
                   1638: </div>
1.4       rillig   1639: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.1       dsieger  1640: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
                   1641: that file depends on the installation. On NetBSD, when you use
1.167   ! leot     1642: <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> from the base system, it is in the directory
1.1       dsieger  1643: <code class="filename">/etc/</code>. In all other cases the default location is
                   1644: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
                   1645: bootstrap program to install the binary packages.</p>
                   1646: <p>The format of the configuration file is that of the usual
                   1647: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
                   1648: is done by setting variables in this file. Note that you can define all
                   1649: kinds of variables, and no special error checking (for example for
1.112     rillig   1650: spelling mistakes) takes place.</p>
1.41      asau     1651: <div class="sect1">
1.1       dsieger  1652: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   1653: <a name="general-configuration"></a>6.1. General configuration</h2></div></div></div>
1.112     rillig   1654: <p>The following variables apply to all
1.1       dsieger  1655:     pkgsrc packages. A complete list of the variables that can be
                   1656:     configured by the user is available in
                   1657:     <code class="filename">mk/defaults/mk.conf</code>, together with some
                   1658:     comments that describe each variable's intent.</p>
1.41      asau     1659: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      1660: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.1       dsieger  1661:            packages will be installed. The default is
                   1662:            <code class="filename">/usr/pkg</code>. Do not mix binary packages
                   1663:            with different <code class="varname">LOCALBASE</code>s!</p></li>
1.23      wiz      1664: <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
                   1665:            <span class="quote">&#8220;<span class="quote">cross</span>&#8221;</span> category packages will be
1.1       dsieger  1666:            installed. The default is
                   1667:            <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.23      wiz      1668: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.1       dsieger  1669:            X11 is installed on the system. The default is
1.84      wiz      1670:            <code class="filename">/usr/X11R7</code>.</p></li>
1.23      wiz      1671: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.1       dsieger  1672:            downloaded copies of the original source distributions used
                   1673:            for building pkgsrc packages. The default is
                   1674:            <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.23      wiz      1675: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.1       dsieger  1676:            database about installed packages is stored.  The default is
1.118     sevan    1677:            <code class="filename">/usr/pkg/pkgdb</code>.</p></li>
1.23      wiz      1678: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.1       dsieger  1679:            If set, override the packages'
                   1680:            <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.23      wiz      1681: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.1       dsieger  1682:            Backup location(s) for distribution files and patch files
                   1683:            if not found locally or in
                   1684:            <code class="filename">${MASTER_SITES}</code> or
                   1685:            <code class="filename">${PATCH_SITES}</code> respectively.
1.118     sevan    1686:            The defaults is
                   1687:            <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.23      wiz      1688: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.1       dsieger  1689:            List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
                   1690:            <em class="replaceable"><code>arch</code></em> are replaced with OS
1.23      wiz      1691:            release (<span class="quote">&#8220;<span class="quote">2.0</span>&#8221;</span>, etc.) and architecture
                   1692:            (<span class="quote">&#8220;<span class="quote">mipsel</span>&#8221;</span>, etc.).</p></li>
                   1693: <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.22      jakllsch 1694:            List of acceptable licenses. License names are case-sensitive.
                   1695:            Whenever you try to build a package whose license is not in this
                   1696:            list, you will get an error message. If the license condition is
                   1697:            simple enough, the error message will include specific
                   1698:            instructions on how to change this variable.</p></li>
1.1       dsieger  1699: </ul></div>
                   1700: </div>
1.41      asau     1701: <div class="sect1">
1.1       dsieger  1702: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   1703: <a name="variables-affecting-build"></a>6.2. Variables affecting the build process</h2></div></div></div>
1.108     rillig   1704: <p>
1.1       dsieger  1705:       </p>
1.41      asau     1706: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      1707: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.1       dsieger  1708:            directory for the binary packages. The default is
                   1709:            <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.23      wiz      1710: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.1       dsieger  1711:            The top level directory where, if defined, the separate
                   1712:            working directories will get created, and symbolically
                   1713:            linked to from <code class="filename">${WRKDIR}</code> (see below).
                   1714:            This is useful for building packages on several
                   1715:            architectures, then <code class="filename">${PKGSRCDIR}</code>
                   1716:            can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
                   1717:            is local to every architecture. (It should be noted that
                   1718:            <code class="varname">PKGSRCDIR</code> should not be set by the user
1.14      jmcneill 1719:            &mdash; it is an internal definition which refers to the
1.1       dsieger  1720:            root of the pkgsrc tree. It is possible to have many
                   1721:            pkgsrc tree instances.)</p></li>
1.23      wiz      1722: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.1       dsieger  1723:            Directory for local patches that aren't part of pkgsrc.
1.154     rillig   1724:            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.1       dsieger  1725:            information.</p></li>
1.23      wiz      1726: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.10      hubertf  1727:            the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.1       dsieger  1728:            BSD-style Makefile. If this is not set,
                   1729:            <code class="varname">MAKECONF</code> is set to
                   1730:            <code class="filename">/dev/null</code> to avoid picking up
                   1731:            settings used by builds in <code class="filename">/usr/src</code>.</p></li>
                   1732: </ul></div>
                   1733: </div>
1.41      asau     1734: <div class="sect1">
1.1       dsieger  1735: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   1736: <a name="variables-affecting-installation"></a>6.3. Variables affecting the installation process</h2></div></div></div>
1.143     maya     1737: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><code class="varname">PKGSRC_KEEP_BIN_PKGSRC</code>:
                   1738:                 By default, binary packages of built packages are
1.150     leot     1739:                 preserved in <code class="filename">${PACKAGES}/All</code>. Setting
1.143     maya     1740:                this variable to "no" prevents this.</p></li></ul></div>
1.107     jnemeth  1741: <p>Packages have to support installation into a
1.4       rillig   1742:     subdirectory of <code class="varname">WRKDIR</code>. This allows a package
                   1743:     to be built, before the actual filesystem is touched. DESTDIR
                   1744:     support exists in two variations:</p>
1.41      asau     1745: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      1746: <li class="listitem"><p>Basic DESTDIR support means that the package
1.24      wiz      1747:       installation and packaging is still run as root.</p></li>
                   1748: <li class="listitem"><p>Full DESTDIR support can run the complete
                   1749:       build, installation and packaging as normal user. Root
                   1750:       privileges are only needed to add packages.</p></li>
                   1751: </ul></div>
1.4       rillig   1752: <p>With basic DESTDIR support, <strong class="userinput"><code>make
                   1753:     clean</code></strong> needs to be run as root.</p>
1.17      imil     1754: <p>Considering the <code class="filename">foo/bar</code> package,
                   1755:     DESTDIR full support can be tested using the following commands
                   1756: 
                   1757: </p>
                   1758: <pre class="programlisting">
                   1759: <code class="prompt">$</code> id
                   1760: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
                   1761: <code class="prompt">$</code> mkdir $HOME/packages
                   1762: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
                   1763: </pre>
                   1764: <p>
                   1765: 
                   1766:     Verify <code class="varname">DESTDIR</code> full support, no root privileges
                   1767:     should be needed
                   1768: 
                   1769: </p>
                   1770: <pre class="programlisting">
1.66      asau     1771: <code class="prompt">$</code> make stage-install
1.17      imil     1772: </pre>
                   1773: <p>
                   1774: 
                   1775:     Create a package without root privileges
                   1776: 
                   1777: </p>
                   1778: <pre class="programlisting">
1.66      asau     1779: <code class="prompt">$</code> make PACKAGES=$HOME/packages package
1.17      imil     1780: </pre>
                   1781: <p>
                   1782: 
                   1783:     For the following command, you must be able to gain root
1.167   ! leot     1784:     privileges using <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?su+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a>
1.17      imil     1785: 
                   1786: </p>
                   1787: <pre class="programlisting">
1.66      asau     1788: <code class="prompt">$</code> make PACKAGES=$HOME/packages install
1.17      imil     1789: </pre>
                   1790: <p>
                   1791: 
                   1792:     Then, as a simple user
                   1793: 
                   1794: </p>
                   1795: <pre class="programlisting">
                   1796: <code class="prompt">$</code> make clean
                   1797: </pre>
                   1798: <p>
                   1799: 
                   1800:     </p>
1.4       rillig   1801: </div>
1.41      asau     1802: <div class="sect1">
1.4       rillig   1803: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   1804: <a name="conf.compiler"></a>6.4. Selecting and configuring the compiler</h2></div></div></div>
1.41      asau     1805: <div class="sect2">
1.1       dsieger  1806: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   1807: <a name="selecting-the-compiler"></a>6.4.1. Selecting the compiler</h3></div></div></div>
1.1       dsieger  1808: <p>By default, pkgsrc will use GCC to build packages.  This may be
                   1809:     overridden by setting the following variables in /etc/mk.conf:</p>
1.41      asau     1810: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  1811: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
                   1812: <dd>
                   1813: <p>This is a list of values specifying the chain of
                   1814:          compilers to invoke when building packages.  Valid values
                   1815:          are:</p>
1.41      asau     1816: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.66      asau     1817: <li class="listitem"><p><code class="varname">ccc</code>:
                   1818:            Compaq C Compilers (Tru64)</p></li>
                   1819: <li class="listitem"><p><code class="varname">ccache</code>:
                   1820:            compiler cache (chainable)</p></li>
                   1821: <li class="listitem"><p><code class="varname">clang</code>:
                   1822:            Clang C and Objective-C compiler</p></li>
1.23      wiz      1823: <li class="listitem"><p><code class="varname">distcc</code>:
1.1       dsieger  1824:            distributed C/C++ (chainable)</p></li>
1.66      asau     1825: <li class="listitem"><p><code class="varname">f2c</code>:
                   1826:            Fortran 77 to C compiler (chainable)</p></li>
                   1827: <li class="listitem"><p><code class="varname">icc</code>:
                   1828:            Intel C++ Compiler (Linux)</p></li>
                   1829: <li class="listitem"><p><code class="varname">ido</code>:
                   1830:            SGI IRIS Development Option cc (IRIX 5)</p></li>
1.23      wiz      1831: <li class="listitem"><p><code class="varname">gcc</code>:
1.1       dsieger  1832:            GNU C/C++ Compiler</p></li>
1.66      asau     1833: <li class="listitem"><p><code class="varname">hp</code>:
                   1834:            HP-UX C/aC++ compilers</p></li>
1.23      wiz      1835: <li class="listitem"><p><code class="varname">mipspro</code>:
1.1       dsieger  1836:            Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.66      asau     1837: <li class="listitem"><p><code class="varname">mipspro-ucode</code>:
1.1       dsieger  1838:            Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.23      wiz      1839: <li class="listitem"><p><code class="varname">sunpro</code>:
1.1       dsieger  1840:            Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
1.66      asau     1841: <li class="listitem"><p><code class="varname">xlc</code>:
1.118     sevan    1842:            IBM's XL C/C++ compiler suite</p></li>
1.1       dsieger  1843: </ul></div>
                   1844: <p>The default is
1.23      wiz      1845:          <span class="quote">&#8220;<span class="quote"><code class="varname">gcc</code></span>&#8221;</span>.  You can use
1.1       dsieger  1846:          <code class="varname">ccache</code> and/or
                   1847:          <code class="varname">distcc</code> with an appropriate
                   1848:          <code class="varname">PKGSRC_COMPILER</code> setting,
1.23      wiz      1849:          e.g. <span class="quote">&#8220;<span class="quote"><code class="varname">ccache gcc</code></span>&#8221;</span>.  This
1.1       dsieger  1850:          variable should always be terminated with a value for
                   1851:          a real compiler.  Note that only one real compiler
1.23      wiz      1852:          should be listed (e.g. <span class="quote">&#8220;<span class="quote"><code class="varname">sunpro gcc</code></span>&#8221;</span>
1.1       dsieger  1853:          is not allowed).</p>
                   1854: </dd>
                   1855: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
                   1856: <dd><p>This specifies the minimum version of GCC to use
                   1857:          when building packages.  If the system GCC doesn't
                   1858:          satisfy this requirement, then pkgsrc will build and
                   1859:          install one of the GCC packages to use instead.</p></dd>
1.153     leot     1860: <dt><span class="term"><code class="varname">PYTHON_VERSION_DEFAULT</code>:</span></dt>
1.114     maya     1861: <dd><p>Specifies which version of python to use when several
                   1862:          options are available.</p></dd>
                   1863: <dt><span class="term"><code class="varname">PKGSRC_FORTRAN</code>:</span></dt>
                   1864: <dd><p>Specifies the fortran compiler to use.
                   1865:          The default is <code class="varname">g95</code>, and
                   1866:          <code class="varname">gfortran</code> is an alternative.</p></dd>
                   1867: <dt><span class="term"><code class="varname">GFORTRAN_VERSION</code>:</span></dt>
                   1868: <dd><p>If <code class="varname">PKGSRC_FORTRAN</code><code class="literal">=</code>
                   1869:          <code class="varname">gfortran</code> is used, this option specifies which
                   1870:          version to use.</p></dd>
1.1       dsieger  1871: </dl></div>
                   1872: </div>
1.41      asau     1873: <div class="sect2">
1.1       dsieger  1874: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   1875: <a name="conf.cflags"></a>6.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</h3></div></div></div>
1.1       dsieger  1876: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
                   1877:        please make sure to use the <code class="literal">+=</code> operator
                   1878:        instead of the <code class="literal">=</code> operator:</p>
                   1879: <pre class="programlisting">
                   1880: CFLAGS+=        -your -flags
                   1881: </pre>
                   1882: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.23      wiz      1883:        <span class="quote">&#8220;<span class="quote">+</span>&#8221;</span>) may lead to problems with packages that
1.16      jnemeth  1884:        need to add their own flags.  You may want to take a look
1.137     leot     1885:        at the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/README.html" target="_top"><code class="filename">devel/cpuflags</code></a>
1.23      wiz      1886:        package if you're interested in optimization specifically
                   1887:        for the current CPU. </p>
1.1       dsieger  1888: </div>
1.41      asau     1889: <div class="sect2">
1.1       dsieger  1890: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   1891: <a name="conf.ldflags"></a>6.4.3. Additional flags to the linker (<code class="varname">LDFLAGS</code>)</h3></div></div></div>
1.1       dsieger  1892: <p>If you want to pass flags to the linker, both in the configure
                   1893: step and the build step, you can do this in two ways.  Either set
                   1894: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>.  The difference
                   1895: between the two is that <code class="varname">LIBS</code> will be appended to
                   1896: the command line, while <code class="varname">LDFLAGS</code> come earlier.
                   1897: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
                   1898: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
                   1899: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>.  As with
                   1900: <code class="varname">CFLAGS</code>, if you do not wish to override these
                   1901: settings, use the <code class="literal">+=</code> operator:</p>
                   1902: <pre class="programlisting">
                   1903: LDFLAGS+=        -your -linkerflags
                   1904: </pre>
                   1905: </div>
                   1906: </div>
1.41      asau     1907: <div class="sect1">
1.1       dsieger  1908: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   1909: <a name="developer-advanced-settings"></a>6.5. Developer/advanced settings</h2></div></div></div>
1.84      wiz      1910: <p>
1.1       dsieger  1911:       </p>
1.41      asau     1912: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      1913: <li class="listitem">
1.1       dsieger  1914: <p><code class="varname">PKG_DEVELOPER</code>:
                   1915:            Run some sanity checks that package developers want:
                   1916:            </p>
1.41      asau     1917: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.23      wiz      1918: <li class="listitem"><p>make sure patches apply with zero
1.1       dsieger  1919:              fuzz</p></li>
1.23      wiz      1920: <li class="listitem"><p>run check-shlibs to see that all
1.1       dsieger  1921:              binaries will find their shared libs.</p></li>
                   1922: </ul></div>
                   1923: <p>
                   1924:        </p>
                   1925: </li>
1.23      wiz      1926: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.1       dsieger  1927:        of debugging output which is displayed whilst making and
                   1928:        installing the package.  The default value for this is 0,
                   1929:        which will not display the commands as they are executed
                   1930:        (normal, default, quiet operation); the value 1 will display
                   1931:        all shell commands before their invocation, and the value 2
                   1932:        will display both the shell commands before their invocation,
1.112     rillig   1933:        as well as their actual execution progress with <span class="command"><strong>set
                   1934:        -x</strong></span>.</p></li>
1.1       dsieger  1935: </ul></div>
                   1936: <p>
                   1937:     </p>
                   1938: </div>
1.41      asau     1939: <div class="sect1">
1.1       dsieger  1940: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   1941: <a name="selecting-build-options"></a>6.6. Selecting Build Options</h2></div></div></div>
1.1       dsieger  1942: <p>Some packages have build time options, usually to select
                   1943:     between different dependencies, enable optional support for big
                   1944:     dependencies or enable experimental features.</p>
                   1945: <p>To see which options, if any, a package supports, and which
1.10      hubertf  1946:     options are mutually exclusive, run <span class="command"><strong>make
1.1       dsieger  1947:     show-options</strong></span>, for example:</p>
                   1948: <pre class="programlisting">
                   1949:     The following options are supported by this package:
                   1950:         ssl      Enable SSL support.
                   1951:     Exactly one of the following gecko options is required:
                   1952:         firefox  Use firefox as gecko rendering engine.
                   1953:         mozilla  Use mozilla as gecko rendering engine.
                   1954:     At most one of the following database options may be selected:
                   1955:         mysql    Enable support for MySQL database.
                   1956:         pgsql    Enable support for PostgreSQL database.
                   1957: 
                   1958:     These options are enabled by default: firefox
                   1959:     These options are currently enabled: mozilla ssl
                   1960: </pre>
                   1961: <p>The following variables can be defined in
1.10      hubertf  1962:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.1       dsieger  1963:     enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
                   1964:     which can be used to select or disable options for all packages
                   1965:     that support them, and
                   1966:     <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
                   1967:     which can be used to select or disable options specifically for
                   1968:     package <em class="replaceable"><code>pkgbase</code></em>.  Options listed in
1.23      wiz      1969:     these variables are selected, options preceded by <span class="quote">&#8220;<span class="quote">-</span>&#8221;</span>
1.1       dsieger  1970:     are disabled. A few examples:</p>
                   1971: <pre class="screen">
1.10      hubertf  1972: <code class="prompt">$</code> <span class="command"><strong>grep "PKG.*OPTION" <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a></strong></span>
1.1       dsieger  1973: PKG_DEFAULT_OPTIONS=    -arts -dvdread -esound
                   1974: PKG_OPTIONS.kdebase=    debug -sasl
                   1975: PKG_OPTIONS.apache=     suexec </pre>
1.11      rillig   1976: <p>It is important to note that options that were specifically
1.18      snj      1977:     suggested by the package maintainer must be explicitly removed if
1.11      rillig   1978:     you do not wish to include the option.  If you are unsure you can view
                   1979:     the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.1       dsieger  1980: <p>The following settings are consulted in the order given, and
                   1981:     the last setting that selects or disables an option is
                   1982:     used:</p>
1.23      wiz      1983: <div class="orderedlist"><ol class="orderedlist" type="1">
                   1984: <li class="listitem"><p>the default options as suggested by the package
1.1       dsieger  1985:       maintainer</p></li>
1.23      wiz      1986: <li class="listitem"><p>the options implied by the settings of legacy
1.1       dsieger  1987:       variables (see below)</p></li>
1.23      wiz      1988: <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
                   1989: <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
1.1       dsieger  1990: </ol></div>
                   1991: <p>For groups of mutually exclusive options, the last option
                   1992:     selected is used, all others are automatically disabled.  If an
                   1993:     option of the group is explicitly disabled, the previously
                   1994:     selected option, if any, is used.  It is an error if no option
                   1995:     from a required group of options is selected, and building the
                   1996:     package will fail.</p>
                   1997: <p>Before the options framework was introduced, build options
                   1998:     were selected by setting a variable (often named
                   1999:     <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.10      hubertf  2000:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option.  To ease
1.1       dsieger  2001:     transition to the options framework for the user, these legacy
                   2002:     variables are converted to the appropriate options setting
                   2003:     (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
                   2004:     automatically.  A warning is issued to prompt the user to update
1.10      hubertf  2005:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.1       dsieger  2006:     directly.  Support for the legacy variables will be removed
                   2007:     eventually.</p>
                   2008: </div>
                   2009: </div>
1.41      asau     2010: <div class="chapter">
1.1       dsieger  2011: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   2012: <a name="binary"></a>Chapter 7. Creating binary packages</h2></div></div></div>
1.1       dsieger  2013: <div class="toc">
                   2014: <p><b>Table of Contents</b></p>
1.100     leot     2015: <dl class="toc">
1.154     rillig   2016: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
                   2017: <dt><span class="sect1"><a href="#settings-for-creationg-of-binary-packages">7.2. Settings for creation of binary packages</a></span></dt>
1.1       dsieger  2018: </dl>
                   2019: </div>
1.41      asau     2020: <div class="sect1">
1.1       dsieger  2021: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2022: <a name="building-a-single-binary-package"></a>7.1. Building a single binary package</h2></div></div></div>
1.1       dsieger  2023: <p>Once you have built and installed a package, you can create
                   2024:     a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.167   ! leot     2025:     another system with <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. This saves having to build
1.1       dsieger  2026:     the same package on a group of hosts and wasting CPU time. It also
                   2027:     provides a simple means for others to install your package, should
                   2028:     you distribute it.</p>
                   2029: <p>To create a binary package, change into the appropriate
1.10      hubertf  2030:     directory in pkgsrc, and run <span class="command"><strong>make
1.1       dsieger  2031:     package</strong></span>:</p>
                   2032: <pre class="screen">
1.112     rillig   2033: <code class="prompt">$</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
                   2034: <code class="prompt">$</code> <strong class="userinput"><code>make package</code></strong>
                   2035: </pre>
1.1       dsieger  2036: <p>This will build and install your package (if not already done),
                   2037:     and then build a binary package from what was installed. You can
1.10      hubertf  2038:     then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.1       dsieger  2039:     it. Binary packages are created by default in
                   2040:     <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.10      hubertf  2041:     gzipped tar file. See <a class="xref" href="#logs.package" title="B.2. Packaging figlet">Section B.2, &#8220;Packaging figlet&#8221;</a> for a
1.137     leot     2042:     continuation of the above <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/misc/figlet/README.html" target="_top"><code class="filename">misc/figlet</code></a> example.</p>
1.154     rillig   2043: <p>See <a class="xref" href="#submit" title="Chapter 23. Submitting and Committing">Chapter 23, <i>Submitting and Committing</i></a> for information on how to submit
1.1       dsieger  2044:     such a binary package.</p>
                   2045: </div>
1.41      asau     2046: <div class="sect1">
1.1       dsieger  2047: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2048: <a name="settings-for-creationg-of-binary-packages"></a>7.2. Settings for creation of binary packages</h2></div></div></div>
                   2049: <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.6       rillig   2050: </div>
                   2051: </div>
1.41      asau     2052: <div class="chapter">
1.6       rillig   2053: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   2054: <a name="bulk"></a>Chapter 8. Creating binary packages for everything in pkgsrc (bulk
1.6       rillig   2055: builds)</h2></div></div></div>
                   2056: <div class="toc">
                   2057: <p><b>Table of Contents</b></p>
1.100     leot     2058: <dl class="toc">
1.154     rillig   2059: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
                   2060: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a pbulk-style bulk build</a></span></dt>
                   2061: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
                   2062: <dt><span class="sect1"><a href="#bulk.req">8.3. Requirements of a full bulk build</a></span></dt>
                   2063: <dt><span class="sect1"><a href="#creating-cdroms">8.4. Creating a multiple CD-ROM packages collection</a></span></dt>
                   2064: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.4.1. Example of cdpack</a></span></dt></dl></dd>
1.6       rillig   2065: </dl>
                   2066: </div>
1.71      wiz      2067: <p>For a number of reasons you may want to build binary packages
                   2068: for a large selected set of packages in pkgsrc or even for all pkgsrc packages.
                   2069: For instance, when you have multiple machines that should run the same software,
                   2070: it is wasted time if they all build their packages themselves from source.
                   2071: Or you may want to build a list of packages you want and check them before
                   2072: deploying onto production system.
                   2073: There is a way of getting a set of binary packages:
1.112     rillig   2074: The bulk build system, or pbulk ("p" stands for "parallel").
                   2075: This chapter describes how to set it up.</p>
1.41      asau     2076: <div class="sect1">
1.6       rillig   2077: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2078: <a name="bulk.pre"></a>8.1. Preparations</h2></div></div></div>
1.71      wiz      2079: <p>First of all, you have to decide whether you build all packages
                   2080: or a limited set of them. Full bulk builds usually consume a lot more resources,
                   2081: both space and time, than builds for some practical sets of packages.
                   2082: There exists a number of particularly heavy packages that are not actually
                   2083: interesting to a wide audience.
                   2084: 
                   2085: For a limited bulk builds you need to make a list of packages you want to build.
1.112     rillig   2086: Note that all their dependencies will be built, so you don't need to track them manually.
1.71      wiz      2087: </p>
                   2088: <p>During bulk builds various packages are installed and deinstalled
                   2089: in <code class="filename">/usr/pkg</code> (or whatever <code class="filename">LOCALBASE</code> is),
                   2090: so make sure that you don't need any package during the builds.
1.112     rillig   2091: Essentially, you should provide a fresh system, either a chroot environment
1.71      wiz      2092: or something even more restrictive, depending on what the operating system provides,
                   2093: or dedicate the whole physical machine.
                   2094: As a useful side effect this makes sure that bulk builds cannot
                   2095: break anything in your system. There have been numerous cases where
1.6       rillig   2096: certain packages tried to install files outside the
                   2097: <code class="filename">LOCALBASE</code> or wanted to edit some files in
1.71      wiz      2098: <code class="filename">/etc</code>.
                   2099: </p>
1.6       rillig   2100: </div>
1.41      asau     2101: <div class="sect1">
1.6       rillig   2102: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2103: <a name="bulk.pbulk"></a>8.2. Running a pbulk-style bulk build</h2></div></div></div>
1.15      rillig   2104: <p>Running a pbulk-style bulk build works roughly as follows:</p>
1.41      asau     2105: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      2106: <li class="listitem"><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
                   2107: <li class="listitem"><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
1.15      rillig   2108: </ul></div>
1.41      asau     2109: <div class="sect2">
1.15      rillig   2110: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   2111: <a name="bulk.pbulk.conf"></a>8.2.1. Configuration</h3></div></div></div>
1.112     rillig   2112: <p>To simplify configuration, we provide the helper script <code class="filename">mk/pbulk/pbulk.sh</code>.</p>
1.68      asau     2113: <p>In order to use it, prepare a clear system (real one, chroot environment, jail, zone, virtual machine).
                   2114: Configure network access to fetch distribution files.
1.112     rillig   2115: Create a user with name "pbulk".</p>
1.68      asau     2116: <p>Fetch and extract pkgsrc. Use a command like one of these:</p>
                   2117: <pre class="screen">
1.151     sevan    2118: <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>
                   2119: <code class="prompt">#</code> <strong class="userinput"><code>(cd /usr &amp;&amp; fetch -o - https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc.tar.gz | tar -zxf-)</code></strong>
1.72      wiz      2120: <code class="prompt">#</code> <strong class="userinput"><code>(cd /usr &amp;&amp; cvs -Q -z3 -d anoncvs@anoncvs.NetBSD.org:/cvsroot get -P pkgsrc)</code></strong>
1.68      asau     2121: </pre>
                   2122: <p>Or any other way that fits (e.g., curl, wget).</p>
                   2123: <p>Deploy and configure pbulk tools, e.g.:</p>
                   2124: <pre class="screen">
1.118     sevan    2125: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -n # use native make, no bootstrap kit needed (for use on NetBSD)</code></strong>
1.68      asau     2126: <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>
                   2127: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -nlc mk.conf.frag # native, apply settings, configure for limited build</code></strong>
                   2128: </pre>
                   2129: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2130: <h3 class="title">Note</h3>
                   2131: <p><code class="filename">mk.conf.frag</code> is a fragment of
                   2132: <code class="filename">mk.conf</code> that contains settings you want to
                   2133: apply to packages you build. For instance,</p>
                   2134: <pre class="programlisting">
1.112     rillig   2135: PKG_DEVELOPER=          yes     # perform more checks
                   2136: X11_TYPE=               modular # use pkgsrc X11
                   2137: SKIP_LICENSE_CHECK=     yes     # accept all licences (useful
                   2138:                                 # when building all packages)
1.68      asau     2139: </pre>
                   2140: </div>
                   2141: <p>If configured for limited list, replace the list in <code class="filename">/usr/pbulk/etc/pbulk.list</code>
1.112     rillig   2142: with your list of packages, one per line without empty lines or comments. E.g.:</p>
1.68      asau     2143: <pre class="programlisting">
                   2144: www/firefox
                   2145: mail/thunderbird
                   2146: misc/libreoffice4
                   2147: </pre>
1.69      asau     2148: <p>At this point you can also review configuration in <code class="filename">/usr/pbulk/etc</code>
                   2149: and make final amendments, if wanted.</p>
1.68      asau     2150: <p>Start it:</p>
                   2151: <pre class="screen">
                   2152: <code class="prompt">#</code> <strong class="userinput"><code>/usr/pbulk/bin/bulkbuild</code></strong>
                   2153: </pre>
                   2154: <p>After it finishes, you'll have <code class="filename">/mnt</code> filled with distribution files, binary packages, and reports,
                   2155: plain text summary in <code class="filename">/mnt/bulklog/meta/report.txt</code>
                   2156: </p>
                   2157: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2158: <h3 class="title">Note</h3>
                   2159: <p>The <code class="filename">pbulk.sh</code> script does not cover all possible use cases.
                   2160: While being ready to run, it serves as a good starting point to understand and build more complex setups.
                   2161: The script is kept small enough for better understanding.</p>
                   2162: </div>
                   2163: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2164: <h3 class="title">Note</h3>
                   2165: <p>The <code class="filename">pbulk.sh</code> script supports running
                   2166: unprivileged bulk build and helps configuring distributed bulk builds.</p>
                   2167: </div>
1.6       rillig   2168: </div>
                   2169: </div>
1.41      asau     2170: <div class="sect1">
1.6       rillig   2171: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2172: <a name="bulk.req"></a>8.3. Requirements of a full bulk build</h2></div></div></div>
1.71      wiz      2173: <p>A complete bulk build requires lots of disk space. Some of the
                   2174: disk space can be read-only, some other must be writable. Some can be on
                   2175: remote filesystems (such as NFS) and some should be local. Some can be
                   2176: temporary filesystems, others must survive a sudden reboot.</p>
                   2177: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   2178: <li class="listitem"><p>40 GB for the distfiles (read-write, remote, temporary)</p></li>
                   2179: <li class="listitem"><p>30 GB for the binary packages (read-write, remote, permanent)</p></li>
                   2180: <li class="listitem"><p>1 GB for the pkgsrc tree (read-only, remote, permanent)</p></li>
                   2181: <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary)</p></li>
                   2182: <li class="listitem"><p>10 GB for the log files (read-write, remote, permanent)</p></li>
                   2183: <li class="listitem"><p>5 GB for temporary files (read-write, local, temporary)</p></li>
                   2184: </ul></div>
                   2185: </div>
                   2186: <div class="sect1">
                   2187: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2188: <a name="creating-cdroms"></a>8.4. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.1       dsieger  2189: <p>After your pkgsrc bulk-build has completed, you may wish to
                   2190:     create a CD-ROM set of the resulting binary packages to assist
                   2191:     in installing packages on other machines.  The
1.137     leot     2192:     <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/cdpack/README.html" target="_top"><code class="filename">pkgtools/cdpack</code></a> package provides
1.1       dsieger  2193:     a simple tool for creating the ISO 9660 images.
1.10      hubertf  2194:     <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.1       dsieger  2195:     way that keeps all the dependencies for a given package on the same
                   2196:     CD as that package.</p>
1.41      asau     2197: <div class="sect2">
1.1       dsieger  2198: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   2199: <a name="cdpack-example"></a>8.4.1. Example of cdpack</h3></div></div></div>
1.1       dsieger  2200: <p>Complete documentation for cdpack is found in the cdpack(1)
                   2201:       man page. The following short example assumes that the binary
                   2202:       packages are left in
                   2203:       <code class="filename">/usr/pkgsrc/packages/All</code> and that
                   2204:       sufficient disk space exists in <code class="filename">/u2</code> to
                   2205:       hold the ISO 9660 images.</p>
                   2206: <pre class="screen">
                   2207: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
                   2208: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
                   2209: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
                   2210:       </pre>
                   2211: <p>If you wish to include a common set of files
                   2212:       (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
                   2213:       etc.) on each CD in the collection, then you need to create a
                   2214:       directory which contains these files. e.g.</p>
                   2215: <pre class="screen">
                   2216: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
                   2217: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" &gt; /tmp/common/README</code></strong>
                   2218: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" &gt; /tmp/common/COPYING</code></strong>
                   2219: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
                   2220: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" &gt; /tmp/common/bin/myscript</code></strong>
                   2221: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" &gt;&gt; /tmp/common/bin/myscript</code></strong>
                   2222: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
                   2223:       </pre>
                   2224: <p>Now create the images:</p>
                   2225: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cdpack -x /tmp/common /usr/pkgsrc/packages/All /u2/images</code></strong></pre>
                   2226: <p>Each image will contain <code class="filename">README</code>,
                   2227:       <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
                   2228:       in their root directories.</p>
                   2229: </div>
                   2230: </div>
                   2231: </div>
1.41      asau     2232: <div class="chapter">
1.1       dsieger  2233: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   2234: <a name="files"></a>Chapter 9. Directory layout of the installed files</h2></div></div></div>
1.1       dsieger  2235: <div class="toc">
                   2236: <p><b>Table of Contents</b></p>
1.100     leot     2237: <dl class="toc">
1.154     rillig   2238: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
                   2239: <dt><span class="sect1"><a href="#files.varbase">9.2. File system layout in <code class="literal">${VARBASE}</code></a></span></dt>
1.1       dsieger  2240: </dl>
                   2241: </div>
                   2242: <p>The files that are installed by pkgsrc are organized in a way that
                   2243: is similar to what you find in the <code class="filename">/usr</code> directory
                   2244: of the base system. But some details are different. This is because
                   2245: pkgsrc initially came from FreeBSD and had adopted its file system
                   2246: hierarchy. Later it was largely influenced by NetBSD. But no matter
                   2247: which operating system you are using pkgsrc with, you can expect the
                   2248: same layout for pkgsrc.</p>
                   2249: <p>There are mainly four root directories for pkgsrc, which are all
                   2250: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
                   2251: When pkgsrc has been installed as root, the default locations
                   2252: are:</p>
                   2253: <pre class="programlisting">
                   2254: LOCALBASE=              /usr/pkg
                   2255: PKG_SYSCONFBASE=        /usr/pkg/etc
                   2256: VARBASE=                /var
1.119     sevan    2257: PKG_DBDIR=              /usr/pkg/pkgdb
1.1       dsieger  2258: </pre>
                   2259: <p>In unprivileged mode (when pkgsrc has been installed as any other
                   2260: user), the default locations are:</p>
                   2261: <pre class="programlisting">
                   2262: LOCALBASE=              ${HOME}/pkg
                   2263: PKG_SYSCONFBASE=        ${HOME}/pkg/etc
                   2264: VARBASE=                ${HOME}/pkg/var
1.119     sevan    2265: PKG_DBDIR=              ${HOME}/pkg/pkgdb
1.1       dsieger  2266: </pre>
                   2267: <p>What these four directories are for, and what they look like is
                   2268: explained below.</p>
1.41      asau     2269: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      2270: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.1       dsieger  2271: <code class="filename">/usr</code> directory in the base system. It is the
1.23      wiz      2272: <span class="quote">&#8220;<span class="quote">main</span>&#8221;</span> directory where the files are installed and contains
1.1       dsieger  2273: the well-known subdirectories like <code class="filename">bin</code>,
                   2274: <code class="filename">include</code>, <code class="filename">lib</code>,
                   2275: <code class="filename">share</code> and
                   2276: <code class="filename">sbin</code>.</p></li>
1.23      wiz      2277: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.1       dsieger  2278: <code class="filename">/var</code> in the base system. Some programs (especially
                   2279: games, network daemons) need write access to it during normal
                   2280: operation.</p></li>
1.23      wiz      2281: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.1       dsieger  2282: <code class="filename">/etc</code> in the base system. It contains configuration
1.10      hubertf  2283: files of the packages, as well as pkgsrc's <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.1       dsieger  2284: itself.</p></li>
                   2285: </ul></div>
1.41      asau     2286: <div class="sect1">
1.1       dsieger  2287: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2288: <a name="files.localbase"></a>9.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.1       dsieger  2289: </h2></div></div></div>
                   2290: <p>The following directories exist in a typical pkgsrc installation
                   2291: in <code class="filename">${LOCALBASE}</code>.</p>
1.41      asau     2292: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  2293: <dt><span class="term"><code class="filename">bin</code></span></dt>
                   2294: <dd><p>Contains executable programs that are intended to be
                   2295: directly used by the end user.</p></dd>
                   2296: <dt><span class="term"><code class="filename">emul</code></span></dt>
                   2297: <dd><p>Contains files for the emulation layers of various other
                   2298: operating systems, especially for
                   2299: NetBSD.</p></dd>
                   2300: <dt><span class="term"><code class="filename">etc</code> (the usual location of
                   2301: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
                   2302: <dd><p>Contains
                   2303: the configuration files.</p></dd>
                   2304: <dt><span class="term"><code class="filename">include</code></span></dt>
                   2305: <dd><p>Contains headers for the C and C++ programming
                   2306: languages.</p></dd>
                   2307: <dt><span class="term"><code class="filename">info</code></span></dt>
                   2308: <dd><p>Contains GNU info files of various
                   2309: packages.</p></dd>
                   2310: <dt><span class="term"><code class="filename">lib</code></span></dt>
                   2311: <dd><p>Contains shared and static
                   2312: libraries.</p></dd>
                   2313: <dt><span class="term"><code class="filename">libdata</code></span></dt>
                   2314: <dd><p>Contains data files that don't change after
                   2315: installation. Other data files belong into
                   2316: <code class="filename">${VARBASE}</code>.</p></dd>
                   2317: <dt><span class="term"><code class="filename">libexec</code></span></dt>
                   2318: <dd><p>Contains programs that are not intended to be used by
                   2319: end users, such as helper programs or network
                   2320: daemons.</p></dd>
                   2321: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
                   2322: <dd><p>Contains programs that are intended to be executed as
                   2323: CGI scripts by a web server.</p></dd>
                   2324: <dt><span class="term"><code class="filename">man</code> (the usual value of
                   2325: <code class="filename">${PKGMANDIR}</code>)</span></dt>
                   2326: <dd><p>Contains brief
                   2327: documentation in form of manual pages.</p></dd>
                   2328: <dt><span class="term"><code class="filename">sbin</code></span></dt>
                   2329: <dd><p>Contains programs that are intended to be used only by
                   2330: the super-user.</p></dd>
                   2331: <dt><span class="term"><code class="filename">share</code></span></dt>
                   2332: <dd><p>Contains platform-independent data files that don't
                   2333: change after installation.</p></dd>
                   2334: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
                   2335: <dd><p>Contains documentation files provided by the
                   2336: packages.</p></dd>
                   2337: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
                   2338: <dd><p>Contains example files provided by the packages. Among
                   2339: others, the original configuration files are saved here and copied to
                   2340: <code class="filename">${PKG_SYSCONFDIR}</code> during
                   2341: installation.</p></dd>
                   2342: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
                   2343: <dd><p>Contains the original files for rc.d
                   2344: scripts.</p></dd>
                   2345: <dt><span class="term"><code class="filename">var</code> (the usual location of
                   2346: <code class="filename">${VARBASE}</code>)</span></dt>
                   2347: <dd><p>Contains files
                   2348: that may be modified after
                   2349: installation.</p></dd>
                   2350: </dl></div>
                   2351: </div>
1.41      asau     2352: <div class="sect1">
1.1       dsieger  2353: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2354: <a name="files.varbase"></a>9.2. File system layout in <code class="literal">${VARBASE}</code>
1.1       dsieger  2355: </h2></div></div></div>
1.41      asau     2356: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  2357: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
                   2358: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
                   2359: <dd><p>Contains
                   2360: information about the currently installed
                   2361: packages.</p></dd>
                   2362: <dt><span class="term"><code class="filename">games</code></span></dt>
                   2363: <dd><p>Contains highscore
                   2364: files.</p></dd>
                   2365: <dt><span class="term"><code class="filename">log</code></span></dt>
                   2366: <dd><p>Contains log files.</p></dd>
                   2367: <dt><span class="term"><code class="filename">run</code></span></dt>
                   2368: <dd><p>Contains informational files about daemons that are
                   2369: currently running.</p></dd>
                   2370: </dl></div>
                   2371: </div>
                   2372: </div>
1.41      asau     2373: <div class="chapter">
1.1       dsieger  2374: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   2375: <a name="faq"></a>Chapter 10. Frequently Asked Questions</h2></div></div></div>
1.1       dsieger  2376: <div class="toc">
                   2377: <p><b>Table of Contents</b></p>
1.100     leot     2378: <dl class="toc">
1.154     rillig   2379: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                   2380: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
                   2381: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
                   2382: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
                   2383: <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>
                   2384: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
                   2385: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
                   2386: <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>
                   2387: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
                   2388: <dt><span class="sect1"><a href="#tmac.andoc-missing">10.10. What does <span class="quote">&#8220;<span class="quote">Don't know how to make
1.23      wiz      2389: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</a></span></dt>
1.154     rillig   2390: <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>
                   2391: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' with pkgsrc</a></span></dt>
                   2392: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
                   2393: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
                   2394: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
                   2395: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build.  What shall I do?</a></span></dt>
                   2396: <dt><span class="sect1"><a href="#faq.rcs-conflicts">10.17. What does <span class="quote">&#8220;<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>&#8221;</span> mean?</a></span></dt>
1.1       dsieger  2397: </dl>
                   2398: </div>
                   2399: <p>This section contains hints, tips &amp; tricks on special things in
                   2400: pkgsrc that we didn't find a better place for in the previous chapters, and
                   2401: it contains items for both pkgsrc users and developers.</p>
1.41      asau     2402: <div class="sect1">
1.1       dsieger  2403: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2404: <a name="mailing-list-pointers"></a>10.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.1       dsieger  2405: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.41      asau     2406: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      2407: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-users" target="_top">pkgsrc-users</a>:
1.1       dsieger  2408:          This is a general purpose list for most issues regarding
                   2409:          pkgsrc, regardless of platform, e.g. soliciting user help
                   2410:          for pkgsrc configuration, unexpected build failures, using
                   2411:          particular packages, upgrading pkgsrc installations,
                   2412:          questions regarding the pkgsrc release branches, etc.  General announcements or
                   2413:          proposals for changes that impact the pkgsrc user community,
                   2414:          e.g. major infrastructure changes, new features, package
                   2415:          removals, etc., may also be posted.</p></li>
1.23      wiz      2416: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-bulk" target="_top">pkgsrc-bulk</a>:
1.1       dsieger  2417:          A list where the results of pkgsrc bulk builds are sent and
                   2418:          discussed.</p></li>
1.23      wiz      2419: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-changes" target="_top">pkgsrc-changes</a>:
1.1       dsieger  2420:          This list is for those who are interested in getting a
                   2421:          commit message for every change committed to pkgsrc. It is
                   2422:          also available in digest form, meaning one daily message
                   2423:          containing all commit messages for changes to the package
                   2424:          source tree in that 24 hour period.</p></li>
                   2425: </ul></div>
                   2426: <p>To subscribe, do:</p>
                   2427: <pre class="programlisting">
                   2428: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
                   2429: </pre>
                   2430: <p>Archives for all these mailing lists are available from
1.10      hubertf  2431: <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
1.1       dsieger  2432: </div>
1.41      asau     2433: <div class="sect1">
1.1       dsieger  2434: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2435: <a name="faq-pkgtools"></a>10.2. Utilities for package management (pkgtools)</h2></div></div></div>
1.1       dsieger  2436: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
                   2437: a number of useful utilities for both users and developers of pkgsrc.  This
1.121     sevan    2438: section attempts only to make the reader aware of some of the utilities and when
1.1       dsieger  2439: they might be useful, and not to duplicate the documentation that comes
                   2440: with each package.</p>
                   2441: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.137     leot     2442: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/x11-links/README.html" target="_top"><code class="filename">pkgtools/x11-links</code></a>:
1.1       dsieger  2443:       Symlinks for use by buildlink.</p></li></ul></div>
                   2444: <p>OS tool augmentation (automatically installed when needed):</p>
1.41      asau     2445: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.137     leot     2446: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/digest/README.html" target="_top"><code class="filename">pkgtools/digest</code></a>:
1.121     sevan    2447:       Calculates various kinds of checksums (including SHA3).</p></li>
1.137     leot     2448: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libnbcompat/README.html" target="_top"><code class="filename">pkgtools/libnbcompat</code></a>:
1.1       dsieger  2449:       Compatibility library for pkgsrc tools.</p></li>
1.137     leot     2450: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/mtree/README.html" target="_top"><code class="filename">pkgtools/mtree</code></a>: Installed on
1.1       dsieger  2451:       non-BSD systems due to lack of native mtree.</p></li>
1.137     leot     2452: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a>:
1.1       dsieger  2453:       Up-to-date replacement for
                   2454:       <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
                   2455:       systems where pkg_install is not present.</p></li>
                   2456: </ul></div>
                   2457: <p>Utilities used by pkgsrc (not automatically installed):</p>
1.41      asau     2458: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.137     leot     2459: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_tarup/README.html" target="_top"><code class="filename">pkgtools/pkg_tarup</code></a>:
1.1       dsieger  2460:       Create a binary package from an
1.10      hubertf  2461:       already-installed package.  Used by <span class="command"><strong>make replace</strong></span> to
1.1       dsieger  2462:       save the old package.</p></li>
1.137     leot     2463: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/dfdisk/README.html" target="_top"><code class="filename">pkgtools/dfdisk</code></a>:
1.1       dsieger  2464:       Adds extra functionality to pkgsrc, allowing it to fetch distfiles
                   2465:       from multiple locations. It currently supports the following
                   2466:       methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.137     leot     2467: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/cpuflags/README.html" target="_top"><code class="filename">devel/cpuflags</code></a>: Determine
1.16      jnemeth  2468:       the best compiler flags to optimise code for your current
1.23      wiz      2469:       CPU and compiler. </p></li>
1.1       dsieger  2470: </ul></div>
                   2471: <p>Utilities for keeping track of installed packages, being up to date,
                   2472: etc:</p>
1.41      asau     2473: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.137     leot     2474: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgin/README.html" target="_top"><code class="filename">pkgtools/pkgin</code></a>: A package
1.65      wiz      2475:     update tool similar to apt(1). Download, install, and upgrade
                   2476:     binary packages easily.</p></li>
1.137     leot     2477: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_chk/README.html" target="_top"><code class="filename">pkgtools/pkg_chk</code></a>: Reports on
1.1       dsieger  2478:       packages whose installed versions do not match the latest pkgsrc
                   2479:       entries.</p></li>
1.137     leot     2480: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdep/README.html" target="_top"><code class="filename">pkgtools/pkgdep</code></a>: Makes
1.1       dsieger  2481:       dependency graphs of packages, to aid in choosing a strategy for
                   2482:       updating.</p></li>
1.137     leot     2483: <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
                   2484:       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>
                   2485: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>: The
1.12      weinem   2486:       pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.137     leot     2487: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/lintpkgsrc/README.html" target="_top"><code class="filename">pkgtools/lintpkgsrc</code></a>: The lintpkgsrc(1) program
1.1       dsieger  2488:       does various checks on the complete pkgsrc system.</p></li>
1.137     leot     2489: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgsurvey/README.html" target="_top"><code class="filename">pkgtools/pkgsurvey</code></a>: Report what
1.1       dsieger  2490:       packages you have installed.</p></li>
                   2491: </ul></div>
                   2492: <p>Utilities for people maintaining or creating individual packages:</p>
1.41      asau     2493: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.137     leot     2494: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkgdiff/README.html" target="_top"><code class="filename">pkgtools/pkgdiff</code></a>: Automate
1.1       dsieger  2495:       making and maintaining patches for a package (includes pkgdiff,
                   2496:       pkgvi, mkpatches, etc.).</p></li>
1.137     leot     2497: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/url2pkg/README.html" target="_top"><code class="filename">pkgtools/url2pkg</code></a>: Aids in
1.1       dsieger  2498:       converting to pkgsrc.</p></li>
                   2499: </ul></div>
                   2500: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
                   2501: utilities)</p>
1.41      asau     2502: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.137     leot     2503: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_comp/README.html" target="_top"><code class="filename">pkgtools/pkg_comp</code></a>: Build
1.1       dsieger  2504:       packages in a chrooted area.</p></li>
1.137     leot     2505: <li class="listitem"><p><a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/libkver/README.html" target="_top"><code class="filename">pkgtools/libkver</code></a>: Spoof
1.1       dsieger  2506:       kernel version for chrooted cross builds.</p></li>
                   2507: </ul></div>
                   2508: </div>
1.41      asau     2509: <div class="sect1">
1.1       dsieger  2510: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2511: <a name="non-root-pkgsrc"></a>10.3. How to use pkgsrc as non-root</h2></div></div></div>
1.108     rillig   2512: <p>To install packages from source as a non-root user, download
1.154     rillig   2513: pkgsrc as described in <a class="xref" href="#getting" title="Chapter 3. Where to get pkgsrc and how to keep it up-to-date">Chapter 3, <i>Where to get pkgsrc and how to keep it up-to-date</i></a>, cd into that
1.108     rillig   2514: directory and run the command <span class="command"><strong>./bootstrap/bootstrap
                   2515: --unprivileged</strong></span>.</p>
                   2516: <p>This will install the binary part of pkgsrc to
                   2517: <code class="filename">~/pkg</code> and put the pkgsrc configuration <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
                   2518: into <code class="filename">~/pkg/etc</code>.</p>
                   2519: <p>For more details, see <code class="filename">mk/unprivileged.mk</code>.</p>
1.1       dsieger  2520: </div>
1.41      asau     2521: <div class="sect1">
1.1       dsieger  2522: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2523: <a name="resume-transfers"></a>10.4. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.1       dsieger  2524: <p>By default, resuming transfers in pkgsrc is disabled, but you can
                   2525: enable this feature by adding the option
                   2526: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.10      hubertf  2527: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  If, during a fetch step, an incomplete
1.1       dsieger  2528: distfile is found, pkgsrc will try to resume it.</p>
                   2529: <p>You can also
1.61      wiz      2530: use a different program than the platform default program by changing the
1.16      jnemeth  2531: <code class="varname">FETCH_USING</code> variable.  You can specify the program by
                   2532: using of ftp, fetch, wget or curl.  Alternatively, fetching can be disabled
                   2533: by using the value manual.  A value of custom disables the system defaults
                   2534: and dependency tracking for the fetch program.  In that case you have to
                   2535: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
                   2536: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
                   2537: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.1       dsieger  2538: <p>For example, if you want to use
1.16      jnemeth  2539: <code class="filename">wget</code> to download, you'll have to use something
1.1       dsieger  2540: like:</p>
                   2541: <pre class="programlisting">
1.112     rillig   2542: FETCH_USING=    wget
1.1       dsieger  2543: </pre>
                   2544: </div>
1.41      asau     2545: <div class="sect1">
1.1       dsieger  2546: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2547: <a name="x.org-from-pkgsrc"></a>10.5. How can I install/use modular X.org from pkgsrc?</h2></div></div></div>
1.4       rillig   2548: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.1       dsieger  2549: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
                   2550: you will have to add the following line into
1.10      hubertf  2551: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1       dsieger  2552: <pre class="programlisting">
1.4       rillig   2553: X11_TYPE=modular
1.1       dsieger  2554: </pre>
                   2555: </div>
1.41      asau     2556: <div class="sect1">
1.1       dsieger  2557: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2558: <a name="fetch-behind-firewall"></a>10.6. How to fetch files from behind a firewall</h2></div></div></div>
1.1       dsieger  2559: <p>If you are sitting behind a firewall which does not allow direct
                   2560: connections to Internet hosts (i.e. non-NAT), you may specify the
                   2561: relevant proxy hosts.  This is done using an environment variable in the
                   2562: form of a URL, e.g. in Amdahl, the machine
1.23      wiz      2563: <span class="quote">&#8220;<span class="quote">orpheus.amdahl.com</span>&#8221;</span> is one of the firewalls, and it uses
1.1       dsieger  2564: port 80 as the proxy port number.  So the proxy environment variables
                   2565: are:</p>
                   2566: <pre class="programlisting">
                   2567: ftp_proxy=ftp://orpheus.amdahl.com:80/
                   2568: http_proxy=http://orpheus.amdahl.com:80/
                   2569: </pre>
                   2570: </div>
1.41      asau     2571: <div class="sect1">
1.1       dsieger  2572: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2573: <a name="fetch-https"></a>10.7. How to fetch files from HTTPS sites</h2></div></div></div>
1.65      wiz      2574: <p>Some fetch tools are not prepared to support HTTPS by default
                   2575: (for example, the one in NetBSD 6.0), or the one installed by the
                   2576: pkgsrc bootstrap (to avoid an openssl dependency that low in the
                   2577: dependency graph).</p>
                   2578: <p>Usually you won't notice, because distribution files are
                   2579: mirrored weekly to <span class="quote">&#8220;<span class="quote">ftp.NetBSD.org</span>&#8221;</span>, but that might not
                   2580: be often enough if you are following pkgsrc-current. In that case, set
                   2581: <code class="varname">FETCH_USING</code> in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file to
                   2582: <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
                   2583: with HTTPS support by default. Of course, these tools need to be
                   2584: installed before you can use them this way.</p>
                   2585: </div>
                   2586: <div class="sect1">
                   2587: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2588: <a name="passive-ftp"></a>10.8. How do I tell <span class="command"><strong>make fetch</strong></span> to do passive FTP?</h2></div></div></div>
1.1       dsieger  2589: <p>This depends on which utility is used to retrieve distfiles.  From
                   2590: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
                   2591: the first available command from the following list:</p>
1.41      asau     2592: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      2593: <li class="listitem"><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
                   2594: <li class="listitem"><p><code class="filename">/usr/bin/ftp</code></p></li>
1.1       dsieger  2595: </ul></div>
                   2596: <p>On a default NetBSD installation, this will be
                   2597: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
                   2598: connections first, and falls back to active connections if the server
                   2599: refuses to do passive.  For the other tools, add the following to your
1.10      hubertf  2600: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.1       dsieger  2601: <code class="varname">PASSIVE_FETCH=1</code>.</p>
                   2602: <p>Having that option present will prevent
                   2603: <code class="filename">/usr/bin/ftp</code> from falling back to active
                   2604: transfers.</p>
                   2605: </div>
1.41      asau     2606: <div class="sect1">
1.1       dsieger  2607: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2608: <a name="fetching-all-distfiles"></a>10.9. How to fetch all distfiles at once</h2></div></div></div>
1.1       dsieger  2609: <p>You would like to download all the distfiles in a single batch
1.10      hubertf  2610: from work or university, where you can't run a <span class="command"><strong>make
1.25      spz      2611: fetch</strong></span>.  There is an archive of distfiles on <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/" target="_top">ftp.NetBSD.org</a>,
1.1       dsieger  2612: but downloading the entire directory may not be appropriate.</p>
1.10      hubertf  2613: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.1       dsieger  2614: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
                   2615: resulting list to your machine at work/school and use it there.  If you
1.167   ! leot     2616: don't have a NetBSD-compatible <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?ftp+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">ftp</span>(1)</span></a> (like tnftp) at work, don't
1.1       dsieger  2617: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
                   2618: URL:</p>
                   2619: <p>At home:</p>
                   2620: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   2621: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles &gt;/tmp/fetch.sh</code></strong>
                   2622: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
                   2623: <p>At work:</p>
                   2624: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
                   2625: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
                   2626: home.</p>
                   2627: <p>If you have a machine running NetBSD, and you want to get
                   2628: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
                   2629: machine architecture), you can do so by using the above-mentioned
1.10      hubertf  2630: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.1       dsieger  2631: directly by running:</p>
                   2632: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
                   2633: <p>If you even decide to ignore
                   2634: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
                   2635: by running:</p>
                   2636: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
                   2637: </div>
1.41      asau     2638: <div class="sect1">
1.1       dsieger  2639: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2640: <a name="tmac.andoc-missing"></a>10.10. What does <span class="quote">&#8220;<span class="quote">Don't know how to make
1.23      wiz      2641: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</h2></div></div></div>
1.137     leot     2642: <p>When compiling the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a>
1.1       dsieger  2643: package, you get the error from make that it doesn't know how to make
                   2644: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.23      wiz      2645: you don't have installed the <span class="quote">&#8220;<span class="quote">text</span>&#8221;</span> set (nroff, ...) from
1.1       dsieger  2646: the NetBSD base distribution on your machine.  It is recommended to do
                   2647: that to format man pages.</p>
1.137     leot     2648: <p>In the case of the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a> package, you
1.1       dsieger  2649: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.10      hubertf  2650: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1       dsieger  2651: </div>
1.41      asau     2652: <div class="sect1">
1.1       dsieger  2653: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2654: <a name="bsd.own.mk-missing"></a>10.11. What does <span class="quote">&#8220;<span class="quote">Could not find bsd.own.mk</span>&#8221;</span> mean?</h2></div></div></div>
1.1       dsieger  2655: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
                   2656: when you installed your NetBSD machine.  Please get and install it, by
                   2657: extracting it in <code class="filename">/</code>:</p>
                   2658: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
                   2659: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
                   2660: <p><code class="filename">comp.tgz</code> is part of every NetBSD release.  Get
1.10      hubertf  2661: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.1       dsieger  2662: -r</strong></span>).</p>
                   2663: </div>
1.41      asau     2664: <div class="sect1">
1.1       dsieger  2665: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2666: <a name="using-sudo-with-pkgsrc"></a>10.12. Using 'sudo' with pkgsrc</h2></div></div></div>
1.1       dsieger  2667: <p>When installing packages as non-root user and using the just-in-time
1.167   ! leot     2668: <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?su+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">su</span>(1)</span></a> feature of pkgsrc, it can become annoying to type in the root
1.1       dsieger  2669: password for each required package installed.  To avoid this, the sudo
                   2670: package can be used, which does password caching over a limited time.  To
                   2671: use it, install sudo (either as binary package or from
1.137     leot     2672: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/security/sudo/README.html" target="_top"><code class="filename">security/sudo</code></a>) and then put the
1.10      hubertf  2673: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.1       dsieger  2674: <span class="emphasis"><em>after</em></span> the definition of the
                   2675: <code class="varname">LOCALBASE</code> variable:</p>
                   2676: <pre class="programlisting">
                   2677: .if exists(${LOCALBASE}/bin/sudo)
                   2678: SU_CMD=        ${LOCALBASE}/bin/sudo /bin/sh -c
                   2679: .endif
                   2680: </pre>
                   2681: </div>
1.41      asau     2682: <div class="sect1">
1.1       dsieger  2683: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2684: <a name="faq.conf"></a>10.13. How do I change the location of configuration files?</h2></div></div></div>
1.1       dsieger  2685: <p>As the system administrator, you can choose where configuration files
                   2686: are installed.  The default settings make all these files go into
                   2687: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
                   2688: be suboptimal depending on your expectations (e.g., a read-only,
                   2689: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
                   2690: configuration of the provided packages).</p>
                   2691: <p>In order to change the defaults, you can modify the
                   2692: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.10      hubertf  2693: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.1       dsieger  2694: directory; some common examples include <code class="filename">/etc</code> or
                   2695: <code class="filename">/etc/pkg</code>.</p>
                   2696: <p>Furthermore, you can change this value on a per-package basis by
                   2697: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
                   2698: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
                   2699: package you would like to modify, that is, the contents of
                   2700: <code class="varname">PKGBASE</code>.</p>
                   2701: <p>Note that after changing these settings, you must rebuild and
                   2702: reinstall any affected packages.</p>
                   2703: </div>
1.41      asau     2704: <div class="sect1">
1.1       dsieger  2705: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2706: <a name="audit-packages"></a>10.14. Automated security checks</h2></div></div></div>
1.1       dsieger  2707: <p>Please be aware that there can often be bugs in third-party software,
                   2708: and some of these bugs can leave a machine vulnerable to exploitation by
                   2709: attackers.  In an effort to lessen the exposure, the NetBSD packages team
                   2710: maintains a database of known-exploits to packages which have at one time
                   2711: been included in pkgsrc.  The database can be downloaded automatically, and
                   2712: a security audit of all packages installed on a system can take place.  To
1.14      jmcneill 2713: do this, refer to the following two tools (installed as part of the
1.137     leot     2714: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_install/README.html" target="_top"><code class="filename">pkgtools/pkg_install</code></a> package):</p>
1.23      wiz      2715: <div class="orderedlist"><ol class="orderedlist" type="1">
                   2716: <li class="listitem">
1.20      snj      2717: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.1       dsieger  2718:     download a list of the security vulnerabilities information.  This list
1.25      spz      2719:     is kept up to date by the pkgsrc security team, and is distributed
                   2720:     from the NetBSD ftp server:</p>
                   2721: <p><a class="ulink" href="ftp://ftp.NetBSD.org/pkgsrc/distfiles/pkg-vulnerabilities" target="_top">ftp://ftp.NetBSD.org/pkgsrc/distfiles/pkg-vulnerabilities</a></p>
1.1       dsieger  2722: </li>
1.23      wiz      2723: <li class="listitem"><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
                   2724:     current machine, checking each known vulnerability.  If a
1.1       dsieger  2725:     vulnerable package is installed, it will be shown by output to stdout,
                   2726:     including a description of the type of vulnerability, and a URL
                   2727:     containing more information.</p></li>
                   2728: </ol></div>
1.121     sevan    2729: <p>Use of these tools is strongly recommended!
1.154     rillig   2730: 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.121     sevan    2731: reporting.</p>
                   2732: <p>If this database is installed, pkgsrc builds will use it to
                   2733: perform a security check before building any package.</p>
1.1       dsieger  2734: </div>
1.41      asau     2735: <div class="sect1">
1.1       dsieger  2736: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2737: <a name="ufaq-cflags"></a>10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</h2></div></div></div>
1.1       dsieger  2738: <p>When you add your own preferences to the
                   2739:        <code class="varname">CFLAGS</code> variable in your
1.10      hubertf  2740:        <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.1       dsieger  2741:        environment variables to the <code class="filename">./configure</code>
1.167   ! leot     2742:        scripts and to <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>. Some package authors ignore the
1.1       dsieger  2743:        <code class="varname">CFLAGS</code> from the environment variable by
                   2744:        overriding them in the <code class="filename">Makefile</code>s of their
                   2745:        package.</p>
                   2746: <p>Currently there is no solution to this problem. If you
                   2747:        really need the package to use your <code class="varname">CFLAGS</code>
1.10      hubertf  2748:        you should run <span class="command"><strong>make patch</strong></span> in the package
1.1       dsieger  2749:        directory and then inspect any <code class="filename">Makefile</code> and
                   2750:        <code class="filename">Makefile.in</code> for whether they define
                   2751:        <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.23      wiz      2752:        these lines. But be aware that some <span class="quote">&#8220;<span class="quote">smart</span>&#8221;</span>
1.1       dsieger  2753:        programmers write so bad code that it only works for the
                   2754:        specific combination of <code class="varname">CFLAGS</code> they have
                   2755:        chosen.</p>
                   2756: </div>
1.41      asau     2757: <div class="sect1">
1.1       dsieger  2758: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2759: <a name="ufaq-fail"></a>10.16. A package does not build.  What shall I do?</h2></div></div></div>
1.23      wiz      2760: <div class="procedure"><ol class="procedure" type="1">
1.41      asau     2761: <li class="step"><p>Make sure that your copy of pkgsrc is consistent. A
1.1       dsieger  2762:        case that occurs often is that people only update pkgsrc in
                   2763:        parts, because of performance reasons. Since pkgsrc is one large
                   2764:        system, not a collection of many small systems, there are
                   2765:        sometimes changes that only work when the whole pkgsrc tree is
                   2766:        updated.</p></li>
1.41      asau     2767: <li class="step"><p>Make sure that you don't have any CVS conflicts.
1.23      wiz      2768:        Search for <span class="quote">&#8220;<span class="quote">&lt;&lt;&lt;&lt;&lt;&lt;</span>&#8221;</span> or
                   2769:        <span class="quote">&#8220;<span class="quote">&gt;&gt;&gt;&gt;&gt;&gt;</span>&#8221;</span> in all your pkgsrc
1.1       dsieger  2770:        files.</p></li>
1.41      asau     2771: <li class="step"><p>Make sure that you don't have old copies of the packages
1.10      hubertf  2772:        extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.1       dsieger  2773:        verify this.</p></li>
1.108     rillig   2774: <li class="step"><p>If you are a package developer who wants to invest
1.154     rillig   2775:        some work, have a look at <a class="xref" href="#fixes" title="Chapter 21. Making your package work">Chapter 21, <i>Making your package work</i></a>.</p></li>
1.41      asau     2776: <li class="step"><p>If the problem still exists, write a mail to the
1.1       dsieger  2777:        <code class="literal">pkgsrc-users</code> mailing list.</p></li>
                   2778: </ol></div>
                   2779: </div>
1.41      asau     2780: <div class="sect1">
1.1       dsieger  2781: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2782: <a name="faq.rcs-conflicts"></a>10.17. What does <span class="quote">&#8220;<span class="quote">Makefile appears to contain unresolved cvs/rcs/??? merge conflicts</span>&#8221;</span> mean?</h2></div></div></div>
1.1       dsieger  2783: <p>You have modified a file from pkgsrc, and someone else has
                   2784: modified that same file afterwards in the CVS repository. Both changes
                   2785: are in the same region of the file, so when you updated pkgsrc, the
                   2786: <code class="literal">cvs</code> command marked the conflicting changes in the
                   2787: file. Because of these markers, the file is no longer a valid
                   2788: <code class="filename">Makefile</code>.</p>
                   2789: <p>Have a look at that file, and if you don't need your local changes
1.10      hubertf  2790: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.1       dsieger  2791: -dP</strong></span> in that directory to download the current version.</p>
                   2792: </div>
                   2793: </div>
                   2794: </div>
1.41      asau     2795: <div class="part">
1.1       dsieger  2796: <div class="titlepage"><div><div><h1 class="title">
                   2797: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.41      asau     2798: <div class="partintro">
1.1       dsieger  2799: <div></div>
                   2800: <p>This part of the book deals with creating and
1.23      wiz      2801:        modifying packages. It starts with a <span class="quote">&#8220;<span class="quote">HOWTO</span>&#8221;</span>-like
1.1       dsieger  2802:        guide on creating a new package. The remaining chapters are more
                   2803:        like a reference manual for pkgsrc.</p>
                   2804: <div class="toc">
                   2805: <p><b>Table of Contents</b></p>
1.100     leot     2806: <dl class="toc">
1.154     rillig   2807: <dt><span class="chapter"><a href="#help-devel">11. Getting help</a></span></dt>
                   2808: <dt><span class="chapter"><a href="#creating">12. Creating a new pkgsrc package from scratch</a></span></dt>
1.1       dsieger  2809: <dd><dl>
1.154     rillig   2810: <dt><span class="sect1"><a href="#creating.common">12.1. Common types of packages</a></span></dt>
1.1       dsieger  2811: <dd><dl>
1.154     rillig   2812: <dt><span class="sect2"><a href="#creating.perl-module">12.1.1. Perl modules</a></span></dt>
                   2813: <dt><span class="sect2"><a href="#creating.python-module">12.1.2. Python modules and programs</a></span></dt>
1.160     brook    2814: <dt><span class="sect2"><a href="#creating.R-package">12.1.3. R packages</a></span></dt>
                   2815: <dt><span class="sect2"><a href="#creating.TeX-package">12.1.4. TeXlive packages</a></span></dt>
1.1       dsieger  2816: </dl></dd>
1.154     rillig   2817: <dt><span class="sect1"><a href="#creating.examples">12.2. Examples</a></span></dt>
                   2818: <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.6       rillig   2819: </dl></dd>
1.154     rillig   2820: <dt><span class="chapter"><a href="#components">13. Package components - files, directories and contents</a></span></dt>
1.6       rillig   2821: <dd><dl>
1.154     rillig   2822: <dt><span class="sect1"><a href="#components.Makefile">13.1. <code class="filename">Makefile</code></a></span></dt>
                   2823: <dt><span class="sect1"><a href="#components.distinfo">13.2. <code class="filename">distinfo</code></a></span></dt>
                   2824: <dt><span class="sect1"><a href="#components.patches">13.3. <code class="filename">patches/*</code></a></span></dt>
1.6       rillig   2825: <dd><dl>
1.154     rillig   2826: <dt><span class="sect2"><a href="#components.patch.structure">13.3.1. Structure of a single patch file</a></span></dt>
                   2827: <dt><span class="sect2"><a href="#components.patches.caveats">13.3.2. Creating patch files</a></span></dt>
                   2828: <dt><span class="sect2"><a href="#components.patches.sources">13.3.3. Sources where the patch files come from</a></span></dt>
                   2829: <dt><span class="sect2"><a href="#components.patches.guidelines">13.3.4. Patching guidelines</a></span></dt>
                   2830: <dt><span class="sect2"><a href="#components.patches.feedback">13.3.5. Feedback to the author</a></span></dt>
1.6       rillig   2831: </dl></dd>
1.154     rillig   2832: <dt><span class="sect1"><a href="#other-mandatory-files">13.4. Other mandatory files</a></span></dt>
                   2833: <dt><span class="sect1"><a href="#components.optional">13.5. Optional files</a></span></dt>
1.6       rillig   2834: <dd><dl>
1.154     rillig   2835: <dt><span class="sect2"><a href="#components.optional.bin">13.5.1. Files affecting the binary package</a></span></dt>
                   2836: <dt><span class="sect2"><a href="#components.optional.build">13.5.2. Files affecting the build process</a></span></dt>
                   2837: <dt><span class="sect2"><a href="#components.optional.none">13.5.3. Files affecting nothing at all</a></span></dt>
1.6       rillig   2838: </dl></dd>
1.154     rillig   2839: <dt><span class="sect1"><a href="#work-dir">13.6. <code class="filename">work*</code></a></span></dt>
                   2840: <dt><span class="sect1"><a href="#files-dir">13.7. <code class="filename">files/*</code></a></span></dt>
1.6       rillig   2841: </dl></dd>
1.154     rillig   2842: <dt><span class="chapter"><a href="#makefile">14. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.6       rillig   2843: <dd><dl>
1.154     rillig   2844: <dt><span class="sect1"><a href="#makefile.style">14.1. Caveats</a></span></dt>
                   2845: <dt><span class="sect1"><a href="#makefile.variables">14.2. <code class="filename">Makefile</code> variables</a></span></dt>
                   2846: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">14.2.1. Naming conventions</a></span></dt></dl></dd>
                   2847: <dt><span class="sect1"><a href="#makefile.code">14.3. Code snippets</a></span></dt>
1.6       rillig   2848: <dd><dl>
1.154     rillig   2849: <dt><span class="sect2"><a href="#adding-to-list">14.3.1. Adding things to a list</a></span></dt>
                   2850: <dt><span class="sect2"><a href="#echo-literal">14.3.2. Echoing a string exactly as-is</a></span></dt>
                   2851: <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>
                   2852: <dt><span class="sect2"><a href="#empty-variables">14.3.4. Handling possibly empty variables</a></span></dt>
1.6       rillig   2853: </dl></dd>
                   2854: </dl></dd>
1.154     rillig   2855: <dt><span class="chapter"><a href="#plist">15. PLIST issues</a></span></dt>
1.6       rillig   2856: <dd><dl>
1.154     rillig   2857: <dt><span class="sect1"><a href="#rcs-id">15.1. RCS ID</a></span></dt>
                   2858: <dt><span class="sect1"><a href="#automatic-plist-generation">15.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                   2859: <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>
                   2860: <dt><span class="sect1"><a href="#plist.misc">15.4. Variable substitution in PLIST</a></span></dt>
                   2861: <dt><span class="sect1"><a href="#manpage-compression">15.5. Man page compression</a></span></dt>
                   2862: <dt><span class="sect1"><a href="#using-PLIST_SRC">15.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
                   2863: <dt><span class="sect1"><a href="#platform-specific-plist">15.7. Platform-specific and differing PLISTs</a></span></dt>
                   2864: <dt><span class="sect1"><a href="#build-plist">15.8. Build-specific PLISTs</a></span></dt>
                   2865: <dt><span class="sect1"><a href="#faq.common-dirs">15.9. Sharing directories between packages</a></span></dt>
1.6       rillig   2866: </dl></dd>
1.154     rillig   2867: <dt><span class="chapter"><a href="#buildlink">16. Buildlink methodology</a></span></dt>
1.6       rillig   2868: <dd><dl>
1.154     rillig   2869: <dt><span class="sect1"><a href="#converting-to-buildlink3">16.1. Converting packages to use buildlink3</a></span></dt>
                   2870: <dt><span class="sect1"><a href="#creating-buildlink3.mk">16.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6       rillig   2871: <dd><dl>
1.154     rillig   2872: <dt><span class="sect2"><a href="#anatomy-of-bl3">16.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
                   2873: <dt><span class="sect2"><a href="#updating-buildlink-depends">16.2.2. Updating
1.26      wiz      2874:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   2875:       and
                   2876:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   2877:       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6       rillig   2878: </dl></dd>
1.154     rillig   2879: <dt><span class="sect1"><a href="#writing-builtin.mk">16.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.6       rillig   2880: <dd><dl>
1.154     rillig   2881: <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>
                   2882: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">16.3.2. Global preferences for native or pkgsrc software</a></span></dt>
1.6       rillig   2883: </dl></dd>
                   2884: </dl></dd>
1.154     rillig   2885: <dt><span class="chapter"><a href="#pkginstall">17. The pkginstall framework</a></span></dt>
1.6       rillig   2886: <dd><dl>
1.154     rillig   2887: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">17.1. Files and directories outside the installation prefix</a></span></dt>
                   2888: <dd><dl>
                   2889: <dt><span class="sect2"><a href="#dirs-outside-prefix">17.1.1. Directory manipulation</a></span></dt>
                   2890: <dt><span class="sect2"><a href="#files-outside-prefix">17.1.2. File manipulation</a></span></dt>
                   2891: </dl></dd>
                   2892: <dt><span class="sect1"><a href="#conf-files">17.2. Configuration files</a></span></dt>
                   2893: <dd><dl>
                   2894: <dt><span class="sect2"><a href="#conf-files-sysconfdir">17.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
                   2895: <dt><span class="sect2"><a href="#conf-files-configure">17.2.2. Telling the software where configuration files are</a></span></dt>
                   2896: <dt><span class="sect2"><a href="#conf-files-patching">17.2.3. Patching installations</a></span></dt>
                   2897: <dt><span class="sect2"><a href="#conf-files-disable">17.2.4. Disabling handling of configuration files</a></span></dt>
                   2898: </dl></dd>
                   2899: <dt><span class="sect1"><a href="#rcd-scripts">17.3. System startup scripts</a></span></dt>
                   2900: <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>
                   2901: <dt><span class="sect1"><a href="#users-and-groups">17.4. System users and groups</a></span></dt>
                   2902: <dt><span class="sect1"><a href="#shells">17.5. System shells</a></span></dt>
                   2903: <dd><dl><dt><span class="sect2"><a href="#shells-disable">17.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   2904: <dt><span class="sect1"><a href="#fonts">17.6. Fonts</a></span></dt>
                   2905: <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>
                   2906: </dl></dd>
                   2907: <dt><span class="chapter"><a href="#options">18. Options handling</a></span></dt>
                   2908: <dd><dl>
                   2909: <dt><span class="sect1"><a href="#global-default-options">18.1. Global default options</a></span></dt>
                   2910: <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>
                   2911: <dt><span class="sect1"><a href="#option-names">18.3. Option Names</a></span></dt>
                   2912: <dt><span class="sect1"><a href="#option-build">18.4. Determining the options of dependencies</a></span></dt>
                   2913: </dl></dd>
                   2914: <dt><span class="chapter"><a href="#build">19. The build process</a></span></dt>
                   2915: <dd><dl>
                   2916: <dt><span class="sect1"><a href="#build.intro">19.1. Introduction</a></span></dt>
                   2917: <dt><span class="sect1"><a href="#build.prefix">19.2. Program location</a></span></dt>
                   2918: <dt><span class="sect1"><a href="#build.builddirs">19.3. Directories used during the build process</a></span></dt>
                   2919: <dt><span class="sect1"><a href="#build.running">19.4. Running a phase</a></span></dt>
                   2920: <dt><span class="sect1"><a href="#build.fetch">19.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                   2921: <dd><dl>
                   2922: <dt><span class="sect2"><a href="#build.fetch.what">19.5.1. What to fetch and where to get it from</a></span></dt>
                   2923: <dt><span class="sect2"><a href="#build.fetch.how">19.5.2. How are the files fetched?</a></span></dt>
                   2924: </dl></dd>
                   2925: <dt><span class="sect1"><a href="#build.checksum">19.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                   2926: <dt><span class="sect1"><a href="#build.extract">19.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                   2927: <dt><span class="sect1"><a href="#build.patch">19.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                   2928: <dt><span class="sect1"><a href="#build.tools">19.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                   2929: <dt><span class="sect1"><a href="#build.wrapper">19.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                   2930: <dt><span class="sect1"><a href="#build.configure">19.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   2931: <dt><span class="sect1"><a href="#build.build">19.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   2932: <dt><span class="sect1"><a href="#build.test">19.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                   2933: <dt><span class="sect1"><a href="#build.install">19.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   2934: <dt><span class="sect1"><a href="#build.package">19.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
                   2935: <dt><span class="sect1"><a href="#build.clean">19.16. Cleaning up</a></span></dt>
                   2936: <dt><span class="sect1"><a href="#build.helpful-targets">19.17. Other helpful targets</a></span></dt>
                   2937: </dl></dd>
                   2938: <dt><span class="chapter"><a href="#tools">20. Tools needed for building or running</a></span></dt>
                   2939: <dd><dl>
                   2940: <dt><span class="sect1"><a href="#pkgsrc-tools">20.1. Tools for pkgsrc builds</a></span></dt>
                   2941: <dt><span class="sect1"><a href="#package-tools">20.2. Tools needed by packages</a></span></dt>
                   2942: <dt><span class="sect1"><a href="#platform-tools">20.3. Tools provided by platforms</a></span></dt>
                   2943: </dl></dd>
                   2944: <dt><span class="chapter"><a href="#fixes">21. Making your package work</a></span></dt>
                   2945: <dd><dl>
                   2946: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
                   2947: <dd><dl>
                   2948: <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>
                   2949: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
                   2950: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
                   2951: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
                   2952: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
                   2953: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
                   2954: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
                   2955: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
                   2956: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
                   2957: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
                   2958: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                   2959: </dl></dd>
                   2960: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                   2961: <dd><dl>
                   2962: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   2963: <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>
                   2964: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
                   2965: </dl></dd>
                   2966: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   2967: <dd><dl>
                   2968: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
                   2969: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   2970: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
                   2971: </dl></dd>
                   2972: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
                   2973: <dd><dl>
                   2974: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
                   2975: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
                   2976: <dt><span class="sect2"><a href="#perl-scripts">21.4.3. Packages containing perl scripts</a></span></dt>
                   2977: <dt><span class="sect2"><a href="#shell-scripts">21.4.4. Packages containing shell scripts</a></span></dt>
                   2978: <dt><span class="sect2"><a href="#other-programming-languages">21.4.5. Other programming languages</a></span></dt>
                   2979: </dl></dd>
                   2980: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   2981: <dd><dl>
                   2982: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   2983: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
                   2984: <dt><span class="sect2"><a href="#undefined-reference">21.5.3. Undefined reference to <span class="quote">&#8220;<span class="quote">...</span>&#8221;</span></a></span></dt>
                   2985: <dt><span class="sect2"><a href="#out-of-memory">21.5.4. Running out of memory</a></span></dt>
                   2986: </dl></dd>
                   2987: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   2988: <dd><dl>
                   2989: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
                   2990: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
                   2991: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
                   2992: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
                   2993: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
                   2994: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing perl modules</a></span></dt>
                   2995: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
                   2996: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
                   2997: <dt><span class="sect2"><a href="#gconf-data-files">21.6.9. Packages installing GConf data files</a></span></dt>
                   2998: <dt><span class="sect2"><a href="#scrollkeeper-data-files">21.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
                   2999: <dt><span class="sect2"><a href="#x11-fonts">21.6.11. Packages installing X11 fonts</a></span></dt>
                   3000: <dt><span class="sect2"><a href="#gtk2-modules">21.6.12. Packages installing GTK2 modules</a></span></dt>
                   3001: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.13. Packages installing SGML or XML data</a></span></dt>
                   3002: <dt><span class="sect2"><a href="#mime-database">21.6.14. Packages installing extensions to the MIME database</a></span></dt>
                   3003: <dt><span class="sect2"><a href="#intltool">21.6.15. Packages using intltool</a></span></dt>
                   3004: <dt><span class="sect2"><a href="#startup-scripts">21.6.16. Packages installing startup scripts</a></span></dt>
                   3005: <dt><span class="sect2"><a href="#tex-packages">21.6.17. Packages installing TeX modules</a></span></dt>
                   3006: <dt><span class="sect2"><a href="#emulation-packages">21.6.18. Packages supporting running binaries in
1.1       dsieger  3007:     emulation</a></span></dt>
1.154     rillig   3008: <dt><span class="sect2"><a href="#hicolor-theme">21.6.19. Packages installing hicolor theme icons</a></span></dt>
                   3009: <dt><span class="sect2"><a href="#desktop-files">21.6.20. Packages installing desktop files</a></span></dt>
1.1       dsieger  3010: </dl></dd>
1.154     rillig   3011: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.1       dsieger  3012: </dl></dd>
1.154     rillig   3013: <dt><span class="chapter"><a href="#debug">22. Debugging</a></span></dt>
                   3014: <dt><span class="chapter"><a href="#submit">23. Submitting and Committing</a></span></dt>
1.1       dsieger  3015: <dd><dl>
1.154     rillig   3016: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
                   3017: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   3018: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
                   3019: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
                   3020: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
                   3021: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
                   3022: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
                   3023: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
                   3024: </dl></dd>
                   3025: <dt><span class="chapter"><a href="#devfaq">24. Frequently Asked Questions</a></span></dt>
                   3026: <dt><span class="chapter"><a href="#gnome">25. GNOME packaging and porting</a></span></dt>
                   3027: <dd><dl>
                   3028: <dt><span class="sect1"><a href="#meta-packages">25.1. Meta packages</a></span></dt>
                   3029: <dt><span class="sect1"><a href="#new-package">25.2. Packaging a GNOME application</a></span></dt>
                   3030: <dt><span class="sect1"><a href="#full-update">25.3. Updating GNOME to a newer version</a></span></dt>
                   3031: <dt><span class="sect1"><a href="#patching">25.4. Patching guidelines</a></span></dt>
1.1       dsieger  3032: </dl></dd>
                   3033: </dl>
                   3034: </div>
                   3035: </div>
1.41      asau     3036: <div class="chapter">
1.1       dsieger  3037: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   3038: <a name="help-devel"></a>Chapter 11. Getting help</h2></div></div></div>
                   3039: <p>
                   3040:        To get help when developing pkgsrc, the definitive source is this
                   3041:        document, the pkgsrc guide. If you don't find anything here,
                   3042:        there are alternatives:
                   3043: </p>
                   3044: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   3045: <li class="listitem">
                   3046: <p>
                   3047:        The built-in pkgsrc help, which is available after bootstrapping
                   3048:        pkgsrc. Run <span class="command"><strong>bmake help topic=&#8230;</strong></span> to get
                   3049:        help for any topic, such as a variable name like
                   3050:        <code class="varname">BUILD_DEFS</code>, a make target like
                   3051:        <span class="command"><strong>do-build</strong></span>, a missing C or C++ function like
                   3052:        <span class="command"><strong>strcasecmp</strong></span> or any other topic.</p>
                   3053: <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>
                   3054: </li>
                   3055: <li class="listitem"><p>
1.163     rillig   3056:        To see the value of a single variable, run <span class="command"><strong>bmake
                   3057:        show-var VARNAME=<em class="replaceable"><code>X</code></em></strong></span>.
                   3058: </p></li>
                   3059: <li class="listitem"><p>
                   3060:        To see the values of the most common variables, run
                   3061:        <span class="command"><strong>bmake show-all</strong></span>. These variables are grouped by
                   3062:        topic. To see the variables for a single topic, run
                   3063:        <span class="command"><strong>bmake
                   3064:        show-all-<em class="replaceable"><code>topic</code></em></strong></span>, for example
                   3065:        <span class="command"><strong>bmake show-all-fetch</strong></span>.
                   3066: </p></li>
                   3067: <li class="listitem"><p>
1.154     rillig   3068:        The tech-pkg mailing list, to which
                   3069:        <a class="ulink" href="https://www.NetBSD.org/mailinglists/#tech-pkg" target="_top">you
                   3070:        can subscribe</a> and then <a class="ulink" href="mailto:tech-pkg@NetBSD.org" target="_top">ask your
                   3071:        questions</a>.</p></li>
                   3072: <li class="listitem"><p>The #pkgsrc IRC channel, which is accessible
                   3073:        <a class="ulink" href="https://webchat.freenode.net/" target="_top">via a web browser</a>
                   3074:        or by using a specialized chat program such as
                   3075:        <a class="ulink" href="http://xchat.org/" target="_top">XChat</a>.
                   3076:        Pick any user name and join the channel #pkgsrc.</p></li>
                   3077: </ul></div>
                   3078: </div>
                   3079: <div class="chapter">
                   3080: <div class="titlepage"><div><div><h2 class="title">
                   3081: <a name="creating"></a>Chapter 12. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.1       dsieger  3082: <div class="toc">
                   3083: <p><b>Table of Contents</b></p>
1.100     leot     3084: <dl class="toc">
1.154     rillig   3085: <dt><span class="sect1"><a href="#creating.common">12.1. Common types of packages</a></span></dt>
1.1       dsieger  3086: <dd><dl>
1.154     rillig   3087: <dt><span class="sect2"><a href="#creating.perl-module">12.1.1. Perl modules</a></span></dt>
                   3088: <dt><span class="sect2"><a href="#creating.python-module">12.1.2. Python modules and programs</a></span></dt>
1.160     brook    3089: <dt><span class="sect2"><a href="#creating.R-package">12.1.3. R packages</a></span></dt>
                   3090: <dt><span class="sect2"><a href="#creating.TeX-package">12.1.4. TeXlive packages</a></span></dt>
1.1       dsieger  3091: </dl></dd>
1.154     rillig   3092: <dt><span class="sect1"><a href="#creating.examples">12.2. Examples</a></span></dt>
                   3093: <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.1       dsieger  3094: </dl>
                   3095: </div>
                   3096: <p>When you find a package that is not yet in pkgsrc, you
                   3097: most likely have a URL from where you can download the source
                   3098: code. Starting with this URL, creating a package involves only a
                   3099: few steps.</p>
1.23      wiz      3100: <div class="procedure"><ol class="procedure" type="1">
1.137     leot     3101: <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.41      asau     3102: <li class="step"><p>Then, choose one of the top-level directories as the
1.1       dsieger  3103: category in which you want to place your package. You can also create a
                   3104: directory of your own (maybe called <code class="filename">local</code>). In that
                   3105: category directory, create another directory for your package and change
                   3106: into it.</p></li>
1.41      asau     3107: <li class="step"><p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
1.1       dsieger  3108: you for a URL. Enter the URL of the distribution file (in most cases a
                   3109: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
                   3110: of your package are created automatically. The distribution file is
                   3111: extracted automatically to fill in some details in the
                   3112: <code class="filename">Makefile</code> that would otherwise have to be done
                   3113: manually.</p></li>
1.41      asau     3114: <li class="step">
1.1       dsieger  3115: <p>Examine the extracted files to determine the dependencies of
                   3116: your package. Ideally, this is mentioned in some
                   3117: <code class="filename">README</code> file, but things may differ. For each of
                   3118: these dependencies, look where it exists in pkgsrc, and if there is a
                   3119: file called <code class="filename">buildlink3.mk</code> in that directory, add a
                   3120: line to your package <code class="filename">Makefile</code> which includes that
                   3121: file just before the last line. If the
1.25      spz      3122: <code class="filename">buildlink3.mk</code> file does not exist, it must be
1.161     leot     3123: created first. The <code class="filename">buildlink3.mk</code> file makes sure
                   3124: that the package's include files and libraries are provided.</p>
1.25      spz      3125: <p>If you just need binaries from a package, add a
1.1       dsieger  3126: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
                   3127: version of the dependency and where it can be found in pkgsrc. This line
                   3128: should be placed in the third paragraph. If the dependency is only
                   3129: needed for building the package, but not when using it, use
1.156     leot     3130: <code class="varname">TOOL_DEPENDS</code> or <code class="varname">BUILD_DEPENDS</code>
                   3131: instead of <code class="varname">DEPENDS</code>.
                   3132: The difference between <code class="varname">TOOL_DEPENDS</code> and
                   3133: <code class="varname">BUILD_DEPENDS</code> occurs when cross-compiling:
                   3134: <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
                   3135: packages, i.e. packages for the architecture where the package
                   3136: is built;
                   3137: <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
                   3138: packages, i.e. packages for the architecture for which the package
                   3139: is built.
1.1       dsieger  3140: Your package may then look like this:</p>
                   3141: <pre class="programlisting">
                   3142: [...]
                   3143: 
1.156     leot     3144: TOOL_DEPENDS+=  libxslt-[0-9]*:../../textproc/libxslt
1.1       dsieger  3145: DEPENDS+=       screen-[0-9]*:../../misc/screen
                   3146: DEPENDS+=       screen&gt;=4.0:../../misc/screen
                   3147: 
                   3148: [...]
                   3149: 
                   3150: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
                   3151: .include "../../devel/glib2/buildlink3.mk"
                   3152: .include "../../mk/bsd.pkg.mk"
                   3153: </pre>
                   3154: </li>
1.41      asau     3155: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
1.23      wiz      3156: 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.10      hubertf  3157: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
                   3158: --explain</strong></span> or <span class="command"><strong>pkglint
1.1       dsieger  3159: -e</strong></span>, which outputs additional
                   3160: explanations.</p></li>
1.41      asau     3161: <li class="step"><p>In many cases the package is not yet ready to build. You can
1.154     rillig   3162: 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.1       dsieger  3163: over there, you can hopefully continue here.</p></li>
1.41      asau     3164: <li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
1.1       dsieger  3165: directory from the extracted files. Besides these files, a lot of cache
                   3166: files and other system information has been saved in the working
                   3167: directory, which may become wrong after you edited the
                   3168: <code class="filename">Makefile</code>.</p></li>
1.41      asau     3169: <li class="step"><p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
1.154     rillig   3170: 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.41      asau     3171: <li class="step"><p>When the package builds fine, the next step is to install
1.10      hubertf  3172: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
1.1       dsieger  3173: everything works.</p></li>
1.41      asau     3174: <li class="step"><p>Up to now, the file <code class="filename">PLIST</code>, which
1.1       dsieger  3175: contains a list of the files that are installed by the package, is
1.10      hubertf  3176: nearly empty. Run <span class="command"><strong>bmake print-PLIST
1.1       dsieger  3177: &gt;PLIST</strong></span> to generate a probably correct list. Check
                   3178: the file using your preferred text editor to see if the list of
                   3179: files looks plausible.</p></li>
1.41      asau     3180: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
1.1       dsieger  3181: <code class="filename">PLIST</code> contains garbage or not.</p></li>
1.41      asau     3182: <li class="step"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
1.1       dsieger  3183: has been registered in the database of installed files, but with an
1.10      hubertf  3184: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
                   3185: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
1.1       dsieger  3186: registered with the list of files from
                   3187: <code class="filename">PLIST</code>.</p></li>
1.41      asau     3188: <li class="step"><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
1.1       dsieger  3189: package from the set of installed files.</p></li>
                   3190: </ol></div>
1.41      asau     3191: <div class="sect1">
1.1       dsieger  3192: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   3193: <a name="creating.common"></a>12.1. Common types of packages</h2></div></div></div>
1.41      asau     3194: <div class="sect2">
1.1       dsieger  3195: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   3196: <a name="creating.perl-module"></a>12.1.1. Perl modules</h3></div></div></div>
1.1       dsieger  3197: <p>Simple Perl modules are handled automatically by
1.10      hubertf  3198: <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
1.1       dsieger  3199: </div>
1.41      asau     3200: <div class="sect2">
1.1       dsieger  3201: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   3202: <a name="creating.python-module"></a>12.1.2. Python modules and programs</h3></div></div></div>
1.17      imil     3203: <p>Python modules and programs packages are easily created using a
                   3204: set of predefined variables.</p>
                   3205: <p>
1.63      wiz      3206: If some Python versions are not supported by the software, set the
                   3207: <code class="varname">PYTHON_VERSIONS_INCOMPATIBLE</code> variable to the Python versions
                   3208: that are not supported, e.g.
1.17      imil     3209: </p>
                   3210: <pre class="programlisting">
1.93      sevan    3211: PYTHON_VERSIONS_INCOMPATIBLE=       27
1.17      imil     3212: </pre>
                   3213: <p>
1.103     wiz      3214: If the packaged software is a Python module, include one of
                   3215: <code class="filename">../../lang/python/egg.mk</code>,
                   3216: <code class="filename">../../lang/python/distutils.mk</code>, or
                   3217: <code class="filename">../../lang/python/extension.mk</code>.</p>
                   3218: <p>Most Python packages use either <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span> or
                   3219: easy-setup/setuptools (<span class="quote">&#8220;<span class="quote">eggs</span>&#8221;</span>).
                   3220: if the packaged software is using setuptools, you only need
                   3221: to include <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>&#8221;</span>.
                   3222: Otherwise, if the software uses <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span>, include 
                   3223: <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/distutils.mk</code></span>&#8221;</span>.
                   3224: so pkgsrc will use this framework.
                   3225: <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span> uses a script called <code class="filename">setup.py</code>,
                   3226: if the <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span> driver is not called
                   3227: <code class="filename">setup.py</code>, set the <code class="varname">PYSETUP</code> variable
                   3228: to the name of the script.</p>
                   3229: <p>Either way, the package directory should be called
1.23      wiz      3230: <span class="quote">&#8220;<span class="quote">py-software</span>&#8221;</span> and <code class="varname">PKGNAME</code> should be set to
                   3231: <span class="quote">&#8220;<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>&#8221;</span>, e.g.
1.17      imil     3232: </p>
                   3233: <pre class="programlisting">
                   3234: DISTNAME=   foopymodule-1.2.10
                   3235: PKGNAME=    ${PYPKGPREFIX}-${DISTNAME}
                   3236: </pre>
1.63      wiz      3237: <p>If it is an application, include
                   3238: <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>&#8221;</span>.
                   3239: In order to correctly set the path to the Python interpreter, use the
1.17      imil     3240: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
1.35      wiz      3241: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
1.63      wiz      3242: For example:
1.17      imil     3243: </p>
                   3244: <pre class="programlisting">
1.35      wiz      3245: REPLACE_PYTHON=   *.py
1.17      imil     3246: </pre>
1.63      wiz      3247: <p>Some Python modules have separate distributions for Python-2.x
                   3248: and Python-3.x support. In pkgsrc this is handled by the
                   3249: <code class="filename">versioned_dependencies.mk</code> file. Set
                   3250: <code class="varname">PYTHON_VERSIONED_DEPENDENCIES</code> to the list of
                   3251: packages that should be depended upon and include
                   3252: <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/versioned_dependencies.mk</code></span>&#8221;</span>,
                   3253: then the pkgsrc infrastructure will depend on the appropriate package
                   3254: version. For example:
                   3255: </p>
                   3256: <pre class="programlisting">
1.135     wiz      3257: PYTHON_VERSIONED_DEPENDENCIES=dialog
1.63      wiz      3258: </pre>
                   3259: <p>
                   3260: Look inside <code class="filename">versioned_dependencies.mk</code> for a list
                   3261: of supported packages.</p>
1.17      imil     3262: </div>
1.160     brook    3263: <div class="sect2">
                   3264: <div class="titlepage"><div><div><h3 class="title">
                   3265: <a name="creating.R-package"></a>12.1.3. R packages</h3></div></div></div>
                   3266: <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>
                   3267: are handled automatically by <span class="command"><strong>R2pkg</strong></span>, which is
                   3268: 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>.
                   3269: Individual packages (and optionally their dependencies) may be created
                   3270: and updated.  R packages generally follow the same form, and most of
                   3271: the relevant information needed is contained in a
                   3272: <code class="filename">DESCRIPTION</code> file as part of each R package on
                   3273: <a class="ulink" href="https://cran.r-project.org/web/packages/available_packages_by_name.html" target="_top">CRAN</a>.
                   3274: Consequently, <span class="command"><strong>R2pkg</strong></span> downloads that information and
                   3275: creates or updates a package in the canonical form.  The resulting
                   3276: package should be reviewed for correctness.</p>
                   3277: </div>
                   3278: <div class="sect2">
                   3279: <div class="titlepage"><div><div><h3 class="title">
                   3280: <a name="creating.TeX-package"></a>12.1.4. TeXlive packages</h3></div></div></div>
                   3281: <p>TeXlive packages from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> are handled automatically by
                   3282: <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>
                   3283: <p>If the TeXlive package name is not known, it may be useful to
                   3284: search <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>.  A
                   3285: <span class="quote">&#8220;<span class="quote">Contained in</span>&#8221;</span> field on the package page typically
                   3286: 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
                   3287: archive</a>.</p>
                   3288: <p>If the TeXlive package name is known, download the files from
                   3289: the <a class="ulink" href="https://www.ctan.org/tex-archive/systems/texlive/tlnet/archive" target="_top">TeXlive
                   3290: archive</a>.  For package <code class="filename">foo</code>, you will need
                   3291: to download <code class="filename">foo.tar.xz</code>.  Most TeXlive packages
                   3292: also have associated documentation packages, so download
                   3293: <code class="filename">foo.doc.tar.xz</code> at the same time.  These files
                   3294: should be placed in the appropriate category directory, which is often
                   3295: but not always <code class="filename">print</code>.  Then run the following
                   3296: command in the category directory.</p>
                   3297: <pre class="programlisting">
                   3298: texlive2pkg foo.tar.xz foo.doc.tar.xz
                   3299: </pre>
                   3300: <p>This will create two packages, <code class="filename">tex-foo</code> and
                   3301: <code class="filename">tex-foo-doc</code>.  Be sure to check that both packages
                   3302: are correct.</p>
                   3303: <p>Finally, <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>
                   3304: currently does not include version information in package filenames
                   3305: and changes their contents periodically when updates occur.
                   3306: Consequently, pkgsrc avoids downloading distfiles directly from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> and instead relies on the
                   3307: pkgsrc archives.  For each new or updated TeXlive package, e.g., the
                   3308: main one and the corresponding documentation, upload the distfiles
                   3309: with the following command in each package directory.</p>
                   3310: <pre class="programlisting">
                   3311: make upload-distfiles
                   3312: </pre>
                   3313: </div>
1.1       dsieger  3314: </div>
1.41      asau     3315: <div class="sect1">
1.1       dsieger  3316: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   3317: <a name="creating.examples"></a>12.2. Examples</h2></div></div></div>
1.41      asau     3318: <div class="sect2">
1.1       dsieger  3319: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   3320: <a name="creating.nvu"></a>12.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
1.41      asau     3321: <div class="sect3">
1.1       dsieger  3322: <div class="titlepage"><div><div><h4 class="title">
1.154     rillig   3323: <a name="creating.nvu.init"></a>12.2.1.1. The initial package</h4></div></div></div>
1.1       dsieger  3324: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
1.23      wiz      3325: that the <span class="quote">&#8220;<span class="quote">nvu</span>&#8221;</span> package has not yet been imported into
1.1       dsieger  3326: pkgsrc. As the description says it has to do with the web, the obvious
1.23      wiz      3327: choice for the category is <span class="quote">&#8220;<span class="quote">www</span>&#8221;</span>.</p>
1.1       dsieger  3328: <pre class="programlisting">
                   3329: <code class="prompt">$</code> mkdir www/nvu
                   3330: <code class="prompt">$</code> cd www/nvu
                   3331: </pre>
                   3332: <p>The web site says that the sources are available as a tar file, so
1.10      hubertf  3333: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
1.1       dsieger  3334: <pre class="programlisting">
                   3335: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
                   3336: </pre>
                   3337: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
                   3338: below the <code class="varname">DISTNAME</code> line, as the package name should
1.23      wiz      3339: not have the word <span class="quote">&#8220;<span class="quote">sources</span>&#8221;</span> in it. I also filled in the
1.1       dsieger  3340: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
                   3341: <code class="varname">COMMENT</code> fields. Then the package
                   3342: <code class="filename">Makefile</code> looked like that:</p>
                   3343: <pre class="programlisting">
1.121     sevan    3344: # $NetBSD $
1.1       dsieger  3345: #
                   3346: 
                   3347: DISTNAME=       nvu-1.0-sources
                   3348: PKGNAME=        nvu-1.0
                   3349: CATEGORIES=     www
                   3350: MASTER_SITES=   http://cvs.nvu.com/download/
                   3351: EXTRACT_SUFX=   .tar.bz2
                   3352: 
                   3353: MAINTAINER=     rillig@NetBSD.org
                   3354: HOMEPAGE=       http://cvs.nvu.com/
                   3355: COMMENT=        Web Authoring System
                   3356: 
                   3357: # url2pkg-marker (please do not remove this line.)
                   3358: .include "../../mk/bsd.pkg.mk"
                   3359: </pre>
1.124     wiz      3360: <p>On the first line of output above, an artificial space has been added between NetBSD and $,
1.121     sevan    3361: this is a workaround to prevent CVS expanding to the filename of the
                   3362: guide.</p>
1.1       dsieger  3363: <p>Then, I quit the editor and watched pkgsrc downloading a large
                   3364: source archive:</p>
                   3365: <pre class="programlisting">
                   3366: url2pkg&gt; Running "make makesum" ...
                   3367: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   3368: =&gt; Fetching nvu-1.0-sources.tar.bz2
                   3369: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
                   3370: 100% |*************************************| 28992 KB  150.77 KB/s00:00 ETA
                   3371: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
                   3372: url2pkg&gt; Running "make extract" ...
                   3373: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   3374: =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   3375: =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   3376: work.bacc -&gt; /tmp/roland/pkgsrc/www/nvu/work.bacc
                   3377: ===&gt; Installing dependencies for nvu-1.0
                   3378: ===&gt; Overriding tools for nvu-1.0
                   3379: ===&gt; Extracting for nvu-1.0
                   3380: url2pkg&gt; Adjusting the Makefile.
                   3381: 
                   3382: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
                   3383: 
                   3384: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
                   3385: </pre>
                   3386: </div>
1.41      asau     3387: <div class="sect3">
1.1       dsieger  3388: <div class="titlepage"><div><div><h4 class="title">
1.154     rillig   3389: <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.1       dsieger  3390: <p>Now that the package has been extracted, let's see what's inside
                   3391: it. The package has a <code class="filename">README.txt</code>, but that only
                   3392: says something about mozilla, so it's probably useless for seeing what
                   3393: dependencies this package has. But since there is a GNU configure script
                   3394: in the package, let's hope that it will complain about everything it
                   3395: needs.</p>
                   3396: <pre class="programlisting">
                   3397: <code class="prompt">$</code> bmake
                   3398: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   3399: =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   3400: =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   3401: ===&gt; Patching for nvu-1.0
                   3402: ===&gt; Creating toolchain wrappers for nvu-1.0
                   3403: ===&gt; Configuring for nvu-1.0
                   3404: [...]
                   3405: configure: error: Perl 5.004 or higher is required.
                   3406: [...]
                   3407: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
                   3408: [...]
                   3409: </pre>
                   3410: <p>That worked quite well. So I opened the package Makefile in my
                   3411: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
1.23      wiz      3412: just appended <span class="quote">&#8220;<span class="quote">perl</span>&#8221;</span> to it. Since the dependencies of the
1.1       dsieger  3413: package have changed now, and since a perl wrapper is automatically
1.23      wiz      3414: installed in the <span class="quote">&#8220;<span class="quote">tools</span>&#8221;</span> phase, I need to build the package
1.1       dsieger  3415: from scratch.</p>
                   3416: <pre class="programlisting">
                   3417: <code class="prompt">$</code> bmake clean
                   3418: ===&gt; Cleaning for nvu-1.0
                   3419: <code class="prompt">$</code> bmake
                   3420: [...]
                   3421: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
                   3422: GNU Make.  You will not be able to build Mozilla without GNU Make.
                   3423: [...]
                   3424: </pre>
1.23      wiz      3425: <p>So I added <span class="quote">&#8220;<span class="quote">gmake</span>&#8221;</span> to the
1.1       dsieger  3426: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
                   3427: <pre class="programlisting">
                   3428: [...]
                   3429: checking for GTK - version &gt;= 1.2.0... no
                   3430: *** Could not run GTK test program, checking why...
                   3431: [...]
                   3432: </pre>
                   3433: <p>Now to the other dependencies. The first question is: Where is the
                   3434: GTK package hidden in pkgsrc?</p>
                   3435: <pre class="programlisting">
                   3436: <code class="prompt">$</code> echo ../../*/gtk*
                   3437: [many packages ...]
                   3438: <code class="prompt">$</code> echo ../../*/gtk
                   3439: ../../x11/gtk
                   3440: <code class="prompt">$</code> echo ../../*/gtk2
                   3441: ../../x11/gtk2
                   3442: <code class="prompt">$</code> echo ../../*/gtk2/bui*
                   3443: ../../x11/gtk2/buildlink3.mk
                   3444: </pre>
                   3445: <p>The first try was definitely too broad. The second one had exactly
                   3446: one result, which is very good. But there is one pitfall with GNOME
                   3447: packages. Before GNOME 2 had been released, there were already many
                   3448: GNOME 1 packages in pkgsrc. To be able to continue to use these
                   3449: packages, the GNOME 2 packages were imported as separate packages, and
1.23      wiz      3450: their names usually have a <span class="quote">&#8220;<span class="quote">2</span>&#8221;</span> appended. So I checked
1.1       dsieger  3451: whether this was the case here, and indeed it was.</p>
                   3452: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
                   3453: file, adding the dependency is very easy. I just inserted an
                   3454: <code class="literal">.include</code> line before the last line of the package
                   3455: <code class="filename">Makefile</code>, so that it now looks like this:</p>
                   3456: <pre class="programlisting">
                   3457: [...]
                   3458: .include "../../x11/gtk2/buildlink3.mk"
                   3459: .include "../../mk/bsd.pkg.mk
                   3460: </pre>
1.10      hubertf  3461: <p>After another <span class="command"><strong>bmake clean &amp;&amp; bmake</strong></span>, the answer
1.1       dsieger  3462: was:</p>
                   3463: <pre class="programlisting">
                   3464: [...]
                   3465: checking for gtk-config... /home/roland/pkg/bin/gtk-config
                   3466: checking for GTK - version &gt;= 1.2.0... no
                   3467: *** Could not run GTK test program, checking why...
                   3468: *** The test program failed to compile or link. See the file config.log for the
                   3469: *** exact error that occured. This usually means GTK was incorrectly installed
                   3470: *** or that you have moved GTK since it was installed. In the latter case, you
                   3471: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
                   3472: configure: error: Test for GTK failed.
                   3473: [...]
                   3474: </pre>
1.23      wiz      3475: <p>In this particular case, the assumption that <span class="quote">&#8220;<span class="quote">every package
                   3476: prefers GNOME 2</span>&#8221;</span> had been wrong. The first of the lines above
1.1       dsieger  3477: told me that this package really wanted to have the GNOME 1 version of
                   3478: GTK. If the package had looked for GTK2, it would have looked for
1.10      hubertf  3479: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
1.1       dsieger  3480: So I changed the <code class="literal">x11/gtk2</code> to
                   3481: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
                   3482: and tried again.</p>
                   3483: <pre class="programlisting">
                   3484: [...]
1.59      jnemeth  3485: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\"  [...]
1.1       dsieger  3486: In file included from xpidl.c:42:
                   3487: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
                   3488: In file included from xpidl.c:42:
                   3489: xpidl.h:132: error: parse error before "IDL_ns"
                   3490: [...]
                   3491: </pre>
                   3492: <p>The package still does not find all of its dependencies. Now the
                   3493: question is: Which package provides the
                   3494: <code class="filename">libIDL/IDL.h</code> header file?</p>
                   3495: <pre class="programlisting">
                   3496: <code class="prompt">$</code> echo ../../*/*idl*
                   3497: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
                   3498: <code class="prompt">$</code> echo ../../*/*IDL*
                   3499: ../../net/libIDL
                   3500: </pre>
                   3501: <p>Let's take the one from the second try. So I included the
                   3502: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
                   3503: again. But the error didn't change. After digging through some of the
                   3504: code, I concluded that the build process of the package was broken and
                   3505: couldn't have ever worked, but since the Mozilla source tree is quite
                   3506: large, I didn't want to fix it. So I added the following to the package
                   3507: <code class="filename">Makefile</code> and tried again:</p>
                   3508: <pre class="programlisting">
                   3509: CPPFLAGS+=              -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
1.139     leot     3510: BUILDLINK_TRANSFORM+=   l:IDL:IDL-2
1.1       dsieger  3511: </pre>
                   3512: <p>The latter line is needed because the package expects the library
                   3513: <code class="filename">libIDL.so</code>, but only
                   3514: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
                   3515: wrapper to rewrite that on the fly.</p>
                   3516: <p>The next problem was related to a recent change of the FreeType
1.137     leot     3517: 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.1       dsieger  3518: which patch files were relevant for this issue and copied them to the
                   3519: <code class="filename">patches</code> directory. Then I retried, fixed the
                   3520: patches so that they applied cleanly and retried again. This time,
                   3521: everything worked.</p>
                   3522: </div>
1.41      asau     3523: <div class="sect3">
1.1       dsieger  3524: <div class="titlepage"><div><div><h4 class="title">
1.154     rillig   3525: <a name="creating.nvu.inst"></a>12.2.1.3. Installing the package</h4></div></div></div>
1.1       dsieger  3526: <pre class="programlisting">
                   3527: <code class="prompt">$</code> bmake CHECK_FILES=no install
                   3528: [...]
                   3529: <code class="prompt">$</code> bmake print-PLIST &gt;PLIST
                   3530: <code class="prompt">$</code> bmake deinstall
                   3531: <code class="prompt">$</code> bmake install
                   3532: </pre>
                   3533: </div>
                   3534: </div>
                   3535: </div>
                   3536: </div>
1.41      asau     3537: <div class="chapter">
1.1       dsieger  3538: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   3539: <a name="components"></a>Chapter 13. Package components - files, directories and contents</h2></div></div></div>
1.1       dsieger  3540: <div class="toc">
                   3541: <p><b>Table of Contents</b></p>
1.100     leot     3542: <dl class="toc">
1.154     rillig   3543: <dt><span class="sect1"><a href="#components.Makefile">13.1. <code class="filename">Makefile</code></a></span></dt>
                   3544: <dt><span class="sect1"><a href="#components.distinfo">13.2. <code class="filename">distinfo</code></a></span></dt>
                   3545: <dt><span class="sect1"><a href="#components.patches">13.3. <code class="filename">patches/*</code></a></span></dt>
                   3546: <dd><dl>
                   3547: <dt><span class="sect2"><a href="#components.patch.structure">13.3.1. Structure of a single patch file</a></span></dt>
                   3548: <dt><span class="sect2"><a href="#components.patches.caveats">13.3.2. Creating patch files</a></span></dt>
                   3549: <dt><span class="sect2"><a href="#components.patches.sources">13.3.3. Sources where the patch files come from</a></span></dt>
                   3550: <dt><span class="sect2"><a href="#components.patches.guidelines">13.3.4. Patching guidelines</a></span></dt>
                   3551: <dt><span class="sect2"><a href="#components.patches.feedback">13.3.5. Feedback to the author</a></span></dt>
                   3552: </dl></dd>
                   3553: <dt><span class="sect1"><a href="#other-mandatory-files">13.4. Other mandatory files</a></span></dt>
                   3554: <dt><span class="sect1"><a href="#components.optional">13.5. Optional files</a></span></dt>
                   3555: <dd><dl>
                   3556: <dt><span class="sect2"><a href="#components.optional.bin">13.5.1. Files affecting the binary package</a></span></dt>
                   3557: <dt><span class="sect2"><a href="#components.optional.build">13.5.2. Files affecting the build process</a></span></dt>
                   3558: <dt><span class="sect2"><a href="#components.optional.none">13.5.3. Files affecting nothing at all</a></span></dt>
1.1       dsieger  3559: </dl></dd>
1.154     rillig   3560: <dt><span class="sect1"><a href="#work-dir">13.6. <code class="filename">work*</code></a></span></dt>
                   3561: <dt><span class="sect1"><a href="#files-dir">13.7. <code class="filename">files/*</code></a></span></dt>
1.1       dsieger  3562: </dl>
                   3563: </div>
                   3564: <p>Whenever you're preparing a package, there are a number of
                   3565: files involved which are described in the following
                   3566: sections.</p>
1.41      asau     3567: <div class="sect1">
1.1       dsieger  3568: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   3569: <a name="components.Makefile"></a>13.1. <code class="filename">Makefile</code>
1.1       dsieger  3570: </h2></div></div></div>
                   3571: <p>Building, installation and creation of a binary package are all
                   3572:   controlled by the package's <code class="filename">Makefile</code>.
                   3573:   The <code class="filename">Makefile</code> describes various things about
                   3574:   a package, for example from where to get it, how to configure,
                   3575:   build, and install it.</p>
                   3576: <p>A package <code class="filename">Makefile</code> contains several
                   3577:   sections that describe the package.</p>
                   3578: <p>In the first section there are the following variables, which
                   3579:   should appear exactly in the order given here.  The order and
                   3580:   grouping of the variables is mostly historical and has no further
                   3581:   meaning.</p>
1.41      asau     3582: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      3583: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
1.1       dsieger  3584:     distribution file to be downloaded from the package's
                   3585:     website.</p></li>
1.23      wiz      3586: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
1.66      asau     3587:     package, as used by pkgsrc. You need to provide it if
1.1       dsieger  3588:     <code class="varname">DISTNAME</code> (which is the default) is not a good
1.66      asau     3589:     name for the package in pkgsrc or <code class="varname">DISTNAME</code> is not
                   3590:     provided (no distribution file is required).  Usually it is the pkgsrc
1.1       dsieger  3591:     directory name together with the version number. It must match the
                   3592:     regular expression
                   3593:     <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
                   3594:     starts with a letter or digit, and contains only letters, digits,
                   3595:     dashes, underscores, dots and plus signs.</p></li>
1.23      wiz      3596: <li class="listitem">
1.1       dsieger  3597: <p><code class="varname">CATEGORIES</code> is a list of categories
                   3598:     which the package fits in. You can choose any of the top-level
                   3599:     directories of pkgsrc for it.</p>
                   3600: <p>Currently the following values are available for
                   3601:     <code class="varname">CATEGORIES</code>. If more than
                   3602:     one is used, they need to be separated by spaces:</p>
                   3603: <pre class="programlisting">
                   3604: archivers     cross         geography     meta-pkgs     security
                   3605: audio         databases     graphics      misc          shells
                   3606: benchmarks    devel         ham           multimedia    sysutils
                   3607: biology       editors       inputmethod   net           textproc
                   3608: cad           emulators     lang          news          time
                   3609: chat          finance       mail          parallel      wm
                   3610: comms         fonts         math          pkgtools      www
                   3611: converters    games         mbone         print         x11
                   3612: </pre>
                   3613: </li>
1.23      wiz      3614: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
1.1       dsieger  3615:     <code class="varname">DYNAMIC_MASTER_SITES</code>,
                   3616:     <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
                   3617:     and <code class="varname">DISTFILES</code> are discussed in detail in
1.154     rillig   3618:     <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.1       dsieger  3619: </ul></div>
                   3620: <p>The second section contains information about separately
                   3621:   downloaded patches, if any.
                   3622:   </p>
1.41      asau     3623: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.80      wiz      3624: <li class="listitem"><p><code class="varname">PATCHFILES</code>:
1.1       dsieger  3625:     Name(s) of additional files that contain distribution patches.
                   3626:     There is no default. pkgsrc will look for them at
                   3627:     <code class="varname">PATCH_SITES</code>.
                   3628:     They will automatically be uncompressed before patching if
                   3629:     the names end with <code class="filename">.gz</code> or
                   3630:     <code class="filename">.Z</code>.</p></li>
1.23      wiz      3631: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
1.1       dsieger  3632:     Primary location(s) for distribution patch files (see
1.80      wiz      3633:     <code class="varname">PATCHFILES</code> above) if not found locally.</p></li>
                   3634: <li class="listitem"><p><code class="varname">PATCH_DIST_STRIP</code>:
1.167   ! leot     3635:     an argument to <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?patch+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> that sets the pathname strip count to
1.80      wiz      3636:     help find the correct files to patch. It defaults to
                   3637:     <span class="command"><strong>-p0</strong></span>.</p></li>
1.1       dsieger  3638: </ul></div>
                   3639: <p>The third section contains the following variables.
                   3640:   </p>
1.41      asau     3641: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      3642: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email
1.14      jmcneill 3643:     address of the person who feels responsible for this package,
                   3644:     and who is most likely to look at problems or questions regarding
1.167   ! leot     3645:     this package which have been reported with <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a>.
1.14      jmcneill 3646:     Other developers may contact the <code class="varname">MAINTAINER</code>
                   3647:     before making changes to the package, but are not required to
                   3648:     do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
                   3649:     to yourself. If you really can't maintain the package for future
                   3650:     updates, set it to
1.10      hubertf  3651:     <code class="email">&lt;<a class="email" href="mailto:pkgsrc-users@NetBSD.org">pkgsrc-users@NetBSD.org</a>&gt;</code>.</p></li>
1.23      wiz      3652: <li class="listitem"><p><code class="varname">OWNER</code> should be used instead
1.14      jmcneill 3653:     of <code class="varname">MAINTAINER</code> when you do not want other
                   3654:     developers to update or change the package without contacting
                   3655:     you first. A package Makefile should contain one of
                   3656:     <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
                   3657:     not both.  </p></li>
1.23      wiz      3658: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
1.1       dsieger  3659:     find more information about the package.</p></li>
1.23      wiz      3660: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
1.1       dsieger  3661:     description of the package (should not include the package
                   3662:     name).</p></li>
1.122     leot     3663: <li class="listitem"><p><code class="varname">LICENSE</code> indicates the license(s)
1.154     rillig   3664:     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.1       dsieger  3665: </ul></div>
                   3666: <p>Other variables that affect the build:
                   3667:   </p>
1.41      asau     3668: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.1       dsieger  3669: <p><code class="varname">WRKSRC</code>: The directory where the
                   3670:       interesting distribution files of the package are found. The
                   3671:       default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
                   3672:       works for most packages.</p>
                   3673: <p>If a package doesn't create a subdirectory for itself
                   3674:       (most GNU software does, for instance), but extracts itself in
                   3675:       the current directory, you should set
                   3676:       <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
                   3677: <p>If a package doesn't create a subdirectory with the
                   3678:       name of <code class="varname">DISTNAME</code> but some different name,
                   3679:       set <code class="varname">WRKSRC</code> to point to the proper name in
                   3680:       <code class="filename">${WRKDIR}</code>, for example
                   3681:       <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.137     leot     3682:       <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.1       dsieger  3683: <p>The name of the working directory created by pkgsrc is
                   3684:       taken from the <code class="varname">WRKDIR_BASENAME</code>
                   3685:       variable. By default, its value is
                   3686:       <code class="filename">work</code>. If you want to use the same
                   3687:       pkgsrc tree for building different kinds of binary packages,
                   3688:       you can change the variable according to your needs. Two
                   3689:       other variables handle common cases of setting
                   3690:       <code class="varname">WRKDIR_BASENAME</code> individually. If
                   3691:       <code class="varname">OBJHOSTNAME</code> is defined in
1.10      hubertf  3692:       <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
1.1       dsieger  3693:       the host's name is attached to the directory name. If
                   3694:       <code class="varname">OBJMACHINE</code> is defined, the platform name
                   3695:       is attached, which might look like
                   3696:       <code class="filename">work.i386</code> or
                   3697:       <code class="filename">work.sparc</code>.</p>
                   3698: </li></ul></div>
                   3699: <p>Please pay attention to the following gotchas:</p>
1.41      asau     3700: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      3701: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
1.1       dsieger  3702:       installed in compressed form by the package.  For packages using
                   3703:       BSD-style makefiles which honor MANZ, there is
                   3704:       <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
1.23      wiz      3705: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
                   3706:       <span class="quote">&#8220;<span class="quote">${PREFIX}</span>&#8221;</span> in all files (see patches,
1.1       dsieger  3707:       below).</p></li>
1.154     rillig   3708: <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.1       dsieger  3709: </ul></div>
                   3710: </div>
1.41      asau     3711: <div class="sect1">
1.1       dsieger  3712: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   3713: <a name="components.distinfo"></a>13.2. <code class="filename">distinfo</code>
1.1       dsieger  3714: </h2></div></div></div>
                   3715: <p>The <code class="filename">distinfo</code> file contains the message
                   3716:   digest, or checksum, of each distfile needed for the package. This
                   3717:   ensures that the distfiles retrieved from the Internet have not been
                   3718:   corrupted during transfer or altered by a malign force to introduce
1.108     rillig   3719:   a security hole. To provide maximum security, all distfiles are
                   3720:   protected using three different message digest algorithms (SHA1,
                   3721:   RMD160, SHA512), as well as the file size.</p>
1.1       dsieger  3722: <p>The <code class="filename">distinfo</code> file also contains the
                   3723:   checksums for all the patches found in the
1.154     rillig   3724:   <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.145     leot     3725:   are only applied intentionally and that they don't accidentally change,
                   3726:   e.g. when merging different changes together. They also make sure that
                   3727:   new patches are actually added to CVS and old ones are removed.
                   3728:   Too see whether the patches and the <code class="filename">distinfo</code> file
                   3729:   match, run <span class="command"><strong>pkglint</strong></span> after changing the patches.</p>
1.1       dsieger  3730: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.108     rillig   3731:   <span class="command"><strong>make distinfo</strong></span> command.</p>
1.1       dsieger  3732: <p>Some packages have different sets of distfiles depending on
1.137     leot     3733:   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.1       dsieger  3734:   <code class="filename">distinfo</code> file and care should be taken when
                   3735:   upgrading such a package to ensure distfile information is not
                   3736:   lost.</p>
                   3737: </div>
1.41      asau     3738: <div class="sect1">
1.1       dsieger  3739: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   3740: <a name="components.patches"></a>13.3. <code class="filename">patches/*</code>
1.108     rillig   3741: </h2></div></div></div>
                   3742: <p>Some packages don't work out-of-the box on the various
                   3743:   platforms that are supported by pkgsrc. These packages need
                   3744:   to be patched to make them work. The patch files can be
1.1       dsieger  3745:   found in the <code class="filename">patches/</code> directory.</p>
                   3746: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
                   3747:   applied to the files in <code class="varname">WRKSRC</code> directory after
1.108     rillig   3748:   extracting them, in alphabetic order.</p>
1.41      asau     3749: <div class="sect2">
1.1       dsieger  3750: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   3751: <a name="components.patch.structure"></a>13.3.1. Structure of a single patch file</h3></div></div></div>
1.1       dsieger  3752: <p>The <code class="filename">patch-*</code> files should be in
1.10      hubertf  3753:   <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
1.1       dsieger  3754:   problems. (To force patches to apply with fuzz you can set
                   3755:   <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
                   3756:   should contain only changes for a single file, and no file should be
                   3757:   patched by more than one patch file. This helps to keep future
                   3758:   modifications simple.</p>
                   3759: <p>Each patch file is structured as follows: In the first line,
                   3760:   there is the RCS Id of the patch itself. The second line should be
                   3761:   empty for aesthetic reasons. After that, there should be a comment for
                   3762:   each change that the patch does. There are a number of standard
                   3763:   cases:</p>
1.41      asau     3764: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      3765: <li class="listitem"><p>Patches for commonly known vulnerabilities should
1.1       dsieger  3766:   mention the vulnerability ID (CAN, CVE).</p></li>
1.23      wiz      3767: <li class="listitem"><p>Patches that change source code should mention the
1.1       dsieger  3768:   platform and other environment (for example, the compiler) that the
                   3769:   patch is needed for.</p></li>
                   3770: </ul></div>
1.108     rillig   3771: <p>The patch should be commented so that any
1.1       dsieger  3772:   developer who knows the code of the application can make some use of
                   3773:   the patch. Special care should be taken for the upstream developers,
                   3774:   since we generally want that they accept our patches, so we have less
                   3775:   work in the future.</p>
                   3776: </div>
1.41      asau     3777: <div class="sect2">
1.1       dsieger  3778: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   3779: <a name="components.patches.caveats"></a>13.3.2. Creating patch files</h3></div></div></div>
1.1       dsieger  3780: <p>One important thing to mention is to pay attention that no RCS
                   3781:   IDs get stored in the patch files, as these will cause problems when
                   3782:   later checked into the NetBSD CVS tree. Use the
1.137     leot     3783:   <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.1       dsieger  3784:   problems.</p>
                   3785: <p>For even more automation, we recommend using
1.10      hubertf  3786:   <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.1       dsieger  3787:   whole set of patches. You just have to backup files before you
                   3788:   edit them to <code class="filename">filename.orig</code>, e.g. with
1.10      hubertf  3789:   <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
                   3790:   using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
1.1       dsieger  3791:   you upgrade a package this way, you can easily compare the new
                   3792:   set of patches with the previously existing one with
1.24      wiz      3793:   <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
                   3794:   are replaced by new files, so carefully check if you want to take all
                   3795:   the changes.</p>
1.1       dsieger  3796: <p>When you have finished a package, remember to generate
1.10      hubertf  3797:   the checksums for the patch files by using the <span class="command"><strong>make
1.154     rillig   3798:   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.1       dsieger  3799: <p>When adding a patch that corrects a problem in the
                   3800:   distfile (rather than e.g. enforcing pkgsrc's view of where
                   3801:   man pages should go), send the patch as a bug report to the
                   3802:   maintainer.  This benefits non-pkgsrc users of the package,
                   3803:   and usually makes it possible to remove the patch in future
                   3804:   version.</p>
1.2       rillig   3805: <p>The file names of the patch files are usually of the form
1.24      wiz      3806:   <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
                   3807:   Many packages still use the previous convention
                   3808:   <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
                   3809:   but new patches should be of the form containing the filename.
1.137     leot     3810:   <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.24      wiz      3811:   automatically.</p>
1.1       dsieger  3812: </div>
1.41      asau     3813: <div class="sect2">
1.1       dsieger  3814: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   3815: <a name="components.patches.sources"></a>13.3.3. Sources where the patch files come from</h3></div></div></div>
1.1       dsieger  3816: <p>If you want to share patches between multiple packages
                   3817:   in pkgsrc, e.g. because they use the same distfiles, set
                   3818:   <code class="varname">PATCHDIR</code> to the path where the patch files
                   3819:   can be found, e.g.:</p>
                   3820: <pre class="programlisting">
1.159     rillig   3821: PATCHDIR=       ../../editors/xemacs/patches
1.1       dsieger  3822: </pre>
                   3823: <p>Patch files that are distributed by the author or other
                   3824:     maintainers can be listed in
                   3825:     <code class="varname">PATCHFILES</code>.</p>
                   3826: <p>If it is desired to store any patches that should not be
                   3827:     committed into pkgsrc, they can be kept outside the pkgsrc
                   3828:     tree in the <code class="filename">$LOCALPATCHES</code> directory. The
                   3829:     directory tree there is expected to have the same
1.23      wiz      3830:     <span class="quote">&#8220;<span class="quote">category/package</span>&#8221;</span> structure as pkgsrc, and
1.1       dsieger  3831:     patches are expected to be stored inside these dirs (also
                   3832:     known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
                   3833:     example, if you want to keep a private patch for
                   3834:     <code class="filename">pkgsrc/graphics/png</code>, keep it in
                   3835:     <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
                   3836:     files in the named directory are expected to be patch files,
                   3837:     and <span class="emphasis"><em>they are applied after pkgsrc patches are
                   3838:     applied</em></span>.</p>
                   3839: </div>
1.41      asau     3840: <div class="sect2">
1.1       dsieger  3841: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   3842: <a name="components.patches.guidelines"></a>13.3.4. Patching guidelines</h3></div></div></div>
1.1       dsieger  3843: <p>When fixing a portability issue in the code do not use
                   3844:       preprocessor magic to check for the current operating system nor
                   3845:       platform.  Doing so hurts portability to other platforms because
                   3846:       the OS-specific details are not abstracted appropriately.</p>
                   3847: <p>The general rule to follow is: instead of checking for the
                   3848:       operating system the application is being built on, check for the
                   3849:       specific <span class="emphasis"><em>features</em></span> you need.  For example,
                   3850:       instead of assuming that kqueue is available under NetBSD and
                   3851:       using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.14      jmcneill 3852:       kqueue support, add a check that detects kqueue itself &mdash;
1.1       dsieger  3853:       yes, this generally involves patching the
1.10      hubertf  3854:       <span class="command"><strong>configure</strong></span> script.  There is absolutely nothing
1.1       dsieger  3855:       that prevents some OSes from adopting interfaces from other OSes
                   3856:       (e.g. Linux implementing kqueue), something that the above checks
                   3857:       cannot take into account.</p>
                   3858: <p>Of course, checking for features generally involves more
                   3859:       work on the developer's side, but the resulting changes are
                   3860:       cleaner and there are chances they will work on many other
                   3861:       platforms.  Not to mention that there are higher chances of being
                   3862:       later integrated into the mainstream sources.  Remember:
                   3863:       <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
                   3864: <p>Some typical examples:</p>
                   3865: <div class="table">
1.154     rillig   3866: <a name="patch-examples"></a><p class="title"><b>Table 13.1. Patching examples</b></p>
1.106     tnn      3867: <div class="table-contents"><table class="table" summary="Patching examples" border="1">
1.1       dsieger  3868: <colgroup>
                   3869: <col>
                   3870: <col>
                   3871: <col>
                   3872: </colgroup>
                   3873: <thead><tr>
                   3874: <th>Where</th>
                   3875: <th>Incorrect</th>
                   3876: <th>Correct</th>
                   3877: </tr></thead>
                   3878: <tbody>
                   3879: <tr>
                   3880: <td>configure script</td>
                   3881: <td>
                   3882: <pre class="programlisting">
                   3883: case ${target_os} in
                   3884: netbsd*) have_kvm=yes ;;
                   3885: *)       have_kvm=no  ;;
                   3886: esac
                   3887: </pre>
                   3888:              </td>
                   3889: <td>
                   3890: <pre class="programlisting">
                   3891: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
                   3892: </pre>
                   3893:              </td>
                   3894: </tr>
                   3895: <tr>
                   3896: <td>C source file</td>
                   3897: <td>
                   3898: <pre class="programlisting">
                   3899: #if defined(__NetBSD__)
                   3900: #  include &lt;sys/event.h&gt;
                   3901: #endif
                   3902: </pre>
                   3903:              </td>
                   3904: <td>
                   3905: <pre class="programlisting">
                   3906: #if defined(HAVE_SYS_EVENT_H)
                   3907: #  include &lt;sys/event.h&gt;
                   3908: #endif
                   3909: </pre>
                   3910:              </td>
                   3911: </tr>
                   3912: <tr>
                   3913: <td>C source file</td>
                   3914: <td>
                   3915: <pre class="programlisting">
                   3916: int
                   3917: monitor_file(...)
                   3918: {
                   3919: #if defined(__NetBSD__)
                   3920:         int fd = kqueue();
                   3921:         ...
                   3922: #else
                   3923:         ...
                   3924: #endif
                   3925: }
                   3926: </pre>
                   3927:              </td>
                   3928: <td>
                   3929: <pre class="programlisting">
                   3930: int
                   3931: monitor_file(...)
                   3932: {
                   3933: #if defined(HAVE_KQUEUE)
                   3934:         int fd = kqueue();
                   3935:         ...
                   3936: #else
1.112     rillig   3937:         ...
1.1       dsieger  3938: #endif
                   3939: }
                   3940: </pre>
                   3941:              </td>
                   3942: </tr>
                   3943: </tbody>
                   3944: </table></div>
                   3945: </div>
1.141     maya     3946: <br class="table-break">
1.1       dsieger  3947: </div>
1.41      asau     3948: <div class="sect2">
1.1       dsieger  3949: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   3950: <a name="components.patches.feedback"></a>13.3.5. Feedback to the author</h3></div></div></div>
1.1       dsieger  3951: <p>Always, always, <span class="strong"><strong>always</strong></span>
                   3952:       feed back any <span class="emphasis"><em>portability fixes</em></span> or
                   3953:       improvements you do to a package to the mainstream developers.
                   3954:       This is the only way to get their attention on portability issues
                   3955:       and to ensure that future versions can be built out-of-the box on
                   3956:       NetBSD.  Furthermore, any user that gets newer distfiles will get
                   3957:       the fixes straight from the packaged code.</p>
                   3958: <p>This generally involves cleaning up the patches
                   3959:       (because sometimes the patches that are
1.40      wiz      3960:       added to pkgsrc are quick hacks), filing bug reports in the
1.1       dsieger  3961:       appropriate trackers for the projects and working with the
                   3962:       mainstream authors to accept your changes.  It is
                   3963:       <span class="emphasis"><em>extremely important</em></span> that you do it so that
                   3964:       the packages in pkgsrc are kept simple and thus further changes
                   3965:       can be done without much hassle.</p>
1.24      wiz      3966: <p>When you have done this, please add a URL to the upstream
                   3967:       bug report to the patch comment.</p>
1.1       dsieger  3968: <p>Support the idea of free software!</p>
                   3969: </div>
                   3970: </div>
1.41      asau     3971: <div class="sect1">
1.1       dsieger  3972: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   3973: <a name="other-mandatory-files"></a>13.4. Other mandatory files</h2></div></div></div>
1.41      asau     3974: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  3975: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
                   3976: <dd><p>A multi-line description of the piece of software.  This should include
                   3977:          any credits where they are due.  Please bear in mind that others do not
                   3978:          share your sense of humour (or spelling idiosyncrasies), and that others
                   3979:          will read everything that you write here.</p></dd>
                   3980: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
                   3981: <dd><p>This file governs the files that are installed on your
                   3982:          system: all the binaries, manual pages, etc. There are other
                   3983:          directives which may be entered in this file, to control the
                   3984:          creation and deletion of directories, and the location of
1.154     rillig   3985:          inserted files.  See <a class="xref" href="#plist" title="Chapter 15. PLIST issues">Chapter 15, <i>PLIST issues</i></a> for more
1.1       dsieger  3986:          information.</p></dd>
                   3987: </dl></div>
                   3988: </div>
1.41      asau     3989: <div class="sect1">
1.1       dsieger  3990: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   3991: <a name="components.optional"></a>13.5. Optional files</h2></div></div></div>
1.41      asau     3992: <div class="sect2">
1.1       dsieger  3993: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   3994: <a name="components.optional.bin"></a>13.5.1. Files affecting the binary package</h3></div></div></div>
1.41      asau     3995: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  3996: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.28      wiz      3997: <dd>
1.167   ! leot     3998: <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-8.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>.
1.1       dsieger  3999:            First time after package extraction and before files are
                   4000:            moved in place, the second time after the files to install
                   4001:            are moved in place. This can be used to do any custom
                   4002:            procedures not possible with @exec commands in
1.167   ! leot     4003:            <code class="filename">PLIST</code>. See <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> and
        !          4004:            <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information.  See also <a class="xref" href="#files-and-dirs-outside-prefix" title="17.1. Files and directories outside the installation prefix">Section 17.1, &#8220;Files and directories outside the installation prefix&#8221;</a>.
1.28      wiz      4005:            Please note that you can modify variables in it easily by using
                   4006:            <code class="varname">FILES_SUBST</code> in the package's
                   4007:            <code class="filename">Makefile</code>:</p>
                   4008: <pre class="programlisting">
                   4009: FILES_SUBST+=  SOMEVAR="somevalue"
                   4010: </pre>
                   4011: <p>replaces "@SOMEVAR@" with <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span> in the
                   4012:            <code class="filename">INSTALL</code>.  By default, substitution is
                   4013:            performed for <code class="varname">PREFIX</code>,
                   4014:            <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
                   4015:            <code class="varname">VARBASE</code>, and a few others, type
                   4016:            <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
                   4017:            complete list.</p>
                   4018: </dd>
1.1       dsieger  4019: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
                   4020: <dd><p>This script is executed before and after any files are removed.  It is
                   4021:            this script's responsibility to clean up any additional messy details
                   4022:            around the package's installation, since all pkg_delete knows is how to
                   4023:            delete the files created in the original distribution.
1.167   ! leot     4024:            See <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
        !          4025:            and <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> for more information.
1.28      wiz      4026:            The same methods to replace variables can be used as for
                   4027:            the <code class="filename">INSTALL</code> file.</p></dd>
1.1       dsieger  4028: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
                   4029: <dd>
                   4030: <p>This file is displayed after installation of the package.
                   4031:            Useful for things like legal notices on almost-free
                   4032:            software and hints for updating config files after
                   4033:            installing modules for apache, PHP etc.
                   4034:            Please note that you can modify variables in it easily by using
                   4035:            <code class="varname">MESSAGE_SUBST</code> in the package's
                   4036:            <code class="filename">Makefile</code>:</p>
                   4037: <pre class="programlisting">
                   4038: MESSAGE_SUBST+=  SOMEVAR="somevalue"
                   4039: </pre>
1.23      wiz      4040: <p>replaces "${SOMEVAR}" with <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span> in
1.1       dsieger  4041:            <code class="filename">MESSAGE</code>.  By default, substitution is
                   4042:            performed for <code class="varname">PKGNAME</code>,
                   4043:            <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
1.99      sevan    4044:            <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
1.1       dsieger  4045:            <code class="varname">PKG_SYSCONFDIR</code>,
                   4046:            <code class="varname">ROOT_GROUP</code>, and
1.16      jnemeth  4047:            <code class="varname">ROOT_USER</code>.</p>
1.1       dsieger  4048: <p>You can display a different or additional files by
                   4049:            setting the <code class="varname">MESSAGE_SRC</code> variable.  Its
                   4050:            default is <code class="filename">MESSAGE</code>, if the file
                   4051:            exists.</p>
                   4052: </dd>
                   4053: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
1.66      asau     4054: <dd>
                   4055: <p>This file is used by the alternatives framework.
                   4056:            It creates, configures, and destroys generic wrappers used to
                   4057:            run programs with similar interfaces.
                   4058:            See pkg_alternatives(8) from pkgtools/pkg_alternatives
                   4059:             for more information.</p>
                   4060: <p>Each line of the file contains two filenames, first
                   4061:            the wrapper and then the alternative provided by the package.
                   4062:            Both paths are relative to <code class="varname">PREFIX</code>.</p>
                   4063: </dd>
1.1       dsieger  4064: </dl></div>
                   4065: </div>
1.41      asau     4066: <div class="sect2">
1.1       dsieger  4067: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   4068: <a name="components.optional.build"></a>13.5.2. Files affecting the build process</h3></div></div></div>
1.41      asau     4069: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  4070: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
                   4071: <dd><p>This file contains arbitrary things that could
                   4072:        also go into a <code class="filename">Makefile</code>, but its purpose is
                   4073:        to be used by more than one package. This file should only be
                   4074:        used when the packages that will use the file are known in
                   4075:        advance. For other purposes it is often better to write a
                   4076:        <code class="filename">*.mk</code> file and give it a good name that
                   4077:        describes what it does.</p></dd>
                   4078: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
                   4079: <dd><p>This file contains the dependency information
1.154     rillig   4080:        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.1       dsieger  4081: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
                   4082: <dd><p>This file contains workarounds for compiler bugs
                   4083:        and similar things. It is included automatically by the pkgsrc
                   4084:        infrastructure, so you don't need an extra
                   4085:        <code class="literal">.include</code> line for
                   4086:        it.</p></dd>
                   4087: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
                   4088: <dd><p>This file contains the code for the
1.154     rillig   4089:        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.1       dsieger  4090:        selected by the user. If a package has only one or two options,
                   4091:        it is equally acceptable to put the code directly into the
                   4092:        <code class="filename">Makefile</code>.</p></dd>
                   4093: </dl></div>
                   4094: </div>
1.41      asau     4095: <div class="sect2">
1.1       dsieger  4096: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   4097: <a name="components.optional.none"></a>13.5.3. Files affecting nothing at all</h3></div></div></div>
1.41      asau     4098: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  4099: <dt><span class="term"><code class="filename">README*</code></span></dt>
                   4100: <dd><p>These files do not take place in the creation of
                   4101:        a package and thus are purely informative to the package
                   4102:        developer.</p></dd>
                   4103: <dt><span class="term"><code class="filename">TODO</code></span></dt>
                   4104: <dd><p>This file contains things that need to be done
                   4105:        to make the package even
                   4106:        better.</p></dd>
                   4107: </dl></div>
                   4108: </div>
                   4109: </div>
1.41      asau     4110: <div class="sect1">
1.1       dsieger  4111: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   4112: <a name="work-dir"></a>13.6. <code class="filename">work*</code>
1.1       dsieger  4113: </h2></div></div></div>
1.10      hubertf  4114: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
1.1       dsieger  4115:     unpacked into the directory denoted by
                   4116:     <code class="varname">WRKDIR</code>. It can be removed by running
1.10      hubertf  4117:     <span class="command"><strong>make clean</strong></span>. Besides the sources, this
1.1       dsieger  4118:     directory is also used to keep various timestamp files.
                   4119:     The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
                   4120:     The default is <code class="filename">${.CURDIR}/work</code>
                   4121:     or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
                   4122:     if <code class="varname">OBJMACHINE</code> is set.</p>
                   4123: </div>
1.41      asau     4124: <div class="sect1">
1.1       dsieger  4125: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   4126: <a name="files-dir"></a>13.7. <code class="filename">files/*</code>
1.1       dsieger  4127: </h2></div></div></div>
                   4128: <p>If you have any files that you wish to be placed in the package prior
                   4129:     to configuration or building, you could place these files here and use
1.10      hubertf  4130:     a <span class="command"><strong>${CP}</strong></span> command in the
1.23      wiz      4131:     <span class="quote">&#8220;<span class="quote">pre-configure</span>&#8221;</span> target to achieve
1.1       dsieger  4132:     this. Alternatively, you could simply diff the file against
                   4133:     <code class="filename">/dev/null</code> and use the patch mechanism to manage
                   4134:     the creation of this file.</p>
                   4135: <p>If you want to share files in this way with other
                   4136:     packages, set the <code class="varname">FILESDIR</code> variable to point
                   4137:     to the other package's <code class="filename">files</code> directory,
                   4138:     e.g.:</p>
                   4139: <pre class="programlisting">
1.159     rillig   4140: FILESDIR=       ../../editors/xemacs/files
1.1       dsieger  4141: </pre>
                   4142: </div>
                   4143: </div>
1.41      asau     4144: <div class="chapter">
1.1       dsieger  4145: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   4146: <a name="makefile"></a>Chapter 14. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.1       dsieger  4147: <div class="toc">
                   4148: <p><b>Table of Contents</b></p>
1.100     leot     4149: <dl class="toc">
1.154     rillig   4150: <dt><span class="sect1"><a href="#makefile.style">14.1. Caveats</a></span></dt>
                   4151: <dt><span class="sect1"><a href="#makefile.variables">14.2. <code class="filename">Makefile</code> variables</a></span></dt>
                   4152: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">14.2.1. Naming conventions</a></span></dt></dl></dd>
                   4153: <dt><span class="sect1"><a href="#makefile.code">14.3. Code snippets</a></span></dt>
                   4154: <dd><dl>
                   4155: <dt><span class="sect2"><a href="#adding-to-list">14.3.1. Adding things to a list</a></span></dt>
                   4156: <dt><span class="sect2"><a href="#echo-literal">14.3.2. Echoing a string exactly as-is</a></span></dt>
                   4157: <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>
                   4158: <dt><span class="sect2"><a href="#empty-variables">14.3.4. Handling possibly empty variables</a></span></dt>
1.1       dsieger  4159: </dl></dd>
                   4160: </dl>
                   4161: </div>
                   4162: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
                   4163:   each of which forms a well-defined part of the pkgsrc system. Using
1.167   ! leot     4164:   the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> system as a programming language for a big system
1.1       dsieger  4165:   like pkgsrc requires some discipline to keep the code correct and
                   4166:   understandable.</p>
                   4167: <p>The basic ingredients for <code class="filename">Makefile</code>
1.154     rillig   4168:   programming are variables and shell
1.1       dsieger  4169:   commands. Among these shell commands may even be more complex ones
1.167   ! leot     4170:   like <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?awk+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">awk</span>(1)</span></a> programs. To make sure that every shell command runs
1.1       dsieger  4171:   as intended it is necessary to quote all variables correctly when they
                   4172:   are used.</p>
1.154     rillig   4173: <p>This chapter describes some patterns that appear quite often in
1.1       dsieger  4174:   <code class="filename">Makefile</code>s, including the pitfalls that come along
                   4175:   with them.</p>
1.41      asau     4176: <div class="sect1">
1.1       dsieger  4177: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   4178: <a name="makefile.style"></a>14.1. Caveats</h2></div></div></div>
1.41      asau     4179: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.1       dsieger  4180: <p>When you are creating a file as a
                   4181:     target of a rule, always write the data to a temporary file first
                   4182:     and finally rename that file. Otherwise there might occur an error
                   4183:     in the middle of generating the file, and when the user runs
1.167   ! leot     4184:     <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> for the second time, the file exists and will not be
1.1       dsieger  4185:     regenerated properly. Example:</p>
                   4186: <pre class="programlisting">
                   4187: wrong:
                   4188:         @echo "line 1" &gt; ${.TARGET}
                   4189:         @echo "line 2" &gt;&gt; ${.TARGET}
                   4190:         @false
                   4191: 
                   4192: correct:
                   4193:         @echo "line 1" &gt; ${.TARGET}.tmp
                   4194:         @echo "line 2" &gt;&gt; ${.TARGET}.tmp
                   4195:         @false
                   4196:         @mv ${.TARGET}.tmp ${.TARGET}
                   4197: </pre>
1.10      hubertf  4198: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
1.1       dsieger  4199:     <code class="filename">wrong</code> will exist, although there was an error
1.10      hubertf  4200:     message in the first run. On the other hand, running <span class="command"><strong>make
1.1       dsieger  4201:     correct</strong></span> gives an error message twice, as expected.</p>
1.167   ! leot     4202: <p>You might remember that <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> sometimes removes
1.1       dsieger  4203:     <code class="literal">${.TARGET}</code> in case of error, but this only
                   4204:     happens when it is interrupted, for example by pressing
1.154     rillig   4205:     <code class="literal">Ctrl+C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.167   ! leot     4206:     when one of the commands fails (like <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?false+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">false</span>(1)</span></a> above).</p>
1.1       dsieger  4207: </li></ul></div>
                   4208: </div>
1.41      asau     4209: <div class="sect1">
1.1       dsieger  4210: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   4211: <a name="makefile.variables"></a>14.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.1       dsieger  4212: <p><code class="filename">Makefile</code> variables contain strings that
1.154     rillig   4213:     can be processed using the five operators <code class="code">=</code>,
                   4214:     <code class="code">+=</code>, <code class="code">?=</code>, <code class="code">:=</code> and
1.167   ! leot     4215:     <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-8.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man
1.1       dsieger  4216:     page.</p>
                   4217: <p>When a variable's value is parsed from a
1.154     rillig   4218:     <code class="filename">Makefile</code>, the hash character <code class="code">#</code> and
                   4219:     the backslash character <code class="code">\</code> are handled specially. If a
                   4220:     backslash is the last character in a line, that backslash is removed
                   4221:     from the line and the line continues with the next line of the file.</p>
                   4222: <p>The <code class="code">#</code> character starts a comment that reaches
                   4223:     until the end of the line. To get an actual <code class="code">#</code> character,
                   4224:     such as in a URL, write <code class="code">\#</code> instead.</p>
1.108     rillig   4225: <p>The evaluation of variables either happens immediately or lazy.
1.154     rillig   4226:     It happens immediately when the variable occurs on the right-hand
                   4227:     side of the <code class="code">:=</code> or the <code class="code">!=</code> operator, in a
1.108     rillig   4228:     <code class="varname">.if</code> condition or a <code class="varname">.for</code> loop.
                   4229:     In the other cases, it is evaluated lazily.</p>
1.1       dsieger  4230: <p>Some of the modifiers split the string into words and then
1.154     rillig   4231:     operate on the words, others operate on the string as a whole. When a
                   4232:     string is split into words, double quotes and single quotes are
1.167   ! leot     4233:     interpreted as delimiters, just like in <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?sh+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">sh</span>(1)</span></a>.</p>
1.41      asau     4234: <div class="sect2">
1.1       dsieger  4235: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   4236: <a name="makefile.variables.names"></a>14.2.1. Naming conventions</h3></div></div></div>
1.41      asau     4237: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      4238: <li class="listitem"><p>All variable names starting with an underscore
1.1       dsieger  4239:        are reserved for use by the pkgsrc infrastructure. They shall
1.154     rillig   4240:        not be used by packages.</p></li>
1.23      wiz      4241: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
1.1       dsieger  4242:        lowercase variable names for the iteration
                   4243:        variables.</p></li>
1.154     rillig   4244: <li class="listitem"><p>All list variables should have a plural name,
                   4245:        such as <code class="varname">PKG_OPTIONS</code> or
1.1       dsieger  4246:        <code class="varname">DISTFILES</code>.</p></li>
                   4247: </ul></div>
                   4248: </div>
                   4249: </div>
1.41      asau     4250: <div class="sect1">
1.1       dsieger  4251: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   4252: <a name="makefile.code"></a>14.3. Code snippets</h2></div></div></div>
1.41      asau     4253: <div class="sect2">
1.1       dsieger  4254: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   4255: <a name="adding-to-list"></a>14.3.1. Adding things to a list</h3></div></div></div>
1.108     rillig   4256: <p>When adding a string that possibly contains whitespace or quotes to
                   4257: a list (example 1), it must be quoted using the <code class="code">:Q</code>
                   4258: modifier.</p>
                   4259: <p>When adding another list to a list (example 2), it must not be
                   4260: quoted, since its elements are already quoted.</p>
1.1       dsieger  4261: <pre class="programlisting">
1.108     rillig   4262: STRING=         foo * bar `date`
                   4263: LIST=           # empty
                   4264: ANOTHER_LIST=   a=b c=d
                   4265: 
                   4266: LIST+=          ${STRING:Q}       # 1
                   4267: LIST+=          ${ANOTHER_LIST}   # 2
1.1       dsieger  4268: </pre>
                   4269: </div>
1.41      asau     4270: <div class="sect2">
1.1       dsieger  4271: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   4272: <a name="echo-literal"></a>14.3.2. Echoing a string exactly as-is</h3></div></div></div>
1.108     rillig   4273: <p>Echoing a string containing special characters needs special
                   4274: work.</p>
1.1       dsieger  4275: <pre class="programlisting">
                   4276: STRING=         foo bar &lt;    &gt; * `date` $$HOME ' "
1.108     rillig   4277: EXAMPLE_ENV=    string=${STRING:Q} x=multiple\ quoted\ words
1.1       dsieger  4278: 
                   4279: all:
                   4280:         echo ${STRING}                  # 1
1.108     rillig   4281:         echo ${STRING:Q}                # 2
                   4282:         printf '%s\n' ${STRING:Q}''     # 3
                   4283:         env ${EXAMPLE_ENV} sh -c 'echo "$$string"; echo "$$x"'   # 4
                   4284: </pre>
                   4285: <p>Example 1 leads to a syntax error in the shell, as the characters
                   4286: are just copied.</p>
                   4287: <p>Example 2 quotes the string so that the shell interprets it
                   4288: correctly. But the echo command may additionally interpret strings with a
                   4289: leading dash or those containing backslashes.</p>
1.167   ! leot     4290: <p>Example 3 can handle arbitrary strings, since <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?printf+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">printf</span>(1)</span></a> only
1.139     leot     4291: interprets the format string, but not the next argument. The trailing
                   4292: single quotes handle the case when the string is empty. In that case, the
                   4293: :Q modifier would result in an empty string too, which would then be
1.167   ! leot     4294: skipped by the shell. For <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?printf+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">printf</span>(1)</span></a> this doesn't make a difference,
1.139     leot     4295: but other programs may care.</p>
1.108     rillig   4296: <p>In example 4, the <code class="varname">EXAMPLE_ENV</code> does not
                   4297: need to be quoted because the quoting has already been done
                   4298: when adding elements to the list.</p>
1.1       dsieger  4299: </div>
1.41      asau     4300: <div class="sect2">
1.1       dsieger  4301: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   4302: <a name="cflags-gnu-configure"></a>14.3.3. Passing <code class="varname">CFLAGS</code> to GNU configure scripts</h3></div></div></div>
1.108     rillig   4303: <p>When passing <code class="varname">CFLAGS</code> or similar variables to a
                   4304: GNU-style configure script (especially those that call other configure
                   4305: scripts), it must not have leading or trailing whitespace, since
                   4306: otherwise the configure script gets confused. To trim leading and
                   4307: trailing whitespace, use the <code class="code">:M</code> modifier, as in the
                   4308: following example:</p>
1.1       dsieger  4309: <pre class="programlisting">
                   4310: CPPFLAGS=               # empty
1.108     rillig   4311: CPPFLAGS+=              -Wundef -DPREFIX=\"${PREFIX}\"
1.1       dsieger  4312: CPPFLAGS+=              ${MY_CPPFLAGS}
                   4313: 
                   4314: CONFIGURE_ARGS+=        CPPFLAGS=${CPPFLAGS:M*:Q}
                   4315: 
                   4316: all:
                   4317:         echo x${CPPFLAGS:Q}x            # leading and trailing whitespace
1.108     rillig   4318:         echo x${CONFIGURE_ARGS:Q}x      # properly trimmed
1.1       dsieger  4319: </pre>
1.108     rillig   4320: <p>In this example, <code class="varname">CPPFLAGS</code> has both leading and
                   4321: trailing whitespace because the <code class="code">+=</code> operator always adds a
                   4322: space.</p>
                   4323: </div>
                   4324: <div class="sect2">
                   4325: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   4326: <a name="empty-variables"></a>14.3.4. Handling possibly empty variables</h3></div></div></div>
1.108     rillig   4327: <p>When a possibly empty variable is used in a shell program, it may
                   4328: lead to a syntax error.</p>
                   4329: <pre class="programlisting">
                   4330: EGFILES=        # empty
                   4331: 
                   4332: install-examples:   # produces a syntax error in the shell
                   4333:         for egfile in ${EGFILES}; do            \
                   4334:                 echo "Installing $$egfile";     \
                   4335:         done
                   4336: </pre>
                   4337: <p>The shell only sees the text <code class="code">for egfile in ; do</code>, since
1.167   ! leot     4338: <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-8.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>.
1.108     rillig   4339: To fix this syntax error, use one of the snippets below.</p>
                   4340: <pre class="programlisting">
                   4341: EMPTY=          # empty
                   4342: 
                   4343: install-examples:
                   4344:         for egfile in ${EGFILES} ""; do         \
                   4345:                 [ -n "$$egfile" ] || continue;  \
                   4346:                 echo "Installing $$egfile";     \
1.1       dsieger  4347:         done
1.108     rillig   4348: </pre>
                   4349: <p>In this case, an empty string is appended to the iteration list (to
                   4350: prevent the syntax error) and filtered out later.</p>
                   4351: <pre class="programlisting">
                   4352: EGFILES=        # empty
1.1       dsieger  4353: 
1.108     rillig   4354: install-examples:
                   4355: .for egfile in ${EGFILES}
                   4356:         echo "Installing ${egfile}"
1.1       dsieger  4357: .endfor
                   4358: </pre>
1.154     rillig   4359: <p>If one of the filenames contains special characters, it should be
                   4360: enclosed in single or double quotes.</p>
1.108     rillig   4361: <p>To have a shell command test whether a make variable is empty, use
                   4362: the following code: <code class="code">${TEST} -z ${POSSIBLY_EMPTY:Q}""</code>.</p>
1.1       dsieger  4363: </div>
                   4364: </div>
                   4365: </div>
1.41      asau     4366: <div class="chapter">
1.1       dsieger  4367: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   4368: <a name="plist"></a>Chapter 15. PLIST issues</h2></div></div></div>
1.1       dsieger  4369: <div class="toc">
                   4370: <p><b>Table of Contents</b></p>
1.100     leot     4371: <dl class="toc">
1.154     rillig   4372: <dt><span class="sect1"><a href="#rcs-id">15.1. RCS ID</a></span></dt>
                   4373: <dt><span class="sect1"><a href="#automatic-plist-generation">15.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                   4374: <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>
                   4375: <dt><span class="sect1"><a href="#plist.misc">15.4. Variable substitution in PLIST</a></span></dt>
                   4376: <dt><span class="sect1"><a href="#manpage-compression">15.5. Man page compression</a></span></dt>
                   4377: <dt><span class="sect1"><a href="#using-PLIST_SRC">15.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
                   4378: <dt><span class="sect1"><a href="#platform-specific-plist">15.7. Platform-specific and differing PLISTs</a></span></dt>
                   4379: <dt><span class="sect1"><a href="#build-plist">15.8. Build-specific PLISTs</a></span></dt>
                   4380: <dt><span class="sect1"><a href="#faq.common-dirs">15.9. Sharing directories between packages</a></span></dt>
1.1       dsieger  4381: </dl>
                   4382: </div>
                   4383: <p>The <code class="filename">PLIST</code> file contains a package's
1.23      wiz      4384:   <span class="quote">&#8220;<span class="quote">packing list</span>&#8221;</span>, i.e. a list of files that belong to
1.1       dsieger  4385:   the package (relative to the <code class="filename">${PREFIX}</code>
                   4386:   directory it's been installed in) plus some additional statements
1.167   ! leot     4387:   - see the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_create+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">pkg_create</span>(1)</span></a> man page for a full list.
1.1       dsieger  4388:   This chapter addresses some issues that need attention when
                   4389:   dealing with the <code class="filename">PLIST</code> file (or files, see
                   4390:   below!).</p>
1.41      asau     4391: <div class="sect1">
1.1       dsieger  4392: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   4393: <a name="rcs-id"></a>15.1. RCS ID</h2></div></div></div>
1.1       dsieger  4394: <p>Be sure to add a RCS ID line as the first thing in any
                   4395:     <code class="filename">PLIST</code> file you write:</p>
                   4396: <pre class="programlisting">
1.121     sevan    4397: @comment $NetBSD $
1.111     sevan    4398: </pre>
1.123     wiz      4399: <p>An artificial space has been added between NetBSD and $, this is a
1.121     sevan    4400: workaround here to prevent CVS expanding to the filename of the guide. When
1.125     leot     4401: adding the RCS ID the space should be omitted.</p>
1.1       dsieger  4402: </div>
1.41      asau     4403: <div class="sect1">
1.1       dsieger  4404: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   4405: <a name="automatic-plist-generation"></a>15.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.10      hubertf  4406: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
1.1       dsieger  4407:     to output a PLIST that matches any new files since the package
1.154     rillig   4408:     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.1       dsieger  4409:     more information on this target.</p>
                   4410: </div>
1.41      asau     4411: <div class="sect1">
1.1       dsieger  4412: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   4413: <a name="print-PLIST"></a>15.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
1.1       dsieger  4414: </h2></div></div></div>
                   4415: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
                   4416:     of AWK patterns and actions that are used to filter the output of
                   4417:     print-PLIST.  You can <span class="emphasis"><em>append</em></span> any chunk of AWK
                   4418:     scripting you like to it, but be careful with quoting.</p>
                   4419: <p>For example, to get all files inside the
                   4420:     <code class="filename">libdata/foo</code> directory removed from the
                   4421:     resulting PLIST:</p>
                   4422: <pre class="programlisting">
                   4423: PRINT_PLIST_AWK+=       /^libdata\/foo/ { next; }
1.111     sevan    4424: </pre>
1.1       dsieger  4425: </div>
1.41      asau     4426: <div class="sect1">
1.1       dsieger  4427: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   4428: <a name="plist.misc"></a>15.4. Variable substitution in PLIST</h2></div></div></div>
1.1       dsieger  4429: <p>A number of variables are substituted automatically in
                   4430:     PLISTs when a package is installed on a system. This includes the
                   4431:     following variables:</p>
1.41      asau     4432: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  4433: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
                   4434: <dd>
                   4435: <p>Some packages like emacs and perl embed information
                   4436:          about which architecture they were built on into the
                   4437:          pathnames where they install their files. To handle this
                   4438:          case, PLIST will be preprocessed before actually used, and
                   4439:          the symbol
1.23      wiz      4440:          <span class="quote">&#8220;<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>&#8221;</span> will be
1.10      hubertf  4441:          replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
1.1       dsieger  4442:          same is done if the string
                   4443:          <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
                   4444:          PLIST somewhere - use this on packages that have GNU
                   4445:          autoconf-created configure scripts.</p>
1.41      asau     4446: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  4447: <h3 class="title">Legacy note</h3>
                   4448: <p>There used to be a symbol
1.23      wiz      4449:            <span class="quote">&#8220;<span class="quote"><code class="varname">$ARCH</code></span>&#8221;</span> that
1.10      hubertf  4450:            was replaced by the output of <span class="command"><strong>uname
1.1       dsieger  4451:            -m</strong></span>, but that's no longer supported and has
                   4452:            been removed.</p>
                   4453: </div>
                   4454: </dd>
                   4455: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
                   4456: <dd>
                   4457: <p>Some packages want to embed the OS name and version
                   4458:          into some paths.  To do this, use these variables in the
                   4459:          <code class="filename">PLIST</code>:
                   4460:          </p>
1.41      asau     4461: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      4462: <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>
                   4463: <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>
                   4464: <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.1       dsieger  4465: </ul></div>
                   4466: </dd>
                   4467: </dl></div>
1.88      tnn      4468: <p>For a list of values which are replaced by
                   4469:     default, the output of <span class="command"><strong>make help topic=PLIST_SUBST</strong></span> as
                   4470: well as searching the <code class="filename">pkgsrc/mk</code> directory with <span class="command"><strong>grep</strong></span> for
                   4471: <code class="varname">PLIST_SUBST</code> should help.</p>
1.1       dsieger  4472: <p>If you want to change other variables not listed above, you
                   4473:     can add variables and their expansions to this variable in the
1.154     rillig   4474:     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.1       dsieger  4475: <pre class="programlisting">
                   4476: PLIST_SUBST+=   SOMEVAR="somevalue"
1.111     sevan    4477: </pre>
1.23      wiz      4478: <p>This replaces all occurrences of <span class="quote">&#8220;<span class="quote">${SOMEVAR}</span>&#8221;</span>
1.1       dsieger  4479:     in the <code class="filename">PLIST</code> with
1.23      wiz      4480:     <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span>.</p>
1.18      snj      4481: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
                   4482:     the common case of conditionally including some
                   4483:     <code class="filename">PLIST</code> entries. It can be done by adding
                   4484:     <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
                   4485:     setting the corresponding <code class="varname">PLIST.foo</code> variable
                   4486:     to <code class="literal">yes</code> if the entry should be included.
1.23      wiz      4487:     This will substitute <span class="quote">&#8220;<span class="quote"><code class="varname">${PLIST.foo}</code></span>&#8221;</span>
1.18      snj      4488:     in the <code class="filename">PLIST</code> with either
1.23      wiz      4489:     <span class="quote">&#8220;<span class="quote"><code class="literal">""</code></span>&#8221;</span> or
                   4490:     <span class="quote">&#8220;<span class="quote"><code class="literal">"@comment "</code></span>&#8221;</span>.
1.18      snj      4491:     For example, in <code class="filename">Makefile</code>:</p>
                   4492: <pre class="programlisting">
1.112     rillig   4493: PLIST_VARS+=    foo
1.18      snj      4494: .if <em class="replaceable"><code>condition</code></em>
1.112     rillig   4495: PLIST.foo=      yes
1.18      snj      4496: .else
1.111     sevan    4497: </pre>
1.18      snj      4498: <p>And then in <code class="filename">PLIST</code>:</p>
                   4499: <pre class="programlisting">
1.121     sevan    4500: @comment $NetBSD $
1.18      snj      4501: bin/bar
                   4502: man/man1/bar.1
                   4503: ${PLIST.foo}bin/foo
                   4504: ${PLIST.foo}man/man1/foo.1
                   4505: ${PLIST.foo}share/bar/foo.data
1.111     sevan    4506: </pre>
1.123     wiz      4507: <p>An artificial space has been added between NetBSD and $, this is a
1.121     sevan    4508: workaround here to prevent CVS expanding to the filename of the guide. When
                   4509: adding the RCS ID the space should be ommited.</p>
1.1       dsieger  4510: </div>
1.41      asau     4511: <div class="sect1">
1.1       dsieger  4512: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   4513: <a name="manpage-compression"></a>15.5. Man page compression</h2></div></div></div>
1.1       dsieger  4514: <p>Man pages should be installed in compressed form if
                   4515:     <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
                   4516:     and uncompressed otherwise. To handle this in the
1.23      wiz      4517:     <code class="filename">PLIST</code> file, the suffix <span class="quote">&#8220;<span class="quote">.gz</span>&#8221;</span> is
1.1       dsieger  4518:     appended/removed automatically for man pages according to
                   4519:     <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
                   4520:     or not, see above for details. This modification of the
                   4521:     <code class="filename">PLIST</code> file is done on a copy of it, not
                   4522:     <code class="filename">PLIST</code> itself.</p>
                   4523: </div>
1.41      asau     4524: <div class="sect1">
1.1       dsieger  4525: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   4526: <a name="using-PLIST_SRC"></a>15.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
1.1       dsieger  4527: </h2></div></div></div>
                   4528: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
                   4529:     in generating the binary package, set the variable
                   4530:     <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.167   ! leot     4531:     The files are later concatenated using <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?cat+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">cat</span>(1)</span></a>, and the order of things is
1.1       dsieger  4532:     important. The default for <code class="varname">PLIST_SRC</code> is
                   4533:     <code class="filename">${PKGDIR}/PLIST</code>.</p>
                   4534: </div>
1.41      asau     4535: <div class="sect1">
1.1       dsieger  4536: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   4537: <a name="platform-specific-plist"></a>15.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.1       dsieger  4538: <p>Some packages decide to install a different set of files based on
                   4539:     the operating system being used. These differences can be
                   4540:     automatically handled by using the following files:</p>
1.41      asau     4541: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      4542: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
                   4543: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
                   4544: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
                   4545: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
                   4546: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
1.1       dsieger  4547: </ul></div>
                   4548: </div>
1.41      asau     4549: <div class="sect1">
1.1       dsieger  4550: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   4551: <a name="build-plist"></a>15.8. Build-specific PLISTs</h2></div></div></div>
1.86      wiz      4552: <p>Some packages decide to generate hard-to-guess file names
                   4553:     during installation that are hard to wire down.</p>
                   4554: <p>In such cases, you can set the
                   4555:     <code class="varname">GENERATE_PLIST</code> variable to shell code
                   4556:     terminated (with a semicolon) that will output PLIST entries which
                   4557:     will be appended to the PLIST</p>
                   4558: <p>You can find one example in editors/xemacs:</p>
                   4559: <pre class="programlisting">
1.111     sevan    4560: GENERATE_PLIST+=        ${ECHO} bin/${DISTNAME}-`${WRKSRC}/src/xemacs -sd`.dmp ;
                   4561: </pre>
1.86      wiz      4562: <p>which will append something like
                   4563:     <code class="filename">bin/xemacs-21.4.23-54e8ea71.dmp</code> to the
                   4564:     <code class="filename">PLIST</code>.
                   4565:     </p>
                   4566: </div>
                   4567: <div class="sect1">
                   4568: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   4569: <a name="faq.common-dirs"></a>15.9. Sharing directories between packages</h2></div></div></div>
1.23      wiz      4570: <p>A <span class="quote">&#8220;<span class="quote">shared directory</span>&#8221;</span> is a directory where
1.1       dsieger  4571:     multiple (and unrelated) packages install files.  These
1.22      jakllsch 4572:     directories were problematic because you had to add special
                   4573:     tricks in the PLIST to conditionally remove them, or have some
1.1       dsieger  4574:     centralized package handle them.</p>
1.22      jakllsch 4575: <p>In pkgsrc, it is now easy: Each package should create
                   4576:     directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
                   4577:     will remove any directories left empty after uninstalling a
                   4578:     package.</p>
                   4579: <p>If a package needs an empty directory to work, create
                   4580:     the directory during installation as usual, and also add an
                   4581:     entry to the PLIST:
1.111     sevan    4582: 
                   4583: </p>
1.1       dsieger  4584: <pre class="programlisting">
1.22      jakllsch 4585: @pkgdir path/to/empty/directory
1.111     sevan    4586: </pre>
1.22      jakllsch 4587: <p>
1.111     sevan    4588: 
1.86      wiz      4589:     or take a look at <code class="varname">MAKE_DIRS</code> and
                   4590:     <code class="varname">OWN_DIRS</code>.
1.22      jakllsch 4591:     </p>
1.1       dsieger  4592: </div>
                   4593: </div>
1.41      asau     4594: <div class="chapter">
1.1       dsieger  4595: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   4596: <a name="buildlink"></a>Chapter 16. Buildlink methodology</h2></div></div></div>
1.1       dsieger  4597: <div class="toc">
                   4598: <p><b>Table of Contents</b></p>
1.100     leot     4599: <dl class="toc">
1.154     rillig   4600: <dt><span class="sect1"><a href="#converting-to-buildlink3">16.1. Converting packages to use buildlink3</a></span></dt>
                   4601: <dt><span class="sect1"><a href="#creating-buildlink3.mk">16.2. Writing <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.1       dsieger  4602: <dd><dl>
1.154     rillig   4603: <dt><span class="sect2"><a href="#anatomy-of-bl3">16.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
                   4604: <dt><span class="sect2"><a href="#updating-buildlink-depends">16.2.2. Updating
1.26      wiz      4605:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   4606:       and
                   4607:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   4608:       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.1       dsieger  4609: </dl></dd>
1.154     rillig   4610: <dt><span class="sect1"><a href="#writing-builtin.mk">16.3. Writing <code class="filename">builtin.mk</code> files</a></span></dt>
1.1       dsieger  4611: <dd><dl>
1.154     rillig   4612: <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>
                   4613: <dt><span class="sect2"><a href="#native-or-pkgsrc-preference">16.3.2. Global preferences for native or pkgsrc software</a></span></dt>
1.1       dsieger  4614: </dl></dd>
                   4615: </dl>
                   4616: </div>
                   4617: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
                   4618:   are seen by a package's configure and build processes.  This is implemented
                   4619:   in a two step process:</p>
1.23      wiz      4620: <div class="orderedlist"><ol class="orderedlist" type="1">
                   4621: <li class="listitem"><p>Symlink headers and libraries for dependencies into
1.1       dsieger  4622:       <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
                   4623:       of <code class="varname">WRKDIR</code>.</p></li>
1.23      wiz      4624: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
1.1       dsieger  4625:       tools that translate <code class="option">-I${LOCALBASE}/include</code> and
                   4626:       <code class="option">-L${LOCALBASE}/lib</code> into references to
                   4627:       <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
                   4628:       native compiler on some operating systems look like GCC, so that
                   4629:       packages that expect GCC won't require modifications to build with
                   4630:       those native compilers.</p></li>
                   4631: </ol></div>
                   4632: <p>This normalizes the environment in which a package is built so that the
                   4633:   package may be built consistently despite what other software may be
                   4634:   installed. Please note that the normal system header and library paths,
                   4635:   e.g. <code class="filename">/usr/include</code>,
                   4636:   <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
                   4637:   designed to insulate the package build from non-system-supplied
                   4638:   software.</p>
1.41      asau     4639: <div class="sect1">
1.1       dsieger  4640: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   4641: <a name="converting-to-buildlink3"></a>16.1. Converting packages to use buildlink3</h2></div></div></div>
1.1       dsieger  4642: <p>The process of converting packages to use the buildlink3
1.23      wiz      4643:     framework (<span class="quote">&#8220;<span class="quote">bl3ifying</span>&#8221;</span>) is fairly straightforward.
1.1       dsieger  4644:     The things to keep in mind are:</p>
1.23      wiz      4645: <div class="orderedlist"><ol class="orderedlist" type="1">
                   4646: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
1.1       dsieger  4647:        instead of the actual toolchain.  Some packages are tricky,
                   4648:        and the only way to know for sure is the check
                   4649:        <code class="filename">${WRKDIR}/.work.log</code> to see if the
                   4650:        wrappers are being invoked.</p></li>
1.23      wiz      4651: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
1.1       dsieger  4652:        the package Makefile, e.g. Java VMs, standalone shells,
                   4653:        etc., because the code to symlink files into
                   4654:        <code class="filename">${BUILDLINK_DIR}</code> looks for files
1.23      wiz      4655:        relative to <span class="quote">&#8220;<span class="quote">pkg_info -qp <em class="replaceable"><code>pkgname</code></em></span>&#8221;</span>.
1.1       dsieger  4656:        </p></li>
1.23      wiz      4657: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
1.1       dsieger  4658:        <code class="filename">buildlink3.mk</code> files that you list in a
                   4659:        package's Makefile are added as dependencies for that package.
                   4660:        </p></li>
                   4661: </ol></div>
                   4662: <p>If a dependency on a particular package is required for its libraries and
                   4663:     headers, then we replace:</p>
                   4664: <pre class="programlisting">
                   4665: DEPENDS+=       foo&gt;=1.1.0:../../category/foo
                   4666: </pre>
                   4667: <p>with</p>
                   4668: <pre class="programlisting">
                   4669: .include "../../category/foo/buildlink3.mk"
                   4670: </pre>
                   4671: <p>The buildlink3.mk files usually define the required dependencies.
                   4672:     If you need a newer version of the dependency when using buildlink3.mk
                   4673:     files, then you can define it in your Makefile; for example:</p>
                   4674: <pre class="programlisting">
                   4675: BUILDLINK_API_DEPENDS.foo+=   foo&gt;=1.1.0
                   4676: .include "../../category/foo/buildlink3.mk"
                   4677: </pre>
                   4678: <p>There are several <code class="filename">buildlink3.mk</code>
                   4679:     files in <code class="filename">pkgsrc/mk</code>
                   4680:     that handle special package issues:</p>
1.41      asau     4681: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      4682: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
1.1       dsieger  4683:        the native or a pkgsrc Berkeley DB implementation based on
                   4684:        the values of <code class="varname">BDB_ACCEPTED</code> and
                   4685:        <code class="varname">BDB_DEFAULT</code>.</p></li>
1.23      wiz      4686: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
1.1       dsieger  4687:        comes with neither Curses nor NCurses, this will take care
1.137     leot     4688:        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.23      wiz      4689: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
1.1       dsieger  4690:        of <code class="varname">KRB5_ACCEPTED</code> to choose between
                   4691:        adding a dependency on Heimdal or MIT-krb5 for packages that
                   4692:        require a Kerberos 5 implementation.</p></li>
1.23      wiz      4693: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
1.1       dsieger  4694:        system-provided Motif installation or adds a dependency on
1.137     leot     4695:        <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.23      wiz      4696:        <code class="varname">MOTIF_TYPE</code> to <span class="quote">&#8220;<span class="quote">dt</span>&#8221;</span>,
1.126     leot     4697:        <span class="quote">&#8220;<span class="quote">lesstif</span>&#8221;</span> or <span class="quote">&#8220;<span class="quote">motif</span>&#8221;</span>
                   4698:        to choose which Motif version will be used.</p></li>
1.55      ryoon    4699: <li class="listitem"><p><code class="filename">readline.buildlink3.mk</code> checks for a
1.56      wiz      4700:        system-provided GNU readline or editline (libedit) installation,
1.137     leot     4701:        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>,
                   4702:        <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.55      ryoon    4703:        <code class="varname">READLINE_DEFAULT</code> to choose readline implementation.
                   4704:        If your package really needs GNU readline library, its Makefile
                   4705:        should include <code class="filename">devel/readline/buildlink3.mk</code>
                   4706:        instead of <code class="filename">readline.buildlink3.mk</code>.</p></li>
1.23      wiz      4707: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
1.1       dsieger  4708:        variables that may be used by packages that use the
                   4709:        Open Sound System (OSS) API.</p></li>
1.23      wiz      4710: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
1.35      wiz      4711:        any of the Postgres versions in the variable
                   4712:        <code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
                   4713:        the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
1.1       dsieger  4714:        the file for more information.</p></li>
1.23      wiz      4715: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
1.1       dsieger  4716:        <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.137     leot     4717:        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.23      wiz      4718: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
1.1       dsieger  4719:        <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
                   4720:        library.</p></li>
                   4721: </ul></div>
                   4722: <p>The comments in those <code class="filename">buildlink3.mk</code>
                   4723:     files provide a more complete
                   4724:     description of how to use them properly.</p>
                   4725: </div>
1.41      asau     4726: <div class="sect1">
1.1       dsieger  4727: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   4728: <a name="creating-buildlink3.mk"></a>16.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.7       rillig   4729: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
1.1       dsieger  4730:     included by Makefiles to indicate the need to compile and link
                   4731:     against header files and libraries provided by the package.  A
                   4732:     <code class="filename">buildlink3.mk</code> file should always provide
                   4733:     enough information to add the correct type of dependency
                   4734:     relationship and include any other
                   4735:     <code class="filename">buildlink3.mk</code> files that it needs to find
                   4736:     headers and libraries that it needs in turn.</p>
                   4737: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.137     leot     4738:     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.1       dsieger  4739:     package is highly recommended.  For most packages, the following
                   4740:     command will generate a good starting point for
                   4741:     <code class="filename">buildlink3.mk</code> files:</p>
                   4742: <pre class="screen">
                   4743: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
                   4744: <code class="prompt">%</code> createbuildlink &gt;buildlink3.mk</code></strong>
                   4745:     </pre>
1.41      asau     4746: <div class="sect2">
1.1       dsieger  4747: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   4748: <a name="anatomy-of-bl3"></a>16.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.1       dsieger  4749: <p>The following real-life example
                   4750:       <code class="filename">buildlink3.mk</code> is taken
                   4751:       from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
                   4752: <pre class="programlisting">
1.18      snj      4753: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
1.1       dsieger  4754: 
1.112     rillig   4755: BUILDLINK_TREE+=        tiff
1.1       dsieger  4756: 
1.18      snj      4757: .if !defined(TIFF_BUILDLINK3_MK)
                   4758: TIFF_BUILDLINK3_MK:=
1.1       dsieger  4759: 
1.112     rillig   4760: BUILDLINK_API_DEPENDS.tiff+=    tiff&gt;=3.6.1
                   4761: BUILDLINK_ABI_DEPENDS.tiff+=    tiff&gt;=3.7.2nb1
                   4762: BUILDLINK_PKGSRCDIR.tiff?=      ../../graphics/tiff
1.1       dsieger  4763: 
                   4764: .include "../../devel/zlib/buildlink3.mk"
                   4765: .include "../../graphics/jpeg/buildlink3.mk"
1.18      snj      4766: .endif # TIFF_BUILDLINK3_MK
1.1       dsieger  4767: 
1.112     rillig   4768: BUILDLINK_TREE+=        -tiff
1.1       dsieger  4769: </pre>
                   4770: <p>The header and footer manipulate
1.18      snj      4771:       <code class="varname">BUILDLINK_TREE</code>, which is common across all
1.1       dsieger  4772:       <code class="filename">buildlink3.mk</code> files and is used to track
1.18      snj      4773:       the dependency tree.</p>
                   4774: <p>The main section is protected from multiple inclusion
1.1       dsieger  4775:       and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
                   4776:       added.  Several important variables are set in the section:</p>
1.41      asau     4777: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      4778: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.1       dsieger  4779:          is the actual dependency recorded in the installed
                   4780:          package; this should always be set using
1.10      hubertf  4781:          <span class="command"><strong>+=</strong></span> to ensure that
1.1       dsieger  4782:          we're appending to any pre-existing list of values.  This
                   4783:          variable should be set to the first version of the
1.26      wiz      4784:          package that had an backwards-incompatible API change.
1.1       dsieger  4785:          </p></li>
1.23      wiz      4786: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
1.1       dsieger  4787:          is the location of the <em class="replaceable"><code>pkg</code></em>
                   4788:          pkgsrc directory.</p></li>
1.23      wiz      4789: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.1       dsieger  4790:          (not shown above) controls whether we use
                   4791:          <code class="varname">BUILD_DEPENDS</code> or
                   4792:          <code class="varname">DEPENDS</code> to add the dependency on
                   4793:          <em class="replaceable"><code>pkg</code></em>.  The build dependency is
                   4794:          selected by setting
                   4795:          <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.23      wiz      4796:          to <span class="quote">&#8220;<span class="quote">build</span>&#8221;</span>.  By default, the full dependency is
1.1       dsieger  4797:          used.</p></li>
1.23      wiz      4798: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
1.1       dsieger  4799:            and
                   4800:            <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
                   4801:            (not shown above) are lists of subdirectories of
                   4802:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
                   4803:            to add to the header and library search paths.  These
1.23      wiz      4804:            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.1       dsieger  4805:          respectively.</p></li>
1.23      wiz      4806: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
1.1       dsieger  4807:            (not shown above) is the list of preprocessor flags to add
                   4808:            to <code class="varname">CPPFLAGS</code>, which are passed on to the
1.23      wiz      4809:            configure and build phases.  The <span class="quote">&#8220;<span class="quote">-I</span>&#8221;</span> option
1.1       dsieger  4810:            should be avoided and instead be handled using
                   4811:            <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
                   4812:          above.</p></li>
                   4813: </ul></div>
                   4814: <p>The following variables are all optionally defined within
                   4815:       this second section (protected against multiple inclusion) and
                   4816:       control which package files are symlinked into
                   4817:       <code class="filename">${BUILDLINK_DIR}</code> and how their names are
                   4818:       transformed during the symlinking:</p>
1.41      asau     4819: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      4820: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
1.1       dsieger  4821:            (not shown above) is a shell glob pattern relative to
                   4822:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
                   4823:            to be symlinked into
                   4824:            <code class="filename">${BUILDLINK_DIR}</code>,
                   4825:          e.g. <code class="filename">include/*.h</code>.</p></li>
1.23      wiz      4826: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
1.1       dsieger  4827:            (not shown above) is a shell pipeline that
                   4828:            outputs to stdout a list of files relative to
                   4829:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
                   4830:            The resulting files are to be symlinked
                   4831:            into <code class="filename">${BUILDLINK_DIR}</code>.  By default,
                   4832:            this takes the <code class="filename">+CONTENTS</code> of a
                   4833:            <em class="replaceable"><code>pkg</code></em> and filters it through
                   4834:            <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
1.23      wiz      4835: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.1       dsieger  4836:            (not shown above) is a filter command that filters
                   4837:            <code class="filename">+CONTENTS</code> input into a list of files
                   4838:            relative to
                   4839:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.84      wiz      4840:            on stdout.  By default,
1.1       dsieger  4841:            <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
                   4842:            outputs the contents of the <code class="filename">include</code>
                   4843:            and <code class="filename">lib</code> directories in the package
1.84      wiz      4844:            <code class="filename">+CONTENTS</code>.</p></li>
1.23      wiz      4845: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
1.1       dsieger  4846:            (not shown above) is a list of sed arguments used to
                   4847:            transform the name of the source filename into a
1.10      hubertf  4848:            destination filename, e.g. <span class="command"><strong>-e
1.1       dsieger  4849:            "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
                   4850: </ul></div>
1.18      snj      4851: <p>This section can additionally include any
1.1       dsieger  4852:       <code class="filename">buildlink3.mk</code> needed for
                   4853:       <em class="replaceable"><code>pkg</code></em>'s library dependencies.
                   4854:       Including these <code class="filename">buildlink3.mk</code> files
                   4855:       means that the headers and libraries for these
                   4856:       dependencies are also symlinked into
                   4857:       <code class="filename">${BUILDLINK_DIR}</code>
                   4858:       whenever the <em class="replaceable"><code>pkg</code></em>
                   4859:       <code class="filename">buildlink3.mk</code>
1.18      snj      4860:       file is included. Dependencies are only added for directly
                   4861:       include <code class="filename">buildlink3.mk</code> files.</p>
1.47      wiz      4862: <p>When providing a <code class="filename">buildlink3.mk</code> and
                   4863:       including other <code class="filename">buildlink3.mk</code> files in it,
1.50      wiz      4864:       please only add necessary ones, i.e., those whose libraries or
1.47      wiz      4865:       header files are automatically exposed when the package is
                   4866:       use.</p>
                   4867: <p>In particular, if only an executable
                   4868:       (<code class="filename">bin/foo</code>) is linked against a library, that
                   4869:       library does not need to be propagated in the
                   4870:       <code class="filename">buildlink3.mk</code> file.</p>
                   4871: <p>The following steps should help you decide if a
                   4872:       <code class="filename">buildlink3.mk</code> file needs to be included:
                   4873:       </p>
                   4874: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   4875: <li class="listitem"><p>Look at the installed header files: What
                   4876:        headers do they include? The packages providing these files
                   4877:        must be buildlinked.</p></li>
1.49      wiz      4878: <li class="listitem"><p>Run <code class="filename">ldd</code> on all installed
                   4879:        libraries and look against what other libraries they link.
                   4880:        Some of the packages providing these probably need to be
                   4881:        buildlinked; however, it's not automatic, since e.g. GTK on
                   4882:        some systems pulls in the X libraries, so they will show up in
                   4883:        the <code class="filename">ldd</code> output, while on others (like OS
1.50      wiz      4884:        X) it won't. <code class="filename">ldd</code> output can thus only be
1.49      wiz      4885:        used as a hint.</p></li>
1.47      wiz      4886: </ul></div>
                   4887: <p>
                   4888:       </p>
1.1       dsieger  4889: </div>
1.41      asau     4890: <div class="sect2">
1.1       dsieger  4891: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   4892: <a name="updating-buildlink-depends"></a>16.2.2. Updating
1.1       dsieger  4893:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.26      wiz      4894:       and
                   4895:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   4896:       in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
                   4897: <p>These two variables differ in that one describes source
                   4898:       compatibility (API) and the other binary compatibility (ABI).
                   4899:       The difference is that a change in the API breaks compilation of
                   4900:       programs while changes in the ABI stop compiled programs from
                   4901:       running.</p>
                   4902: <p>Changes to the
1.27      wiz      4903:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.26      wiz      4904:       variable in a <code class="filename">buildlink3.mk</code> file happen
                   4905:       very rarely. One possible reason is that all packages depending
                   4906:       on this already need a newer version. In case it is bumped see
                   4907:       the description below.</p>
                   4908: <p>The most common example of an ABI change is that the major
                   4909:       version of a shared library is increased. In this case,
                   4910:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   4911:       should be adjusted to require at least the new package version.
                   4912:       Then the packages that depend on this package need their
                   4913:       <code class="varname">PKGREVISION</code>s increased and, if they have
                   4914:       <code class="filename">buildlink3.mk</code> files, their
                   4915:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   4916:       adjusted, too. This is needed so pkgsrc will require the correct
                   4917:       package dependency and not settle for an older one when building
                   4918:       the source.</p>
1.154     rillig   4919: <p>See <a class="xref" href="#dependencies" title="21.1.5. Handling dependencies">Section 21.1.5, &#8220;Handling dependencies&#8221;</a> for
1.26      wiz      4920:       more information about dependencies on other packages,
                   4921:       including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
1.1       dsieger  4922:       <code class="varname">ABI_DEPENDS</code> definitions.</p>
                   4923: <p>Please take careful consideration before adjusting
                   4924:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   4925:       or
                   4926:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   4927:       as we don't want to cause unneeded package deletions and
                   4928:       rebuilds.  In many cases, new versions of packages work just
                   4929:       fine with older dependencies.</p>
                   4930: <p>Also it is not needed to set
1.26      wiz      4931:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   4932:       when it is identical to
1.1       dsieger  4933:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.        </p>
                   4934: </div>
                   4935: </div>
1.41      asau     4936: <div class="sect1">
1.1       dsieger  4937: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   4938: <a name="writing-builtin.mk"></a>16.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.1       dsieger  4939: <p>Some packages in pkgsrc install headers and libraries that
                   4940:       coincide with headers and libraries present in the base system.
                   4941:       Aside from a <code class="filename">buildlink3.mk</code> file, these
                   4942:       packages should also include a <code class="filename">builtin.mk</code>
                   4943:       file that includes the necessary checks to decide whether using
                   4944:       the built-in software or the pkgsrc software is
                   4945:     appropriate.</p>
                   4946: <p>The only requirements of a builtin.mk file for
                   4947:     <em class="replaceable"><code>pkg</code></em> are:</p>
1.23      wiz      4948: <div class="orderedlist"><ol class="orderedlist" type="1">
                   4949: <li class="listitem"><p>It should set
1.1       dsieger  4950:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23      wiz      4951:        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.1       dsieger  4952:        after it is included.</p></li>
1.23      wiz      4953: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
1.1       dsieger  4954:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   4955:        which is already set before the
                   4956:        <code class="filename">builtin.mk</code> file is included.</p></li>
1.23      wiz      4957: <li class="listitem"><p>It should be written to allow multiple inclusion.  This
1.1       dsieger  4958:        is <span class="emphasis"><em>very</em></span> important and takes careful
                   4959:        attention to <code class="filename">Makefile</code> coding.</p></li>
                   4960: </ol></div>
1.41      asau     4961: <div class="sect2">
1.1       dsieger  4962: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   4963: <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.1       dsieger  4964: <p>The following is the recommended template for builtin.mk
                   4965:       files:</p>
                   4966: <pre class="programlisting">
                   4967: .if !defined(IS_BUILTIN.foo)
                   4968: #
                   4969: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
                   4970: # genuinely exists in the system or not.
                   4971: #
                   4972: IS_BUILTIN.foo?=        no
                   4973: 
                   4974: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
                   4975: # version can be determined.
                   4976: #
                   4977: .  if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
                   4978: BUILTIN_PKG.foo?=       foo-1.0
                   4979: .  endif
                   4980: .endif  # IS_BUILTIN.foo
                   4981: 
                   4982: .if !defined(USE_BUILTIN.foo)
                   4983: USE_BUILTIN.foo?=       ${IS_BUILTIN.foo}
                   4984: .  if defined(BUILTIN_PKG.foo)
                   4985: .    for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
                   4986: .      if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
                   4987: USE_BUILTIN.foo!=                                                       \
                   4988:         ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo}            \
                   4989:         &amp;&amp; ${ECHO} "yes" || ${ECHO} "no"
                   4990: .      endif
                   4991: .    endfor
                   4992: .  endif
                   4993: .endif  # USE_BUILTIN.foo
                   4994: 
                   4995: CHECK_BUILTIN.foo?=     no
                   4996: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
                   4997: #
                   4998: # Here we place code that depends on whether USE_BUILTIN.foo is set to
                   4999: # "yes" or "no".
                   5000: #
                   5001: .endif  # CHECK_BUILTIN.foo
                   5002: </pre>
                   5003: <p>The first section sets
                   5004:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5005:       depending on if <em class="replaceable"><code>pkg</code></em> really exists
                   5006:       in the base system.  This should not be a base system software
                   5007:       with similar functionality to <em class="replaceable"><code>pkg</code></em>;
1.23      wiz      5008:       it should only be <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> if the actual package is
1.1       dsieger  5009:       included as part of the base system.  This variable is only
                   5010:       used internally within the <code class="filename">builtin.mk</code>
                   5011:       file.</p>
                   5012: <p>The second section sets
                   5013:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   5014:       to the version of <em class="replaceable"><code>pkg</code></em> in the base
                   5015:       system if it exists (if
                   5016:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23      wiz      5017:       is <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>).  This variable is only used internally
1.1       dsieger  5018:       within the <code class="filename">builtin.mk</code> file.</p>
                   5019: <p>The third section sets
                   5020:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5021:       and is <span class="emphasis"><em>required</em></span> in all
                   5022:       <code class="filename">builtin.mk</code> files.  The code in this
                   5023:       section must make the determination whether the built-in
                   5024:       software is adequate to satisfy the dependencies listed in
                   5025:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   5026:       This is typically done by comparing
                   5027:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   5028:       against each of the dependencies in
                   5029:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   5030:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5031:       <span class="emphasis"><em>must</em></span> be set to the correct value by the
                   5032:       end of the <code class="filename">builtin.mk</code> file.  Note that
                   5033:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23      wiz      5034:       may be <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> even if
1.1       dsieger  5035:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23      wiz      5036:       is <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span> because we may make the determination
1.1       dsieger  5037:       that the built-in version of the software is similar enough to
                   5038:       be used as a replacement.</p>
                   5039: <p>The last section is guarded by
                   5040:       <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
                   5041:       and includes code that uses the value of
                   5042:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5043:       set in the previous section.  This typically includes, e.g.,
                   5044:       adding additional dependency restrictions and listing additional
                   5045:       files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
                   5046:       <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
                   5047: </div>
1.41      asau     5048: <div class="sect2">
1.1       dsieger  5049: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   5050: <a name="native-or-pkgsrc-preference"></a>16.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.1       dsieger  5051: <p>When building packages, it's possible to choose whether to set
                   5052:        a global preference for using either the built-in (native)
                   5053:        version or the pkgsrc version of software to satisfy a
                   5054:        dependency.  This is controlled by setting
                   5055:        <code class="varname">PREFER_PKGSRC</code> and
                   5056:        <code class="varname">PREFER_NATIVE</code>.  These variables take values
1.23      wiz      5057:        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.1       dsieger  5058:        packages.  <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
                   5059:        use the pkgsrc versions of software, while
                   5060:        <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
                   5061:        built-in versions.  Preferences are determined by the most
                   5062:        specific instance of the package in either
                   5063:        <code class="varname">PREFER_PKGSRC</code> or
                   5064:        <code class="varname">PREFER_NATIVE</code>.  If a package is specified
                   5065:        in neither or in both variables, then
                   5066:        <code class="varname">PREFER_PKGSRC</code> has precedence over
                   5067:        <code class="varname">PREFER_NATIVE</code>.  For example, to require
                   5068:        using pkgsrc versions of software for all but the most basic
                   5069:       bits on a NetBSD system, you can set:</p>
                   5070: <pre class="programlisting">
                   5071: PREFER_PKGSRC=  yes
                   5072: PREFER_NATIVE=  getopt skey tcp_wrappers
                   5073: </pre>
                   5074: <p>A package <span class="emphasis"><em>must</em></span> have a
                   5075:       <code class="filename">builtin.mk</code>
                   5076:       file to be listed in <code class="varname">PREFER_NATIVE</code>,
                   5077:       otherwise it is simply ignored in that list.</p>
1.117     sevan    5078: <p>Setting <code class="varname">PREFER_NATIVE</code> should be performed
                   5079:       straight after bootstrap and <code class="varname">PREFER_PKGSRC</code> during
                   5080:       bootstrap.
                   5081:       Switching between settings globally at a later date can introduce
                   5082:       complications with dependency resolution. This is caused by packages
                   5083:       built with the opposite preference being installed alongside each other.</p>
                   5084: <pre class="screen">
                   5085: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap --prefer-pkgsrc yes</code></strong>
                   5086: </pre>
1.1       dsieger  5087: </div>
                   5088: </div>
                   5089: </div>
1.41      asau     5090: <div class="chapter">
1.1       dsieger  5091: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   5092: <a name="pkginstall"></a>Chapter 17. The pkginstall framework</h2></div></div></div>
1.1       dsieger  5093: <div class="toc">
                   5094: <p><b>Table of Contents</b></p>
1.100     leot     5095: <dl class="toc">
1.154     rillig   5096: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">17.1. Files and directories outside the installation prefix</a></span></dt>
1.1       dsieger  5097: <dd><dl>
1.154     rillig   5098: <dt><span class="sect2"><a href="#dirs-outside-prefix">17.1.1. Directory manipulation</a></span></dt>
                   5099: <dt><span class="sect2"><a href="#files-outside-prefix">17.1.2. File manipulation</a></span></dt>
1.1       dsieger  5100: </dl></dd>
1.154     rillig   5101: <dt><span class="sect1"><a href="#conf-files">17.2. Configuration files</a></span></dt>
1.1       dsieger  5102: <dd><dl>
1.154     rillig   5103: <dt><span class="sect2"><a href="#conf-files-sysconfdir">17.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
                   5104: <dt><span class="sect2"><a href="#conf-files-configure">17.2.2. Telling the software where configuration files are</a></span></dt>
                   5105: <dt><span class="sect2"><a href="#conf-files-patching">17.2.3. Patching installations</a></span></dt>
                   5106: <dt><span class="sect2"><a href="#conf-files-disable">17.2.4. Disabling handling of configuration files</a></span></dt>
                   5107: </dl></dd>
                   5108: <dt><span class="sect1"><a href="#rcd-scripts">17.3. System startup scripts</a></span></dt>
                   5109: <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>
                   5110: <dt><span class="sect1"><a href="#users-and-groups">17.4. System users and groups</a></span></dt>
                   5111: <dt><span class="sect1"><a href="#shells">17.5. System shells</a></span></dt>
                   5112: <dd><dl><dt><span class="sect2"><a href="#shells-disable">17.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   5113: <dt><span class="sect1"><a href="#fonts">17.6. Fonts</a></span></dt>
                   5114: <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.1       dsieger  5115: </dl>
                   5116: </div>
                   5117: <p>This chapter describes the framework known as
                   5118: <code class="literal">pkginstall</code>, whose key features are:</p>
1.41      asau     5119: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      5120: <li class="listitem"><p>Generic installation and manipulation of directories and files
1.1       dsieger  5121:     outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
1.23      wiz      5122: <li class="listitem"><p>Automatic handling of configuration files during installation,
1.1       dsieger  5123:     provided that packages are correctly designed.</p></li>
1.23      wiz      5124: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
                   5125: <li class="listitem"><p>Registration of system users and groups.</p></li>
                   5126: <li class="listitem"><p>Registration of system shells.</p></li>
                   5127: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
1.1       dsieger  5128: </ul></div>
                   5129: <p>The following sections inspect each of the above points in detail.</p>
                   5130: <p>You may be thinking that many of the things described here could be
                   5131: easily done with simple code in the package's post-installation target
                   5132: (<code class="literal">post-install</code>).  <span class="emphasis"><em>This is incorrect</em></span>,
                   5133: as the code in them is only executed when building from source.  Machines
                   5134: using binary packages could not benefit from it at all (as the code itself
                   5135: could be unavailable).  Therefore, the only way to achieve any of the items
                   5136: described above is by means of the installation scripts, which are
                   5137: automatically generated by pkginstall.</p>
1.41      asau     5138: <div class="sect1">
1.1       dsieger  5139: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   5140: <a name="files-and-dirs-outside-prefix"></a>17.1. Files and directories outside the installation prefix</h2></div></div></div>
1.1       dsieger  5141: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
                   5142: of files and directories that belong to a package.  The names used in it
                   5143: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
                   5144: which means that it cannot register files outside this directory (absolute
                   5145: path names are not allowed).  Despite this restriction, some packages need
                   5146: to install files outside this location; e.g., under
                   5147: <code class="filename">${VARBASE}</code> or
                   5148: <code class="filename">${PKG_SYSCONFDIR}</code>.  The only way to achieve this
                   5149: is to create such files during installation time by using
                   5150: installation scripts.</p>
                   5151: <p>The generic installation scripts are shell scripts that can
                   5152: contain arbitrary code.  The list of scripts to execute is taken from
                   5153: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
                   5154: <code class="filename">INSTALL</code>.  A similar variable exists for package
                   5155: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
                   5156: <code class="filename">DEINSTALL</code>).  These scripts can run arbitrary
                   5157: commands, so they have the potential to create and manage files
                   5158: anywhere in the file system.</p>
                   5159: <p>Using these general installation files is not recommended, but
                   5160: may be needed in some special cases.  One reason for avoiding them is
                   5161: that the user has to trust the packager that there is no unwanted or
                   5162: simply erroneous code included in the installation script. Also,
                   5163: previously there were many similar scripts for the same functionality,
                   5164: and fixing a common error involved finding and changing all of
                   5165: them.</p>
                   5166: <p>The pkginstall framework offers another, standardized way.  It
                   5167: provides generic scripts to abstract the manipulation of such files
                   5168: and directories based on variables set in the package's
                   5169: <code class="filename">Makefile</code>.  The rest of this section describes
                   5170: these variables.</p>
1.41      asau     5171: <div class="sect2">
1.1       dsieger  5172: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   5173: <a name="dirs-outside-prefix"></a>17.1.1. Directory manipulation</h3></div></div></div>
1.1       dsieger  5174: <p>The following variables can be set to request the creation of
                   5175: directories anywhere in the file system:</p>
1.41      asau     5176: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.108     rillig   5177: <li class="listitem">
                   5178: <p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
1.1       dsieger  5179:     contain a list of directories that should be created and should attempt
                   5180:     to be destroyed by the installation scripts.  The difference between
                   5181:     the two is that the latter prompts the administrator to remove any
                   5182:     directories that may be left after deinstallation (because they were
1.108     rillig   5183:     not empty), while the former does not.  Example:</p>
                   5184: <pre class="programlisting">
                   5185: MAKE_DIRS+=             ${VARBASE}/foo/private
                   5186: </pre>
                   5187: </li>
1.23      wiz      5188: <li class="listitem">
1.1       dsieger  5189: <p><code class="varname">MAKE_DIRS_PERMS</code> and
                   5190:     <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
                   5191:     which directories should be created and should attempt to be destroyed
                   5192:     by the installation scripts.  Each tuple holds the following values,
                   5193:     separated by spaces: the directory name, its owner, its group and its
                   5194:     numerical mode.  For example:</p>
                   5195: <pre class="programlisting">
1.108     rillig   5196: MAKE_DIRS_PERMS+=       ${VARBASE}/foo/private \
                   5197:                         ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1       dsieger  5198: </pre>
                   5199: <p>The difference between the two is exactly the same as their
                   5200:     non-<code class="varname">PERMS</code> counterparts.</p>
                   5201: </li>
                   5202: </ul></div>
                   5203: </div>
1.41      asau     5204: <div class="sect2">
1.1       dsieger  5205: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   5206: <a name="files-outside-prefix"></a>17.1.2. File manipulation</h3></div></div></div>
1.1       dsieger  5207: <p>Creating non-empty files outside the installation prefix is tricky
                   5208: because the <code class="filename">PLIST</code> forces all files to be inside it.
                   5209: To overcome this problem, the only solution is to extract the file in the
                   5210: known place (i.e., inside the installation prefix) and copy it to the
                   5211: appropriate location during installation (done by the installation scripts
                   5212: generated by pkginstall).  We will call the former the <span class="emphasis"><em>master
                   5213: file</em></span> in the following paragraphs, which describe the variables
                   5214: that can be used to automatically and consistently handle files outside the
                   5215: installation prefix:</p>
1.41      asau     5216: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      5217: <li class="listitem">
1.1       dsieger  5218: <p><code class="varname">CONF_FILES</code> and
1.30      wiz      5219:     <code class="varname">REQD_FILES</code> are pairs of master and target files.
1.1       dsieger  5220:     During installation time, the master file is copied to the target one
                   5221:     if and only if the latter does not exist.  Upon deinstallation, the
                   5222:     target file is removed provided that it was not modified by the
                   5223:     installation.</p>
                   5224: <p>The difference between the two is that the latter prompts the
                   5225:     administrator to remove any files that may be left after
                   5226:     deinstallation (because they were not empty), while the former does
                   5227:     not.</p>
                   5228: </li>
1.23      wiz      5229: <li class="listitem">
1.1       dsieger  5230: <p><code class="varname">CONF_FILES_PERMS</code> and
1.30      wiz      5231:     <code class="varname">REQD_FILES_PERMS</code> contain tuples describing master
1.1       dsieger  5232:     files as well as their target locations.  For each of them, it also
                   5233:     specifies their owner, their group and their numeric permissions, in
                   5234:     this order.  For example:</p>
                   5235: <pre class="programlisting">
1.108     rillig   5236: REQD_FILES_PERMS+=      ${PREFIX}/share/somefile ${VARBASE}/somefile \
                   5237:                         ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1       dsieger  5238: </pre>
                   5239: <p>The difference between the two is exactly the same as their
                   5240:     non-<code class="varname">PERMS</code> counterparts.</p>
                   5241: </li>
                   5242: </ul></div>
                   5243: </div>
                   5244: </div>
1.41      asau     5245: <div class="sect1">
1.1       dsieger  5246: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   5247: <a name="conf-files"></a>17.2. Configuration files</h2></div></div></div>
1.1       dsieger  5248: <p>Configuration files are special in the sense that they are installed
                   5249: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
                   5250: need special treatment during installation (most of which is automated by
                   5251: pkginstall).  The main concept you must bear in mind is that files marked
                   5252: as configuration files are automatically copied to the right place (somewhere
                   5253: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
                   5254: and only if</em></span> they didn't exist before.  Similarly, they will not
                   5255: be removed if they have local modifications.  This ensures that
                   5256: administrators never lose any custom changes they may have made.</p>
1.41      asau     5257: <div class="sect2">
1.1       dsieger  5258: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   5259: <a name="conf-files-sysconfdir"></a>17.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</h3></div></div></div>
1.1       dsieger  5260: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
                   5261: specifies where configuration files shall be installed.  Its contents are
                   5262: set based upon the following variables:</p>
1.41      asau     5263: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      5264: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
1.1       dsieger  5265:     directory.  Defaults to <code class="filename">${PREFIX}/etc</code> although it may
                   5266:     be overridden by the user to point to his preferred location (e.g.,
                   5267:     <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
                   5268:     Packages must not use it directly.</p></li>
1.23      wiz      5269: <li class="listitem">
1.1       dsieger  5270: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
                   5271:     <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
                   5272:     for the package being built shall be installed.  The definition of this
                   5273:     variable only makes sense in the package's
                   5274:     <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
                   5275: <p>As an example, consider the Apache package,
1.137     leot     5276:     <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.1       dsieger  5277:     configuration files under the
                   5278:     <code class="filename">httpd/</code> subdirectory of
                   5279:     <code class="varname">PKG_SYSCONFBASE</code>.  This should be set in the package
                   5280:     Makefile.</p>
                   5281: </li>
1.23      wiz      5282: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
1.1       dsieger  5283:     variable that holds this package's configuration directory (if
                   5284:     different from <code class="varname">PKG_SYSCONFBASE</code>).  It defaults to
                   5285:     <code class="varname">PKGBASE</code>'s value, and is always prefixed with
                   5286:     <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
1.23      wiz      5287: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
1.1       dsieger  5288:     directory where the configuration files for the package identified by
                   5289:     <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
                   5290: </ul></div>
                   5291: <p>Based on the above variables, pkginstall determines the value of
                   5292: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
                   5293: variable that can be used within a package to refer to its configuration
                   5294: directory.  The algorithm used to set its value is basically the
                   5295: following:</p>
1.23      wiz      5296: <div class="orderedlist"><ol class="orderedlist" type="1">
                   5297: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
1.1       dsieger  5298:     its value is used.</p></li>
1.23      wiz      5299: <li class="listitem"><p>If the previous variable is not defined but
1.1       dsieger  5300:     <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
                   5301:     <code class="filename">Makefile</code>, the resulting value is
                   5302:     <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
1.23      wiz      5303: <li class="listitem"><p>Otherwise, it is set to
1.1       dsieger  5304:     <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
                   5305: </ol></div>
                   5306: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.154     rillig   5307: 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.16      jnemeth  5308: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
                   5309: be created with OWN_DIRS or MAKE_DIRS.</p>
1.1       dsieger  5310: </div>
1.41      asau     5311: <div class="sect2">
1.1       dsieger  5312: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   5313: <a name="conf-files-configure"></a>17.2.2. Telling the software where configuration files are</h3></div></div></div>
1.1       dsieger  5314: <p>Given that pkgsrc (and users!) expect configuration files to be in a
                   5315: known place, you need to teach each package where it shall install its
                   5316: files.  In some cases you will have to patch the package Makefiles to
                   5317: achieve it.  If you are lucky, though, it may be as easy as passing an
                   5318: extra flag to the configuration script; this is the case of GNU Autoconf-
                   5319: generated files:</p>
                   5320: <pre class="programlisting">
                   5321: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
                   5322: </pre>
                   5323: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
                   5324: for</em></span> its configuration files, not where they will be originally
                   5325: installed (although the difference is never explicit,
                   5326: unfortunately).</p>
                   5327: </div>
1.41      asau     5328: <div class="sect2">
1.1       dsieger  5329: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   5330: <a name="conf-files-patching"></a>17.2.3. Patching installations</h3></div></div></div>
1.1       dsieger  5331: <p>As said before, pkginstall automatically handles configuration files.
                   5332: This means that <span class="strong"><strong>the packages themselves must not
                   5333: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
                   5334: directly</strong></span>.  Bad news is that many software installation scripts
                   5335: will, out of the box, mess with the contents of that directory.  So what is
                   5336: the correct procedure to fix this issue?</p>
                   5337: <p>You must teach the package (usually by manually patching it) to
                   5338: install any configuration files under the examples hierarchy,
                   5339: <code class="filename">share/examples/${PKGBASE}/</code>.  This way, the
                   5340: <code class="filename">PLIST</code> registers them and the administrator always
                   5341: has the original copies available.</p>
                   5342: <p>Once the required configuration files are in place (i.e., under the
                   5343: examples hierarchy), the pkginstall framework can use them as master copies
                   5344: during the package installation to update what is in
                   5345: <code class="filename">${PKG_SYSCONFDIR}</code>.  To achieve this, the variables
                   5346: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.154     rillig   5347: 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.1       dsieger  5348: about their syntax and their purpose.  Here is an example, taken from the
1.137     leot     5349: <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/mail/mutt/README.html" target="_top"><code class="filename">mail/mutt</code></a> package:</p>
1.1       dsieger  5350: <pre class="programlisting">
                   5351: EGDIR=        ${PREFIX}/share/doc/mutt/samples
                   5352: CONF_FILES=   ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
                   5353: </pre>
                   5354: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
                   5355: package and has no meaning outside it.</p>
                   5356: </div>
1.41      asau     5357: <div class="sect2">
1.1       dsieger  5358: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   5359: <a name="conf-files-disable"></a>17.2.4. Disabling handling of configuration files</h3></div></div></div>
1.1       dsieger  5360: <p>The automatic copying of config files can be toggled by setting the
                   5361: environment variable <code class="varname">PKG_CONFIG</code> prior to package
                   5362: installation.</p>
                   5363: </div>
                   5364: </div>
1.41      asau     5365: <div class="sect1">
1.1       dsieger  5366: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   5367: <a name="rcd-scripts"></a>17.3. System startup scripts</h2></div></div></div>
1.1       dsieger  5368: <p>System startup scripts are special files because they must be
                   5369: installed in a place known by the underlying OS, usually outside the
1.154     rillig   5370: 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.1       dsieger  5371: can be used.  However, pkginstall provides a special mechanism to handle
                   5372: these files.</p>
                   5373: <p>In order to provide system startup scripts, the package has
                   5374: to:</p>
1.23      wiz      5375: <div class="orderedlist"><ol class="orderedlist" type="1">
                   5376: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
1.1       dsieger  5377:     the <code class="literal">.sh</code> suffix appended.  Considering the
1.137     leot     5378:     <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.1       dsieger  5379:     <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.23      wiz      5380: <li class="listitem">
1.1       dsieger  5381: <p>Tell pkginstall to handle it, appending the name of the script,
                   5382:     without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
                   5383:     Continuing the previous example:</p>
                   5384: <pre class="programlisting">
                   5385: RCD_SCRIPTS+=   cupsd
                   5386: </pre>
                   5387: </li>
                   5388: </ol></div>
                   5389: <p>Once this is done, pkginstall will do the following steps for each
                   5390: script in an automated fashion:</p>
1.23      wiz      5391: <div class="orderedlist"><ol class="orderedlist" type="1">
                   5392: <li class="listitem"><p>Process the file found in the files directory applying all the
1.1       dsieger  5393:     substitutions described in the <code class="filename">FILES_SUBST</code>
                   5394:     variable.</p></li>
1.23      wiz      5395: <li class="listitem"><p>Copy the script from the files directory to the examples
1.1       dsieger  5396:     hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>.  Note
                   5397:     that this master file must be explicitly registered in the
                   5398:     <code class="filename">PLIST</code>.</p></li>
1.23      wiz      5399: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
1.1       dsieger  5400:     from the examples hierarchy into the system-wide startup scripts
                   5401:     directory.</p></li>
                   5402: </ol></div>
1.41      asau     5403: <div class="sect2">
1.1       dsieger  5404: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   5405: <a name="rcd-scripts-disable"></a>17.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.1       dsieger  5406: <p>The automatic copying of config files can be toggled by setting the
                   5407: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
                   5408: installation.  Note that the scripts will be always copied inside the
                   5409: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
                   5410: matter what the value of this variable is.</p>
                   5411: </div>
                   5412: </div>
1.41      asau     5413: <div class="sect1">
1.1       dsieger  5414: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   5415: <a name="users-and-groups"></a>17.4. System users and groups</h2></div></div></div>
1.1       dsieger  5416: <p>If a package needs to create special users and/or groups during
                   5417: installation, it can do so by using the pkginstall framework.</p>
                   5418: <p>Users can be created by adding entries to the
                   5419: <code class="varname">PKG_USERS</code> variable.  Each entry has the following
                   5420: syntax:</p>
                   5421: <pre class="programlisting">
                   5422: user:group
                   5423: </pre>
                   5424: <p>Further specification of user details may be done by setting
                   5425: per-user variables.
                   5426: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
                   5427: numeric UID for the user.
                   5428: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
                   5429: user's description or comment.
                   5430: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
                   5431: user's home directory, and defaults to
                   5432: <code class="filename">/nonexistent</code> if not specified.
                   5433: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
                   5434: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
                   5435: not specified.</p>
                   5436: <p>Similarly, groups can be created by adding entries to the
                   5437: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
                   5438: <pre class="programlisting">
                   5439: group
                   5440: </pre>
                   5441: <p>The numeric GID of the group may be set by defining
                   5442: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
                   5443: <p>If a package needs to create the users and groups at an earlier
1.116     wiz      5444: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to either
                   5445: <code class="literal">configure</code>,<code class="literal">build</code>, or
                   5446: <code class="literal">pre-install</code> to indicate the phase before which the
                   5447: users and groups are created. In this case, the numeric UIDs and GIDs
                   5448: of the created users and groups are automatically hardcoded into the
                   5449: final installation scripts.</p>
1.1       dsieger  5450: </div>
1.41      asau     5451: <div class="sect1">
1.1       dsieger  5452: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   5453: <a name="shells"></a>17.5. System shells</h2></div></div></div>
1.1       dsieger  5454: <p>Packages that install system shells should register them in the shell
                   5455: database, <code class="filename">/etc/shells</code>, to make things easier to the
                   5456: administrator.  This must be done from the installation scripts to keep
                   5457: binary packages working on any system.  pkginstall provides an easy way to
                   5458: accomplish this task.</p>
                   5459: <p>When a package provides a shell interpreter, it has to set the
                   5460: <code class="varname">PKG_SHELL</code> variable to its absolute file name.  This will
                   5461: add some hooks to the installation scripts to handle it.  Consider the
1.137     leot     5462: 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.1       dsieger  5463: <pre class="programlisting">
                   5464: PKG_SHELL=      ${PREFIX}/bin/zsh
                   5465: </pre>
1.41      asau     5466: <div class="sect2">
1.1       dsieger  5467: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   5468: <a name="shells-disable"></a>17.5.1. Disabling shell registration</h3></div></div></div>
1.1       dsieger  5469: <p>The automatic registration of shell interpreters can be disabled by
                   5470: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
                   5471: environment variable to <code class="literal">NO</code>.</p>
                   5472: </div>
                   5473: </div>
1.41      asau     5474: <div class="sect1">
1.1       dsieger  5475: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   5476: <a name="fonts"></a>17.6. Fonts</h2></div></div></div>
1.1       dsieger  5477: <p>Packages that install X11 fonts should update the database files
                   5478: that index the fonts within each fonts directory.  This can easily be
                   5479: accomplished within the pkginstall framework.</p>
                   5480: <p>When a package installs X11 fonts, it must list the directories in
                   5481: which fonts are installed in the
                   5482: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
1.23      wiz      5483: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">&#8220;<span class="quote">ttf</span>&#8221;</span>,
                   5484: <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.1       dsieger  5485: installation scripts to run the appropriate commands to update the fonts
                   5486: database files within each of those directories.  For convenience, if the
                   5487: directory path is relative, it is taken to be relative to the package's
1.137     leot     5488: installation prefix.  Consider the following example, taken from <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/fonts/dbz-ttf/README.html" target="_top"><code class="filename">fonts/dbz-ttf</code></a>:</p>
1.1       dsieger  5489: <pre class="programlisting">
1.67      wiz      5490: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF
1.1       dsieger  5491: </pre>
1.41      asau     5492: <div class="sect2">
1.1       dsieger  5493: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   5494: <a name="fonts-disable"></a>17.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.1       dsieger  5495: <p>The automatic update of fonts databases can be disabled by
                   5496: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
                   5497: environment variable to <code class="literal">NO</code>.</p>
                   5498: </div>
                   5499: </div>
                   5500: </div>
1.41      asau     5501: <div class="chapter">
1.1       dsieger  5502: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   5503: <a name="options"></a>Chapter 18. Options handling</h2></div></div></div>
1.1       dsieger  5504: <div class="toc">
                   5505: <p><b>Table of Contents</b></p>
1.100     leot     5506: <dl class="toc">
1.154     rillig   5507: <dt><span class="sect1"><a href="#global-default-options">18.1. Global default options</a></span></dt>
                   5508: <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>
                   5509: <dt><span class="sect1"><a href="#option-names">18.3. Option Names</a></span></dt>
                   5510: <dt><span class="sect1"><a href="#option-build">18.4. Determining the options of dependencies</a></span></dt>
1.1       dsieger  5511: </dl>
                   5512: </div>
                   5513: <p>Many packages have the ability to be built to support different
                   5514: sets of features.  <code class="filename">bsd.options.mk</code> is a framework
                   5515: in pkgsrc that provides generic handling of those options that
                   5516: determine different ways in which the packages can be built.  It's
                   5517: possible for the user to specify exactly which sets of options will be
                   5518: built into a package or to allow a set of global default options
                   5519: apply.</p>
1.7       rillig   5520: <p>There are two broad classes of behaviors that one might want to
                   5521: control via options.  One is whether some particular feature is
                   5522: enabled in a program that will be built anyway, often by including or
                   5523: not including a dependency on some other package.  The other is
                   5524: whether or not an additional program will be built as part of the
                   5525: package.  Generally, it is better to make a split package for such
                   5526: additional programs instead of using options, because it enables
                   5527: binary packages to be built which can then be added separately.  For
                   5528: example, the foo package might have minimal dependencies (those
                   5529: packages without which foo doesn't make sense), and then the foo-gfoo
                   5530: package might include the GTK frontend program gfoo.  This is better
                   5531: than including a gtk option to foo that adds gfoo, because either that
                   5532: option is default, in which case binary users can't get foo without
                   5533: gfoo, or not default, in which case they can't get gfoo.  With split
                   5534: packages, they can install foo without having GTK, and later decide to
                   5535: install gfoo (pulling in GTK at that time).  This is an advantage to
                   5536: source users too, avoiding the need for rebuilds.</p>
                   5537: <p>Plugins with widely varying dependencies should usually be split
                   5538: instead of options.</p>
                   5539: <p>It is often more work to maintain split packages, especially if
                   5540: the upstream package does not support this.  The decision of split
                   5541: vs. option should be made based on the likelihood that users will want
                   5542: or object to the various pieces, the size of the dependencies that are
                   5543: included, and the amount of work.</p>
                   5544: <p>A further consideration is licensing.  Non-free parts, or parts
                   5545: that depend on non-free dependencies (especially plugins) should
                   5546: almost always be split if feasible.</p>
1.41      asau     5547: <div class="sect1">
1.1       dsieger  5548: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   5549: <a name="global-default-options"></a>18.1. Global default options</h2></div></div></div>
1.1       dsieger  5550: <p>Global default options are listed in
                   5551: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
                   5552: that should be built into every package if that option is supported.
1.10      hubertf  5553: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1       dsieger  5554: </div>
1.41      asau     5555: <div class="sect1">
1.1       dsieger  5556: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   5557: <a name="converting-to-options"></a>18.2. Converting packages to use <code class="filename">bsd.options.mk</code>
1.1       dsieger  5558: </h2></div></div></div>
                   5559: <p>The following example shows how
                   5560: <code class="filename">bsd.options.mk</code> should be used
                   5561: by the hypothetical ``wibble'' package, either in the package
                   5562: <code class="filename">Makefile</code>, or in a file,
                   5563: e.g. <code class="filename">options.mk</code>, that is included by the
                   5564: main package <code class="filename">Makefile</code>.</p>
                   5565: <pre class="programlisting">
                   5566: PKG_OPTIONS_VAR=                PKG_OPTIONS.wibble
                   5567: PKG_SUPPORTED_OPTIONS=          wibble-foo ldap
                   5568: PKG_OPTIONS_OPTIONAL_GROUPS=    database
                   5569: PKG_OPTIONS_GROUP.database=     mysql pgsql
                   5570: PKG_SUGGESTED_OPTIONS=          wibble-foo
                   5571: PKG_OPTIONS_LEGACY_VARS+=       WIBBLE_USE_OPENLDAP:ldap
                   5572: PKG_OPTIONS_LEGACY_OPTS+=       foo:wibble-foo
                   5573: 
                   5574: .include "../../mk/bsd.prefs.mk"
                   5575: 
                   5576: # this package was previously named wibble2
                   5577: .if defined(PKG_OPTIONS.wibble2)
                   5578: PKG_LEGACY_OPTIONS+=            ${PKG_OPTIONS.wibble2}
                   5579: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
                   5580:         "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
                   5581: .endif
                   5582: 
                   5583: .include "../../mk/bsd.options.mk"
                   5584: 
                   5585: # Package-specific option-handling
                   5586: 
                   5587: ###
                   5588: ### FOO support
                   5589: ###
                   5590: .if !empty(PKG_OPTIONS:Mwibble-foo)
                   5591: CONFIGURE_ARGS+=    --enable-foo
                   5592: .endif
                   5593: 
                   5594: ###
                   5595: ### LDAP support
                   5596: ###
                   5597: .if !empty(PKG_OPTIONS:Mldap)
                   5598: .  include "../../databases/openldap-client/buildlink3.mk"
                   5599: CONFIGURE_ARGS+=    --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
                   5600: .endif
                   5601: 
                   5602: ###
                   5603: ### database support
                   5604: ###
                   5605: .if !empty(PKG_OPTIONS:Mmysql)
                   5606: .  include "../../mk/mysql.buildlink3.mk"
                   5607: .endif
                   5608: .if !empty(PKG_OPTIONS:Mpgsql)
                   5609: .  include "../../mk/pgsql.buildlink3.mk"
                   5610: .endif
                   5611: </pre>
                   5612: <p>The first section contains the information about which build
                   5613: options are supported by the package, and any default options settings
                   5614: if needed.</p>
1.23      wiz      5615: <div class="orderedlist"><ol class="orderedlist" type="1">
                   5616: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.167   ! leot     5617: <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> variable that the user can set to override the default
1.1       dsieger  5618: options.  It should be set to
                   5619: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
                   5620: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
                   5621: at the point where the options are processed.</p></li>
1.23      wiz      5622: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
1.1       dsieger  5623: build options supported by the package.</p></li>
1.23      wiz      5624: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
1.1       dsieger  5625: list of names of groups of mutually exclusive options.  The options in
                   5626: each group are listed in
                   5627: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
                   5628: The most specific setting of any option from the group takes
                   5629: precedence over all other options in the group.  Options from the
                   5630: groups will be automatically added to
                   5631: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
1.23      wiz      5632: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
1.1       dsieger  5633: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
                   5634: packages will fail if no option from the group is
                   5635: selected.</p></li>
1.23      wiz      5636: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
1.1       dsieger  5637: of names of sets of options.  At least one option from each set must
                   5638: be selected.  The options in each set are listed in
                   5639: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
                   5640: Options from the sets will be automatically added to
                   5641: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.  Building the package will
                   5642: fail if no option from the set is selected.</p></li>
1.23      wiz      5643: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
1.1       dsieger  5644: build options which are enabled by default.</p></li>
1.23      wiz      5645: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
1.1       dsieger  5646: of
1.23      wiz      5647: <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.10      hubertf  5648: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
1.1       dsieger  5649: their option counterparts.  Pairs should be added with
1.23      wiz      5650: <span class="quote">&#8220;<span class="quote">+=</span>&#8221;</span> to keep the listing of global legacy variables.  A
1.1       dsieger  5651: warning will be issued if the user uses a legacy
                   5652: variable.</p></li>
1.23      wiz      5653: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
1.1       dsieger  5654: of
1.23      wiz      5655: <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.1       dsieger  5656: pairs that map options that have been renamed to their new
1.23      wiz      5657: counterparts.  Pairs should be added with <span class="quote">&#8220;<span class="quote">+=</span>&#8221;</span> to keep
1.1       dsieger  5658: the listing of global legacy options.  A warning will be issued if
                   5659: the user uses a legacy option.</p></li>
1.23      wiz      5660: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
1.1       dsieger  5661: options implied by deprecated variables used.  This can be used for
                   5662: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
                   5663: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
                   5664: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
1.23      wiz      5665: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
1.1       dsieger  5666: a list of warnings about deprecated variables or options used, and
                   5667: what to use instead.</p></li>
                   5668: </ol></div>
                   5669: <p>A package should never modify
                   5670: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
                   5671: <code class="varname">PKG_OPTIONS_VAR</code>.  These are strictly user-settable.
                   5672: To suggest a default set of options, use
                   5673: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
                   5674: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
                   5675: including <code class="filename">bsd.options.mk</code>.  If none of
                   5676: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
                   5677: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
                   5678: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
                   5679: happen with platform-specific options if none of them is supported on
                   5680: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
                   5681: empty list and the package is otherwise treated as not using the
                   5682: options framework.</p>
                   5683: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
                   5684: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
                   5685: build options, properly filtered to remove unsupported and duplicate
                   5686: options.</p>
                   5687: <p>The remaining sections contain the logic that is specific to
                   5688: each option.  The correct way to check for an option is to check
                   5689: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
                   5690: <pre class="programlisting">
                   5691: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
                   5692: </pre>
                   5693: </div>
1.41      asau     5694: <div class="sect1">
1.1       dsieger  5695: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   5696: <a name="option-names"></a>18.3. Option Names</h2></div></div></div>
1.1       dsieger  5697: <p>Options that enable similar features in different packages (like
                   5698: optional support for a library) should use a common name in all
                   5699: packages that support it (like the name of the library).  If another
                   5700: package already has an option with the same meaning, use the same
                   5701: name.</p>
                   5702: <p>Options that enable features specific to one package, where it's
                   5703: unlikely that another (unrelated) package has the same (or a similar)
                   5704: optional feature, should use a name prefixed with
                   5705: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
                   5706: <p>If a group of related packages share an optional feature
                   5707: specific to that group, prefix it with the name of the
1.23      wiz      5708: <span class="quote">&#8220;<span class="quote">main</span>&#8221;</span> package
1.1       dsieger  5709: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
                   5710: <p>For new options, add a line to
                   5711: <code class="filename">mk/defaults/options.description</code>.  Lines have two
                   5712: fields, separated by tab.  The first field is the option name, the
                   5713: second its description.  The description should be a whole sentence
                   5714: (starting with an uppercase letter and ending with a period) that
1.23      wiz      5715: describes what enabling the option does.  E. g. <span class="quote">&#8220;<span class="quote">Enable ispell
                   5716: support.</span>&#8221;</span> The file is sorted by option names.</p>
1.1       dsieger  5717: </div>
1.41      asau     5718: <div class="sect1">
1.7       rillig   5719: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   5720: <a name="option-build"></a>18.4. Determining the options of dependencies</h2></div></div></div>
1.10      hubertf  5721: <p>When writing <a class="link" href="#buildlink3.mk"><code class="filename">buildlink3.mk</code></a> files, it is often necessary to list
1.7       rillig   5722: different dependencies based on the options with which the package was
                   5723: built. For querying these options, the file
                   5724: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
                   5725: typical example looks like this:</p>
                   5726: <pre class="programlisting">
                   5727: pkgbase := libpurple
                   5728: .include "../../mk/pkg-build-options.mk"
                   5729: 
                   5730: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
                   5731: ...
                   5732: .endif
                   5733: </pre>
                   5734: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
                   5735: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
                   5736: options of the libpurple package, which can then be queried like
                   5737: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
                   5738: file. See the file <code class="filename">pkg-build-options.mk</code> for more
                   5739: details.</p>
                   5740: </div>
1.1       dsieger  5741: </div>
1.41      asau     5742: <div class="chapter">
1.1       dsieger  5743: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   5744: <a name="build"></a>Chapter 19. The build process</h2></div></div></div>
1.1       dsieger  5745: <div class="toc">
                   5746: <p><b>Table of Contents</b></p>
1.100     leot     5747: <dl class="toc">
1.154     rillig   5748: <dt><span class="sect1"><a href="#build.intro">19.1. Introduction</a></span></dt>
                   5749: <dt><span class="sect1"><a href="#build.prefix">19.2. Program location</a></span></dt>
                   5750: <dt><span class="sect1"><a href="#build.builddirs">19.3. Directories used during the build process</a></span></dt>
                   5751: <dt><span class="sect1"><a href="#build.running">19.4. Running a phase</a></span></dt>
                   5752: <dt><span class="sect1"><a href="#build.fetch">19.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                   5753: <dd><dl>
                   5754: <dt><span class="sect2"><a href="#build.fetch.what">19.5.1. What to fetch and where to get it from</a></span></dt>
                   5755: <dt><span class="sect2"><a href="#build.fetch.how">19.5.2. How are the files fetched?</a></span></dt>
                   5756: </dl></dd>
                   5757: <dt><span class="sect1"><a href="#build.checksum">19.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                   5758: <dt><span class="sect1"><a href="#build.extract">19.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                   5759: <dt><span class="sect1"><a href="#build.patch">19.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                   5760: <dt><span class="sect1"><a href="#build.tools">19.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                   5761: <dt><span class="sect1"><a href="#build.wrapper">19.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                   5762: <dt><span class="sect1"><a href="#build.configure">19.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   5763: <dt><span class="sect1"><a href="#build.build">19.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   5764: <dt><span class="sect1"><a href="#build.test">19.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                   5765: <dt><span class="sect1"><a href="#build.install">19.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   5766: <dt><span class="sect1"><a href="#build.package">19.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
                   5767: <dt><span class="sect1"><a href="#build.clean">19.16. Cleaning up</a></span></dt>
                   5768: <dt><span class="sect1"><a href="#build.helpful-targets">19.17. Other helpful targets</a></span></dt>
1.1       dsieger  5769: </dl>
                   5770: </div>
1.41      asau     5771: <div class="sect1">
1.1       dsieger  5772: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   5773: <a name="build.intro"></a>19.1. Introduction</h2></div></div></div>
1.1       dsieger  5774: <p>This chapter gives a detailed description on how a package is
                   5775:     built. Building a package is separated into different
                   5776:     <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
                   5777:     <code class="varname">build</code>, <code class="varname">install</code>), all of which are
1.18      snj      5778:     described in the following sections. Each phase is split into
1.1       dsieger  5779:     so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
                   5780:     containing phase, prefixed by one of <code class="varname">pre-</code>,
                   5781:     <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
                   5782:     <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
                   5783:     of the actual work is done in the <code class="varname">do-*</code> stages.</p>
                   5784: <p>Never override the regular targets (like
                   5785:     <code class="varname">fetch</code>), if you have to, override the
                   5786:     <code class="varname">do-*</code> ones instead.</p>
                   5787: <p>The basic steps for building a program are always the same.  First
                   5788:     the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
                   5789:     the local system and then extracted. After any pkgsrc-specific patches
                   5790:     to compile properly are applied, the software can be configured, then
                   5791:     built (usually by compiling), and finally the generated binaries, etc.
                   5792:     can be put into place on the system.</p>
                   5793: <p>To get more details about what is happening at each step,
                   5794:     you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
                   5795:     <code class="varname">PATCH_DEBUG</code> variable if you are just interested
                   5796:     in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
                   5797: </div>
1.41      asau     5798: <div class="sect1">
1.1       dsieger  5799: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   5800: <a name="build.prefix"></a>19.2. Program location</h2></div></div></div>
1.1       dsieger  5801: <p>Before outlining the process performed by the NetBSD package system in
                   5802:     the next section, here's a brief discussion on where programs are
                   5803:     installed, and which variables influence this.</p>
                   5804: <p>The automatic variable <code class="varname">PREFIX</code> indicates
                   5805:     where all files of the final program shall be installed. It is
                   5806:     usually set to <code class="varname">LOCALBASE</code>
                   5807:     (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
                   5808:     for pkgs in the <code class="filename">cross</code> category.  The value of
                   5809:     <code class="varname">PREFIX</code> needs to be put
                   5810:     into the various places in the program's source where paths to
1.154     rillig   5811:     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.1       dsieger  5812: <p>When choosing which of these variables to use,
                   5813:     follow the following rules:</p>
1.41      asau     5814: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      5815: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
1.1       dsieger  5816:        where the current pkg will be installed.  When referring to a
                   5817:        pkg's own installation path, use
1.23      wiz      5818:        <span class="quote">&#8220;<span class="quote">${PREFIX}</span>&#8221;</span>.</p></li>
                   5819: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
1.1       dsieger  5820:        are installed.  If you need to construct a -I or -L argument
                   5821:        to the compiler to find includes and libraries installed by
1.23      wiz      5822:        another non-X11 pkg, use <span class="quote">&#8220;<span class="quote">${LOCALBASE}</span>&#8221;</span>. The name
1.1       dsieger  5823:        <code class="varname">LOCALBASE</code> stems from FreeBSD, which
                   5824:        installed all packages in <code class="filename">/usr/local</code>. As
                   5825:        pkgsrc leaves <code class="filename">/usr/local</code> for the system
                   5826:        administrator, this variable is a misnomer.</p></li>
1.23      wiz      5827: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
1.1       dsieger  5828:        distribution (from xsrc, etc.) is installed. When looking for
                   5829:        <span class="emphasis"><em>standard</em></span> X11 includes (not those
1.23      wiz      5830:        installed by a package), use <span class="quote">&#8220;<span class="quote">${X11BASE}</span>&#8221;</span>.</p></li>
1.99      sevan    5831: <li class="listitem"><p>X11-based packages using imake must set
                   5832:        <code class="varname">USE_IMAKE</code> to be installed correctly under
                   5833:        <code class="varname">LOCALBASE</code>.</p></li>
1.23      wiz      5834: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.167   ! leot     5835:        install files according to <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?hier+7.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">hier</span>(7)</span></a>, with the exception that
1.1       dsieger  5836:        manual pages go into <code class="filename">${PREFIX}/man</code>, not
                   5837:        <code class="filename">${PREFIX}/share/man</code>.</p></li>
                   5838: </ul></div>
                   5839: </div>
1.41      asau     5840: <div class="sect1">
1.1       dsieger  5841: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   5842: <a name="build.builddirs"></a>19.3. Directories used during the build process</h2></div></div></div>
1.14      jmcneill 5843: <p>When building a package, various directories are used to store
1.1       dsieger  5844:     source files, temporary files, pkgsrc-internal files, and so on. These
                   5845:     directories are explained here.</p>
                   5846: <p>Some of the directory variables contain relative pathnames. There
                   5847:     are two common base directories for these relative directories:
                   5848:     <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
                   5849:     pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
                   5850:     inside the package itself.</p>
1.41      asau     5851: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  5852: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
                   5853: <dd><p>This is an absolute pathname that points to the pkgsrc
                   5854:       root directory. Generally, you don't need
                   5855:       it.</p></dd>
                   5856: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
                   5857: <dd><p>This is an absolute pathname that points to the
                   5858:       current package.</p></dd>
                   5859: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
                   5860: <dd><p>This is a pathname relative to
                   5861:       <code class="varname">PKGSRCDIR</code> that points to the current
                   5862:       package.</p></dd>
                   5863: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
                   5864: <dd><p>This is an absolute pathname pointing to the directory
                   5865:       where all work takes place. The distfiles are extracted to this
                   5866:       directory. It also contains temporary directories and log files used by
                   5867:       the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
                   5868:       the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
                   5869: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
                   5870: <dd><p>This is an absolute pathname pointing to the directory
                   5871:       where the distfiles are extracted. It is usually a direct subdirectory
                   5872:       of <code class="varname">WRKDIR</code>, and often it's the only directory entry
                   5873:       that isn't hidden. This variable may be changed by a package
                   5874:       <code class="filename">Makefile</code>.</p></dd>
                   5875: </dl></div>
1.14      jmcneill 5876: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
                   5877:     the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
1.15      rillig   5878:     to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
1.14      jmcneill 5879:     <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
                   5880:     If users would like to have their pkgsrc trees behave in a
                   5881:     read-only manner, then the value of
                   5882:     <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
                   5883:     <span class="emphasis"><em>no</em></span>.</p>
1.1       dsieger  5884: </div>
1.41      asau     5885: <div class="sect1">
1.1       dsieger  5886: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   5887: <a name="build.running"></a>19.4. Running a phase</h2></div></div></div>
1.10      hubertf  5888: <p>You can run a particular phase by typing <span class="command"><strong>make
1.1       dsieger  5889:     phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
                   5890:     phase. This will automatically run all phases that are required for this
                   5891:     phase. The default phase is <code class="varname">build</code>, that is, when you
1.10      hubertf  5892:     run <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.1       dsieger  5893:     the package will be built, but not installed.</p>
                   5894: </div>
1.41      asau     5895: <div class="sect1">
1.1       dsieger  5896: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   5897: <a name="build.fetch"></a>19.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.1       dsieger  5898: <p>The first step in building a package is to fetch the
                   5899:     distribution files (distfiles) from the sites that are providing
                   5900:     them. This is the task of the <span class="emphasis"><em>fetch</em></span>
                   5901:     phase.</p>
1.41      asau     5902: <div class="sect2">
1.1       dsieger  5903: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   5904: <a name="build.fetch.what"></a>19.5.1. What to fetch and where to get it from</h3></div></div></div>
1.1       dsieger  5905: <p>In simple cases, <code class="varname">MASTER_SITES</code>
                   5906:       defines all URLs from where the distfile, whose name is
                   5907:       derived from the <code class="varname">DISTNAME</code> variable, is
                   5908:       fetched. The more complicated cases are described
                   5909:       below.</p>
                   5910: <p>The variable <code class="varname">DISTFILES</code> specifies
                   5911:       the list of distfiles that have to be fetched. Its value
1.66      asau     5912:       defaults to <code class="literal">${DEFAULT_DISTFILES}</code> and
                   5913:       its value is <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
1.1       dsieger  5914:       so that most packages don't need to define it at all.
                   5915:       <code class="varname">EXTRACT_SUFX</code> is
                   5916:       <code class="literal">.tar.gz</code> by default, but can be changed
                   5917:       freely. Note that if your package requires additional
                   5918:       distfiles to the default one, you cannot just append the
                   5919:       additional filenames using the <code class="literal">+=</code>
                   5920:       operator, but you have write for example:</p>
                   5921: <pre class="programlisting">
1.66      asau     5922: DISTFILES=      ${DEFAULT_DISTFILES} additional-files.tar.gz
1.1       dsieger  5923: </pre>
                   5924: <p>Each distfile is fetched from a list of sites, usually
                   5925:       <code class="varname">MASTER_SITES</code>. If the package has multiple
                   5926:       <code class="varname">DISTFILES</code> or multiple
                   5927:       <code class="varname">PATCHFILES</code> from different sites, you can
                   5928:       set
                   5929:       <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
                   5930:       to the list of URLs where the file
                   5931:       <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
                   5932:       (including the suffix) can be found.</p>
                   5933: <pre class="programlisting">
                   5934: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX}
                   5935: DISTFILES+=     foo-file.tar.gz
                   5936: SITES.foo-file.tar.gz= \
                   5937: http://www.somewhere.com/somehow/ \
                   5938: http://www.somewhereelse.com/mirror/somehow/
                   5939: </pre>
                   5940: <p>When actually fetching the distfiles, each item from
                   5941:       <code class="varname">MASTER_SITES</code> or
                   5942:       <code class="varname">SITES.*</code> gets the name of each distfile
                   5943:       appended to it, without an intermediate slash. Therefore,
                   5944:       all site values have to end with a slash or other separator
                   5945:       character. This allows for example to set
                   5946:       <code class="varname">MASTER_SITES</code> to a URL of a CGI script
                   5947:       that gets the name of the distfile as a parameter. In this
                   5948:       case, the definition would look like:</p>
                   5949: <pre class="programlisting">
                   5950: MASTER_SITES=   http://www.example.com/download.cgi?file=
                   5951: </pre>
1.22      jakllsch 5952: <p> The exception to this rule are URLs starting with a dash.
1.66      asau     5953:       In that case the URL is taken as is, fetched and the result
                   5954:       stored under the name of the distfile. You can use this style
                   5955:       for the case when the download URL style does not match the
                   5956:       above common case. For example, if permanent download URL is a
                   5957:       redirector to the real download URL, or the download file name
                   5958:       is offered by an HTTP Content-Disposition header. In the
                   5959:       following example, <code class="filename">foo-1.0.0.tar.gz</code> will be
                   5960:       created instead of the default
                   5961:       <code class="filename">v1.0.0.tar.gz</code>.</p>
                   5962: <pre class="programlisting">
                   5963: DISTNAME=       foo-1.0.0
                   5964: MASTER_SITES=   -http://www.example.com/archive/v1.0.0.tar.gz
                   5965: </pre>
1.1       dsieger  5966: <p>There are some predefined values for
                   5967:       <code class="varname">MASTER_SITES</code>, which can be used in
                   5968:       packages.  The names of the variables should speak for
                   5969:       themselves.</p>
1.156     leot     5970: <table border="0" summary="Simple list" class="simplelist">
                   5971: <tr>
                   5972: <td>MASTER_SITE_APACHE</td>
                   5973: <td>MASTER_SITE_BACKUP</td>
                   5974: </tr>
                   5975: <tr>
                   5976: <td>MASTER_SITE_CRATESIO</td>
                   5977: <td>MASTER_SITE_CYGWIN</td>
                   5978: </tr>
                   5979: <tr>
                   5980: <td>MASTER_SITE_DEBIAN</td>
                   5981: <td>MASTER_SITE_FREEBSD</td>
                   5982: </tr>
                   5983: <tr>
                   5984: <td>MASTER_SITE_FREEBSD_LOCAL</td>
                   5985: <td>MASTER_SITE_GENTOO</td>
                   5986: </tr>
                   5987: <tr>
                   5988: <td>MASTER_SITE_GITHUB</td>
                   5989: <td>MASTER_SITE_GNOME</td>
                   5990: </tr>
                   5991: <tr>
                   5992: <td>MASTER_SITE_GNU</td>
                   5993: <td>MASTER_SITE_GNUSTEP</td>
                   5994: </tr>
                   5995: <tr>
                   5996: <td>MASTER_SITE_HASKELL_HACKAGE</td>
                   5997: <td>MASTER_SITE_IFARCHIVE</td>
                   5998: </tr>
                   5999: <tr>
                   6000: <td>MASTER_SITE_KDE</td>
                   6001: <td>MASTER_SITE_MOZILLA</td>
                   6002: </tr>
                   6003: <tr>
                   6004: <td>MASTER_SITE_MOZILLA_ALL</td>
                   6005: <td>MASTER_SITE_MYSQL</td>
                   6006: </tr>
                   6007: <tr>
                   6008: <td>MASTER_SITE_NETLIB</td>
                   6009: <td>MASTER_SITE_OPENBSD</td>
                   6010: </tr>
                   6011: <tr>
                   6012: <td>MASTER_SITE_OPENOFFICE</td>
                   6013: <td>MASTER_SITE_OSDN</td>
                   6014: </tr>
                   6015: <tr>
                   6016: <td>MASTER_SITE_PERL_CPAN</td>
                   6017: <td>MASTER_SITE_PGSQL</td>
                   6018: </tr>
                   6019: <tr>
                   6020: <td>MASTER_SITE_PYPI</td>
                   6021: <td>MASTER_SITE_RUBYGEMS</td>
                   6022: </tr>
                   6023: <tr>
                   6024: <td>MASTER_SITE_R_CRAN</td>
                   6025: <td>MASTER_SITE_SOURCEFORGE</td>
                   6026: </tr>
                   6027: <tr>
                   6028: <td>MASTER_SITE_SUNSITE</td>
                   6029: <td>MASTER_SITE_SUSE</td>
                   6030: </tr>
                   6031: <tr>
                   6032: <td>MASTER_SITE_TEX_CTAN</td>
                   6033: <td>MASTER_SITE_XCONTRIB</td>
                   6034: </tr>
                   6035: <tr>
                   6036: <td>MASTER_SITE_XEMACS</td>
                   6037: <td>MASTER_SITE_XORG</td>
                   6038: </tr>
                   6039: </table>
1.1       dsieger  6040: <p>Some explanations for the less self-explaining ones:
                   6041:       <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.26      wiz      6042:       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.25      spz      6043:       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.1       dsieger  6044: <p>If you choose one of these predefined sites, you may
                   6045:       want to specify a subdirectory of that site. Since these
                   6046:       macros may expand to more than one actual site, you
                   6047:       <span class="emphasis"><em>must</em></span> use the following construct to
                   6048:       specify a subdirectory:</p>
                   6049: <pre class="programlisting">
                   6050: MASTER_SITES=   ${MASTER_SITE_GNU:=subdirectory/name/}
                   6051: MASTER_SITES=   ${MASTER_SITE_SOURCEFORGE:=project_name/}
                   6052: </pre>
                   6053: <p>Note the trailing slash after the subdirectory
                   6054:       name.</p>
                   6055: </div>
1.41      asau     6056: <div class="sect2">
1.1       dsieger  6057: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   6058: <a name="build.fetch.how"></a>19.5.2. How are the files fetched?</h3></div></div></div>
1.1       dsieger  6059: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
                   6060:       all the distfiles exist in a local directory
                   6061:       (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
                   6062:       user). If the files do not exist, they are fetched using
                   6063:       commands of the form</p>
                   6064: <pre class="programlisting">
                   6065: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
                   6066: </pre>
                   6067: <p>where <code class="literal">${site}</code> varies through
                   6068:       several possibilities in turn: first,
                   6069:       <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
                   6070:       sites specified in either <code class="varname">SITES.file</code> if
                   6071:       defined, else <code class="varname">MASTER_SITES</code> or
                   6072:       <code class="varname">PATCH_SITES</code>, as applies, then finally the
                   6073:       value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
                   6074:       all except the first and the last can be optionally sorted
                   6075:       by the user, via setting either
                   6076:       <code class="varname">MASTER_SORT_RANDOM</code>, and
                   6077:       <code class="varname">MASTER_SORT_AWK</code> or
                   6078:       <code class="varname">MASTER_SORT_REGEX</code>.</p>
1.16      jnemeth  6079: <p> The specific command and arguments used depend on the
                   6080:       <code class="varname">FETCH_USING</code> parameter. The example above is
                   6081:       for <code class="literal">FETCH_USING=custom</code>.</p>
1.1       dsieger  6082: <p>The distfiles mirror run by the NetBSD Foundation uses the
                   6083:       <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
                   6084:       distfiles, if they are freely distributable.  Packages setting
                   6085:       <code class="varname">NO_SRC_ON_FTP</code> (usually to
1.23      wiz      6086:       <span class="quote">&#8220;<span class="quote">${RESTRICTED}</span>&#8221;</span>) will not have their distfiles
1.1       dsieger  6087:       mirrored.</p>
                   6088: </div>
                   6089: </div>
1.41      asau     6090: <div class="sect1">
1.1       dsieger  6091: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   6092: <a name="build.checksum"></a>19.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.1       dsieger  6093: <p>After the distfile(s) are fetched, their checksum is
                   6094:     generated and compared with the checksums stored in the
                   6095:     distinfo file. If the checksums don't match, the build is
                   6096:     aborted. This is to ensure the same distfile is used for
                   6097:     building, and that the distfile wasn't changed, e.g. by some
                   6098:     malign force, deliberately changed distfiles on the master
                   6099:     distribution site or network lossage.</p>
                   6100: </div>
1.41      asau     6101: <div class="sect1">
1.1       dsieger  6102: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   6103: <a name="build.extract"></a>19.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.1       dsieger  6104: <p>When the distfiles are present on the local system, they
                   6105:     need to be extracted, as they usually come in the form of some
                   6106:     compressed archive format.</p>
                   6107: <p>By default, all <code class="varname">DISTFILES</code> are
                   6108:     extracted. If you only need some of them, you can set the
                   6109:     <code class="varname">EXTRACT_ONLY</code> variable to the list of those
                   6110:     files.</p>
                   6111: <p>Extracting the files is usually done by a little
                   6112:     program, <code class="filename">mk/extract/extract</code>, which
                   6113:     already knows how to extract various archive formats, so most
                   6114:     likely you will not need to change anything here. But if you
                   6115:     need, the following variables may help you:</p>
1.41      asau     6116: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  6117: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
                   6118: <dd><p>Use these variables to override the default
                   6119:       options for an extract command, which are defined in
                   6120:       <code class="filename">mk/extract/extract</code>.</p></dd>
                   6121: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
                   6122: <dd><p>This variable can be set to
1.14      jmcneill 6123:       <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
                   6124:       (which is the default value), <code class="literal">pax</code>, or an
1.1       dsieger  6125:       absolute pathname pointing to the command with which tar
1.14      jmcneill 6126:       archives should be extracted.  It is preferred to choose bsdtar over gtar
                   6127:       if NetBSD's pax-as-tar is not good enough.</p></dd>
1.1       dsieger  6128: </dl></div>
                   6129: <p>If the <code class="filename">extract</code> program doesn't
                   6130:     serve your needs, you can also override the
                   6131:     <code class="varname">EXTRACT_CMD</code> variable, which holds the
                   6132:     command used for extracting the files. This command is
                   6133:     executed in the <code class="filename">${WRKSRC}</code>
                   6134:     directory. During execution of this command, the shell
                   6135:     variable <code class="varname">extract_file</code> holds the absolute
                   6136:     pathname of the file that is going to be extracted.</p>
                   6137: <p>And if that still does not suffice, you can override the
                   6138:     <code class="varname">do-extract</code> target in the package
                   6139:     Makefile.</p>
                   6140: </div>
1.41      asau     6141: <div class="sect1">
1.1       dsieger  6142: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   6143: <a name="build.patch"></a>19.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.1       dsieger  6144: <p>After extraction, all the patches named by the
                   6145:     <code class="varname">PATCHFILES</code>, those present in the patches
                   6146:     subdirectory of the package as well as in
                   6147:     $LOCALPATCHES/$PKGPATH (e.g.
                   6148:     <code class="filename">/usr/local/patches/graphics/png</code>) are
                   6149:     applied.  Patchfiles ending in <code class="filename">.Z</code> or
                   6150:     <code class="filename">.gz</code> are uncompressed before they are
                   6151:     applied, files ending in <code class="filename">.orig</code> or
                   6152:     <code class="filename">.rej</code> are ignored. Any special options to
1.167   ! leot     6153:     <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?patch+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> can be handed in
1.154     rillig   6154:     <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.167   ! leot     6155: <p>By default <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?patch+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">patch</span>(1)</span></a> is given special args to make
1.1       dsieger  6156:     it fail if the patches apply with some lines of fuzz. Please
                   6157:     fix (regen) the patches so that they apply cleanly. The
                   6158:     rationale behind this is that patches that don't apply cleanly
                   6159:     may end up being applied in the wrong place, and cause severe
                   6160:     harm there.</p>
                   6161: </div>
1.41      asau     6162: <div class="sect1">
1.1       dsieger  6163: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   6164: <a name="build.tools"></a>19.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
                   6165: <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.1       dsieger  6166:     </p>
                   6167: </div>
1.41      asau     6168: <div class="sect1">
1.1       dsieger  6169: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   6170: <a name="build.wrapper"></a>19.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.1       dsieger  6171: <p>This phase creates wrapper programs for the compilers and
                   6172:     linkers. The following variables can be used to tweak the
                   6173:     wrappers.</p>
1.41      asau     6174: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  6175: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
                   6176: <dd><p>The command used to print progress
                   6177:       messages. Does nothing by default. Set to
                   6178:       <code class="literal">${ECHO}</code> to see the progress
                   6179:       messages.</p></dd>
                   6180: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
                   6181: <dd><p>This variable can be set to
                   6182:       <code class="literal">yes</code> (default) or <code class="literal">no</code>,
                   6183:       depending on whether you want additional information in the
                   6184:       wrapper log file.</p></dd>
                   6185: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
                   6186: <dd><p>This variable can be set to
                   6187:       <code class="literal">yes</code> or <code class="literal">no</code>, depending
                   6188:       on whether the wrapper should use its cache, which will
                   6189:       improve the speed. The default value is
                   6190:       <code class="literal">yes</code>, but is forced to
                   6191:       <code class="literal">no</code> if the platform does not support
                   6192:       it.</p></dd>
                   6193: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
                   6194: <dd><p>A list of reordering commands. A reordering
                   6195:       command has the form
                   6196:       <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
                   6197:       It ensures that that
                   6198:       <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
                   6199:       before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
                   6200:       </p></dd>
                   6201: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
                   6202: <dd><p>A list of transformation commands. [TODO:
                   6203:       investigate further]</p></dd>
                   6204: </dl></div>
                   6205: </div>
1.41      asau     6206: <div class="sect1">
1.1       dsieger  6207: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   6208: <a name="build.configure"></a>19.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.1       dsieger  6209: <p>Most pieces of software need information on the header
                   6210:     files, system calls, and library routines which are available
                   6211:     on the platform they run on. The process of determining this
                   6212:     information is known as configuration, and is usually
                   6213:     automated. In most cases, a script is supplied with the
                   6214:     distfiles, and its invocation results in generation of header
                   6215:     files, Makefiles, etc.</p>
                   6216: <p>If the package contains a configure script, this can be
                   6217:     invoked by setting <code class="varname">HAS_CONFIGURE</code> to
1.23      wiz      6218:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. If the configure script is a GNU autoconf
1.1       dsieger  6219:     script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.23      wiz      6220:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> instead. What happens in the
1.1       dsieger  6221:     <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
                   6222: <pre class="programlisting">
                   6223: .for d in ${CONFIGURE_DIRS}
                   6224:         cd ${WRKSRC} \
                   6225:         &amp;&amp; cd ${d} \
                   6226:         &amp;&amp; env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
                   6227: .endfor
                   6228: </pre>
                   6229: <p><code class="varname">CONFIGURE_DIRS</code> (default:
1.23      wiz      6230:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span>) is a list of pathnames relative to
1.1       dsieger  6231:     <code class="varname">WRKSRC</code>. In each of these directories, the
                   6232:     configure script is run with the environment
                   6233:     <code class="varname">CONFIGURE_ENV</code> and arguments
                   6234:     <code class="varname">CONFIGURE_ARGS</code>. The variables
                   6235:     <code class="varname">CONFIGURE_ENV</code>,
                   6236:     <code class="varname">CONFIGURE_SCRIPT</code> (default:
1.23      wiz      6237:     <span class="quote">&#8220;<span class="quote">./configure</span>&#8221;</span>) and
1.1       dsieger  6238:     <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
                   6239:     package.</p>
1.37      wiz      6240: <p>If the program uses the Perl way of configuration (mainly Perl
                   6241:     modules, but not only), i.e. a file called
                   6242:     <code class="filename">Makefile.PL</code>, it should include
                   6243:     <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
                   6244:     <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
                   6245:     variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
1.1       dsieger  6246: <p>If the program uses an <code class="filename">Imakefile</code>
                   6247:     for configuration, the appropriate steps can be invoked by
                   6248:     setting <code class="varname">USE_IMAKE</code> to
1.99      sevan    6249:     <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>.
                   6250:     You can add variables to xmkmf's environment by adding them to the
1.1       dsieger  6251:     <code class="varname">SCRIPTS_ENV</code> variable.</p>
1.11      rillig   6252: <p>If the program uses <code class="filename">cmake</code>
                   6253:     for configuration, the appropriate steps can be invoked by
1.23      wiz      6254:     setting <code class="varname">USE_CMAKE</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.
1.11      rillig   6255:     You can add variables to cmake's environment by adding them to the
                   6256:     <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
                   6257:     by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
                   6258:     The top directory argument is given by the
                   6259:     <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
1.23      wiz      6260:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span> (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
1.1       dsieger  6261: <p>If there is no configure step at all, set
1.23      wiz      6262:     <code class="varname">NO_CONFIGURE</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.</p>
1.1       dsieger  6263: </div>
1.41      asau     6264: <div class="sect1">
1.1       dsieger  6265: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   6266: <a name="build.build"></a>19.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.1       dsieger  6267: <p>For building a package, a rough equivalent of the
                   6268:     following code is executed.</p>
                   6269: <pre class="programlisting">
                   6270: .for d in ${BUILD_DIRS}
                   6271:         cd ${WRKSRC} \
                   6272:         &amp;&amp; cd ${d} \
                   6273:         &amp;&amp; env ${MAKE_ENV} \
                   6274:             ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
                   6275:                 -f ${MAKE_FILE} \
                   6276:                 ${BUILD_TARGET}
                   6277: .endfor
                   6278: </pre>
                   6279: <p><code class="varname">BUILD_DIRS</code> (default:
1.23      wiz      6280:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span>) is a list of pathnames relative to
1.1       dsieger  6281:     <code class="varname">WRKSRC</code>. In each of these directories,
                   6282:     <code class="varname">MAKE_PROGRAM</code> is run with the environment
                   6283:     <code class="varname">MAKE_ENV</code> and arguments
                   6284:     <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
                   6285:     <code class="varname">MAKE_ENV</code>,
                   6286:     <code class="varname">BUILD_MAKE_FLAGS</code>,
                   6287:     <code class="varname">MAKE_FILE</code> and
                   6288:     <code class="varname">BUILD_TARGET</code> may all be changed by the
                   6289:     package.</p>
                   6290: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.23      wiz      6291:     <span class="quote">&#8220;<span class="quote">gmake</span>&#8221;</span> if <code class="varname">USE_TOOLS</code> contains
                   6292:     <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.1       dsieger  6293:     default value of <code class="varname">MAKE_FILE</code> is
1.23      wiz      6294:     <span class="quote">&#8220;<span class="quote">Makefile</span>&#8221;</span>, and <code class="varname">BUILD_TARGET</code>
                   6295:     defaults to <span class="quote">&#8220;<span class="quote">all</span>&#8221;</span>.</p>
1.1       dsieger  6296: <p>If there is no build step at all, set
1.23      wiz      6297:     <code class="varname">NO_BUILD</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.</p>
1.1       dsieger  6298: </div>
1.41      asau     6299: <div class="sect1">
1.1       dsieger  6300: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   6301: <a name="build.test"></a>19.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.1       dsieger  6302: <p>[TODO]</p>
                   6303: </div>
1.41      asau     6304: <div class="sect1">
1.1       dsieger  6305: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   6306: <a name="build.install"></a>19.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.1       dsieger  6307: <p>Once the build stage has completed, the final step is to
                   6308:     install the software in public directories, so users can
                   6309:     access the programs and files.</p>
                   6310: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
                   6311:     equivalent of the following code is executed. Additionally,
                   6312:     before and after this code, much magic is performed to do
                   6313:     consistency checks, registering the package, and so on.</p>
                   6314: <pre class="programlisting">
                   6315: .for d in ${INSTALL_DIRS}
                   6316:         cd ${WRKSRC} \
                   6317:         &amp;&amp; cd ${d} \
                   6318:         &amp;&amp; env ${MAKE_ENV} \
                   6319:             ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
                   6320:                 -f ${MAKE_FILE} \
                   6321:                 ${INSTALL_TARGET}
                   6322: .endfor
                   6323: </pre>
                   6324: <p>The variable's meanings are analogous to the ones in the
                   6325:     <span class="emphasis"><em>build</em></span> phase.
                   6326:     <code class="varname">INSTALL_DIRS</code> defaults to
                   6327:     <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
1.23      wiz      6328:     is <span class="quote">&#8220;<span class="quote">install</span>&#8221;</span> by default, plus
                   6329:     <span class="quote">&#8220;<span class="quote">install.man</span>&#8221;</span> if <code class="varname">USE_IMAKE</code> is
1.1       dsieger  6330:     defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
                   6331:     defined.</p>
                   6332: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
                   6333:     variables are useful. They are all variations of the
1.167   ! leot     6334:     <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?install+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a> command that have the owner, group and
1.1       dsieger  6335:     permissions preset. <code class="varname">INSTALL</code> is the plain
                   6336:     install command. The specialized variants, together with their
                   6337:     intended use, are:</p>
1.41      asau     6338: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  6339: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
                   6340: <dd><p>directories that contain
                   6341:       binaries</p></dd>
                   6342: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
                   6343: <dd><p>directories that contain
                   6344:       scripts</p></dd>
                   6345: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
                   6346: <dd><p>directories that contain shared and static
                   6347:       libraries</p></dd>
                   6348: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
                   6349: <dd><p>directories that contain data
                   6350:       files</p></dd>
                   6351: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
                   6352: <dd><p>directories that contain man
                   6353:       pages</p></dd>
1.100     leot     6354: <dt><span class="term"><code class="varname">INSTALL_GAME_DIR</code></span></dt>
                   6355: <dd><p>directories that contain data files for games
                   6356:       </p></dd>
1.1       dsieger  6357: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
                   6358: <dd><p>binaries that can be stripped from debugging
                   6359:       symbols</p></dd>
                   6360: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
                   6361: <dd><p>binaries that cannot be
                   6362:       stripped</p></dd>
                   6363: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
                   6364: <dd><p>game
                   6365:       binaries</p></dd>
                   6366: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
                   6367: <dd><p>shared and static
                   6368:       libraries</p></dd>
                   6369: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
                   6370: <dd><p>data files</p></dd>
                   6371: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
                   6372: <dd><p>data files for
                   6373:       games</p></dd>
                   6374: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
                   6375: <dd><p>man pages</p></dd>
                   6376: </dl></div>
                   6377: <p>Some other variables are:</p>
1.41      asau     6378: <div class="variablelist"><dl class="variablelist">
1.106     tnn      6379: <dt><span class="term"><code class="varname">INSTALL_UNSTRIPPED</code></span></dt>
1.167   ! leot     6380: <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-8.1"><span class="citerefentry"><span class="refentrytitle">strip</span>(1)</span></a>
1.106     tnn      6381:       when installing binaries. Any debugging sections and symbols present in
                   6382:       binaries will be preserved.
                   6383:       </p></dd>
1.1       dsieger  6384: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
                   6385: <dd><p>A list of directories relative to
                   6386:       <code class="varname">PREFIX</code> that are created by pkgsrc at the
                   6387:       beginning of the <span class="emphasis"><em>install</em></span> phase.
                   6388:       The package is supposed to create all needed directories itself
                   6389:       before installing files to it and list all other directories here.
                   6390:       </p></dd>
                   6391: </dl></div>
                   6392: <p>In the rare cases that a package shouldn't install anything,
1.23      wiz      6393:     set <code class="varname">NO_INSTALL</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. This is
1.1       dsieger  6394:     mostly relevant for packages in the <code class="filename">regress</code>
                   6395:     category.</p>
                   6396: </div>
1.41      asau     6397: <div class="sect1">
1.1       dsieger  6398: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   6399: <a name="build.package"></a>19.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.1       dsieger  6400: <p>Once the install stage has completed, a binary package of
                   6401:     the installed files can be built.  These binary packages can be
                   6402:     used for quick installation without previous compilation, e.g. by
1.10      hubertf  6403:     the <span class="command"><strong>make bin-install</strong></span> or by using
                   6404:     <span class="command"><strong>pkg_add</strong></span>.</p>
1.1       dsieger  6405: <p>By default, the binary packages are created in
                   6406:     <code class="filename">${PACKAGES}/All</code> and symlinks are created in
                   6407:     <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
                   6408:     one for each category in the <code class="varname">CATEGORIES</code>
                   6409:     variable.  <code class="varname">PACKAGES</code> defaults to
                   6410:     <code class="filename">pkgsrc/packages</code>.</p>
                   6411: </div>
1.41      asau     6412: <div class="sect1">
1.1       dsieger  6413: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   6414: <a name="build.clean"></a>19.16. Cleaning up</h2></div></div></div>
1.1       dsieger  6415: <p>Once you're finished with a package, you can clean the work
1.10      hubertf  6416:     directory by running <span class="command"><strong>make clean</strong></span>.  If you want
1.1       dsieger  6417:     to clean the work directories of all dependencies too, use
1.10      hubertf  6418:     <span class="command"><strong>make clean-depends</strong></span>.</p>
1.1       dsieger  6419: </div>
1.41      asau     6420: <div class="sect1">
1.1       dsieger  6421: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   6422: <a name="build.helpful-targets"></a>19.17. Other helpful targets</h2></div></div></div>
1.41      asau     6423: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  6424: <dt><span class="term">pre/post-*</span></dt>
                   6425: <dd><p>For any of the main targets described in the
                   6426:          previous section, two auxiliary targets exist with
1.23      wiz      6427:          <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.1       dsieger  6428:          prefix for the main target's name.  These targets are
                   6429:          invoked before and after the main target is called,
                   6430:          allowing extra configuration or installation steps be
                   6431:          performed from a package's Makefile, for example, which
                   6432:          a program's configure script or install target
                   6433:          omitted.</p></dd>
                   6434: <dt><span class="term">do-*</span></dt>
                   6435: <dd><p>Should one of the main targets do the wrong thing,
                   6436:          and should there be no variable to fix this, you can
                   6437:          redefine it with the do-* target.  (Note that redefining
                   6438:          the target itself instead of the do-* target is a bad
                   6439:          idea, as the pre-* and post-* targets won't be called
                   6440:          anymore, etc.) You will not usually need to do
                   6441:          this.</p></dd>
                   6442: <dt><span class="term">reinstall</span></dt>
                   6443: <dd>
1.10      hubertf  6444: <p>If you did a <span class="command"><strong>make install</strong></span> and
1.1       dsieger  6445:          you noticed some file was not installed properly, you
                   6446:          can repeat the installation with this target, which will
1.23      wiz      6447:          ignore the <span class="quote">&#8220;<span class="quote">already installed</span>&#8221;</span> flag.</p>
1.1       dsieger  6448: <p>This is the default value of
                   6449:          <code class="varname">DEPENDS_TARGET</code> except in the case of
1.10      hubertf  6450:          <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
1.1       dsieger  6451:          package</strong></span>, where the defaults are
1.23      wiz      6452:          <span class="quote">&#8220;<span class="quote">package</span>&#8221;</span> and <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span>,
1.1       dsieger  6453:          respectively.</p>
                   6454: </dd>
                   6455: <dt><span class="term">deinstall</span></dt>
                   6456: <dd>
1.167   ! leot     6457: <p>This target does a <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> in the
1.1       dsieger  6458:          current directory, effectively de-installing the
                   6459:          package. The following variables can be used to tune the
                   6460:          behaviour:</p>
1.41      asau     6461: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  6462: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.167   ! leot     6463: <dd><p>Add a "-v" to the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> command.</p></dd>
1.1       dsieger  6464: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
                   6465: <dd><p>Remove all packages that require (depend on)
                   6466:                the given package.  This can be used to remove any
                   6467:                packages that may have been pulled in by a given
1.10      hubertf  6468:                package, e.g. if <span class="command"><strong>make deinstall
1.1       dsieger  6469:                DEINSTALLDEPENDS=1</strong></span> is done in
                   6470:                <code class="filename">pkgsrc/x11/kde</code>, this is
                   6471:                likely to remove whole KDE. Works by adding
1.167   ! leot     6472:                <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-8.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a>
1.1       dsieger  6473:                command line.</p></dd>
                   6474: </dl></div>
                   6475: </dd>
                   6476: <dt><span class="term">bin-install</span></dt>
                   6477: <dd><p>Install a binary package from local disk and via FTP
                   6478:          from a list of sites (see the
                   6479:          <code class="varname">BINPKG_SITES</code> variable), and do a
1.10      hubertf  6480:          <span class="command"><strong>make package</strong></span> if no binary package is
1.1       dsieger  6481:          available anywhere.  The arguments given to
1.10      hubertf  6482:          <span class="command"><strong>pkg_add</strong></span> can be set via
1.1       dsieger  6483:          <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
                   6484:          operation, etc.</p></dd>
1.95      wiz      6485: <dt><span class="term">install-clean</span></dt>
                   6486: <dd><p>This target removes the state files for the "install" and later
                   6487:          phases so that the "install" target may be re-invoked. This can be
                   6488:          used after editing the PLIST to install the package without
                   6489:          rebuilding it.</p></dd>
                   6490: <dt><span class="term">build-clean</span></dt>
                   6491: <dd><p>This target removes the state files for the "build" and later
                   6492:          phases so that the "build" target may be re-invoked.</p></dd>
1.1       dsieger  6493: <dt><span class="term">update</span></dt>
                   6494: <dd>
                   6495: <p>This target causes the current package to be
                   6496:          updated to the latest version.  The package and all
                   6497:          depending packages first get de-installed, then current
                   6498:          versions of the corresponding packages get compiled and
                   6499:          installed.  This is similar to manually noting which
                   6500:          packages are currently installed, then performing a
1.10      hubertf  6501:          series of <span class="command"><strong>make deinstall</strong></span> and
                   6502:          <span class="command"><strong>make install</strong></span> (or whatever
1.1       dsieger  6503:          <code class="varname">UPDATE_TARGET</code> is set to) for these
                   6504:          packages.</p>
1.23      wiz      6505: <p>You can use the <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> target to
1.10      hubertf  6506:          resume package updating in case a previous <span class="command"><strong>make
1.1       dsieger  6507:          update</strong></span> was interrupted for some reason.
                   6508:          However, in this case, make sure you don't call
1.10      hubertf  6509:          <span class="command"><strong>make clean</strong></span> or otherwise remove the
1.1       dsieger  6510:          list of dependent packages in <code class="varname">WRKDIR</code>.
                   6511:          Otherwise, you lose the ability to automatically update
                   6512:          the current package along with the dependent packages
                   6513:          you have installed.</p>
1.10      hubertf  6514: <p>Resuming an interrupted <span class="command"><strong>make
1.1       dsieger  6515:          update</strong></span> will only work as long as the package
                   6516:          tree remains unchanged.  If the source code for one of
                   6517:          the packages to be updated has been changed, resuming
1.10      hubertf  6518:          <span class="command"><strong>make update</strong></span> will most certainly
1.1       dsieger  6519:          fail!</p>
                   6520: <p>The following variables can be used either on the
1.10      hubertf  6521:          command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
                   6522:          alter the behaviour of <span class="command"><strong>make
1.1       dsieger  6523:          update</strong></span>:</p>
1.41      asau     6524: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  6525: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
                   6526: <dd><p>Install target to recursively use for the
                   6527:                updated package and the dependent packages.
                   6528:                Defaults to <code class="varname">DEPENDS_TARGET</code> if
1.23      wiz      6529:                set, <span class="quote">&#8220;<span class="quote">install</span>&#8221;</span> otherwise for
1.10      hubertf  6530:                <span class="command"><strong>make update</strong></span>.  Other good
1.23      wiz      6531:                targets are <span class="quote">&#8220;<span class="quote">package</span>&#8221;</span> or
                   6532:                <span class="quote">&#8220;<span class="quote">bin-install</span>&#8221;</span>.  Do not set this to
                   6533:                <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> or you will get stuck in an
1.1       dsieger  6534:                endless loop!</p></dd>
                   6535: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
                   6536: <dd><p>Don't clean up after updating.  Useful if
                   6537:                you want to leave the work sources of the updated
                   6538:                packages around for inspection or other purposes.
                   6539:                Be sure you eventually clean up the source tree
1.23      wiz      6540:                (see the <span class="quote">&#8220;<span class="quote">clean-update</span>&#8221;</span> target below)
1.1       dsieger  6541:                or you may run into troubles with old source code
                   6542:                still lying around on your next
1.10      hubertf  6543:                <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
1.1       dsieger  6544:                update</strong></span>.</p></dd>
                   6545: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
                   6546: <dd><p>Deinstall each package before installing
                   6547:                (making <code class="varname">DEPENDS_TARGET</code>). This
                   6548:                may be necessary if the
1.23      wiz      6549:                <span class="quote">&#8220;<span class="quote">clean-update</span>&#8221;</span> target (see below) was
1.10      hubertf  6550:                called after interrupting a running <span class="command"><strong>make
1.1       dsieger  6551:                update</strong></span>.</p></dd>
                   6552: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
                   6553: <dd><p>Allows you to disable recursion and hardcode
                   6554:                the target for packages.  The default is
1.23      wiz      6555:                <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> for the update target,
1.1       dsieger  6556:                facilitating a recursive update of prerequisite
                   6557:                packages.  Only set
                   6558:                <code class="varname">DEPENDS_TARGET</code> if you want to
                   6559:                disable recursive updates. Use
                   6560:                <code class="varname">UPDATE_TARGET</code> instead to just
                   6561:                set a specific target for each package to be
1.10      hubertf  6562:                installed during <span class="command"><strong>make update</strong></span>
1.1       dsieger  6563:                (see above).</p></dd>
                   6564: </dl></div>
                   6565: </dd>
                   6566: <dt><span class="term">clean-update</span></dt>
                   6567: <dd>
                   6568: <p>Clean the source tree for all packages that would
1.10      hubertf  6569:          get updated if <span class="command"><strong>make update</strong></span> was called
1.1       dsieger  6570:          from the current directory.  This target should not be
                   6571:          used if the current package (or any of its depending
                   6572:          packages) have already been de-installed (e.g., after
1.10      hubertf  6573:          calling <span class="command"><strong>make update</strong></span>) or you may lose
1.1       dsieger  6574:          some packages you intended to update. As a rule of
                   6575:          thumb: only use this target <span class="emphasis"><em>before</em></span>
1.10      hubertf  6576:          the first time you run <span class="command"><strong>make update</strong></span>
1.1       dsieger  6577:          and only if you have a dirty package tree (e.g., if you
                   6578:          used <code class="varname">NOCLEAN</code>).</p>
                   6579: <p>If you are unsure about whether your tree is
1.10      hubertf  6580:          clean, you can either perform a <span class="command"><strong>make
1.1       dsieger  6581:          clean</strong></span> at the top of the tree, or use the
                   6582:          following sequence of commands from the directory of the
                   6583:          package you want to update (<span class="emphasis"><em>before</em></span>
1.10      hubertf  6584:          running <span class="command"><strong>make update</strong></span> for the first
1.1       dsieger  6585:          time, otherwise you lose all the packages you wanted to
                   6586:          update!):</p>
                   6587: <pre class="screen">
                   6588: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
                   6589: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
                   6590: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
                   6591:          </pre>
                   6592: <p>The following variables can be used either on the
1.10      hubertf  6593:          command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
                   6594:          <span class="command"><strong>make clean-update</strong></span>:</p>
1.41      asau     6595: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  6596: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
1.10      hubertf  6597: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
1.1       dsieger  6598:                reconstruct the list of directories to update for
1.10      hubertf  6599:                this package.  Only use this if <span class="command"><strong>make
1.1       dsieger  6600:                update</strong></span> successfully installed all
                   6601:                packages you wanted to update.  Normally, this is
1.10      hubertf  6602:                done automatically on <span class="command"><strong>make
1.1       dsieger  6603:                update</strong></span>, but may have been suppressed by
                   6604:                the <code class="varname">NOCLEAN</code> variable (see
                   6605:                above).</p></dd>
                   6606: </dl></div>
                   6607: </dd>
                   6608: <dt><span class="term">replace</span></dt>
                   6609: <dd>
                   6610: <p>Update the installation of the current package.  This
                   6611:          differs from update in that it does not replace dependent
1.137     leot     6612:          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.1       dsieger  6613:          target to work.</p>
                   6614: <p><span class="emphasis"><em>Be careful when using this
                   6615:          target!</em></span> There are no guarantees that dependent
                   6616:          packages will still work, in particular they will most
1.10      hubertf  6617:          certainly break if you <span class="command"><strong>make replace</strong></span> a
1.1       dsieger  6618:          library package whose shared library major version changed
                   6619:          between your installed version and the new one.  For this
                   6620:          reason, this target is not officially supported and only
                   6621:          recommended for advanced users.</p>
                   6622: </dd>
                   6623: <dt><span class="term">info</span></dt>
1.167   ! leot     6624: <dd><p>This target invokes <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a> for the current
1.1       dsieger  6625:          package. You can use this to check which version of a
                   6626:          package is installed.</p></dd>
                   6627: <dt><span class="term">index</span></dt>
                   6628: <dd>
                   6629: <p>This is a top-level command, i.e. it should be used in
                   6630:          the <code class="filename">pkgsrc</code> directory.  It creates a
                   6631:          database of all packages in the local pkgsrc tree, including
                   6632:          dependencies, comment, maintainer, and some other useful
                   6633:          information.  Individual entries are created by running
1.10      hubertf  6634:          <span class="command"><strong>make describe</strong></span> in the packages'
1.1       dsieger  6635:          directories.  This index file is saved as
                   6636:          <code class="filename">pkgsrc/INDEX</code>.  It can be displayed in
1.10      hubertf  6637:          verbose format by running <span class="command"><strong>make
1.1       dsieger  6638:          print-index</strong></span>.  You can search in it with
1.10      hubertf  6639:          <span class="command"><strong>make search
1.1       dsieger  6640:          key=<em class="replaceable"><code>something</code></em></strong></span>.  You can
                   6641:          extract a list of all packages that depend on a particular
1.10      hubertf  6642:          one by running <span class="command"><strong>make show-deps
1.1       dsieger  6643:          PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
                   6644: <p>Running this command takes a very long time, some
                   6645:          hours even on fast machines!</p>
                   6646: </dd>
                   6647: <dt><span class="term">readme</span></dt>
                   6648: <dd>
                   6649: <p>This target generates a
                   6650:          <code class="filename">README.html</code> file, which can be
1.137     leot     6651:          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.1       dsieger  6652:          contain references to any packages which are in the
                   6653:          <code class="varname">PACKAGES</code> directory on the local
                   6654:          host. The generated files can be made to refer to URLs
                   6655:          based on <code class="varname">FTP_PKG_URL_HOST</code> and
                   6656:          <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
                   6657:          wanted to generate <code class="filename">README.html</code>
                   6658:          files which pointed to binary packages on the local
                   6659:          machine, in the directory
                   6660:          <code class="filename">/usr/packages</code>, set
                   6661:          <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
                   6662:          <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
                   6663:          <code class="varname">${PACKAGES}</code> directory and its
                   6664:          subdirectories will be searched for all the binary
                   6665:          packages.</p>
                   6666: <p>The target can be run at the toplevel or in category
                   6667:          directories, in which case it descends recursively.</p>
                   6668: </dd>
                   6669: <dt><span class="term">readme-all</span></dt>
                   6670: <dd><p>This is a top-level command, run it in
                   6671:          <code class="filename">pkgsrc</code>.  Use this target to create a
                   6672:          file <code class="filename">README-all.html</code> which contains a
                   6673:          list of all packages currently available in the NetBSD
                   6674:          Packages Collection, together with the category they belong
                   6675:          to and a short description. This file is compiled from the
                   6676:          <code class="filename">pkgsrc/*/README.html</code> files, so be sure
1.10      hubertf  6677:          to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
1.1       dsieger  6678:          readme</strong></span>.</p></dd>
                   6679: <dt><span class="term">cdrom-readme</span></dt>
                   6680: <dd><p>This is very much the same as the
1.23      wiz      6681:          <span class="quote">&#8220;<span class="quote">readme</span>&#8221;</span> target (see above), but is to be
1.1       dsieger  6682:          used when generating a pkgsrc tree to be written to a
                   6683:          CD-ROM.  This target also produces
                   6684:          <code class="filename">README.html</code> files, and can be made
                   6685:          to refer to URLs based on
                   6686:          <code class="varname">CDROM_PKG_URL_HOST</code> and
                   6687:          <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
                   6688: <dt><span class="term">show-distfiles</span></dt>
                   6689: <dd><p>This target shows which distfiles and patchfiles
                   6690:          are needed to build the package
                   6691:          (<code class="varname">ALLFILES</code>, which contains all
                   6692:          <code class="varname">DISTFILES</code> and
                   6693:          <code class="varname">PATCHFILES</code>, but not
                   6694:          <code class="filename">patches/*</code>).</p></dd>
                   6695: <dt><span class="term">show-downlevel</span></dt>
                   6696: <dd><p>This target shows nothing if the package is not
                   6697:          installed. If a version of this package is installed,
                   6698:          but is not the version provided in this version of
                   6699:          pkgsrc, then a warning message is displayed. This target
                   6700:          can be used to show which of your installed packages are
                   6701:          downlevel, and so the old versions can be deleted, and
                   6702:          the current ones added.</p></dd>
                   6703: <dt><span class="term">show-pkgsrc-dir</span></dt>
                   6704: <dd><p>This target shows the directory in the pkgsrc
                   6705:          hierarchy from which the package can be built and
                   6706:          installed. This may not be the same directory as the one
                   6707:          from which the package was installed. This target is
                   6708:          intended to be used by people who may wish to upgrade
                   6709:          many packages on a single host, and can be invoked from
                   6710:          the top-level pkgsrc Makefile by using the
1.23      wiz      6711:          <span class="quote">&#8220;<span class="quote">show-host-specific-pkgs</span>&#8221;</span> target.</p></dd>
1.1       dsieger  6712: <dt><span class="term">show-installed-depends</span></dt>
                   6713: <dd><p>This target shows which installed packages match
                   6714:          the current package's <code class="varname">DEPENDS</code>. Useful
                   6715:          if out of date dependencies are causing build
                   6716:          problems.</p></dd>
1.95      wiz      6717: <dt><span class="term">print-build-depends-list</span></dt>
                   6718: <dd><p>This target shows the list of packages that the current package
                   6719:            depends on for building.</p></dd>
                   6720: <dt><span class="term">print-run-depends-list</span></dt>
                   6721: <dd><p>This target shows the list of packages that the current package
                   6722:            depends on for running.</p></dd>
1.1       dsieger  6723: <dt><span class="term">check-shlibs</span></dt>
                   6724: <dd><p>After a package is installed, check all its
                   6725:          binaries and (on ELF platforms) shared libraries to see
                   6726:          if they find the shared libs they need.  Run by default
1.10      hubertf  6727:          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.1       dsieger  6728: <dt><span class="term">print-PLIST</span></dt>
                   6729: <dd>
1.23      wiz      6730: <p>After a <span class="quote">&#8220;<span class="quote">make install</span>&#8221;</span> from a new or
1.1       dsieger  6731:          upgraded pkg, this prints out an attempt to generate a
1.10      hubertf  6732:          new <code class="filename">PLIST</code> from a <span class="command"><strong>find
1.1       dsieger  6733:          -newer work/.extract_done</strong></span>.  An attempt is made
                   6734:          to care for shared libs etc., but it is
                   6735:          <span class="emphasis"><em>strongly</em></span> recommended to review the
                   6736:          result before putting it into
                   6737:          <code class="filename">PLIST</code>. On upgrades, it's useful to
                   6738:          diff the output of this command against an already
                   6739:          existing <code class="filename">PLIST</code> file.</p>
1.167   ! leot     6740: <p>If the package installs files via <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?tar+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a> or
1.1       dsieger  6741:          other methods that don't update file access times, be
                   6742:          sure to add these files manually to your
1.23      wiz      6743:          <code class="filename">PLIST</code>, as the <span class="quote">&#8220;<span class="quote">find
                   6744:          -newer</span>&#8221;</span> command used by this target won't catch
1.1       dsieger  6745:          them!</p>
1.154     rillig   6746: <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.1       dsieger  6747:          information on this target.</p>
                   6748: </dd>
                   6749: <dt><span class="term">bulk-package</span></dt>
                   6750: <dd>
                   6751: <p>Used to do bulk builds. If an appropriate binary
                   6752:          package already exists, no action is taken. If not, this
                   6753:          target will compile, install and package it (and its
                   6754:          depends, if <code class="varname">PKG_DEPENDS</code> is set
1.154     rillig   6755:          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.66      asau     6756: builds)</i></a>).
1.1       dsieger  6757:          After creating the binary package, the sources, the
                   6758:          just-installed package and its required packages are
                   6759:          removed, preserving free disk space.</p>
                   6760: <p><span class="emphasis"><em>Beware that this target may deinstall
                   6761:          all packages installed on a system!</em></span></p>
                   6762: </dd>
                   6763: <dt><span class="term">bulk-install</span></dt>
                   6764: <dd>
                   6765: <p>Used during bulk-installs to install required
                   6766:          packages. If an up-to-date binary package is available,
1.167   ! leot     6767:          it will be installed via <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a>. If not,
1.10      hubertf  6768:          <span class="command"><strong>make bulk-package</strong></span> will be executed,
1.1       dsieger  6769:          but the installed binary won't be removed.</p>
                   6770: <p>A binary package is considered
1.23      wiz      6771:          <span class="quote">&#8220;<span class="quote">up-to-date</span>&#8221;</span> to be installed via
1.167   ! leot     6772:          <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> if:</p>
1.41      asau     6773: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      6774: <li class="listitem"><p>None of the package's files
1.1       dsieger  6775:              (<code class="filename">Makefile</code>, ...) were modified
                   6776:              since it was built.</p></li>
1.23      wiz      6777: <li class="listitem"><p>None of the package's required (binary)
1.1       dsieger  6778:              packages were modified since it was built.</p></li>
                   6779: </ul></div>
                   6780: <p><span class="emphasis"><em>Beware that this target may deinstall
                   6781:          all packages installed on a system!</em></span></p>
                   6782: </dd>
                   6783: </dl></div>
                   6784: </div>
                   6785: </div>
1.41      asau     6786: <div class="chapter">
1.1       dsieger  6787: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   6788: <a name="tools"></a>Chapter 20. Tools needed for building or running</h2></div></div></div>
1.1       dsieger  6789: <div class="toc">
                   6790: <p><b>Table of Contents</b></p>
1.100     leot     6791: <dl class="toc">
1.154     rillig   6792: <dt><span class="sect1"><a href="#pkgsrc-tools">20.1. Tools for pkgsrc builds</a></span></dt>
                   6793: <dt><span class="sect1"><a href="#package-tools">20.2. Tools needed by packages</a></span></dt>
                   6794: <dt><span class="sect1"><a href="#platform-tools">20.3. Tools provided by platforms</a></span></dt>
1.1       dsieger  6795: </dl>
                   6796: </div>
                   6797: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
                   6798: by pkgsrc and also for individual packages to define what commands
1.156     leot     6799: are needed for building a package (like <code class="varname">TOOL_DEPENDS</code>)
1.1       dsieger  6800: or for later run-time of an installed packaged (such as
                   6801: <code class="varname">DEPENDS</code>).
                   6802: If the native system provides an adequate tool, then in many cases, a pkgsrc
                   6803: package will not be used.</p>
                   6804: <p>When building a package, the replacement tools are
                   6805: made available in a directory (as symlinks or wrapper scripts)
                   6806: that is early in the executable search path. Just like the buildlink
                   6807: system, this helps with consistent builds.</p>
                   6808: <p>A tool may be needed to help build a specific package. For example,
                   6809: perl, GNU make (gmake) or yacc may be needed.</p>
                   6810: <p>Also a tool may be needed, for example, because the native system's supplied
                   6811: tool may be inefficient for building a package with pkgsrc.
                   6812: For example, a package may need GNU awk, bison (instead of
                   6813: yacc) or a better sed.</p>
                   6814: <p>The tools used by a package can be listed by running
1.10      hubertf  6815: <span class="command"><strong>make show-tools</strong></span>.</p>
1.41      asau     6816: <div class="sect1">
1.1       dsieger  6817: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   6818: <a name="pkgsrc-tools"></a>20.1. Tools for pkgsrc builds</h2></div></div></div>
1.1       dsieger  6819: <p>The default set of tools used by pkgsrc is defined in
                   6820: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
1.10      hubertf  6821: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
                   6822: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
1.1       dsieger  6823: These can be seen by running:
1.10      hubertf  6824: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
1.1       dsieger  6825: <p>If a package needs a specific program to build
                   6826: then the <code class="varname">USE_TOOLS</code> variable can be used
                   6827: to define the tools needed.</p>
                   6828: </div>
1.41      asau     6829: <div class="sect1">
1.1       dsieger  6830: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   6831: <a name="package-tools"></a>20.2. Tools needed by packages</h2></div></div></div>
1.28      wiz      6832: <p>In the following examples, the :run means that it is needed at
                   6833: run-time (and becomes a DEPENDS).
1.1       dsieger  6834: The default is a build dependency which can be set with
                   6835: :build. (So in this example, it is the same as gmake:build
                   6836: and pkg-config:build.)</p>
                   6837: <pre class="programlisting">
                   6838: USE_TOOLS+=     gmake perl:run pkg-config
                   6839: </pre>
                   6840: <p>When using the tools framework, a
                   6841: <code class="varname">TOOLS_PATH.foo</code> variable is defined
                   6842: which contains the full path to the appropriate tool. For example,
1.23      wiz      6843: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">&#8220;<span class="quote">/bin/bash</span>&#8221;</span>
1.1       dsieger  6844: on Linux systems.</p>
                   6845: <p>If you always need a pkgsrc version of the
                   6846: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
                   6847: </p>
                   6848: </div>
1.41      asau     6849: <div class="sect1">
1.1       dsieger  6850: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   6851: <a name="platform-tools"></a>20.3. Tools provided by platforms</h2></div></div></div>
1.1       dsieger  6852: <p>When improving or porting pkgsrc to a new platform, have a look
                   6853: at (or create) the corresponding platform specific make file fragment under
                   6854: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
                   6855: the name of the common tools. For example:</p>
                   6856: <pre class="programlisting">
                   6857: .if exists(/usr/bin/bzcat)
                   6858: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzcat
                   6859: .elif exists(/usr/bin/bzip2)
                   6860: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzip2 -cd
                   6861: .endif
                   6862: 
                   6863: TOOLS_PLATFORM.true?=           true                    # shell builtin
                   6864: </pre>
                   6865: </div>
                   6866: </div>
1.41      asau     6867: <div class="chapter">
1.1       dsieger  6868: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   6869: <a name="fixes"></a>Chapter 21. Making your package work</h2></div></div></div>
1.1       dsieger  6870: <div class="toc">
                   6871: <p><b>Table of Contents</b></p>
1.100     leot     6872: <dl class="toc">
1.154     rillig   6873: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
1.1       dsieger  6874: <dd><dl>
1.154     rillig   6875: <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>
                   6876: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
                   6877: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
                   6878: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
                   6879: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
                   6880: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
                   6881: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
                   6882: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
                   6883: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
                   6884: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
                   6885: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                   6886: </dl></dd>
                   6887: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                   6888: <dd><dl>
                   6889: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   6890: <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>
                   6891: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
                   6892: </dl></dd>
                   6893: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   6894: <dd><dl>
                   6895: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
                   6896: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   6897: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
                   6898: </dl></dd>
                   6899: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
                   6900: <dd><dl>
                   6901: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
                   6902: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
                   6903: <dt><span class="sect2"><a href="#perl-scripts">21.4.3. Packages containing perl scripts</a></span></dt>
                   6904: <dt><span class="sect2"><a href="#shell-scripts">21.4.4. Packages containing shell scripts</a></span></dt>
                   6905: <dt><span class="sect2"><a href="#other-programming-languages">21.4.5. Other programming languages</a></span></dt>
                   6906: </dl></dd>
                   6907: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   6908: <dd><dl>
                   6909: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   6910: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
                   6911: <dt><span class="sect2"><a href="#undefined-reference">21.5.3. Undefined reference to <span class="quote">&#8220;<span class="quote">...</span>&#8221;</span></a></span></dt>
                   6912: <dt><span class="sect2"><a href="#out-of-memory">21.5.4. Running out of memory</a></span></dt>
                   6913: </dl></dd>
                   6914: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   6915: <dd><dl>
                   6916: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
                   6917: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
                   6918: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
                   6919: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
                   6920: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
                   6921: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing perl modules</a></span></dt>
                   6922: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
                   6923: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
                   6924: <dt><span class="sect2"><a href="#gconf-data-files">21.6.9. Packages installing GConf data files</a></span></dt>
                   6925: <dt><span class="sect2"><a href="#scrollkeeper-data-files">21.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
                   6926: <dt><span class="sect2"><a href="#x11-fonts">21.6.11. Packages installing X11 fonts</a></span></dt>
                   6927: <dt><span class="sect2"><a href="#gtk2-modules">21.6.12. Packages installing GTK2 modules</a></span></dt>
                   6928: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.13. Packages installing SGML or XML data</a></span></dt>
                   6929: <dt><span class="sect2"><a href="#mime-database">21.6.14. Packages installing extensions to the MIME database</a></span></dt>
                   6930: <dt><span class="sect2"><a href="#intltool">21.6.15. Packages using intltool</a></span></dt>
                   6931: <dt><span class="sect2"><a href="#startup-scripts">21.6.16. Packages installing startup scripts</a></span></dt>
                   6932: <dt><span class="sect2"><a href="#tex-packages">21.6.17. Packages installing TeX modules</a></span></dt>
                   6933: <dt><span class="sect2"><a href="#emulation-packages">21.6.18. Packages supporting running binaries in
1.1       dsieger  6934:     emulation</a></span></dt>
1.154     rillig   6935: <dt><span class="sect2"><a href="#hicolor-theme">21.6.19. Packages installing hicolor theme icons</a></span></dt>
                   6936: <dt><span class="sect2"><a href="#desktop-files">21.6.20. Packages installing desktop files</a></span></dt>
1.1       dsieger  6937: </dl></dd>
1.154     rillig   6938: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.1       dsieger  6939: </dl>
                   6940: </div>
1.41      asau     6941: <div class="sect1">
1.1       dsieger  6942: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   6943: <a name="general-operation"></a>21.1. General operation</h2></div></div></div>
1.1       dsieger  6944: <p>One appealing feature of pkgsrc is that it runs on many
1.108     rillig   6945:   different platforms. As a result, it is important to ensure,
                   6946:   where possible, that packages in pkgsrc are portable. This
                   6947:   chapter mentions some particular details you should pay
                   6948:   attention to while working on pkgsrc.</p>
1.41      asau     6949: <div class="sect2">
1.1       dsieger  6950: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   6951: <a name="pulling-vars-from-etc-mk.conf"></a>21.1.1. How to pull in user-settable variables from <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
1.1       dsieger  6952: </h3></div></div></div>
                   6953: <p>The pkgsrc user can configure pkgsrc by overriding several
                   6954:     variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.10      hubertf  6955:     which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.1       dsieger  6956:     want to use those variables in the preprocessor directives of
1.167   ! leot     6957:     <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> (for example <code class="literal">.if</code> or
1.1       dsieger  6958:     <code class="literal">.for</code>), you need to include the file
                   6959:     <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
                   6960:     loads the user preferences.</p>
                   6961: <p>But note that some variables may not be completely defined
                   6962:     after <code class="filename">../../mk/bsd.prefs.mk</code> has been
                   6963:     included, as they may contain references to variables that are
1.108     rillig   6964:     not yet defined. In shell commands (the lines in
                   6965:     <code class="filename">Makefile</code> that are indented with a tab) this
                   6966:     is no problem, since variables are only expanded when they are
                   6967:     used. But in the preprocessor directives mentioned above and in
                   6968:     dependency lines (of the form <code class="literal">target:
1.1       dsieger  6969:     dependencies</code>) the variables are expanded at load
                   6970:     time.</p>
1.41      asau     6971: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  6972: <h3 class="title">Note</h3>
1.108     rillig   6973: <p>To check whether a variable can be used at load time,
                   6974:     run <span class="command"><strong>pkglint -Wall</strong></span> on your package.</p>
1.1       dsieger  6975: </div>
                   6976: </div>
1.41      asau     6977: <div class="sect2">
1.1       dsieger  6978: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   6979: <a name="user-interaction"></a>21.1.2. User interaction</h3></div></div></div>
1.1       dsieger  6980: <p>Occasionally, packages require interaction from the user,
                   6981:     and this can be in a number of ways:</p>
1.41      asau     6982: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      6983: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.1       dsieger  6984:        interaction such as entering username/password or accepting a
                   6985:        license on a web page.</p></li>
1.23      wiz      6986: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.1       dsieger  6987:        passwords.</p></li>
1.23      wiz      6988: <li class="listitem"><p>help to configure the package before it is built</p></li>
                   6989: <li class="listitem"><p>help during the build process</p></li>
                   6990: <li class="listitem"><p>help during the installation of a package</p></li>
1.1       dsieger  6991: </ul></div>
1.108     rillig   6992: <p>A package can set the <code class="varname">INTERACTIVE_STAGE</code>
                   6993:     variable to define which stages need interaction. This should be
                   6994:     done in the package's <code class="filename">Makefile</code>, e.g.:</p>
1.1       dsieger  6995: <pre class="programlisting">
                   6996: INTERACTIVE_STAGE=      configure install
1.111     sevan    6997: </pre>
1.1       dsieger  6998: <p>The user can then decide to skip this package by setting the
1.108     rillig   6999:     <code class="varname">BATCH</code> variable. Packages that require interaction
                   7000:     are also excluded from bulk builds.</p>
1.1       dsieger  7001: </div>
1.41      asau     7002: <div class="sect2">
1.1       dsieger  7003: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   7004: <a name="handling-licenses"></a>21.1.3. Handling licenses</h3></div></div></div>
1.111     sevan    7005: <p>Authors of software can choose the licence under which software
                   7006:     can be copied.  The Free Software Foundation has declared some
                   7007:     licenses "Free", and the Open Source Initiative has a definition of
                   7008:     "Open Source".</p>
                   7009: <p>By default, pkgsrc allows packages with Free or Open Source
                   7010:     licenses to be built.  To allow packages with other licenses to be
                   7011:     built as well, the pkgsrc user needs to add these licenses to the
                   7012:     <code class="varname">ACCEPTABLE_LICENSES</code> variable in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  Note
                   7013:     that this variable only affects which packages may be
                   7014:     <span class="emphasis"><em>built</em></span>, while the license terms often also
                   7015:     restrict the actual use of the package and its redistribution.</p>
1.1       dsieger  7016: <p>One might want to only install packages with a BSD license,
1.108     rillig   7017:     or the GPL, and not the other.  The free licenses are added to the
1.111     sevan    7018:     default <code class="varname">ACCEPTABLE_LICENSES</code> variable.  The pkgsrc
1.19      jnemeth  7019:     user can override the default by setting the
                   7020:     <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
1.111     sevan    7021:     of "+=".  The licenses accepted by default are defined in the
                   7022:     <code class="varname">DEFAULT_ACCEPTABLE_LICENSES</code> variable in the file
                   7023:     <code class="filename">pkgsrc/mk/license.mk</code>.</p>
1.1       dsieger  7024: <p>The license tag mechanism is intended to address
                   7025:     copyright-related issues surrounding building, installing and
                   7026:     using a package, and not to address redistribution issues (see
                   7027:     <code class="varname">RESTRICTED</code> and
1.111     sevan    7028:     <code class="varname">NO_SRC_ON_FTP</code>, etc.).
1.19      jnemeth  7029:     Packages with redistribution restrictions should set these
                   7030:     tags.</p>
1.1       dsieger  7031: <p>Denoting that a package may be copied according to a
                   7032:     particular license is done by placing the license in
                   7033:     <code class="filename">pkgsrc/licenses</code> and setting the
                   7034:     <code class="varname">LICENSE</code> variable to a string identifying the
1.137     leot     7035:     license, e.g. in <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/graphics/xv/README.html" target="_top"><code class="filename">graphics/xv</code></a>:</p>
1.1       dsieger  7036: <pre class="programlisting">
                   7037: LICENSE=        xv-license
1.111     sevan    7038: </pre>
1.1       dsieger  7039: <p>When trying to build, the user will get a notice that the
                   7040:     package is covered by a license which has not been placed in the
                   7041:     <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
                   7042: <pre class="programlisting">
                   7043: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   7044: ===&gt; xv-3.10anb9 has an unacceptable license: xv-license.
                   7045: ===&gt;     To view the license, enter "/usr/bin/make show-license".
                   7046: ===&gt;     To indicate acceptance, add this line to your /etc/mk.conf:
                   7047: ===&gt;     ACCEPTABLE_LICENSES+=xv-license
                   7048: *** Error code 1
1.111     sevan    7049: </pre>
1.10      hubertf  7050: <p>The license can be viewed with <span class="command"><strong>make
1.1       dsieger  7051:     show-license</strong></span>, and if the user so chooses, the line
1.10      hubertf  7052:     printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1       dsieger  7053:     convey to pkgsrc that it should not in the future fail because of
                   7054:     that license:</p>
                   7055: <pre class="programlisting">
                   7056: ACCEPTABLE_LICENSES+=xv-license
1.111     sevan    7057: </pre>
                   7058: <p>The use of <code class="varname">LICENSE=shareware</code>,
                   7059:     <code class="varname">LICENSE=no-commercial-use</code>, and similar language
                   7060:     is deprecated because it does not crisply refer to a particular
                   7061:     license text.  Another problem with such usage is that it does not
                   7062:     enable a user to tell pkgsrc to proceed for a single package
                   7063:     without also telling pkgsrc to proceed for all packages with that
                   7064:     tag.</p>
                   7065: <div class="sect3">
                   7066: <div class="titlepage"><div><div><h4 class="title">
1.154     rillig   7067: <a name="new-license"></a>21.1.3.1. Adding a package with a new license</h4></div></div></div>
1.48      rodent   7068: <p>When adding a package with a new license, the following steps
                   7069:     are required:</p>
                   7070: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7071: <li class="listitem">
1.111     sevan    7072: <p>Check whether the license qualifies as Free or Open
                   7073:     Source by referencing <a class="ulink" href="http://www.gnu.org/licenses/license-list.en.html" target="_top">Various Licenses
                   7074:     and Comments about Them</a> and <a class="ulink" href="http://opensource.org/licenses/alphabetical" target="_top">Licenses by Name |
                   7075:     Open Source Initiative</a>.  If this is the case, the filename in
                   7076:     <code class="filename">pkgsrc/licenses/</code> does not need the
                   7077:     <code class="filename">-license</code> suffix, and the license name should be
                   7078:     added to:</p>
1.48      rodent   7079: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   7080: <li class="listitem"><p>DEFAULT_ACCEPTABLE_LICENSES in <code class="filename">pkgsrc/mk/license.mk</code></p></li>
                   7081: <li class="listitem"><p>default_acceptable_licenses in <code class="filename">pkgsrc/pkgtools/pkg_install/files/lib/license.c</code></p></li>
                   7082: </ul></div>
                   7083: </li>
                   7084: <li class="listitem"><p>The license text should be added to <code class="filename">pkgsrc/licenses</code> for displaying.  A list of known licenses can be seen in this directory.</p></li>
                   7085: </ol></div>
1.111     sevan    7086: </div>
                   7087: <div class="sect3">
                   7088: <div class="titlepage"><div><div><h4 class="title">
1.154     rillig   7089: <a name="change-license"></a>21.1.3.2. Change to the license</h4></div></div></div>
1.1       dsieger  7090: <p>When the license changes (in a way other than formatting),
1.111     sevan    7091:     make sure that the new license has a different name (e.g.,
1.1       dsieger  7092:     append the version number if it exists, or the date).  Just
                   7093:     because a user told pkgsrc to build programs under a previous
                   7094:     version of a license does not mean that pkgsrc should build
                   7095:     programs under the new licenses.  The higher-level point is that
                   7096:     pkgsrc does not evaluate licenses for reasonableness; the only
                   7097:     test is a mechanistic test of whether a particular text has been
1.111     sevan    7098:     approved by either of two bodies (FSF or OSI).</p>
                   7099: </div>
1.1       dsieger  7100: </div>
1.41      asau     7101: <div class="sect2">
1.1       dsieger  7102: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   7103: <a name="restricted-packages"></a>21.1.4. Restricted packages</h3></div></div></div>
1.1       dsieger  7104: <p>Some licenses restrict how software may be re-distributed.
1.111     sevan    7105:     By declaring the restrictions, package tools can
1.1       dsieger  7106:     automatically refrain from e.g. placing binary packages on FTP
                   7107:     sites.</p>
1.111     sevan    7108: <p>There are four possible restrictions, which are
1.1       dsieger  7109:     the cross product of sources (distfiles) and binaries not being
                   7110:     placed on FTP sites and CD-ROMs.  Because this is rarely the exact
                   7111:     language in any license, and because non-Free licenses tend to be
                   7112:     different from each other, pkgsrc adopts a definition of FTP and
1.111     sevan    7113:     CD-ROM.
                   7114: 
                   7115:     "FTP" means making the source or binary file available over the
                   7116:     Internet at no charge.
                   7117: 
                   7118:     "CD-ROM" means making the source or binary available on some kind of
                   7119:     media, together with other source and binary packages, which is sold
                   7120:     for a distribution charge.
1.1       dsieger  7121:     </p>
                   7122: <p>In order to encode these restrictions, the package system
                   7123:     defines five make variables that can be set to note these
                   7124:     restrictions:</p>
1.41      asau     7125: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      7126: <li class="listitem">
1.1       dsieger  7127: <p><code class="varname">RESTRICTED</code></p>
                   7128: <p>This variable should be set whenever a restriction
                   7129:        exists (regardless of its kind).  Set this variable to a
                   7130:        string containing the reason for the restriction.  It should
                   7131:        be understood that those wanting to understand the restriction
                   7132:        will have to read the license, and perhaps seek advice of
                   7133:        counsel.</p>
                   7134: </li>
1.23      wiz      7135: <li class="listitem">
1.1       dsieger  7136: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
                   7137: <p>Binaries may not be placed on CD-ROM containing other
                   7138:        binary packages, for which a distribution charge may be made.
                   7139:        In this case, set this variable to
                   7140:        <code class="varname">${RESTRICTED}</code>.</p>
                   7141: </li>
1.23      wiz      7142: <li class="listitem">
1.1       dsieger  7143: <p><code class="varname">NO_BIN_ON_FTP</code></p>
                   7144: <p>Binaries may not made available on the Internet without
                   7145:        charge.  In this case, set this variable to
                   7146:        <code class="varname">${RESTRICTED}</code>.  If this variable is set,
                   7147:        binary packages will not be included on ftp.NetBSD.org.</p>
                   7148: </li>
1.23      wiz      7149: <li class="listitem">
1.1       dsieger  7150: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
                   7151: <p>Distfiles may not be placed on CD-ROM, together with
                   7152:        other distfiles, for which a fee may be charged.  In this
                   7153:        case, set this variable to <code class="varname">${RESTRICTED}</code>.
                   7154:        </p>
                   7155: </li>
1.23      wiz      7156: <li class="listitem">
1.1       dsieger  7157: <p><code class="varname">NO_SRC_ON_FTP</code></p>
                   7158: <p>Distfiles may not made available via FTP at no charge.
                   7159:        In this case, set this variable to
                   7160:        <code class="varname">${RESTRICTED}</code>.  If this variable is set,
                   7161:        the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
                   7162: </li>
                   7163: </ul></div>
1.111     sevan    7164: <p>Please note that packages will be removed from pkgsrc when the
                   7165:     distfiles are not distributable and cannot be obtained for a period
                   7166:     of one full quarter branch. Packages with manual/interactive fetch
                   7167:     must have a maintainer and it is his/her responsibility to ensure
                   7168:     this.</p>
1.1       dsieger  7169: </div>
1.41      asau     7170: <div class="sect2">
1.1       dsieger  7171: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   7172: <a name="dependencies"></a>21.1.5. Handling dependencies</h3></div></div></div>
1.1       dsieger  7173: <p>Your package may depend on some other package being present
                   7174:     - and there are various ways of expressing this dependency.
                   7175:     pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
1.156     leot     7176:     <code class="varname">DEPENDS</code> and
                   7177:     <code class="varname">TOOL_DEPENDS</code> definitions, the
1.1       dsieger  7178:     <code class="varname">USE_TOOLS</code> definition, as well as dependencies
                   7179:     via <code class="filename">buildlink3.mk</code>, which is the preferred way
                   7180:     to handle dependencies, and which uses the variables named above.
1.154     rillig   7181:     See <a class="xref" href="#buildlink" title="Chapter 16. Buildlink methodology">Chapter 16, <i>Buildlink methodology</i></a> for more information.</p>
1.1       dsieger  7182: <p>The basic difference between the two variables is as
                   7183:     follows: The <code class="varname">DEPENDS</code> definition registers
                   7184:     that pre-requisite in the binary package so it will be pulled in
                   7185:     when the binary package is later installed, whilst the
1.156     leot     7186:     <code class="varname">BUILD_DEPENDS</code> and <code class="varname">TOOL_DEPENDS</code>
                   7187:     definitions does not, marking a dependency that is only needed for
                   7188:     building the package.</p>
1.1       dsieger  7189: <p>This means that if you only need a package present whilst
                   7190:     you are building, it should be noted as a
1.156     leot     7191:     <code class="varname">TOOL_DEPENDS</code> or
                   7192:     <code class="varname">BUILD_DEPENDS</code>.  When cross-compiling,
                   7193:     <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
                   7194:     packages, i.e. packages for the architecture where the package
                   7195:     is built;
                   7196:     <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
                   7197:     packages, i.e. packages for the architecture for which the package
                   7198:     is built.</p>
                   7199: <p>The format for <code class="varname">BUILD_DEPENDS</code>,
                   7200:     <code class="varname">DEPENDS</code> and <code class="varname">TOOL_DEPENDS</code>
                   7201:     definition is:</p>
1.1       dsieger  7202: <pre class="programlisting">
                   7203: &lt;pre-req-package-name&gt;:../../&lt;category&gt;/&lt;pre-req-package&gt;
1.111     sevan    7204: </pre>
1.23      wiz      7205: <p>Please note that the <span class="quote">&#8220;<span class="quote">pre-req-package-name</span>&#8221;</span>
1.1       dsieger  7206:     may include any of the wildcard version numbers recognized by
1.167   ! leot     7207:     <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_info+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">pkg_info</span>(1)</span></a>.</p>
1.23      wiz      7208: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7209: <li class="listitem">
1.1       dsieger  7210: <p>If your package needs another package's binaries or
1.54      wiz      7211:        libraries to build and run, and if that package has a
1.1       dsieger  7212:        <code class="filename">buildlink3.mk</code> file available, use it:</p>
                   7213: <pre class="programlisting">
                   7214: .include "../../graphics/jpeg/buildlink3.mk"
1.111     sevan    7215: </pre>
1.1       dsieger  7216: </li>
1.23      wiz      7217: <li class="listitem">
1.54      wiz      7218: <p>If your package needs another package's binaries or
                   7219:        libraries only for building, and if that package has a
                   7220:        <code class="filename">buildlink3.mk</code> file available, use it:</p>
                   7221: <pre class="programlisting">
                   7222: .include "../../graphics/jpeg/buildlink3.mk"
1.111     sevan    7223: </pre>
1.54      wiz      7224: <p>but set
                   7225:        <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>jpeg</code></em>?=build</code>
                   7226:        to make it a build dependency only. This case is rather
                   7227:        rare.</p>
                   7228: </li>
                   7229: <li class="listitem">
1.25      spz      7230: <p>If your package needs binaries from another package to build,
1.156     leot     7231:        use the <code class="varname">TOOL_DEPENDS</code> definition:</p>
1.1       dsieger  7232: <pre class="programlisting">
1.156     leot     7233: TOOL_DEPENDS+= itstool-[0-9]*:../../textproc/itstool
1.111     sevan    7234: </pre>
1.1       dsieger  7235: </li>
1.156     leot     7236: <li class="listitem"><p>If your package needs static libraries to link against, header
                   7237:        files to include, etc. from another package to build,
                   7238:        use the <code class="varname">BUILD_DEPENDS</code> definition.</p></li>
1.25      spz      7239: <li class="listitem"><p>If your package needs a library with which to link and
                   7240:        there is no <code class="filename">buildlink3.mk</code> file
                   7241:        available, create one. Using
                   7242:        <code class="varname">DEPENDS</code> won't be sufficient because the
                   7243:        include files and libraries will be hidden from the compiler.</p></li>
1.23      wiz      7244: <li class="listitem">
1.25      spz      7245: <p>If your package needs some executable to be able to run
                   7246:        correctly and if there's no
                   7247:        <code class="filename">buildlink3.mk</code> file, this is specified
                   7248:        using the <code class="varname">DEPENDS</code> variable. The
1.137     leot     7249:        <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/lyx/README.html" target="_top"><code class="filename">print/lyx</code></a> package needs to
1.129     wiz      7250:        be able to execute the latex binary from the tex-latex-bin package
1.25      spz      7251:        when it runs, and that is specified:</p>
1.1       dsieger  7252: <pre class="programlisting">
1.129     wiz      7253: DEPENDS+=        tex-latex-bin-[0-9]*:../../print/tex-latex-bin
1.111     sevan    7254: </pre>
1.25      spz      7255: </li>
                   7256: <li class="listitem">
                   7257: <p>You can use wildcards in package dependencies. Note that
                   7258:        such wildcard dependencies are retained when creating binary
                   7259:        packages. The dependency is checked when installing the binary
                   7260:        package and any package which matches the pattern will be
                   7261:        used. Wildcard dependencies should be used with care.</p>
1.23      wiz      7262: <p>The <span class="quote">&#8220;<span class="quote">-[0-9]*</span>&#8221;</span> should be used instead of
                   7263:        <span class="quote">&#8220;<span class="quote">-*</span>&#8221;</span> to avoid potentially ambiguous matches
                   7264:        such as <span class="quote">&#8220;<span class="quote">tk-postgresql</span>&#8221;</span> matching a
                   7265:        <span class="quote">&#8220;<span class="quote">tk-*</span>&#8221;</span> <code class="varname">DEPENDS</code>.</p>
1.1       dsieger  7266: <p>Wildcards can also be used to specify that a package
                   7267:        will only build against a certain minimum version of a
                   7268:        pre-requisite:</p>
                   7269: <pre class="programlisting">
1.25      spz      7270: DEPENDS+=       ImageMagick&gt;=6.0:../../graphics/ImageMagick
1.111     sevan    7271: </pre>
1.25      spz      7272: <p>This means that the package will build using version 6.0
                   7273:        of ImageMagick or newer. Such a dependency may be warranted
                   7274:        if, for example, the command line options of an executable
                   7275:        have changed.</p>
                   7276: <p>If you need to depend on minimum versions of libraries,
                   7277:        see the buildlink section of the pkgsrc guide.</p>
1.1       dsieger  7278: <p>For security fixes, please update the package
1.154     rillig   7279:        vulnerabilities file. See <a class="xref" href="#security-handling" title="21.1.9. Handling packages with security problems">Section 21.1.9, &#8220;Handling packages with security problems&#8221;</a> for more
1.1       dsieger  7280:        information.</p>
                   7281: </li>
                   7282: </ol></div>
                   7283: <p>If your package needs files from another package to build,
                   7284:     add the relevant distribution files to
                   7285:     <code class="varname">DISTFILES</code>, so they will be extracted
1.137     leot     7286:     automatically. See the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/print/ghostscript/README.html" target="_top"><code class="filename">print/ghostscript</code></a> package for an example.
1.1       dsieger  7287:     (It relies on the jpeg sources being present in source form
                   7288:     during the build.)</p>
                   7289: </div>
1.41      asau     7290: <div class="sect2">
1.1       dsieger  7291: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   7292: <a name="conflicts"></a>21.1.6. Handling conflicts with other packages</h3></div></div></div>
1.1       dsieger  7293: <p>Your package may conflict with other packages a user might
                   7294:     already have installed on his system, e.g. if your package
                   7295:     installs the same set of files as another package in the pkgsrc
1.80      wiz      7296:     tree or has the same <code class="varname">PKGNAME</code>.</p>
1.142     leot     7297: <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>
                   7298:     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>
                   7299:     install the same shared library, thus you set in
                   7300:     <code class="filename">pkgsrc/x11/libXaw3d/Makefile</code>:</p>
                   7301: <pre class="programlisting">
                   7302: CONFLICTS=      Xaw-Xpm-[0-9]*
                   7303:     </pre>
                   7304: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
                   7305: <pre class="programlisting">
                   7306: CONFLICTS=      libXaw3d-[0-9]*
                   7307:     </pre>
1.167   ! leot     7308: <p><a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_add+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">pkg_add</span>(1)</span></a> is able to detect attempts to install packages
1.142     leot     7309:     that conflict with existing packages and abort. However, in many
                   7310:     situations this is too late in the process. Binary package managers
                   7311:     will not know about the conflict until they attempt to install the
                   7312:     package after already downloading it and all its dependencies.
                   7313:     Users may also waste time building a package and its dependencies
                   7314:     only to find out at the end that it conflicts with another package
                   7315:     they have installed.</p>
                   7316: <p>To avoid these issues <code class="varname">CONFLICTS</code> entries
                   7317:     should be added in all cases where it is known that packages conflict
                   7318:     with each other.  These <code class="varname">CONFLICTS</code> entries are
1.167   ! leot     7319:     exported in <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_summary+5.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">pkg_summary</span>(5)</span></a> files and consumed by binary package
1.142     leot     7320:     managers to inform users that packages cannot be installed onto
                   7321:     the target system.</p>
1.1       dsieger  7322: </div>
1.41      asau     7323: <div class="sect2">
1.1       dsieger  7324: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   7325: <a name="not-building-packages"></a>21.1.7. Packages that cannot or should not be built</h3></div></div></div>
1.1       dsieger  7326: <p>There are several reasons why a package might be
                   7327:     instructed to not build under certain circumstances.  If the
                   7328:     package builds and runs on most platforms, the exceptions
1.83      dholland 7329:     should be noted with <code class="varname">BROKEN_ON_PLATFORM</code>.  If
                   7330:     the package builds and runs on a small handful of platforms,
                   7331:     set <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> instead.
                   7332:     Both <code class="varname">BROKEN_ON_PLATFORM</code> and
                   7333:     <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> are OS triples
                   7334:     (OS-version-platform) that can use glob-style
                   7335:     wildcards.</p>
                   7336: <p>If a package is not appropriate for some platforms (as
1.114     maya     7337:     opposed to merely broken), a different set of variables should be
1.83      dholland 7338:     used as this affects failure reporting and statistics.
                   7339:     If the package is appropriate for most platforms, the exceptions
1.1       dsieger  7340:     should be noted with <code class="varname">NOT_FOR_PLATFORM</code>.  If
1.83      dholland 7341:     the package is appropriate for only a small handful of platforms
                   7342:     (often exactly one), set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
1.1       dsieger  7343:     Both <code class="varname">ONLY_FOR_PLATFORM</code> and
                   7344:     <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
                   7345:     (OS-version-platform) that can use glob-style
                   7346:     wildcards.</p>
                   7347: <p>Some packages are tightly bound to a specific version of an
1.137     leot     7348:     operating system, e.g. LKMs or <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/sysutils/lsof/README.html" target="_top"><code class="filename">sysutils/lsof</code></a>.  Such binary packages are not
1.1       dsieger  7349:     backwards compatible with other versions of the OS, and should be
                   7350:     uploaded to a version specific directory on the FTP server.  Mark
                   7351:     these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.23      wiz      7352:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.  This variable is not currently used by any of
1.1       dsieger  7353:     the package system internals, but may be used in the
                   7354:     future.</p>
                   7355: <p>If the package should be skipped (for example, because it
                   7356:     provides functionality already provided by the system), set
                   7357:     <code class="varname">PKG_SKIP_REASON</code> to a descriptive message.  If
                   7358:     the package should fail because some preconditions are not met,
                   7359:     set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
                   7360:     message.</p>
                   7361: </div>
1.41      asau     7362: <div class="sect2">
1.1       dsieger  7363: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   7364: <a name="undeletable-packages"></a>21.1.8. Packages which should not be deleted, once installed</h3></div></div></div>
1.1       dsieger  7365: <p>To ensure that a package may not be deleted, once it has been
                   7366:     installed, the <code class="varname">PKG_PRESERVE</code> definition should
                   7367:     be set in the package Makefile. This will be carried into any
                   7368:     binary package that is made from this pkgsrc entry. A
1.23      wiz      7369:     <span class="quote">&#8220;<span class="quote">preserved</span>&#8221;</span> package will
1.167   ! leot     7370:     not be deleted using <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_delete+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">pkg_delete</span>(1)</span></a> unless the
1.23      wiz      7371:     <span class="quote">&#8220;<span class="quote">-f</span>&#8221;</span> option is used.</p>
1.1       dsieger  7372: </div>
1.41      asau     7373: <div class="sect2">
1.1       dsieger  7374: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   7375: <a name="security-handling"></a>21.1.9. Handling packages with security problems</h3></div></div></div>
1.1       dsieger  7376: <p>When a vulnerability is found, this should be noted in
                   7377:     <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
1.31      wiz      7378:     and after committing that file, ask pkgsrc-security@NetBSD.org to
                   7379:     update the file on ftp.NetBSD.org.</p>
1.1       dsieger  7380: <p>After fixing the vulnerability by a patch, its
1.31      wiz      7381:     <code class="varname">PKGREVISION</code> should be increased (this is of
                   7382:     course not necessary if the problem is fixed by using a newer
                   7383:     release of the software), and the pattern in the
                   7384:     pkg-vulnerabilities file must be updated.</p>
1.1       dsieger  7385: <p>Also, if the fix should be applied to the stable pkgsrc
                   7386:     branch, be sure to submit a pullup request!</p>
                   7387: <p>Binary packages already on ftp.NetBSD.org will be handled
                   7388:     semi-automatically by a weekly cron job.</p>
                   7389: </div>
1.41      asau     7390: <div class="sect2">
1.1       dsieger  7391: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   7392: <a name="bumping-pkgrevision"></a>21.1.10. How to handle incrementing versions when fixing an existing package</h3></div></div></div>
1.1       dsieger  7393: <p>When making fixes to an existing package it can be useful
                   7394:     to change the version number in <code class="varname">PKGNAME</code>. To
                   7395:     avoid conflicting with future versions by the original author, a
1.23      wiz      7396:     <span class="quote">&#8220;<span class="quote">nb1</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">nb2</span>&#8221;</span>, ... suffix can be used
1.1       dsieger  7397:     on package versions by setting <code class="varname">PKGREVISION=1</code>
1.23      wiz      7398:     (2, ...). The <span class="quote">&#8220;<span class="quote">nb</span>&#8221;</span> is treated like a
                   7399:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span> by the package tools. e.g.</p>
1.1       dsieger  7400: <pre class="programlisting">
                   7401: DISTNAME=       foo-17.42
                   7402: PKGREVISION=    9
1.111     sevan    7403: </pre>
1.1       dsieger  7404: <p>will result in a <code class="varname">PKGNAME</code> of
1.23      wiz      7405:     <span class="quote">&#8220;<span class="quote">foo-17.42nb9</span>&#8221;</span>. If you want to use the original
                   7406:     value of <code class="varname">PKGNAME</code> without the <span class="quote">&#8220;<span class="quote">nbX</span>&#8221;</span>
1.1       dsieger  7407:     suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
                   7408:     <code class="varname">PKGNAME_NOREV</code>.</p>
                   7409: <p>When a new release of the package is released, the
                   7410:     <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
                   7411:     minor release of the above package, things should be like:</p>
                   7412: <pre class="programlisting">
                   7413: DISTNAME=       foo-17.43
1.111     sevan    7414: </pre>
1.1       dsieger  7415: <p><code class="varname">PKGREVISION</code> should be incremented for any
                   7416:     non-trivial change in the resulting binary package.  Without a
                   7417:     <code class="varname">PKGREVISION</code> bump, someone with the previous
                   7418:     version installed has no way of knowing that their package is out
                   7419:     of date.  Thus, changes without increasing
                   7420:     <code class="varname">PKGREVISION</code> are essentially labeled "this is so
                   7421:     trivial that no reasonable person would want to upgrade", and this
                   7422:     is the rough test for when increasing
                   7423:     <code class="varname">PKGREVISION</code> is appropriate.  Examples of
                   7424:     changes that do not merit increasing
                   7425:     <code class="varname">PKGREVISION</code> are:</p>
1.41      asau     7426: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      7427: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.14      jmcneill 7428:       <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>,
1.1       dsieger  7429:       or comments in Makefile.</p></li>
1.23      wiz      7430: <li class="listitem"><p>
1.1       dsieger  7431:       Changing build variables if the resulting binary package is the same.</p></li>
1.23      wiz      7432: <li class="listitem"><p>
1.1       dsieger  7433:       Changing <code class="filename">DESCR</code>.</p></li>
1.23      wiz      7434: <li class="listitem"><p>
1.1       dsieger  7435:       Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.</p></li>
                   7436: </ul></div>
                   7437: <p>Examples of changes that do merit an increase to
                   7438:     <code class="varname">PKGREVISION</code> include:</p>
1.41      asau     7439: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      7440: <li class="listitem"><p>
1.1       dsieger  7441:       Security fixes</p></li>
1.23      wiz      7442: <li class="listitem"><p>
1.1       dsieger  7443:       Changes or additions to a patch file</p></li>
1.23      wiz      7444: <li class="listitem"><p>
1.1       dsieger  7445:       Changes to the <code class="filename">PLIST</code></p></li>
1.23      wiz      7446: <li class="listitem"><p>A dependency is changed or renamed.</p></li>
1.1       dsieger  7447: </ul></div>
                   7448: <p>PKGREVISION must also be incremented when dependencies have ABI
                   7449:     changes.</p>
                   7450: </div>
1.41      asau     7451: <div class="sect2">
1.1       dsieger  7452: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   7453: <a name="fixes.subst"></a>21.1.11. Substituting variable text in the package files (the SUBST framework)</h3></div></div></div>
1.1       dsieger  7454: <p>When you want to replace the same text in multiple files
                   7455:     or when the replacement text varies, patches alone cannot help.
                   7456:     This is where the SUBST framework comes in. It provides an
                   7457:     easy-to-use interface for replacing text in files.
                   7458:     Example:</p>
                   7459: <pre class="programlisting">
                   7460: SUBST_CLASSES+=                 fix-paths
                   7461: SUBST_STAGE.fix-paths=          pre-configure
                   7462: SUBST_MESSAGE.fix-paths=        Fixing absolute paths.
                   7463: SUBST_FILES.fix-paths=          src/*.c
                   7464: SUBST_FILES.fix-paths+=         scripts/*.sh
                   7465: SUBST_SED.fix-paths=            -e 's,"/usr/local,"${PREFIX},g'
                   7466: SUBST_SED.fix-paths+=           -e 's,"/var/log,"${VARBASE}/log,g'
1.111     sevan    7467: </pre>
1.1       dsieger  7468: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
                   7469:     that are used to identify the different SUBST blocks that are
                   7470:     defined. The SUBST framework is heavily used by pkgsrc, so it is
                   7471:     important to always use the <code class="literal">+=</code> operator with
                   7472:     this variable. Otherwise some substitutions may be
                   7473:     skipped.</p>
                   7474: <p>The remaining variables of each SUBST block are
                   7475:     parameterized with the identifier from the first line
                   7476:     (<code class="literal">fix-paths</code> in this case.) They can be seen as
                   7477:     parameters to a function call.</p>
                   7478: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
                   7479:     which the replacement will take place. All combinations of
                   7480:     <code class="literal">pre-</code>, <code class="literal">do-</code> and
                   7481:     <code class="literal">post-</code> together with a phase name are
                   7482:     possible, though only few are actually used. Most commonly used
                   7483:     are <code class="literal">post-patch</code> and
                   7484:     <code class="literal">pre-configure</code>. Of these two,
                   7485:     <code class="literal">pre-configure</code> should be preferred because
1.10      hubertf  7486:     then it is possible to run <span class="command"><strong>bmake patch</strong></span> and
1.1       dsieger  7487:     have the state after applying the patches but before making any
                   7488:     other changes. This is especially useful when you are debugging
                   7489:     a package in order to create new patches for it. Similarly,
                   7490:     <code class="literal">post-build</code> is preferred over
                   7491:     <code class="literal">pre-install</code>, because the install phase should
                   7492:     generally be kept as simple as possible. When you use
                   7493:     <code class="literal">post-build</code>, you have the same files in the
                   7494:     working directory that will be installed later, so you can check
                   7495:     if the substitution has succeeded.</p>
                   7496: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
                   7497:     that is printed just before the substitution is done.</p>
                   7498: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
                   7499:     globbing patterns that specifies the files in which the
                   7500:     substitution will take place. The patterns are interpreted
                   7501:     relatively to the <code class="varname">WRKSRC</code> directory.</p>
                   7502: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
1.167   ! leot     7503:     <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?sed+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">sed</span>(1)</span></a> that specify the actual substitution. Every sed
1.1       dsieger  7504:     command should be prefixed with <code class="literal">-e</code>, so that
                   7505:     all SUBST blocks look uniform.</p>
                   7506: <p>There are some more variables, but they are so seldomly
                   7507:     used that they are only documented in the
                   7508:     <code class="filename">mk/subst.mk</code> file.</p>
                   7509: </div>
                   7510: </div>
1.41      asau     7511: <div class="sect1">
1.1       dsieger  7512: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   7513: <a name="fixes.fetch"></a>21.2. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.41      asau     7514: <div class="sect2">
1.1       dsieger  7515: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   7516: <a name="no-plain-download"></a>21.2.1. Packages whose distfiles aren't available for plain downloading</h3></div></div></div>
1.1       dsieger  7517: <p>If you need to download from a dynamic URL you can set
1.10      hubertf  7518:     <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.1       dsieger  7519:     fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
                   7520:     with the name of each file to download as an argument, expecting
                   7521:     it to output the URL of the directory from which to download
1.137     leot     7522:     it. <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/graphics/ns-cult3d/README.html" target="_top"><code class="filename">graphics/ns-cult3d</code></a> is an
1.1       dsieger  7523:     example of this usage.</p>
                   7524: <p>If the download can't be automated, because the user must
                   7525:     submit personal information to apply for a password, or must pay
                   7526:     for the source, or whatever, you can set
                   7527:     <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
                   7528:     displayed to the user before aborting the build. Example:</p>
                   7529: <pre class="programlisting">
                   7530: FETCH_MESSAGE=  "Please download the files"
                   7531: FETCH_MESSAGE+= "    "${DISTFILES:Q}
                   7532: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.111     sevan    7533: </pre>
1.1       dsieger  7534: </div>
1.41      asau     7535: <div class="sect2">
1.1       dsieger  7536: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   7537: <a name="modified-distfiles-same-name"></a>21.2.2. How to handle modified distfiles with the 'old' name</h3></div></div></div>
1.1       dsieger  7538: <p>Sometimes authors of a software package make some
                   7539:     modifications after the software was released, and they put up a
                   7540:     new distfile without changing the package's version number. If a
                   7541:     package is already in pkgsrc at that time, the checksum will
                   7542:     no longer match. The contents of the new distfile should be
                   7543:     compared against the old one before changing anything, to make
                   7544:     sure the distfile was really updated on purpose, and that
                   7545:     no trojan horse or so crept in.
                   7546:     Please mention that the distfiles were compared and what was found
1.53      rodent   7547:     in your commit message.</p>
1.109     wiz      7548: <p>Then, the correct way to work around this is to set
                   7549:     <code class="varname">DIST_SUBDIR</code> to a unique directory name, usually
                   7550:     based on <code class="varname">PKGNAME_NOREV</code> (but take care with
                   7551:     python or ruby packages, where <code class="varname">PKGNAME</code> includes
                   7552:     a variable prefix). All <code class="varname">DISTFILES</code> and
1.1       dsieger  7553:     <code class="varname">PATCHFILES</code> for this package will be put in that
1.154     rillig   7554:     subdirectory of the local distfiles directory. (See <a class="xref" href="#bumping-pkgrevision" title="21.1.10. How to handle incrementing versions when fixing an existing package">Section 21.1.10, &#8220;How to handle incrementing versions when fixing an existing package&#8221;</a> for more details.) In case this
1.1       dsieger  7555:     happens more often, <code class="varname">PKGNAME</code> can be used (thus
1.109     wiz      7556:     including the <code class="filename">nbX</code> suffix) or a date stamp can
                   7557:     be appended, like
                   7558:     <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.</p>
1.53      rodent   7559: <p><code class="varname">DIST_SUBDIR</code> is also used when a distfile's name does not contain a version and the distfile is apt to change. In cases where the likelihood of this is very small, <code class="varname">DIST_SUBDIR</code> might not be required. Additionally, <code class="varname">DIST_SUBDIR</code> must not be removed unless the distfile name changes, even if a package is being moved or renamed.</p>
                   7560: <p>Do not forget regenerating the <code class="filename">distinfo</code> file
1.1       dsieger  7561:     after that, since it contains the <code class="varname">DIST_SUBDIR</code>
                   7562:     path in the filenames.
1.53      rodent   7563:     Also, increase the PKGREVISION if the installed package is different.
1.1       dsieger  7564:     Furthermore, a mail to the package's authors seems appropriate
                   7565:     telling them that changing distfiles after releases without
                   7566:     changing the file names is not good practice.</p>
                   7567: </div>
1.88      tnn      7568: <div class="sect2">
                   7569: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   7570: <a name="build.fetch.github"></a>21.2.3. Packages hosted on github.com</h3></div></div></div>
1.90      tnn      7571: <p>Helper methods exist for packages hosted on github.com which will often have distfile names that clash with other packages, for example <code class="filename">1.0.tar.gz</code>. Use one of the three recipes from below:
                   7572:     </p>
1.88      tnn      7573: <div class="sect3">
                   7574: <div class="titlepage"><div><div><h4 class="title">
1.154     rillig   7575: <a name="build.fetch.github.tag"></a>21.2.3.1. Fetch based on a tagged release</h4></div></div></div>
1.88      tnn      7576: <p>
                   7577:         If your distfile URL looks similar to <code class="literal">http://github.com/username/exampleproject/archive/v1.0.zip</code>, then you are packaging a tagged release.
                   7578:       </p>
                   7579: <pre class="programlisting">
                   7580: DISTNAME=       exampleproject-1.0
1.90      tnn      7581: MASTER_SITES=   ${MASTER_SITE_GITHUB:=username/}
                   7582: #GITHUB_PROJECT=        # can be omitted if same as DISTNAME
                   7583: GITHUB_TAG=     v${PKGVERSION_NOREV}
1.88      tnn      7584: EXTRACT_SUFX=   .zip
                   7585: </pre>
                   7586: </div>
                   7587: <div class="sect3">
                   7588: <div class="titlepage"><div><div><h4 class="title">
1.154     rillig   7589: <a name="build.fetch.github.commit"></a>21.2.3.2. Fetch based on a specific commit</h4></div></div></div>
1.88      tnn      7590: <p>
                   7591:         If your distfile URL looks similar to <code class="literal">http://github.com/example/example/archive/988881adc9fc3655077dc2d4d757d480b5ea0e11.tar.gz</code>, then you are packaging a specific commit not tied to a release.
                   7592:       </p>
                   7593: <pre class="programlisting">
                   7594: DISTNAME=       example-1.0
1.107     jnemeth  7595: MASTER_SITES=   ${MASTER_SITE_GITHUB:=example/}
1.90      tnn      7596: #GITHUB_PROJECT=        # can be omitted if same as DISTNAME
                   7597: GITHUB_TAG=     988881adc9fc3655077dc2d4d757d480b5ea0e11
1.111     sevan    7598: </pre>
1.88      tnn      7599: </div>
                   7600: <div class="sect3">
                   7601: <div class="titlepage"><div><div><h4 class="title">
1.154     rillig   7602: <a name="build.fetch.github.release"></a>21.2.3.3. Fetch based on release</h4></div></div></div>
1.88      tnn      7603: <p>
                   7604:         If your distfile URL looks similar to <code class="literal">http://github.com/username/exampleproject/releases/download/rel-1.6/offensive-1.6.zip</code>, then you are packaging a release.
                   7605:       </p>
                   7606: <pre class="programlisting">
                   7607: DISTNAME=       offensive-1.6
1.90      tnn      7608: PKGNAME=        ${DISTNAME:S/offensive/proper/}
                   7609: MASTER_SITES=   ${MASTER_SITE_GITHUB:=username/}
                   7610: GITHUB_PROJECT= exampleproject
                   7611: GITHUB_RELEASE= rel-${PKGVERSION_NOREV} # usually just set this to ${DISTNAME}
                   7612: EXTRACT_SUFX=   .zip
1.111     sevan    7613: </pre>
1.88      tnn      7614: </div>
                   7615: </div>
1.1       dsieger  7616: </div>
1.41      asau     7617: <div class="sect1">
1.1       dsieger  7618: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   7619: <a name="fixes.configure"></a>21.3. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.41      asau     7620: <div class="sect2">
1.1       dsieger  7621: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   7622: <a name="fixes.libtool"></a>21.3.1. Shared libraries - libtool</h3></div></div></div>
1.1       dsieger  7623: <p>pkgsrc supports many different machines, with different
                   7624:     object formats like a.out and ELF, and varying abilities to do
                   7625:     shared library and dynamic loading at all. To accompany this,
                   7626:     varying commands and options have to be passed to the
                   7627:     compiler, linker, etc. to get the Right Thing, which can be
                   7628:     pretty annoying especially if you don't have all the machines
                   7629:     at your hand to test things.  The
1.137     leot     7630:     <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/libtool/README.html" target="_top"><code class="filename">devel/libtool</code></a> pkg
1.23      wiz      7631:     can help here, as it just <span class="quote">&#8220;<span class="quote">knows</span>&#8221;</span> how to build
1.1       dsieger  7632:     both static and dynamic libraries from a set of source files,
                   7633:     thus being platform-independent.</p>
                   7634: <p>Here's how to use libtool in a package in seven simple
                   7635:     steps:</p>
1.23      wiz      7636: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7637: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.1       dsieger  7638:        Makefile.</p></li>
1.23      wiz      7639: <li class="listitem"><p>For library objects, use <span class="quote">&#8220;<span class="quote">${LIBTOOL} --mode=compile
                   7640:        ${CC}</span>&#8221;</span> in place of <span class="quote">&#8220;<span class="quote">${CC}</span>&#8221;</span>. You could even
1.1       dsieger  7641:        add it to the definition of <code class="varname">CC</code>, if only
                   7642:        libraries are being built in a given Makefile. This one command
                   7643:        will build both PIC and non-PIC library objects, so you need not
                   7644:        have separate shared and non-shared library rules.</p></li>
1.23      wiz      7645: <li class="listitem">
1.1       dsieger  7646: <p>For the linking of the library, remove any
1.23      wiz      7647:        <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
                   7648:        -Bshareable</span>&#8221;</span> commands, and instead use:</p>
1.1       dsieger  7649: <pre class="programlisting">
                   7650: ${LIBTOOL} --mode=link \
                   7651:     ${CC} -o ${.TARGET:.a=.la} \
                   7652:         ${OBJS:.o=.lo} \
                   7653:         -rpath ${PREFIX}/lib \
                   7654:         -version-info major:minor
1.111     sevan    7655: </pre>
1.1       dsieger  7656: <p>Note that the library is changed to have a
                   7657:        <code class="filename">.la</code> extension, and the objects are
                   7658:        changed to have a <code class="filename">.lo</code>
                   7659:        extension. Change <code class="varname">OBJS</code> as
                   7660:        necessary. This automatically creates all of the
                   7661:        <code class="filename">.a</code>,
                   7662:        <code class="filename">.so.major.minor</code>, and ELF symlinks (if
                   7663:        necessary) in the build directory. Be sure to include
1.23      wiz      7664:        <span class="quote">&#8220;<span class="quote">-version-info</span>&#8221;</span>, especially when major and
1.1       dsieger  7665:        minor are zero, as libtool will otherwise strip off the
                   7666:        shared library version.</p>
                   7667: <p>From the libtool manual:</p>
                   7668: <pre class="programlisting">
                   7669: So, libtool library versions are described by three integers:
                   7670: 
                   7671: CURRENT
                   7672: The most recent interface number that this library implements.
                   7673: 
                   7674: REVISION
                   7675: The implementation number of the CURRENT interface.
                   7676: 
                   7677: AGE
                   7678: The difference between the newest and oldest interfaces that
                   7679: this library implements.  In other words, the library implements
                   7680: all the interface numbers in the range from number `CURRENT -
                   7681: AGE' to `CURRENT'.
                   7682: 
                   7683: If two libraries have identical CURRENT and AGE numbers, then the
                   7684: dynamic linker chooses the library with the greater REVISION number.
1.111     sevan    7685: </pre>
1.23      wiz      7686: <p>The <span class="quote">&#8220;<span class="quote">-release</span>&#8221;</span> option will produce
1.1       dsieger  7687:        different results for a.out and ELF (excluding symlinks)
                   7688:        in only one case. An ELF library of the form
1.23      wiz      7689:        <span class="quote">&#8220;<span class="quote">libfoo-release.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>&#8221;</span>
1.1       dsieger  7690:        will have a symlink of
1.23      wiz      7691:        <span class="quote">&#8220;<span class="quote">libfoo.so.<span class="emphasis"><em>x</em></span>.<span class="emphasis"><em>y</em></span></span>&#8221;</span>
1.1       dsieger  7692:        on an a.out platform. This is handled
                   7693:        automatically.</p>
1.23      wiz      7694: <p>The <span class="quote">&#8220;<span class="quote">-rpath argument</span>&#8221;</span> is the install
1.1       dsieger  7695:        directory of the library being built.</p>
                   7696: <p>In the <code class="filename">PLIST</code>, include only the
                   7697:        <code class="filename">.la</code> file, the other files will be
                   7698:        added automatically.</p>
                   7699: </li>
1.23      wiz      7700: <li class="listitem">
1.1       dsieger  7701: <p>When linking shared object (<code class="filename">.so</code>)
1.167   ! leot     7702:        files, i.e. files that are loaded via <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?dlopen+3.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">dlopen</span>(3)</span></a>, NOT
1.23      wiz      7703:        shared libraries, use <span class="quote">&#8220;<span class="quote">-module
                   7704:        -avoid-version</span>&#8221;</span> to prevent them getting version
1.1       dsieger  7705:        tacked on.</p>
                   7706: <p>The <code class="filename">PLIST</code> file gets the
                   7707:        <code class="filename">foo.so</code> entry.</p>
                   7708: </li>
1.23      wiz      7709: <li class="listitem">
1.1       dsieger  7710: <p>When linking programs that depend on these libraries
                   7711:        <span class="emphasis"><em>before</em></span> they are installed, preface
1.167   ! leot     7712:        the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?cc+1.i386+NetBSD-8.1"><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-8.1"><span class="citerefentry"><span class="refentrytitle">ld</span>(1)</span></a> line with <span class="quote">&#8220;<span class="quote">${LIBTOOL}
1.23      wiz      7713:        --mode=link</span>&#8221;</span>, and it will find the correct
1.1       dsieger  7714:        libraries (static or shared), but please be aware that
                   7715:        libtool will not allow you to specify a relative path in
1.23      wiz      7716:        -L (such as <span class="quote">&#8220;<span class="quote">-L../somelib</span>&#8221;</span>), because it
1.1       dsieger  7717:        expects you to change that argument to be the
                   7718:        <code class="filename">.la</code> file. e.g.</p>
                   7719: <pre class="programlisting">
                   7720: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.111     sevan    7721: </pre>
1.1       dsieger  7722: <p>should be changed to:</p>
                   7723: <pre class="programlisting">
                   7724: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.111     sevan    7725: </pre>
1.1       dsieger  7726: <p>and it will do the right thing with the libraries.</p>
                   7727: </li>
1.23      wiz      7728: <li class="listitem">
1.167   ! leot     7729: <p>When installing libraries, preface the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?install+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a>
        !          7730:        or <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?cp+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">cp</span>(1)</span></a> command with <span class="quote">&#8220;<span class="quote">${LIBTOOL}
1.23      wiz      7731:        --mode=install</span>&#8221;</span>, and change the library name to
1.1       dsieger  7732:        <code class="filename">.la</code>. e.g.</p>
                   7733: <pre class="programlisting">
1.22      jakllsch 7734: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.111     sevan    7735: </pre>
1.1       dsieger  7736: <p>This will install the static <code class="filename">.a</code>,
                   7737:        shared library, any needed symlinks, and run
1.167   ! leot     7738:        <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?ldconfig+8.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">ldconfig</span>(8)</span></a>.</p>
1.1       dsieger  7739: </li>
1.23      wiz      7740: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.1       dsieger  7741:        the <code class="filename">.la</code>
                   7742:        file (this is a change from previous behaviour).</p></li>
                   7743: </ol></div>
                   7744: </div>
1.41      asau     7745: <div class="sect2">
1.1       dsieger  7746: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   7747: <a name="using-libtool"></a>21.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.1       dsieger  7748: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
                   7749:     package Makefile. This will override the package's own libtool
                   7750:     in most cases.  For older libtool using packages,  libtool is
                   7751:     made by ltconfig script during the do-configure step; you can
1.10      hubertf  7752:     check the libtool script location by doing <span class="command"><strong>make
1.1       dsieger  7753:     configure; find work*/ -name libtool</strong></span>.</p>
                   7754: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
                   7755:     scripts, relative to <code class="varname">WRKSRC</code>, to override.  By
1.23      wiz      7756:     default, it is set to <span class="quote">&#8220;<span class="quote">libtool */libtool
                   7757:     */*/libtool</span>&#8221;</span>.  If this does not match the location of the
1.1       dsieger  7758:     package's libtool script(s), set it as appropriate.</p>
                   7759: <p>If you do not need <code class="filename">*.a</code> static
                   7760:     libraries built and installed, then use
                   7761:     <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
                   7762: <p>If your package makes use of the platform-independent library
                   7763:     for loading dynamic shared objects, that comes with libtool
                   7764:     (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
                   7765: <p>Some packages use libtool incorrectly so that the package
                   7766:     may not work or build in some circumstances. Some of the more
                   7767:     common errors are:</p>
1.41      asau     7768: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      7769: <li class="listitem">
1.1       dsieger  7770: <p>The inclusion of a shared object (-module) as a dependent library in an
                   7771:        executable or library. This in itself isn't a problem if one of two things
                   7772:        has been done:</p>
1.23      wiz      7773: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7774: <li class="listitem"><p>The shared object is named correctly, i.e.
1.1       dsieger  7775:            <code class="filename">libfoo.la</code>, not
                   7776:            <code class="filename">foo.la</code></p></li>
1.23      wiz      7777: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.1       dsieger  7778: </ol></div>
                   7779: </li>
1.23      wiz      7780: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.1       dsieger  7781:        The function lt_dlinit() should be called and the macro
                   7782:        <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
                   7783:        executables.</p></li>
                   7784: </ul></div>
                   7785: </div>
1.41      asau     7786: <div class="sect2">
1.1       dsieger  7787: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   7788: <a name="autoconf-automake"></a>21.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.1       dsieger  7789: <p>If a package needs GNU autoconf or automake to be executed
                   7790:     to regenerate the configure script and Makefile.in makefile
                   7791:     templates, then they should be executed in a pre-configure
                   7792:     target.</p>
                   7793: <p>For packages that need only autoconf:</p>
                   7794: <pre class="programlisting">
                   7795: AUTOCONF_REQD=  2.50            # if default version is not good enough
                   7796: USE_TOOLS+=     autoconf        # use "autoconf213" for autoconf-2.13
                   7797: ...
                   7798: 
                   7799: pre-configure:
                   7800:         cd ${WRKSRC} &amp;&amp; autoconf
                   7801: 
                   7802: ...
1.111     sevan    7803: </pre>
1.1       dsieger  7804: <p>and for packages that need automake and autoconf:</p>
                   7805: <pre class="programlisting">
                   7806: AUTOMAKE_REQD=  1.7.1           # if default version is not good enough
                   7807: USE_TOOLS+=     automake        # use "automake14" for automake-1.4
                   7808: ...
                   7809: 
                   7810: pre-configure:
                   7811:         set -e; cd ${WRKSRC}; \
                   7812:         aclocal; autoheader; automake -a --foreign -i; autoconf
                   7813: 
                   7814: ...
1.111     sevan    7815: </pre>
1.1       dsieger  7816: <p>Packages which use GNU Automake will almost certainly
                   7817:     require GNU Make.</p>
                   7818: <p>There are times when the configure process makes
                   7819:     additional changes to the generated files, which then causes
                   7820:     the build process to try to re-execute the automake sequence.
                   7821:     This is prevented by touching various files in the configure
                   7822:     stage. If this causes problems with your package you can set
                   7823:     <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
                   7824:     Makefile.</p>
                   7825: </div>
                   7826: </div>
1.41      asau     7827: <div class="sect1">
1.1       dsieger  7828: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   7829: <a name="programming-languages"></a>21.4. Programming languages</h2></div></div></div>
1.41      asau     7830: <div class="sect2">
1.1       dsieger  7831: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   7832: <a name="basic-programming-languages"></a>21.4.1. C, C++, and Fortran</h3></div></div></div>
1.1       dsieger  7833: <p>Compilers for the C, C++, and Fortran languages comes with
                   7834:     the NetBSD base system.  By default, pkgsrc assumes that a package
                   7835:     is written in C and will hide all other compilers (via the wrapper
1.154     rillig   7836:     framework, see <a class="xref" href="#buildlink" title="Chapter 16. Buildlink methodology">Chapter 16, <i>Buildlink methodology</i></a>).</p>
1.1       dsieger  7837: <p>To declare which language's compiler a package needs, set
                   7838:     the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.23      wiz      7839:     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
                   7840:     <span class="quote">&#8220;<span class="quote">fortran</span>&#8221;</span> (and any combination).  The default is
                   7841:     <span class="quote">&#8220;<span class="quote">c</span>&#8221;</span>.  Packages using GNU configure scripts, even if
1.1       dsieger  7842:     written in C++, usually need a C compiler for the configure
                   7843:     phase.</p>
                   7844: </div>
1.41      asau     7845: <div class="sect2">
1.1       dsieger  7846: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   7847: <a name="java-programming-language"></a>21.4.2. Java</h3></div></div></div>
1.1       dsieger  7848: <p>If a program is written in Java, use the Java framework in
                   7849:     pkgsrc.  The package must include
                   7850:     <code class="filename">../../mk/java-vm.mk</code>.  This Makefile fragment
                   7851:     provides the following variables:</p>
1.41      asau     7852: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      7853: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.1       dsieger  7854:       dependency on the JDK is added.  If
1.23      wiz      7855:       <code class="varname">USE_JAVA</code> is set to <span class="quote">&#8220;<span class="quote">run</span>&#8221;</span>, then
1.1       dsieger  7856:       there is only a runtime dependency on the JDK.  The default is
1.23      wiz      7857:       <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>, which also adds a build dependency on the
1.1       dsieger  7858:       JDK.</p></li>
1.23      wiz      7859: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.1       dsieger  7860:       a package needs a Java2 implementation.  The supported values
1.23      wiz      7861:       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
                   7862:       <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
                   7863:       implementation, <span class="quote">&#8220;<span class="quote">1.4</span>&#8221;</span> insists on versions 1.4 or
                   7864:       above, and <span class="quote">&#8220;<span class="quote">1.5</span>&#8221;</span> only accepts versions 1.5 or
1.1       dsieger  7865:       above. This variable is not set by default.</p></li>
1.24      wiz      7866: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
                   7867:       automatically set to the runtime location of the used Java
                   7868:       implementation dependency. It may be used to set
                   7869:       <code class="varname">JAVA_HOME</code> to a good value if the program
                   7870:       needs this variable to be defined.
                   7871:       </p></li>
1.1       dsieger  7872: </ul></div>
                   7873: </div>
1.41      asau     7874: <div class="sect2">
1.1       dsieger  7875: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   7876: <a name="perl-scripts"></a>21.4.3. Packages containing perl scripts</h3></div></div></div>
1.1       dsieger  7877: <p>If your package contains interpreted perl scripts, add
1.23      wiz      7878:     <span class="quote">&#8220;<span class="quote">perl</span>&#8221;</span> to the <code class="varname">USE_TOOLS</code> variable
1.1       dsieger  7879:     and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
                   7880:     interpreter path is set. <code class="varname">REPLACE_PERL</code> should
                   7881:     contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
1.74      wiz      7882:     that you want adjusted. Every occurrence of
                   7883:     <code class="filename">*/bin/perl</code> in a she-bang line will be
                   7884:     replaced with the full path to the perl executable.</p>
1.1       dsieger  7885: <p>If a particular version of perl is needed, set the
                   7886:     <code class="varname">PERL5_REQD</code> variable to the version number.  The
1.23      wiz      7887:     default is <span class="quote">&#8220;<span class="quote">5.0</span>&#8221;</span>.</p>
1.154     rillig   7888: <p>See <a class="xref" href="#perl-modules" title="21.6.6. Packages installing perl modules">Section 21.6.6, &#8220;Packages installing perl modules&#8221;</a> for information
1.1       dsieger  7889:     about handling perl modules.</p>
                   7890: </div>
1.41      asau     7891: <div class="sect2">
1.1       dsieger  7892: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   7893: <a name="shell-scripts"></a>21.4.4. Packages containing shell scripts</h3></div></div></div>
1.40      wiz      7894: <p><code class="varname">REPLACE_SH</code>,
                   7895:     <code class="varname">REPLACE_BASH</code>, <code class="varname">REPLACE_CSH</code>,
                   7896:     and <code class="varname">REPLACE_KSH</code> can be used to replace shell
                   7897:     hash bangs in files. Please use the appropriate one, prefering
                   7898:     <code class="varname">REPLACE_SH</code> in case this shell is sufficient.
1.74      wiz      7899:     Each should contain a list of scripts, relative to
                   7900:     <code class="varname">WRKSRC</code>, that you want adjusted. Every
                   7901:     occurrence of the matching shell in a she-bang line will be
                   7902:     replaced with the full path to the shell executable.
1.40      wiz      7903:     When using <code class="varname">REPLACE_BASH</code>, don't forget to add
                   7904:     <code class="filename">bash</code> to <code class="varname">USE_TOOLS</code>.</p>
                   7905: </div>
1.41      asau     7906: <div class="sect2">
1.40      wiz      7907: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   7908: <a name="other-programming-languages"></a>21.4.5. Other programming languages</h3></div></div></div>
1.1       dsieger  7909: <p>Currently, there is no special handling for other languages
                   7910:     in pkgsrc.  If a compiler package provides a
                   7911:     <code class="filename">buildlink3.mk</code> file, include that, otherwise
                   7912:     just add a (build) dependency on the appropriate compiler
                   7913:     package.</p>
                   7914: </div>
                   7915: </div>
1.41      asau     7916: <div class="sect1">
1.1       dsieger  7917: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   7918: <a name="fixes.build"></a>21.5. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.1       dsieger  7919: <p>The most common failures when building a package are that
                   7920:        some platforms do not provide certain header files, functions or
                   7921:        libraries, or they provide the functions in a library that the
                   7922:        original package author didn't know. To work around this, you
                   7923:        can rewrite the source code in most cases so that it does not
                   7924:        use the missing functions or provides a replacement function.</p>
1.41      asau     7925: <div class="sect2">
1.1       dsieger  7926: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   7927: <a name="fixes.build.cpp"></a>21.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.1       dsieger  7928: <p>If a package already comes with a GNU configure script, the
                   7929:        preferred way to fix the build failure is to change the
                   7930:        configure script, not the code. In the other cases, you can
                   7931:        utilize the C preprocessor, which defines certain macros
                   7932:        depending on the operating system and hardware architecture it
                   7933:        compiles for. These macros can be queried using for example
                   7934:        <code class="varname">#if defined(__i386)</code>. Almost every operating
                   7935:        system, hardware architecture and compiler has its own macro.
                   7936:        For example, if the macros <code class="varname">__GNUC__</code>,
                   7937:        <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
                   7938:        are all defined, you know that you are using NetBSD on an i386
                   7939:        compatible CPU, and your compiler is GCC.</p>
                   7940: <p>The list of the following macros for hardware and
                   7941:        operating system depends on the compiler that is used. For
                   7942:        example, if you want to conditionally compile code on Solaris,
                   7943:        don't use <code class="varname">__sun__</code>, as the SunPro compiler
                   7944:        does not define it. Use <code class="varname">__sun</code> instead.</p>
1.41      asau     7945: <div class="sect3">
1.1       dsieger  7946: <div class="titlepage"><div><div><h4 class="title">
1.154     rillig   7947: <a name="fixes.build.cpp.os"></a>21.5.1.1. C preprocessor macros to identify the operating system</h4></div></div></div>
1.1       dsieger  7948: <p>To distinguish between 4.4 BSD-derived systems and the
                   7949:         rest of the world, you should use the following code.</p>
                   7950: <pre class="programlisting">
                   7951: #include &lt;sys/param.h&gt;
                   7952: #if (defined(BSD) &amp;&amp; BSD &gt;= 199306)
                   7953: /* BSD-specific code goes here */
                   7954: #else
                   7955: /* non-BSD-specific code goes here */
                   7956: #endif
                   7957: </pre>
                   7958: <p>If this distinction is not fine enough, you can also test
                   7959:        for the following macros.</p>
                   7960: <pre class="programlisting">
1.45      obache   7961: Cygwin      __CYGWIN__
                   7962: DragonFly   __DragonFly__
1.1       dsieger  7963: FreeBSD     __FreeBSD__
1.45      obache   7964: Haiku       __HAIKU__
1.1       dsieger  7965: Interix     __INTERIX
                   7966: IRIX        __sgi (TODO: get a definite source for this)
                   7967: Linux       linux, __linux, __linux__
1.83      dholland 7968: Mac OS X    __APPLE__
1.45      obache   7969: MirBSD      __MirBSD__ (__OpenBSD__ is also defined)
                   7970: Minix3      __minix
1.1       dsieger  7971: NetBSD      __NetBSD__
                   7972: OpenBSD     __OpenBSD__
                   7973: Solaris     sun, __sun
                   7974: </pre>
                   7975: </div>
1.41      asau     7976: <div class="sect3">
1.1       dsieger  7977: <div class="titlepage"><div><div><h4 class="title">
1.154     rillig   7978: <a name="fixes.build.cpp.arch"></a>21.5.1.2. C preprocessor macros to identify the hardware architecture</h4></div></div></div>
1.1       dsieger  7979: <pre class="programlisting">
                   7980: i386        i386, __i386, __i386__
                   7981: MIPS        __mips
                   7982: SPARC       sparc, __sparc
                   7983: </pre>
                   7984: </div>
1.41      asau     7985: <div class="sect3">
1.1       dsieger  7986: <div class="titlepage"><div><div><h4 class="title">
1.154     rillig   7987: <a name="fixes.build.cpp.compiler"></a>21.5.1.3. C preprocessor macros to identify the compiler</h4></div></div></div>
1.1       dsieger  7988: <pre class="programlisting">
                   7989: GCC         __GNUC__ (major version), __GNUC_MINOR__
                   7990: MIPSpro     _COMPILER_VERSION (0x741 for MIPSpro 7.41)
                   7991: SunPro      __SUNPRO_C (0x570 for Sun C 5.7)
                   7992: SunPro C++  __SUNPRO_CC (0x580 for Sun C++ 5.8)
                   7993: </pre>
                   7994: </div>
                   7995: </div>
1.41      asau     7996: <div class="sect2">
1.1       dsieger  7997: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   7998: <a name="compiler-bugs"></a>21.5.2. How to handle compiler bugs</h3></div></div></div>
1.1       dsieger  7999: <p>Some source files trigger bugs in the compiler, based on
                   8000:         combinations of compiler version and architecture and almost
                   8001:         always relation to optimisation being enabled.  Common symptoms
                   8002:         are gcc internal errors or never finishing compiling a
                   8003:        file.</p>
                   8004: <p>Typically, a workaround involves testing the
                   8005:         <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
                   8006:         optimisation for that combination of file,
1.87      tnn      8007:        <code class="varname">MACHINE_ARCH</code> and compiler.</p>
                   8008: <p>This used to be a big problem in the past, but is rarely
                   8009:        needed now as compiler technology has matured. If you still need
                   8010:        to add a compiler specific workaround, please do so in the file
                   8011:        <code class="filename">hacks.mk</code> and describe the symptom and
                   8012:        compiler version as detailed as possible.</p>
1.1       dsieger  8013: </div>
1.41      asau     8014: <div class="sect2">
1.1       dsieger  8015: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8016: <a name="undefined-reference"></a>21.5.3. Undefined reference to <span class="quote">&#8220;<span class="quote">...</span>&#8221;</span>
1.23      wiz      8017: </h3></div></div></div>
1.1       dsieger  8018: <p>This error message often means that a package did not
                   8019:        link to a shared library it needs. The following functions are
                   8020:        known to cause this error message over and over.</p>
                   8021: <div class="informaltable">
1.106     tnn      8022: <a name="undefined-reference-functions"></a><table class="informaltable" border="1">
1.1       dsieger  8023: <colgroup>
                   8024: <col>
                   8025: <col>
                   8026: <col>
                   8027: </colgroup>
                   8028: <thead><tr>
                   8029: <th>Function</th>
                   8030: <th>Library</th>
                   8031: <th>Affected platforms</th>
                   8032: </tr></thead>
                   8033: <tbody>
                   8034: <tr>
                   8035: <td>accept, bind, connect</td>
                   8036: <td>-lsocket</td>
                   8037: <td>Solaris</td>
                   8038: </tr>
                   8039: <tr>
                   8040: <td>crypt</td>
                   8041: <td>-lcrypt</td>
                   8042: <td>DragonFly, NetBSD</td>
                   8043: </tr>
                   8044: <tr>
                   8045: <td>dlopen, dlsym</td>
                   8046: <td>-ldl</td>
                   8047: <td>Linux</td>
                   8048: </tr>
                   8049: <tr>
                   8050: <td>gethost*</td>
                   8051: <td>-lnsl</td>
                   8052: <td>Solaris</td>
                   8053: </tr>
                   8054: <tr>
                   8055: <td>inet_aton</td>
                   8056: <td>-lresolv</td>
                   8057: <td>Solaris</td>
                   8058: </tr>
                   8059: <tr>
                   8060: <td>nanosleep, sem_*, timer_*</td>
                   8061: <td>-lrt</td>
                   8062: <td>Solaris</td>
                   8063: </tr>
                   8064: <tr>
                   8065: <td>openpty</td>
                   8066: <td>-lutil</td>
                   8067: <td>Linux</td>
                   8068: </tr>
                   8069: </tbody>
                   8070: </table>
                   8071: </div>
                   8072: <p>To fix these linker errors, it is often sufficient to say
                   8073:     <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
                   8074:     -l<em class="replaceable"><code>foo</code></em></code> to the package
1.10      hubertf  8075:     <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
1.1       dsieger  8076:     bmake</strong></span>.</p>
1.41      asau     8077: <div class="sect3">
1.1       dsieger  8078: <div class="titlepage"><div><div><h4 class="title">
1.154     rillig   8079: <a name="undefined-reference-sunpro"></a>21.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
1.1       dsieger  8080: <p>When you are using the SunPro compiler, there is another
                   8081: possibility. That compiler cannot handle the following code:</p>
                   8082: <pre class="programlisting">
                   8083: extern int extern_func(int);
                   8084: 
                   8085: static inline int
                   8086: inline_func(int x)
                   8087: {
                   8088:         return extern_func(x);
                   8089: }
                   8090: 
                   8091: int main(void)
                   8092: {
                   8093:         return 0;
                   8094: }
                   8095: </pre>
                   8096: <p>It generates the code for <code class="function">inline_func</code> even if
                   8097: that function is never used. This code then refers to
                   8098: <code class="function">extern_func</code>, which can usually not be resolved. To
                   8099: solve this problem you can try to tell the package to disable inlining
                   8100: of functions.</p>
                   8101: </div>
                   8102: </div>
1.41      asau     8103: <div class="sect2">
1.1       dsieger  8104: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8105: <a name="out-of-memory"></a>21.5.4. Running out of memory</h3></div></div></div>
1.1       dsieger  8106: <p>Sometimes packages fail to build because the compiler runs
                   8107:     into an operating system specific soft limit.  With the
                   8108:     <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
1.94      wiz      8109:     to unlimit the resources.  Currently, the allowed values are any combination of
                   8110:     <span class="quote">&#8220;<span class="quote">cputime</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">datasize</span>&#8221;</span>,
                   8111:     <span class="quote">&#8220;<span class="quote">memorysize</span>&#8221;</span>, and <span class="quote">&#8220;<span class="quote">stacksize</span>&#8221;</span>.
1.1       dsieger  8112:     Setting this variable is similar to running the shell builtin
1.10      hubertf  8113:     <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.1       dsieger  8114:     segment size or maximum stack size of a process, respectively, to
                   8115:     their hard limits.</p>
                   8116: </div>
                   8117: </div>
1.41      asau     8118: <div class="sect1">
1.1       dsieger  8119: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   8120: <a name="fixes.install"></a>21.6. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.41      asau     8121: <div class="sect2">
1.1       dsieger  8122: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8123: <a name="install-scripts"></a>21.6.1. Creating needed directories</h3></div></div></div>
1.10      hubertf  8124: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.1       dsieger  8125:     with some operating systems cannot create more than one
                   8126:     directory at a time. As such, you should call
                   8127:     <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
                   8128: <pre class="programlisting">
                   8129: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
                   8130: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.111     sevan    8131: </pre>
1.23      wiz      8132: <p>You can also just append <span class="quote">&#8220;<span class="quote"><code class="literal">dir1
                   8133:     dir2</code></span>&#8221;</span> to the
1.1       dsieger  8134:     <code class="varname">INSTALLATION_DIRS</code> variable, which will
                   8135:     automatically do the right thing.</p>
                   8136: </div>
1.41      asau     8137: <div class="sect2">
1.1       dsieger  8138: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8139: <a name="where-to-install-documentation"></a>21.6.2. Where to install documentation</h3></div></div></div>
1.1       dsieger  8140: <p>In general, documentation should be installed into
                   8141:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
                   8142:     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
                   8143:     includes the version number of the package).</p>
                   8144: <p>Many modern packages using GNU autoconf allow to set the
                   8145:     directory where HTML documentation is installed with the
1.23      wiz      8146:     <span class="quote">&#8220;<span class="quote">--with-html-dir</span>&#8221;</span> option. Sometimes using this flag
1.1       dsieger  8147:     is needed because otherwise the documentation ends up in
                   8148:     <code class="filename">${PREFIX}/share/doc/html</code> or other
                   8149:     places.</p>
                   8150: <p>An exception to the above is that library API documentation
1.137     leot     8151:     generated with the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/textproc/gtk-doc/README.html" target="_top"><code class="filename">textproc/gtk-doc</code></a> tools, for use by special
1.1       dsieger  8152:     browsers (devhelp) should be left at their default location, which
                   8153:     is <code class="filename">${PREFIX}/share/gtk-doc</code>.  Such
                   8154:     documentation can be recognized from files ending in
                   8155:     <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
                   8156:     (It is also acceptable to install such files in
                   8157:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
                   8158:     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
                   8159:     <code class="filename">.devhelp*</code> file must be directly in that
                   8160:     directory then, no additional subdirectory level is allowed in
                   8161:     this case. This is usually achieved by using
1.23      wiz      8162:     <span class="quote">&#8220;<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>&#8221;</span>.
1.1       dsieger  8163:     <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
                   8164:     though.)</p>
                   8165: </div>
1.41      asau     8166: <div class="sect2">
1.1       dsieger  8167: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8168: <a name="installing-score-files"></a>21.6.3. Installing highscore files</h3></div></div></div>
1.1       dsieger  8169: <p>Certain packages, most of them in the games category, install
                   8170:     a score file that allows all users on the system to record their
                   8171:     highscores.  In order for this to work, the binaries need to be
                   8172:     installed setgid and the score files owned by the appropriate
1.35      wiz      8173:     group and/or owner (traditionally the "games" user/group).  Set
                   8174:     <code class="varname">USE_GAMESGROUP</code> to yes to support this. The
1.1       dsieger  8175:     following variables, documented in more detail in
                   8176:     <code class="filename">mk/defaults/mk.conf</code>, control this
1.35      wiz      8177:     behaviour: <code class="varname">GAMEDATAMODE</code>,
                   8178:     <code class="varname">GAMEDIRMODE</code>, <code class="varname">GAMES_GROUP</code>,
1.100     leot     8179:     <code class="varname">GAMEMODE</code>, <code class="varname">GAME_USER</code>.
                   8180:     Other useful variables are: <code class="varname">GAMEDIR_PERMS</code>,
                   8181:     <code class="varname">GAMEDATA_PERMS</code> and
                   8182:     <code class="varname">SETGID_GAMES_PERMS</code>.</p>
                   8183: <p>An example that illustrates some of the variables described above is
                   8184:     <code class="filename">games/moon-buggy</code>. <code class="varname">OWN_DIRS_PERMS</code> is
                   8185:     used to properly set directory permissions of the directory where the
                   8186:     scorefile is saved, <code class="varname">REQD_FILES_PERMS</code> is used to create a
                   8187:     dummy scorefile (<code class="filename">mbscore</code>) with the proper permissions
                   8188:     and <code class="varname">SPECIAL_PERMS</code> is used to install setgid the game
                   8189:     binary:</p>
                   8190: <pre class="programlisting">
1.112     rillig   8191: USE_GAMESGROUP=         yes
1.100     leot     8192: 
1.112     rillig   8193: BUILD_DEFS+=            VARBASE
1.100     leot     8194: 
1.112     rillig   8195: OWN_DIRS_PERMS+=        ${VARBASE}/games/moon-buggy ${GAMEDIR_PERMS}
                   8196: REQD_FILES_PERMS+=      /dev/null ${VARBASE}/games/moon-buggy/mbscore ${GAMEDATA_PERMS}
                   8197: SPECIAL_PERMS+=         ${PREFIX}/bin/moon-buggy ${SETGID_GAMES_PERMS}
1.111     sevan    8198: </pre>
1.100     leot     8199: <p>Various <code class="varname">INSTALL_*</code> variables are also available:
                   8200:     <code class="varname">INSTALL_GAME</code> to install setgid game binaries,
                   8201:     <code class="varname">INSTALL_GAME_DIR</code> to install game directories that are
                   8202:     needed to be accessed by setgid games and
                   8203:     <code class="varname">INSTALL_GAME_DATA</code> to install scorefiles.</p>
1.14      jmcneill 8204: <p>A package should therefore never hard code file ownership or
1.100     leot     8205:     access permissions but rely on <code class="varname">*_PERMS</code> as described above
                   8206:     or alternatively on <code class="varname">INSTALL_GAME</code>,
                   8207:     <code class="varname">INSTALL_GAME_DATA</code> and
                   8208:     <code class="varname">INSTALL_GAME_DIR</code> to set these correctly.</p>
1.1       dsieger  8209: </div>
1.41      asau     8210: <div class="sect2">
1.1       dsieger  8211: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8212: <a name="destdir-support"></a>21.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.14      jmcneill 8213: <p><code class="varname">DESTDIR</code> support means that a package
                   8214:     installs into a staging directory, not the final location of the
                   8215:     files. Then a binary package is created which can be used for
                   8216:     installation as usual. There are two ways: Either the package must
1.23      wiz      8217:     install as root (<span class="quote">&#8220;<span class="quote">destdir</span>&#8221;</span>) or the package can
                   8218:     install as non-root user (<span class="quote">&#8220;<span class="quote">user-destdir</span>&#8221;</span>).</p>
1.41      asau     8219: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      8220: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
1.113     leot     8221:       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>.
                   8222:       By default <code class="varname">PKG_DESTDIR_SUPPORT</code>
1.38      wiz      8223:       is set to <span class="quote">&#8220;<span class="quote">user-destdir</span>&#8221;</span> to help catching more
                   8224:       potential packaging problems. If bsd.prefs.mk is included in the Makefile,
1.14      jmcneill 8225:       <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
                   8226:       the inclusion.</p></li>
1.23      wiz      8227: <li class="listitem"><p>All installation operations have to be prefixed with
1.4       rillig   8228:       <code class="filename">${DESTDIR}</code>.</p></li>
1.23      wiz      8229: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.4       rillig   8230:       automatically. Many manual rules and pre/post-install often are
                   8231:       incorrect; fix them.</p></li>
1.23      wiz      8232: <li class="listitem"><p>If files are installed with special owner/group
1.17      imil     8233:       use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.23      wiz      8234: <li class="listitem"><p>In general, packages should support
1.4       rillig   8235:       <code class="varname">UNPRIVILEGED</code> to be able to use
                   8236:       DESTDIR.</p></li>
                   8237: </ul></div>
                   8238: </div>
1.41      asau     8239: <div class="sect2">
1.4       rillig   8240: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8241: <a name="hardcoded-paths"></a>21.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.1       dsieger  8242: <p>Your package may also contain scripts with hardcoded paths to
                   8243:       other interpreters besides (or as well as) perl.  To correct the
                   8244:       full pathname to the script interpreter, you need to set the
                   8245:       following definitions in your <code class="filename">Makefile</code> (we
1.10      hubertf  8246:     shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.1       dsieger  8247: <pre class="programlisting">
                   8248: REPLACE_INTERPRETER+=   tcl
                   8249: REPLACE.tcl.old=        .*/bin/tclsh
                   8250: REPLACE.tcl.new=        ${PREFIX}/bin/tclsh
                   8251: REPLACE_FILES.tcl=      # list of tcl scripts which need to be fixed,
                   8252: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.111     sevan    8253: </pre>
1.41      asau     8254: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  8255: <h3 class="title">Note</h3>
                   8256: <p>Before March 2006, these variables were called
                   8257:     <code class="varname">_REPLACE.*</code> and
                   8258:     <code class="varname">_REPLACE_FILES.*</code>.</p>
                   8259: </div>
                   8260: </div>
1.41      asau     8261: <div class="sect2">
1.1       dsieger  8262: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8263: <a name="perl-modules"></a>21.6.6. Packages installing perl modules</h3></div></div></div>
1.1       dsieger  8264: <p>Makefiles of packages providing perl5 modules should include
                   8265:     the Makefile fragment
                   8266:     <code class="filename">../../lang/perl5/module.mk</code>.  It provides a
1.10      hubertf  8267:     <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.1       dsieger  8268:     configuration for such modules as well as various hooks to tune
                   8269:     this configuration.  See comments in this file for
                   8270:     details.</p>
                   8271: <p>Perl5 modules will install into different places depending
                   8272:     on the version of perl used during the build process.  To
                   8273:     address this, pkgsrc will append lines to the
                   8274:     <code class="filename">PLIST</code> corresponding to the files listed in
                   8275:     the installed <code class="filename">.packlist</code> file generated by
                   8276:     most perl5 modules.  This is invoked by defining
                   8277:     <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
1.47      wiz      8278:     packlist files relative to <code class="varname">PERL5_PACKLIST_DIR</code>
                   8279:     (<code class="varname">PERL5_INSTALLVENDORARCH</code> by default),
                   8280:     e.g.:</p>
1.1       dsieger  8281: <pre class="programlisting">
1.47      wiz      8282: PERL5_PACKLIST= auto/Pg/.packlist
1.111     sevan    8283: </pre>
1.47      wiz      8284: <p>The perl5 config variables
                   8285:     <code class="varname">installarchlib</code>,
                   8286:     <code class="varname">installscript</code>,
                   8287:     <code class="varname">installvendorbin</code>,
                   8288:     <code class="varname">installvendorscript</code>,
                   8289:     <code class="varname">installvendorarch</code>,
                   8290:     <code class="varname">installvendorlib</code>,
                   8291:     <code class="varname">installvendorman1dir</code>, and
                   8292:     <code class="varname">installvendorman3dir</code> represent those
                   8293:     locations in which components of perl5 modules may be installed,
                   8294:     provided as variable with uppercase and prefixed with
                   8295:     <code class="varname">PERL5_</code>, e.g. <code class="varname">PERL5_INSTALLARCHLIB</code>
                   8296:     and may be used by perl5 packages that don't have a packlist.
                   8297:     These variables are also substituted for in the
                   8298:     <code class="filename">PLIST</code> as uppercase prefixed with
                   8299:     <code class="varname">PERL5_SUB_</code>.</p>
1.1       dsieger  8300: </div>
1.41      asau     8301: <div class="sect2">
1.1       dsieger  8302: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8303: <a name="faq.info-files"></a>21.6.7. Packages installing info files</h3></div></div></div>
1.1       dsieger  8304: <p>Some packages install info files or use the
1.23      wiz      8305:     <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span>  or <span class="quote">&#8220;<span class="quote">install-info</span>&#8221;</span>
1.1       dsieger  8306:     commands.  <code class="varname">INFO_FILES</code> should be defined in
                   8307:     the package Makefile so that <code class="filename">INSTALL</code> and
                   8308:     <code class="filename">DEINSTALL</code> scripts will be generated to
                   8309:     handle registration of the info files in the Info directory
1.23      wiz      8310:     file. The <span class="quote">&#8220;<span class="quote">install-info</span>&#8221;</span> command used for the info
1.1       dsieger  8311:     files registration is either provided by the system, or by a
                   8312:     special purpose package automatically added as dependency if
                   8313:     needed.</p>
                   8314: <p><code class="varname">PKGINFODIR</code> is the directory under
                   8315:     <code class="filename">${PREFIX}</code> where info files are primarily
                   8316:     located. <code class="varname">PKGINFODIR</code> defaults to
1.23      wiz      8317:     <span class="quote">&#8220;<span class="quote">info</span>&#8221;</span> and can be overridden by the user.</p>
1.1       dsieger  8318: <p>The info files for the package should be listed in the
                   8319:     package <code class="filename">PLIST</code>; however any split info files
                   8320:     need not be listed.</p>
1.23      wiz      8321: <p>A package which needs the <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> command
                   8322:     at build time must add <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> to
1.1       dsieger  8323:     <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.23      wiz      8324:     version of the <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> command is needed it
1.1       dsieger  8325:     should be noted with the <code class="varname">TEXINFO_REQD</code>
                   8326:     variable in the package <code class="filename">Makefile</code>. By
                   8327:     default, a minimum version of 3.12 is required. If the system
1.10      hubertf  8328:     does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.1       dsieger  8329:     does not match the required minimum, a build dependency on the
1.137     leot     8330:     <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/devel/gtexinfo/README.html" target="_top"><code class="filename">devel/gtexinfo</code></a> package will
1.1       dsieger  8331:     be added automatically.</p>
                   8332: <p>The build and installation process of the software provided
                   8333:     by the package should not use the
1.10      hubertf  8334:     <span class="command"><strong>install-info</strong></span> command as the registration of
1.1       dsieger  8335:     info files is the task of the package
                   8336:     <code class="filename">INSTALL</code> script, and it must use the
1.10      hubertf  8337:     appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.1       dsieger  8338: <p>To achieve this goal, the pkgsrc infrastructure creates
1.10      hubertf  8339:     overriding scripts for the <span class="command"><strong>install-info</strong></span> and
                   8340:     <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.1       dsieger  8341:     in <code class="varname">PATH</code>.</p>
1.10      hubertf  8342: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.1       dsieger  8343:     no effect except the logging of a message. The script overriding
1.10      hubertf  8344:     <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.1       dsieger  8345:     value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.10      hubertf  8346:     <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.1       dsieger  8347: </div>
1.41      asau     8348: <div class="sect2">
1.1       dsieger  8349: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8350: <a name="manpages"></a>21.6.8. Packages installing man pages</h3></div></div></div>
1.1       dsieger  8351: <p>All packages that install manual pages should install them
                   8352:     into the same directory, so that there is one common place to look
                   8353:     for them. In pkgsrc, this place is
                   8354:     <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
                   8355:     should be used in packages. The default for
                   8356:     <code class="varname">PKGMANDIR</code> is
1.23      wiz      8357:     <span class="quote">&#8220;<span class="quote"><code class="filename">man</code></span>&#8221;</span>. Another often-used value
                   8358:     is <span class="quote">&#8220;<span class="quote"><code class="filename">share/man</code></span>&#8221;</span>.</p>
1.41      asau     8359: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  8360: <h3 class="title">Note</h3>
                   8361: <p>The support for a custom <code class="varname">PKGMANDIR</code>
                   8362:     is far from complete.</p>
                   8363: </div>
                   8364: <p>The <code class="filename">PLIST</code> files can just use
                   8365:     <code class="filename">man/</code> as the top level directory for the man
                   8366:     page file entries, and the pkgsrc framework will convert as
                   8367:     needed. In all other places, the correct
                   8368:     <code class="varname">PKGMANDIR</code> must be used.</p>
                   8369: <p>Packages that are
                   8370:     configured with <code class="varname">GNU_CONFIGURE</code> set as
1.23      wiz      8371:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>, by default will use the
1.1       dsieger  8372:     <code class="filename">./configure</code>
                   8373:     --mandir switch to set where the man pages should be installed.
                   8374:     The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
                   8375:     to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
                   8376: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
                   8377:     use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.23      wiz      8378:     to <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span>.
1.1       dsieger  8379:     Or if the <code class="filename">./configure</code> script uses
                   8380:     a non-standard use of --mandir, you can set
                   8381:     <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.154     rillig   8382: <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.1       dsieger  8383:     information on installation of compressed manual pages.</p>
                   8384: </div>
1.41      asau     8385: <div class="sect2">
1.1       dsieger  8386: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8387: <a name="gconf-data-files"></a>21.6.9. Packages installing GConf data files</h3></div></div></div>
1.1       dsieger  8388: <p>If a package installs <code class="filename">.schemas</code> or
1.7       rillig   8389:     <code class="filename">.entries</code> files, used by GConf,
1.1       dsieger  8390:     you need to take some extra steps to make sure they get registered
                   8391:     in the database:</p>
1.23      wiz      8392: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8393: <li class="listitem"><p>Include <code class="filename">../../devel/GConf/schemas.mk</code>
1.1       dsieger  8394:        instead of its <code class="filename">buildlink3.mk</code> file.  This
1.7       rillig   8395:        takes care of rebuilding the GConf database at installation and
1.1       dsieger  8396:        deinstallation time, and tells the package where to install
1.7       rillig   8397:        GConf data files using some standard configure arguments.  It
1.1       dsieger  8398:        also disallows any access to the database directly from the
                   8399:        package.</p></li>
1.23      wiz      8400: <li class="listitem"><p>Ensure that the package installs its
1.1       dsieger  8401:        <code class="filename">.schemas</code> files under
                   8402:        <code class="filename">${PREFIX}/share/gconf/schemas</code>.  If they get
                   8403:        installed under <code class="filename">${PREFIX}/etc</code>, you will
                   8404:        need to manually patch the package.</p></li>
1.23      wiz      8405: <li class="listitem"><p>Check the PLIST and remove any entries under the etc/gconf
1.1       dsieger  8406:        directory, as they will be handled automatically.  See
1.154     rillig   8407:        <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.23      wiz      8408: <li class="listitem"><p>Define the <code class="varname">GCONF_SCHEMAS</code> variable in
1.1       dsieger  8409:        your <code class="filename">Makefile</code> with a list of all
                   8410:        <code class="filename">.schemas</code> files installed by the package, if
                   8411:        any.  Names must not contain any directories in them.</p></li>
1.23      wiz      8412: <li class="listitem"><p>Define the <code class="varname">GCONF_ENTRIES</code> variable in
1.1       dsieger  8413:        your <code class="filename">Makefile</code> with a
                   8414:        list of all <code class="filename">.entries</code> files installed by the
                   8415:        package, if any. Names must not contain any directories in
                   8416:        them.</p></li>
                   8417: </ol></div>
                   8418: </div>
1.41      asau     8419: <div class="sect2">
1.1       dsieger  8420: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8421: <a name="scrollkeeper-data-files"></a>21.6.10. Packages installing scrollkeeper/rarian data files</h3></div></div></div>
1.1       dsieger  8422: <p>If a package installs <code class="filename">.omf</code> files, used by
1.18      snj      8423:     scrollkeeper/rarian, you need to take some extra steps to make sure they
1.1       dsieger  8424:     get registered in the database:</p>
1.23      wiz      8425: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8426: <li class="listitem"><p>Include
1.18      snj      8427:        <code class="filename">../../mk/omf-scrollkeeper.mk</code>
                   8428:        instead of rarian's <code class="filename">buildlink3.mk</code> file.  This
1.1       dsieger  8429:        takes care of rebuilding the scrollkeeper database at
                   8430:        installation and deinstallation time, and disallows any access
                   8431:        to it directly from the package.</p></li>
1.23      wiz      8432: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.1       dsieger  8433:        <code class="filename">libdata/scrollkeeper</code> directory, as they
                   8434:        will be handled automatically.</p></li>
1.23      wiz      8435: <li class="listitem"><p>Remove the <code class="filename">share/omf</code> directory from
1.18      snj      8436:        the PLIST.  It will be handled by rarian. (<span class="command"><strong>make
                   8437:        print-PLIST</strong></span> does this automatically.)</p></li>
1.1       dsieger  8438: </ol></div>
                   8439: </div>
1.41      asau     8440: <div class="sect2">
1.1       dsieger  8441: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8442: <a name="x11-fonts"></a>21.6.11. Packages installing X11 fonts</h3></div></div></div>
1.1       dsieger  8443: <p>If a package installs font files, you will need to rebuild
                   8444:     the fonts database in the directory where they get installed at
                   8445:     installation and deinstallation time.  This can be automatically
                   8446:     done by using the pkginstall framework.</p>
                   8447: <p>You can list the directories where fonts are installed in the
                   8448:     <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
                   8449:     variables, where <em class="replaceable"><code>type</code></em> can be one of
1.23      wiz      8450:     <span class="quote">&#8220;<span class="quote">ttf</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">type1</span>&#8221;</span> or <span class="quote">&#8220;<span class="quote">x11</span>&#8221;</span>.
1.1       dsieger  8451:     Also make sure that the database file
                   8452:     <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
                   8453: <p>Note that you should not create new directories for fonts;
                   8454:     instead use the standard ones to avoid that the user needs to
                   8455:     manually configure his X server to find them.</p>
                   8456: </div>
1.41      asau     8457: <div class="sect2">
1.1       dsieger  8458: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8459: <a name="gtk2-modules"></a>21.6.12. Packages installing GTK2 modules</h3></div></div></div>
1.1       dsieger  8460: <p>If a package installs GTK2 immodules or loaders, you need to
                   8461:     take some extra steps to get them registered in the GTK2 database
                   8462:     properly:</p>
1.23      wiz      8463: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8464: <li class="listitem"><p>Include
1.1       dsieger  8465:       <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
                   8466:       <code class="filename">buildlink3.mk</code> file.  This takes care of
                   8467:       rebuilding the database at installation and deinstallation time.</p></li>
1.23      wiz      8468: <li class="listitem"><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
1.1       dsieger  8469:       your package installs GTK2 immodules.</p></li>
1.23      wiz      8470: <li class="listitem"><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
1.1       dsieger  8471:       GTK2 loaders.</p></li>
1.23      wiz      8472: <li class="listitem">
1.1       dsieger  8473: <p>Patch the package to not touch any of the GTK2
                   8474:       databases directly.  These are:</p>
1.41      asau     8475: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      8476: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
                   8477: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.1       dsieger  8478: </ul></div>
                   8479: </li>
1.23      wiz      8480: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove
1.1       dsieger  8481:       any entries under the <code class="filename">libdata/gtk-2.0</code>
                   8482:       directory, as they will be handled automatically.</p></li>
                   8483: </ol></div>
                   8484: </div>
1.41      asau     8485: <div class="sect2">
1.1       dsieger  8486: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8487: <a name="sgml-xml-data"></a>21.6.13. Packages installing SGML or XML data</h3></div></div></div>
1.1       dsieger  8488: <p>If a package installs SGML or XML data files that need to be
                   8489:     registered in system-wide catalogs (like DTDs, sub-catalogs,
                   8490:     etc.), you need to take some extra steps:</p>
1.23      wiz      8491: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8492: <li class="listitem"><p>Include
1.1       dsieger  8493:        <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
                   8494:        your <code class="filename">Makefile</code>, which takes care of
                   8495:        registering those files in system-wide catalogs at
                   8496:        installation and deinstallation time.</p></li>
1.23      wiz      8497: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.1       dsieger  8498:        any SGML catalogs installed by the package.</p></li>
1.23      wiz      8499: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.1       dsieger  8500:        any XML catalogs installed by the package.</p></li>
1.23      wiz      8501: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.1       dsieger  8502:        to be added to the SGML catalog.  These come in groups of
                   8503:        three strings; see xmlcatmgr(1) for more information
                   8504:        (specifically, arguments recognized by the 'add' action).
                   8505:        Note that you will normally not use this variable.</p></li>
1.23      wiz      8506: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.1       dsieger  8507:        to be added to the XML catalog.  These come in groups of three
                   8508:        strings; see xmlcatmgr(1) for more information (specifically,
                   8509:        arguments recognized by the 'add' action).  Note that you will
                   8510:        normally not use this variable.</p></li>
                   8511: </ol></div>
                   8512: </div>
1.41      asau     8513: <div class="sect2">
1.1       dsieger  8514: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8515: <a name="mime-database"></a>21.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
1.1       dsieger  8516: <p>If a package provides extensions to the MIME database by
                   8517:     installing <code class="filename">.xml</code> files inside
                   8518:     <code class="filename">${PREFIX}/share/mime/packages</code>, you
                   8519:     need to take some extra steps to ensure that the database is kept
                   8520:     consistent with respect to these new files:</p>
1.23      wiz      8521: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8522: <li class="listitem"><p>Include
1.1       dsieger  8523:        <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
                   8524:        (avoid using the <code class="filename">buildlink3.mk</code> file from
                   8525:        this same directory, which is reserved for inclusion from
                   8526:        other <code class="filename">buildlink3.mk</code> files).  It takes
                   8527:        care of rebuilding the MIME database at installation and
                   8528:        deinstallation time, and disallows any access to it directly
                   8529:        from the package.</p></li>
1.23      wiz      8530: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.1       dsieger  8531:        <code class="filename">share/mime</code> directory,
                   8532:        <span class="emphasis"><em>except</em></span> for files saved under
                   8533:        <code class="filename">share/mime/packages</code>.  The former are
                   8534:        handled automatically by
                   8535:        the update-mime-database program, but the latter are
                   8536:        package-dependent and must be removed by the package that
                   8537:        installed them in the first place.</p></li>
1.23      wiz      8538: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.1       dsieger  8539:        from the PLIST.  They will be handled by the shared-mime-info
                   8540:        package.</p></li>
                   8541: </ol></div>
                   8542: </div>
1.41      asau     8543: <div class="sect2">
1.1       dsieger  8544: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8545: <a name="intltool"></a>21.6.15. Packages using intltool</h3></div></div></div>
1.1       dsieger  8546: <p>If a package uses intltool during its build, add
                   8547:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
                   8548:     which forces it to use the intltool package provided by pkgsrc,
                   8549:     instead of the one bundled with the distribution file.</p>
                   8550: <p>This tracks intltool's build-time dependencies and uses the
                   8551:     latest available version; this way, the package benefits of any
                   8552:     bug fixes that may have appeared since it was released.</p>
                   8553: </div>
1.41      asau     8554: <div class="sect2">
1.1       dsieger  8555: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8556: <a name="startup-scripts"></a>21.6.16. Packages installing startup scripts</h3></div></div></div>
1.1       dsieger  8557: <p>If a package contains a rc.d script, it won't be copied into
                   8558:     the startup directory by default, but you can enable it, by adding
                   8559:     the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.10      hubertf  8560:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.1       dsieger  8561:     into <code class="filename">/etc/rc.d</code> when a package is installed, and
                   8562:     it will automatically remove the scripts when the package is
                   8563:     deinstalled.</p>
                   8564: </div>
1.41      asau     8565: <div class="sect2">
1.1       dsieger  8566: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8567: <a name="tex-packages"></a>21.6.17. Packages installing TeX modules</h3></div></div></div>
1.1       dsieger  8568: <p>If a package installs TeX packages into the texmf tree,
                   8569:     the <code class="filename">ls-R</code> database of the tree needs to be
                   8570:     updated.</p>
1.41      asau     8571: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  8572: <h3 class="title">Note</h3>
1.22      jakllsch 8573: <p>Except the main TeX packages such as kpathsea,
1.1       dsieger  8574:     packages should install files
1.22      jakllsch 8575:     into <code class="filename">${PREFIX}/share/texmf-dist</code>,
                   8576:     not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.1       dsieger  8577: </div>
1.23      wiz      8578: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8579: <li class="listitem"><p>Include
1.22      jakllsch 8580:       <code class="filename">../../print/kpathsea/texmf.mk</code>.  This
1.1       dsieger  8581:       takes care of rebuilding the <code class="filename">ls-R</code>
                   8582:       database at installation and deinstallation time.</p></li>
1.23      wiz      8583: <li class="listitem">
1.1       dsieger  8584: <p>If your package installs files into a texmf
                   8585:       tree other than the one
1.22      jakllsch 8586:       at <code class="filename">${PREFIX}/share/texmf-dist</code>,
                   8587:       set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.1       dsieger  8588:       trees that need database update.</p>
                   8589: <p>If your package also installs font map files that need
1.10      hubertf  8590:       to be registered using <span class="command"><strong>updmap</strong></span>,
1.29      dholland 8591:       include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.22      jakllsch 8592:       set <code class="varname">TEX_MAP_FILES</code> and/or
                   8593:       <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.10      hubertf  8594:       such font map files.  Then <span class="command"><strong>updmap</strong></span> will
1.1       dsieger  8595:       be run automatically at installation/deinstallation to
                   8596:       enable/disable font map files for TeX output
                   8597:       drivers.</p>
                   8598: </li>
1.23      wiz      8599: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.1       dsieger  8600:       databases are included in <code class="filename">PLIST</code>, as
1.29      dholland 8601:       they will be removed only by the kpathsea package.</p></li>
1.1       dsieger  8602: </ol></div>
                   8603: </div>
1.41      asau     8604: <div class="sect2">
1.1       dsieger  8605: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8606: <a name="emulation-packages"></a>21.6.18. Packages supporting running binaries in
1.1       dsieger  8607:     emulation</h3></div></div></div>
                   8608: <p>There are some packages that provide libraries and
                   8609:     executables for running binaries from a one operating system
                   8610:     on a different one (if the latter supports it).  One example
                   8611:     is running Linux binaries on NetBSD.</p>
1.137     leot     8612: <p>The <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/rpm2pkg/README.html" target="_top"><code class="filename">pkgtools/rpm2pkg</code></a>
1.1       dsieger  8613:     helps in extracting and packaging Linux rpm packages.</p>
                   8614: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.10      hubertf  8615:     avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.1       dsieger  8616:     if all libraries for each installed executable can be found by
                   8617:     the dynamic linker.  Since the standard dynamic linker is run,
                   8618:     this fails for emulation packages, because the libraries used
                   8619:     by the emulation are not in the standard directories.</p>
                   8620: </div>
1.41      asau     8621: <div class="sect2">
1.1       dsieger  8622: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8623: <a name="hicolor-theme"></a>21.6.19. Packages installing hicolor theme icons</h3></div></div></div>
1.1       dsieger  8624: <p>If a package installs images under the
                   8625:     <code class="filename">share/icons/hicolor</code> and/or updates the
                   8626:     <code class="filename">share/icons/hicolor/icon-theme.cache</code>
                   8627:     database, you need to take some extra steps to make sure that the
                   8628:     shared theme directory is handled appropriately and that the cache
                   8629:     database is rebuilt:</p>
1.23      wiz      8630: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8631: <li class="listitem"><p>Include
1.1       dsieger  8632:        <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
1.23      wiz      8633: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
1.1       dsieger  8634:        entry that refers to the theme cache.</p></li>
1.23      wiz      8635: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
1.1       dsieger  8636:          directories from the <code class="filename">share/icons/hicolor</code>
                   8637:          hierarchy because they will be handled automatically.</p></li>
                   8638: </ol></div>
                   8639: <p>The best way to verify that the PLIST is correct with
                   8640:       respect to the last two points is to regenerate it using
1.10      hubertf  8641:       <span class="command"><strong>make print-PLIST</strong></span>.</p>
1.1       dsieger  8642: </div>
1.41      asau     8643: <div class="sect2">
1.1       dsieger  8644: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8645: <a name="desktop-files"></a>21.6.20. Packages installing desktop files</h3></div></div></div>
1.1       dsieger  8646: <p>If a package installs <code class="filename">.desktop</code> files
                   8647:       under <code class="filename">share/applications</code> and these include
1.53      rodent   8648:       MIME information (MimeType key), you need to take extra steps to
                   8649:       ensure that they are registered into the MIME database:</p>
1.23      wiz      8650: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8651: <li class="listitem"><p>Include
1.1       dsieger  8652:          <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
1.23      wiz      8653: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
1.1       dsieger  8654:          <code class="filename">share/applications/mimeinfo.cache</code> file.
                   8655:          It will be handled automatically.</p></li>
                   8656: </ol></div>
                   8657: <p>The best way to verify that the PLIST is correct with
1.10      hubertf  8658:       respect to the last point is to regenerate it using <span class="command"><strong>make
1.1       dsieger  8659:       print-PLIST</strong></span>.</p>
                   8660: </div>
                   8661: </div>
1.41      asau     8662: <div class="sect1">
1.1       dsieger  8663: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   8664: <a name="punting"></a>21.7. Marking packages as having problems</h2></div></div></div>
1.1       dsieger  8665: <p>In some cases one does not have the time to solve a problem
1.22      jakllsch 8666:   immediately. In this case, one can plainly mark a package as broken.  For
                   8667:   this, one just sets the variable <code class="varname">BROKEN</code> to the
                   8668:   reason why the package is broken (similar to the
1.162     rillig   8669:   <code class="varname">PKG_FAIL_REASON</code> variable).  A user trying to build
1.22      jakllsch 8670:   the package will immediately be shown this message, and the build
                   8671:   will not be even tried.</p>
                   8672: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
1.1       dsieger  8673:   intervals.</p>
                   8674: </div>
                   8675: </div>
1.41      asau     8676: <div class="chapter">
1.1       dsieger  8677: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   8678: <a name="debug"></a>Chapter 22. Debugging</h2></div></div></div>
1.1       dsieger  8679: <p>To check out all the gotchas when building a package, here are
                   8680:   the steps that I do in order to get a package working.  Please note
                   8681:   this is basically the same as what was explained in the previous
                   8682:   sections, only with some debugging aids.</p>
1.41      asau     8683: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      8684: <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>
                   8685: <li class="listitem">
1.137     leot     8686: <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.1       dsieger  8687:       create a directory for a new package, change into it, then run
1.10      hubertf  8688:       <span class="command"><strong>url2pkg</strong></span>:</p>
1.1       dsieger  8689: <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>
                   8690: <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>
                   8691: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
                   8692: </li>
1.23      wiz      8693: <li class="listitem"><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
                   8694: <li class="listitem"><p>Fill in the <code class="filename">DESCR</code> file</p></li>
                   8695: <li class="listitem"><p>Run <span class="command"><strong>make configure</strong></span></p></li>
                   8696: <li class="listitem"><p>Add any dependencies glimpsed from documentation and the
1.1       dsieger  8697:       configure step to the package's
                   8698:       <code class="filename">Makefile</code>.</p></li>
1.23      wiz      8699: <li class="listitem">
1.1       dsieger  8700: <p>Make the package compile, doing multiple rounds of</p>
                   8701: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   8702: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
                   8703: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
                   8704: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
                   8705: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
                   8706: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
                   8707: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
                   8708: <p>Doing this step as non-root user will ensure that no files
                   8709:       are modified that shouldn't be, especially during the build
1.10      hubertf  8710:       phase.  <span class="command"><strong>mkpatches</strong></span>,
                   8711:       <span class="command"><strong>patchdiff</strong></span> and <span class="command"><strong>pkgvi</strong></span> are
1.137     leot     8712:       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.1       dsieger  8713:       package.</p>
                   8714: </li>
1.23      wiz      8715: <li class="listitem"><p>Look at the <code class="filename">Makefile</code>, fix if
1.154     rillig   8716:       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.23      wiz      8717: <li class="listitem">
1.1       dsieger  8718: <p>Generate a <code class="filename">PLIST</code>:</p>
                   8719: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   8720: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST &gt;PLIST</code></strong>
                   8721: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
                   8722: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   8723: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
                   8724: <p>You usually need to be <code class="username">root</code> to do
                   8725:       this.  Look if there are any files left:</p>
                   8726: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
                   8727: <p>If this reveals any files that are missing in
                   8728:       <code class="filename">PLIST</code>, add them.</p>
                   8729: </li>
1.23      wiz      8730: <li class="listitem">
1.1       dsieger  8731: <p>Now that the <code class="filename">PLIST</code> is OK, install the
                   8732:       package again and make a binary package:</p>
                   8733: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
                   8734: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
                   8735: </li>
1.23      wiz      8736: <li class="listitem">
1.1       dsieger  8737: <p>Delete the installed package:</p>
                   8738: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_delete <em class="replaceable"><code>examplepkg</code></em></code></strong></pre>
                   8739: </li>
1.23      wiz      8740: <li class="listitem">
1.10      hubertf  8741: <p>Repeat the above <span class="command"><strong>make print-PLIST</strong></span>
1.1       dsieger  8742:       command, which shouldn't find anything now:</p>
                   8743: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
                   8744: </li>
1.23      wiz      8745: <li class="listitem">
1.1       dsieger  8746: <p>Reinstall the binary package:</p>
                   8747: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add .../<em class="replaceable"><code>examplepkg</code></em>.tgz</code></strong></pre>
                   8748: </li>
1.23      wiz      8749: <li class="listitem"><p>Play with it.  Make sure everything works.</p></li>
                   8750: <li class="listitem">
1.137     leot     8751: <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.1       dsieger  8752:       reports:</p>
                   8753: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
                   8754: </li>
1.154     rillig   8755: <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.1       dsieger  8756: </ul></div>
                   8757: </div>
1.41      asau     8758: <div class="chapter">
1.1       dsieger  8759: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   8760: <a name="submit"></a>Chapter 23. Submitting and Committing</h2></div></div></div>
1.1       dsieger  8761: <div class="toc">
                   8762: <p><b>Table of Contents</b></p>
1.100     leot     8763: <dl class="toc">
1.154     rillig   8764: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
                   8765: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   8766: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
                   8767: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
                   8768: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
                   8769: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
                   8770: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
                   8771: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
1.1       dsieger  8772: </dl>
                   8773: </div>
1.41      asau     8774: <div class="sect1">
1.1       dsieger  8775: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   8776: <a name="submitting-binary-packages"></a>23.1. Submitting binary packages</h2></div></div></div>
1.1       dsieger  8777: <p>Our policy is that we accept binaries only from pkgsrc
                   8778:        developers to guarantee that the packages don't contain any
                   8779:        trojan horses etc. This is not to annoy anyone but rather to
                   8780:        protect our users! You're still free to put up your home-made
                   8781:        binary packages and tell the world where to get them. NetBSD
                   8782:        developers doing bulk builds and wanting to upload them please
1.154     rillig   8783:        see <a class="xref" href="#bulk" title="Chapter 8. Creating binary packages for everything in pkgsrc (bulk builds)">Chapter 8, <i>Creating binary packages for everything in pkgsrc (bulk
1.66      asau     8784: builds)</i></a>.</p>
1.1       dsieger  8785: </div>
1.41      asau     8786: <div class="sect1">
1.1       dsieger  8787: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   8788: <a name="submitting-your-package"></a>23.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.1       dsieger  8789: <p>First, check that your package is complete, compiles and
1.154     rillig   8790:        runs well; see <a class="xref" href="#debug" title="Chapter 22. Debugging">Chapter 22, <i>Debugging</i></a> and the rest of this
1.167   ! leot     8791:        document. Next, generate an uuencoded gzipped <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?tar+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">tar</span>(1)</span></a>
1.1       dsieger  8792:        archive that contains all files that make up the package.
                   8793:        Finally, send this package to the pkgsrc bug tracking system,
1.167   ! leot     8794:        either with the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> command, or if you don't have
1.1       dsieger  8795:        that, go to the web page
1.10      hubertf  8796:        <a class="ulink" href="http://www.NetBSD.org/support/send-pr.html" target="_top">http://www.NetBSD.org/support/send-pr.html</a>,
1.21      snj      8797:        which contains some instructions and a link to a form where you
                   8798:        can submit packages.  The
1.137     leot     8799:        <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/sysutils/gtk-send-pr/README.html" target="_top"><code class="filename">sysutils/gtk-send-pr</code></a> package is
1.21      snj      8800:        also available as a substitute for either of the above two tools.
                   8801:        </p>
1.1       dsieger  8802: <p>In the form of the problem report, the category should be
1.23      wiz      8803:        <span class="quote">&#8220;<span class="quote">pkg</span>&#8221;</span>, the synopsis should include the package name
1.1       dsieger  8804:        and version number, and the description field should contain a
                   8805:        short description of your package (contents of the COMMENT
                   8806:        variable or DESCR file are OK). The uuencoded package data should
1.23      wiz      8807:        go into the <span class="quote">&#8220;<span class="quote">fix</span>&#8221;</span> field.</p>
1.1       dsieger  8808: <p>If you want to submit several packages, please send a
                   8809:        separate PR for each one, it's easier for us to track things
                   8810:        that way.</p>
                   8811: <p>Alternatively, you can also import new packages into
1.23      wiz      8812:        pkgsrc-wip (<span class="quote">&#8220;<span class="quote">pkgsrc work-in-progress</span>&#8221;</span>); see the
1.105     wiz      8813:        homepage at <a class="ulink" href="http://pkgsrc.org/wip/" target="_top">http://pkgsrc.org/wip/</a>
1.1       dsieger  8814:        for details.</p>
                   8815: </div>
1.41      asau     8816: <div class="sect1">
1.1       dsieger  8817: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   8818: <a name="general-notes-for-changes"></a>23.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.1       dsieger  8819: <p>Please note all package additions, updates, moves, and
                   8820:        removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
                   8821:        important to keep this file up to date and conforming to the
                   8822:        existing format, because it will be used by scripts to
1.10      hubertf  8823:        automatically update pages on <a class="ulink" href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.1       dsieger  8824:        sites. Additionally, check the
                   8825:        <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
                   8826:        for the package you updated or removed, in case it was mentioned
                   8827:        there.</p>
                   8828: <p>When the <code class="varname">PKGREVISION</code> of a package is
                   8829:        bumped, the change should appear in
                   8830:        <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
                   8831:        related or otherwise relevant. Mass bumps that result from a
                   8832:        dependency being updated should not be mentioned. In all other
                   8833:        cases it's the developer's decision.</p>
                   8834: <p>There is a make target that helps in creating proper
1.10      hubertf  8835:   <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries:  <span class="command"><strong>make
1.1       dsieger  8836:   changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
                   8837:   and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
                   8838:   usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
                   8839:   file is up-to-date (to avoid having to resolve conflicts later-on)
1.10      hubertf  8840:   and then to <span class="command"><strong>cd</strong></span> to the package directory.  For
                   8841:   package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.1       dsieger  8842:   For new packages, or package moves or removals, set the
                   8843:   <code class="varname">CTYPE</code> variable on the command line to "Added",
                   8844:   "Moved", or "Removed".  You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.10      hubertf  8845:   in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.22      jakllsch 8846:   not the same as your NetBSD login name. The target also automatically
                   8847:   removes possibly existing entries for the package in the
                   8848:   <code class="filename">TODO</code> file. Don't forget to commit
1.66      asau     8849:   the changes, e.g. by using <span class="command"><strong>make commit-changes-entry</strong></span>!
1.22      jakllsch 8850:   If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
                   8851:   a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
                   8852:   makes the cvs commands use the main repository.
                   8853:   </p>
1.1       dsieger  8854: </div>
1.41      asau     8855: <div class="sect1">
1.1       dsieger  8856: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   8857: <a name="commit-messages"></a>23.4. Commit Messages</h2></div></div></div>
1.130     wiz      8858: <p>For several years, there have been mirrors of pkgsrc in
                   8859:   fossil, git, and hg. Standard practise when using these tools is to
                   8860:   make the first line of a commit message function as a summary that
                   8861:   can be read without the rest, such as is commonly done with "git log
                   8862:   --oneline". For this reason, we have the following guidelines for
                   8863:   pkgsrc commit messages:</p>
                   8864: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   8865: <li class="listitem"><p>Start the commit message with a line that explains the
1.131     wiz      8866:     big picture in 65 characters or less. When a commit is for one
1.130     wiz      8867:     package, include the name of the package. For updates, include the
                   8868:     version to which it is updated.</p></li>
                   8869: <li class="listitem"><p>Leave the next line empty.</p></li>
                   8870: <li class="listitem"><p>Then come the details for the commit (changes in that
                   8871:     package, reason for a change) and any relevant PRs. Wrap this
                   8872:     section.</p></li>
                   8873: </ul></div>
                   8874: <p>Here is an example:
                   8875:   </p>
                   8876: <pre class="programlisting">
                   8877:   libxslt: update to 1.0.30
                   8878: 
                   8879:   Changes since 1.0.29:
                   8880:   ...
                   8881:   </pre>
                   8882: <p>
                   8883:   </p>
                   8884: <p>Here is another example:
                   8885:   </p>
                   8886: <pre class="programlisting">
                   8887:   mk/bsd.pkg.mk: enable SSP by default on NetBSD
                   8888: 
                   8889:   (rationale)
                   8890:   </pre>
                   8891: <p>
                   8892:   </p>
                   8893: <p>Commit messages are final: no <span class="quote">&#8220;<span class="quote">cvs admin</span>&#8221;</span> is
                   8894:   allowed on the pkgsrc repository to change commit messages.</p>
                   8895: </div>
                   8896: <div class="sect1">
                   8897: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   8898: <a name="committing-importing"></a>23.5. Committing: Adding a package to CVS</h2></div></div></div>
1.1       dsieger  8899: <p>This section is only of interest for pkgsrc developers with write
1.33      wiz      8900:   access to the pkgsrc repository.</p>
                   8901: <p>When the package is finished, <span class="quote">&#8220;<span class="quote">cvs add</span>&#8221;</span> the files.
                   8902: Start by adding the directory and then files in the directory. Don't
                   8903: forget to add the new package to the category's
                   8904: <code class="filename">Makefile</code>. Make sure you don't forget any files;
                   8905: you can check by running <span class="quote">&#8220;<span class="quote">cvs status</span>&#8221;</span>. An example:</p>
                   8906: <pre class="programlisting">
                   8907: <code class="prompt">$</code> cd .../pkgsrc/category
                   8908: <code class="prompt">$</code> cvs add pkgname
                   8909: <code class="prompt">$</code> cd pkgname
                   8910: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
                   8911: <code class="prompt">$</code> cvs add patches/p*
                   8912: <code class="prompt">$</code> cvs status | less
1.34      wiz      8913: <code class="prompt">$</code> cvs commit
1.33      wiz      8914: <code class="prompt">$</code> cd ..
                   8915: <code class="prompt">$</code> vi Makefile # add SUBDIRS+=pkgname line
1.34      wiz      8916: <code class="prompt">$</code> cvs commit Makefile
1.66      asau     8917: <code class="prompt">$</code> cd pkgname
1.73      jnemeth  8918: <code class="prompt">$</code> make CTYPE=Added commit-changes-entry
1.33      wiz      8919: </pre>
1.1       dsieger  8920: <p>The commit message of the initial import should include part of the
                   8921:   <code class="filename">DESCR</code> file, so people reading the mailing lists know
                   8922:   what the package is/does.</p>
1.33      wiz      8923: <p>Also mention the new package in
                   8924: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
                   8925: <p>Previously, <span class="quote">&#8220;<span class="quote">cvs import</span>&#8221;</span> was suggested, but it was
                   8926: much easier to get wrong than <span class="quote">&#8220;<span class="quote">cvs add</span>&#8221;</span>.</p>
1.1       dsieger  8927: </div>
1.41      asau     8928: <div class="sect1">
1.1       dsieger  8929: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   8930: <a name="updating-package"></a>23.6. Updating a package to a newer version</h2></div></div></div>
1.1       dsieger  8931: <p>Please always put a concise, appropriate and relevant summary of the
                   8932:   changes between old and new versions into the commit log when updating
                   8933:   a package. There are various reasons for this:</p>
1.41      asau     8934: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      8935: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.1       dsieger  8936:   or its information may be overwritten by newer information.</p></li>
1.23      wiz      8937: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1       dsieger  8938:   repository is very useful for people who use either cvs or anoncvs.</p></li>
1.23      wiz      8939: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1       dsieger  8940:   repository is very useful for people who read the pkgsrc-changes mailing
                   8941:   list, so that they can make tactical decisions about when to upgrade
                   8942:   the package.</p></li>
                   8943: </ul></div>
                   8944: <p>Please also recognize that, just because a new version of a package
                   8945:   has been released, it should not automatically be upgraded in the CVS
                   8946:   repository.  We prefer to be conservative in the packages that are
                   8947:   included in pkgsrc - development or beta packages are not really the
                   8948:   best thing for most places in which pkgsrc is used. Please use your
                   8949:   judgement about what should go into pkgsrc, and bear in mind that
                   8950:   stability is to be preferred above new and possibly untested features.</p>
                   8951: </div>
1.41      asau     8952: <div class="sect1">
1.1       dsieger  8953: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   8954: <a name="renaming-package"></a>23.7. Renaming a package in pkgsrc</h2></div></div></div>
1.20      snj      8955: <p>Renaming packages is not recommended.</p>
                   8956: <p>When renaming packages, be sure to fix any references to old name
                   8957:   in other Makefiles, options, buildlink files, etc.</p>
1.167   ! leot     8958: <p>
        !          8959:   Also when renaming a package, please add
        !          8960:   the package name and version pattern(s) of the previous package
        !          8961:   to <code class="varname">SUPERSEDES</code>.
1.20      snj      8962:   This may be repeated for multiple renames.
                   8963:   The new package would be an exact replacement.
1.167   ! leot     8964:   Example:
1.20      snj      8965: </p>
1.167   ! leot     8966: <pre class="programlisting">
        !          8967: SUPERSEDES+=    p5-IO-Compress-Zlib&lt;2.017
        !          8968: SUPERSEDES+=    optcomp-[0-9]*
        !          8969: </pre>
1.23      wiz      8970: <p>Note that <span class="quote">&#8220;<span class="quote">successor</span>&#8221;</span> in the
1.20      snj      8971:   CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
                   8972:   mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
                   8973:   not be an exact replacement but is a suggestion for the replaced
                   8974:   functionality.</p>
                   8975: </div>
1.41      asau     8976: <div class="sect1">
1.20      snj      8977: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   8978: <a name="moving-package"></a>23.8. Moving a package in pkgsrc</h2></div></div></div>
1.20      snj      8979: <p>It is preferred that packages are not renamed or moved, but if needed
                   8980:   please follow these steps.
                   8981: </p>
1.23      wiz      8982: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8983: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
                   8984: <li class="listitem">
1.1       dsieger  8985: <p>Remove all CVS dirs.</p>
                   8986: <p>Alternatively to the first two steps you can also do:</p>
                   8987: <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>
                   8988: <p>and use that for further work.</p>
                   8989: </li>
1.23      wiz      8990: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
                   8991: <code class="varname">DEPENDS</code> paths that just did <span class="quote">&#8220;<span class="quote">../package</span>&#8221;</span>
                   8992: instead of <span class="quote">&#8220;<span class="quote">../../category/package</span>&#8221;</span>.</p></li>
                   8993: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.20      snj      8994: <code class="varname">PREV_PKGPATH</code> to the previous category/package
                   8995: pathname.  The <code class="varname">PREV_PKGPATH</code> can be used by tools
                   8996: for doing an update using pkgsrc building; for example, it can
1.167   ! leot     8997: search the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?pkg_summary+5.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">pkg_summary</span>(5)</span></a> database for <code class="varname">PREV_PKGPATH</code>
1.20      snj      8998: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
                   8999: new <code class="varname">PKGPATH</code> for that moved package.  Note that
                   9000: it may have multiple matches, so the tool should also check on the
                   9001: <code class="varname">PKGBASE</code> too.  The <code class="varname">PREV_PKGPATH</code>
                   9002: probably has no value unless <code class="varname">SUPERSEDES</code> is not
                   9003: set, i.e.  <code class="varname">PKGBASE</code> stays the same.  </p></li>
1.23      wiz      9004: <li class="listitem"><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.1       dsieger  9005: place.</p></li>
1.23      wiz      9006: <li class="listitem">
1.1       dsieger  9007: <p>Check if any package depends on it:
                   9008: </p>
                   9009: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   9010: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
                   9011: </li>
1.23      wiz      9012: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
                   9013: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
                   9014: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
                   9015: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
                   9016: <li class="listitem">
1.1       dsieger  9017: <p>Commit the changed and removed files:</p>
                   9018: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile</code></strong></pre>
                   9019: <p>(and any packages from step 5, of course).</p>
                   9020: </li>
                   9021: </ol></div>
                   9022: </div>
                   9023: </div>
1.41      asau     9024: <div class="chapter">
1.1       dsieger  9025: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   9026: <a name="devfaq"></a>Chapter 24. Frequently Asked Questions</h2></div></div></div>
1.1       dsieger  9027: <p>This section contains the answers to questions that may
                   9028:        arise when you are writing a package. If you don't find your
                   9029:        question answered here, first have a look in the other chapters,
                   9030:        and if you still don't have the answer, ask on the
                   9031:        <code class="literal">pkgsrc-users</code> mailing list.</p>
1.41      asau     9032: <div class="qandaset">
1.167   ! leot     9033: <a name="idm75601104"></a><dl>
1.154     rillig   9034: <dt>24.1. <a href="#devfaq.makeflags">What is the difference between
1.1       dsieger  9035:        MAKEFLAGS, .MAKEFLAGS and
                   9036:        MAKE_FLAGS?</a>
                   9037: </dt>
1.154     rillig   9038: <dt>24.2. <a href="#devfaq.make">What is the difference between
1.1       dsieger  9039:        MAKE, GMAKE and
                   9040:        MAKE_PROGRAM?</a>
                   9041: </dt>
1.154     rillig   9042: <dt>24.3. <a href="#devfaq.cc">What is the difference between
1.1       dsieger  9043:        CC, PKG_CC and
                   9044:        PKGSRC_COMPILER?</a>
                   9045: </dt>
1.154     rillig   9046: <dt>24.4. <a href="#devfaq.bl3flags">What is the difference between
1.1       dsieger  9047:        BUILDLINK_LDFLAGS,
                   9048:        BUILDLINK_LDADD and
                   9049:        BUILDLINK_LIBS?</a>
                   9050: </dt>
1.154     rillig   9051: <dt>24.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.1       dsieger  9052:        VARNAME=BUILDLINK_PREFIX.foo
                   9053:        say it's empty?</a>
                   9054: </dt>
1.154     rillig   9055: <dt>24.6. <a href="#devfaq.master_sites">What does
1.1       dsieger  9056:        ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
                   9057:        don't understand the := inside
                   9058:        it.</a>
                   9059: </dt>
1.154     rillig   9060: <dt>24.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.1       dsieger  9061:        developers?</a>
                   9062: </dt>
1.154     rillig   9063: <dt>24.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.1       dsieger  9064:        documentation?</a>
                   9065: </dt>
1.154     rillig   9066: <dt>24.9. <a href="#devfaq.too-much-time">I have a little time to kill.  What shall I
1.1       dsieger  9067: do?</a>
                   9068: </dt>
                   9069: </dl>
1.41      asau     9070: <table border="0" style="width: 100%;">
                   9071: <colgroup>
1.1       dsieger  9072: <col align="left" width="1%">
1.23      wiz      9073: <col>
1.41      asau     9074: </colgroup>
1.1       dsieger  9075: <tbody>
1.41      asau     9076: <tr class="question">
1.1       dsieger  9077: <td align="left" valign="top">
1.167   ! leot     9078: <a name="devfaq.makeflags"></a><a name="idm75600720"></a><p><b>24.1.</b></p>
1.1       dsieger  9079: </td>
                   9080: <td align="left" valign="top"><p>What is the difference between
                   9081:        <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
                   9082:        <code class="varname">MAKE_FLAGS</code>?</p></td>
                   9083: </tr>
                   9084: <tr class="answer">
                   9085: <td align="left" valign="top"></td>
                   9086: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
1.167   ! leot     9087:        to the pkgsrc-internal invocations of <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a>, while
1.1       dsieger  9088:        <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
                   9089:        the <code class="varname">MAKE_PROGRAM</code> when building the
                   9090:        package. [FIXME: What is .MAKEFLAGS for?]</p></td>
                   9091: </tr>
1.41      asau     9092: <tr class="question">
1.1       dsieger  9093: <td align="left" valign="top">
1.167   ! leot     9094: <a name="devfaq.make"></a><a name="idm75604944"></a><p><b>24.2.</b></p>
1.1       dsieger  9095: </td>
                   9096: <td align="left" valign="top"><p>What is the difference between
                   9097:        <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
                   9098:        <code class="varname">MAKE_PROGRAM</code>?</p></td>
                   9099: </tr>
                   9100: <tr class="answer">
                   9101: <td align="left" valign="top"></td>
                   9102: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
1.167   ! leot     9103:        <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> program that is used in the pkgsrc
1.1       dsieger  9104:        infrastructure. <code class="varname">GMAKE</code> is the path to GNU
                   9105:        Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
                   9106:        use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
                   9107:        Make program that is used for building the
                   9108:        package.</p></td>
                   9109: </tr>
1.41      asau     9110: <tr class="question">
1.1       dsieger  9111: <td align="left" valign="top">
1.167   ! leot     9112: <a name="devfaq.cc"></a><a name="idm75608784"></a><p><b>24.3.</b></p>
1.1       dsieger  9113: </td>
                   9114: <td align="left" valign="top"><p>What is the difference between
                   9115:        <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
                   9116:        <code class="varname">PKGSRC_COMPILER</code>?</p></td>
                   9117: </tr>
                   9118: <tr class="answer">
                   9119: <td align="left" valign="top"></td>
                   9120: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
                   9121:        compiler, which can be configured by the pkgsrc user.
                   9122:        <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
                   9123:        <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
                   9124:        path to a compiler, but the type of compiler that should be
                   9125:        used. See <code class="filename">mk/compiler.mk</code> for more
                   9126:        information about the latter variable.</p></td>
                   9127: </tr>
1.41      asau     9128: <tr class="question">
1.1       dsieger  9129: <td align="left" valign="top">
1.167   ! leot     9130: <a name="devfaq.bl3flags"></a><a name="idm75612880"></a><p><b>24.4.</b></p>
1.1       dsieger  9131: </td>
                   9132: <td align="left" valign="top"><p>What is the difference between
                   9133:        <code class="varname">BUILDLINK_LDFLAGS</code>,
                   9134:        <code class="varname">BUILDLINK_LDADD</code> and
                   9135:        <code class="varname">BUILDLINK_LIBS</code>?</p></td>
                   9136: </tr>
                   9137: <tr class="answer">
                   9138: <td align="left" valign="top"></td>
                   9139: <td align="left" valign="top"><p>[FIXME]</p></td>
                   9140: </tr>
1.41      asau     9141: <tr class="question">
1.1       dsieger  9142: <td align="left" valign="top">
1.167   ! leot     9143: <a name="devfaq.bl3prefix"></a><a name="idm75610704"></a><p><b>24.5.</b></p>
1.1       dsieger  9144: </td>
1.10      hubertf  9145: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.1       dsieger  9146:        VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
                   9147:        say it's empty?</p></td>
                   9148: </tr>
                   9149: <tr class="answer">
                   9150: <td align="left" valign="top"></td>
                   9151: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.23      wiz      9152:        available in the <span class="quote">&#8220;<span class="quote">wrapper</span>&#8221;</span> phase and later. To
                   9153:        <span class="quote">&#8220;<span class="quote">simulate</span>&#8221;</span> the wrapper phase, append
1.10      hubertf  9154:        <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.1       dsieger  9155:        command.</p></td>
                   9156: </tr>
1.41      asau     9157: <tr class="question">
1.1       dsieger  9158: <td align="left" valign="top">
1.167   ! leot     9159: <a name="devfaq.master_sites"></a><a name="idm75615824"></a><p><b>24.6.</b></p>
1.1       dsieger  9160: </td>
                   9161: <td align="left" valign="top"><p>What does
1.108     rillig   9162:        <code class="code">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
                   9163:        don't understand the <code class="code">:=</code> inside
1.1       dsieger  9164:        it.</p></td>
                   9165: </tr>
                   9166: <tr class="answer">
                   9167: <td align="left" valign="top"></td>
1.108     rillig   9168: <td align="left" valign="top"><p>The <code class="code">:=</code> is not really an
                   9169:        assignment operator, although it looks like it.
1.1       dsieger  9170:        Instead, it is a degenerate form of
1.108     rillig   9171:        <code class="code">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.167   ! leot     9172:        which is documented in the <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?make+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">make</span>(1)</span></a> man page and which is
1.108     rillig   9173:        commonly used in the form <code class="code">${SRCS:.c=.o}</code>. In the
1.1       dsieger  9174:        case of <code class="varname">MASTER_SITE_*</code>,
                   9175:        <em class="replaceable"><code>old_string</code></em> is the empty string and
                   9176:        <em class="replaceable"><code>new_string</code></em> is
1.108     rillig   9177:        <code class="code">package/</code>. That's where the
                   9178:        <code class="code">:</code> and the <code class="code">=</code> fall
1.1       dsieger  9179:        together.</p></td>
                   9180: </tr>
1.41      asau     9181: <tr class="question">
1.1       dsieger  9182: <td align="left" valign="top">
1.167   ! leot     9183: <a name="devfaq.mailinglists"></a><a name="idm75625424"></a><p><b>24.7.</b></p>
1.1       dsieger  9184: </td>
                   9185: <td align="left" valign="top"><p>Which mailing lists are there for package
                   9186:        developers?</p></td>
                   9187: </tr>
                   9188: <tr class="answer">
                   9189: <td align="left" valign="top"></td>
1.41      asau     9190: <td align="left" valign="top"><div class="variablelist"><dl class="variablelist">
1.10      hubertf  9191: <dt><span class="term"><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a></span></dt>
1.1       dsieger  9192: <dd><p>This is a list for technical discussions related
                   9193:        to pkgsrc development, e.g. soliciting feedback for changes to
                   9194:        pkgsrc infrastructure, proposed new features, questions related
                   9195:        to porting pkgsrc to a new platform, advice for maintaining a
                   9196:        package, patches that affect many packages, help requests moved
                   9197:        from pkgsrc-users when an infrastructure bug is found,
                   9198:        etc.</p></dd>
1.10      hubertf  9199: <dt><span class="term"><a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#pkgsrc-bugs" target="_top">pkgsrc-bugs</a></span></dt>
1.1       dsieger  9200: <dd><p>All bug reports in category "pkg" sent with
1.167   ! leot     9201:        <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?send-pr+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">send-pr</span>(1)</span></a> appear here. Please do not report your bugs here
1.1       dsieger  9202:        directly; use one of the other mailing
                   9203:        lists.</p></dd>
                   9204: </dl></div></td>
                   9205: </tr>
1.41      asau     9206: <tr class="question">
1.1       dsieger  9207: <td align="left" valign="top">
1.167   ! leot     9208: <a name="devfaq.documentation"></a><a name="idm75629904"></a><p><b>24.8.</b></p>
1.1       dsieger  9209: </td>
                   9210: <td align="left" valign="top"><p>Where is the pkgsrc
                   9211:        documentation?</p></td>
                   9212: </tr>
                   9213: <tr class="answer">
                   9214: <td align="left" valign="top"></td>
                   9215: <td align="left" valign="top">
                   9216: <p>There are many places where you can find
                   9217:        documentation about pkgsrc:</p>
1.41      asau     9218: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      9219: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.1       dsieger  9220:        of chapters that explain large parts of pkgsrc, but some
                   9221:        chapters tend to be outdated. Which ones they are is hard to
                   9222:        say.</p></li>
1.23      wiz      9223: <li class="listitem"><p>On the mailing list archives (see <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>), you can find discussions
1.1       dsieger  9224:        about certain features, announcements of new parts of the pkgsrc
                   9225:        infrastructure and sometimes even announcements that a certain
                   9226:        feature has been marked as obsolete. The benefit here is that
                   9227:        each message has a date appended to it.</p></li>
1.23      wiz      9228: <li class="listitem"><p>Many of the files in the
1.1       dsieger  9229:        <code class="filename">mk/</code> directory start with a comment that
                   9230:        describes the purpose of the file and how it can be used by the
                   9231:        pkgsrc user and package authors. An easy way to find this
1.10      hubertf  9232:        documentation is to run <span class="command"><strong>bmake
1.1       dsieger  9233:        help</strong></span>.</p></li>
1.23      wiz      9234: <li class="listitem"><p>The CVS log messages are a rich source of
1.1       dsieger  9235:        information, but they tend to be highly abbreviated, especially
                   9236:        for actions that occur often. Some contain a detailed
                   9237:        description of what has changed, but they are geared towards the
                   9238:        other pkgsrc developers, not towards an average pkgsrc user.
                   9239:        They also only document <span class="emphasis"><em>changes</em></span>, so if you
                   9240:        don't know what has been before, these messages may not be worth
                   9241:        too much to you.</p></li>
1.23      wiz      9242: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">&#8220;<span class="quote">implicitly
                   9243:        documented</span>&#8221;</span>, that is the documentation exists only in the
1.1       dsieger  9244:        mind of the developer who wrote the code. To get this
1.10      hubertf  9245:        information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.1       dsieger  9246:        to see who has written it and ask on the
                   9247:        <code class="literal">tech-pkg</code> mailing list, so that others can
                   9248:        find your questions later (see above). To be sure that the
                   9249:        developer in charge reads the mail, you may CC him or
                   9250:        her.</p></li>
                   9251: </ul></div>
                   9252: </td>
                   9253: </tr>
1.41      asau     9254: <tr class="question">
1.1       dsieger  9255: <td align="left" valign="top">
1.167   ! leot     9256: <a name="devfaq.too-much-time"></a><a name="idm75631696"></a><p><b>24.9.</b></p>
1.1       dsieger  9257: </td>
                   9258: <td align="left" valign="top"><p>I have a little time to kill.  What shall I
                   9259: do?</p></td>
                   9260: </tr>
                   9261: <tr class="answer">
                   9262: <td align="left" valign="top"></td>
                   9263: <td align="left" valign="top">
                   9264: <p>This is not really an FAQ yet, but here's the answer
                   9265: anyway.</p>
1.41      asau     9266: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      9267: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.137     leot     9268:     <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.1       dsieger  9269:     will tell you about newer versions of installed packages that are
                   9270:     available, but not yet updated in pkgsrc.</p></li>
1.23      wiz      9271: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
1.14      jmcneill 9272:     &mdash; it contains a list of suggested new packages and a list of
1.1       dsieger  9273:     cleanups and enhancements for pkgsrc that would be nice to
                   9274:     have.</p></li>
1.23      wiz      9275: <li class="listitem"><p>Review packages for which review was requested on
1.71      wiz      9276:     the <a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a>
1.1       dsieger  9277:     mailing list.</p></li>
                   9278: </ul></div>
                   9279: </td>
                   9280: </tr>
                   9281: </tbody>
                   9282: </table>
                   9283: </div>
                   9284: </div>
1.41      asau     9285: <div class="chapter">
1.1       dsieger  9286: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   9287: <a name="gnome"></a>Chapter 25. GNOME packaging and porting</h2></div></div></div>
1.1       dsieger  9288: <div class="toc">
                   9289: <p><b>Table of Contents</b></p>
1.100     leot     9290: <dl class="toc">
1.154     rillig   9291: <dt><span class="sect1"><a href="#meta-packages">25.1. Meta packages</a></span></dt>
                   9292: <dt><span class="sect1"><a href="#new-package">25.2. Packaging a GNOME application</a></span></dt>
                   9293: <dt><span class="sect1"><a href="#full-update">25.3. Updating GNOME to a newer version</a></span></dt>
                   9294: <dt><span class="sect1"><a href="#patching">25.4. Patching guidelines</a></span></dt>
1.1       dsieger  9295: </dl>
                   9296: </div>
1.10      hubertf  9297: <p>Quoting <a class="ulink" href="http://www.gnome.org/" target="_top">GNOME's web
1.1       dsieger  9298: site</a>:</p>
                   9299: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
                   9300:   environment, an intuitive and attractive desktop for users, and the
                   9301:   GNOME development platform, an extensive framework for building
                   9302:   applications that integrate into the rest of the desktop.</p></blockquote></div>
                   9303: <p>pkgsrc provides a seamless way to automatically build and install
                   9304: a complete GNOME environment <span class="emphasis"><em>under many different
                   9305: platforms</em></span>.  We can say with confidence that pkgsrc is one of
                   9306: the most advanced build and packaging systems for GNOME due to its
                   9307: included technologies buildlink3, the wrappers and tools framework and
                   9308: automatic configuration file management.  Lots of efforts are put into
                   9309: achieving a completely clean deinstallation of installed software
                   9310: components.</p>
1.10      hubertf  9311: <p>Given that pkgsrc is <a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
1.1       dsieger  9312: the above also means that great efforts are put into making GNOME work
1.10      hubertf  9313: under this operating system.  Recently, <a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
1.1       dsieger  9314: pkgsrc as its preferred packaging system, contributing lots of
                   9315: portability fixes to make GNOME build and install under it.</p>
                   9316: <p>This chapter is aimed at pkgsrc developers and other people
                   9317: interested in helping our GNOME porting and packaging efforts.  It
                   9318: provides instructions on how to manage the existing packages and some
                   9319: important information regarding their internals.</p>
1.41      asau     9320: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  9321: <h3 class="title">We need your help!</h3>
                   9322: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
                   9323:   and GNOME and are willing to learn new exciting stuff, please jump
1.10      hubertf  9324:   straight to the <a class="ulink" href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
1.1       dsieger  9325:   work</a> list!  There is still a long way to go to get a
                   9326:   fully-functional GNOME desktop under NetBSD and we need your help to
                   9327:   achieve it!</p>
                   9328: </div>
1.41      asau     9329: <div class="sect1">
1.1       dsieger  9330: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   9331: <a name="meta-packages"></a>25.1. Meta packages</h2></div></div></div>
1.1       dsieger  9332: <p>pkgsrc includes three GNOME-related meta packages:</p>
1.41      asau     9333: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.137     leot     9334: <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.1       dsieger  9335:     the core GNOME desktop environment.  It only includes the necessary
                   9336:     bits to get it to boot correctly, although it may lack important
                   9337:     functionality for daily operation.  The idea behind this package is
                   9338:     to let end users build their own configurations on top of this one,
                   9339:     first installing this meta package to achieve a functional setup and
                   9340:     then adding individual applications.</p></li>
1.137     leot     9341: <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.1       dsieger  9342:     complete installation of the GNOME platform and desktop as defined
                   9343:     by the GNOME project; this is based on the components distributed in
                   9344:     the <code class="filename">platform/x.y/x.y.z/sources</code> and
                   9345:     <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
                   9346:     official FTP server.  Developer-only tools found in those
                   9347:     directories are not installed unless required by some other
                   9348:     component to work properly.  Similarly, packages from the bindings
                   9349:     set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
                   9350:     in unless required as a dependency for an end-user component.  This
1.137     leot     9351:     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>
                   9352: <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.1       dsieger  9353:     Installs all the tools required to build a GNOME component when
                   9354:     fetched from the CVS repository.  These are required to let the
1.10      hubertf  9355:     <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
1.1       dsieger  9356: </ul></div>
                   9357: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
                   9358: sorted in a way that eases updates: a package may depend on other
                   9359: packages listed before it but not on any listed after it.  It is very
                   9360: important to keep this order to ease updates so... <span class="emphasis"><em>do not
                   9361: change it to alphabetical sorting!</em></span></p>
                   9362: </div>
1.41      asau     9363: <div class="sect1">
1.1       dsieger  9364: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   9365: <a name="new-package"></a>25.2. Packaging a GNOME application</h2></div></div></div>
1.1       dsieger  9366: <p>Almost all GNOME applications are written in C and use a common
                   9367: set of tools as their build system.  Things get different with the new
                   9368: bindings to other languages (such as Python), but the following will
                   9369: give you a general idea on the minimum required tools:</p>
1.41      asau     9370: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      9371: <li class="listitem">
1.1       dsieger  9372: <p>Almost all GNOME applications use the GNU Autotools as their
                   9373:     build system.  As a general rule you will need to tell this to your
                   9374:     package:</p>
                   9375: <pre class="programlisting">
                   9376: GNU_CONFIGURE=yes
                   9377: USE_LIBTOOL=yes
                   9378: USE_TOOLS+=gmake
                   9379: </pre>
                   9380: </li>
1.23      wiz      9381: <li class="listitem">
1.1       dsieger  9382: <p>If the package uses pkg-config to detect dependencies, add this
                   9383:     tool to the list of required utilities:</p>
1.111     sevan    9384: <pre class="programlisting">
                   9385: USE_TOOLS+=pkg-config
                   9386: </pre>
1.137     leot     9387: <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.1       dsieger  9388:     the end of the build process to ensure that you did not miss to
                   9389:     specify any dependency in your package and that the version
                   9390:     requirements are all correct.</p>
                   9391: </li>
1.23      wiz      9392: <li class="listitem"><p>If the package uses intltool, be sure to add
1.1       dsieger  9393:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
                   9394:     to handle dependencies and to force the package to use the latest
                   9395:     available version.</p></li>
1.23      wiz      9396: <li class="listitem">
1.1       dsieger  9397: <p>If the package uses gtk-doc (a documentation generation
                   9398:     utility), do <span class="emphasis"><em>not</em></span> add a dependency on it.  The
                   9399:     tool is rather big and the distfile should come with pregenerated
                   9400:     documentation anyway; if it does not, it is a bug that you ought to
                   9401:     report.  For such packages you should disable gtk-doc (unless it is
                   9402:     the default):</p>
1.111     sevan    9403: <pre class="programlisting">
                   9404: CONFIGURE_ARGS+=--disable-gtk-doc
                   9405: </pre>
1.1       dsieger  9406: <p>The default location of installed HTML files
                   9407:     (<code class="filename">share/gtk-doc/&lt;package-name&gt;</code>) is correct
                   9408:     and should not be changed unless the package insists on installing
                   9409:     them somewhere else.  Otherwise programs as
1.10      hubertf  9410:     <span class="command"><strong>devhelp</strong></span> will not be able to open them.  You can
1.1       dsieger  9411:     do that with an entry similar to:</p>
1.111     sevan    9412: <pre class="programlisting">
                   9413: CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...
                   9414: </pre>
1.1       dsieger  9415: </li>
                   9416: </ul></div>
                   9417: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
                   9418: files under the installation prefix to maintain databases.  In this
                   9419: context, shared means that those exact same directories and files are
                   9420: used among several different packages, leading to conflicts in the
                   9421: <code class="filename">PLIST</code>.  pkgsrc currently includes functionality to
                   9422: handle the most common cases, so you have to forget about using
                   9423: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
                   9424: omitting shared files from them.  If you find yourself doing those,
                   9425: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
                   9426: <p>The following table lists the common situations that result in
                   9427: using shared directories or files.  For each of them, the appropriate
                   9428: solution is given.  After applying the solution be sure to
                   9429: <span class="emphasis"><em>regenerate the package's file list</em></span> with
1.10      hubertf  9430: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
1.1       dsieger  9431: <div class="table">
1.154     rillig   9432: <a name="plist-handling"></a><p class="title"><b>Table 25.1. PLIST handling for GNOME packages</b></p>
1.106     tnn      9433: <div class="table-contents"><table class="table" summary="PLIST handling for GNOME packages" border="1">
1.1       dsieger  9434: <colgroup>
                   9435: <col>
                   9436: <col>
                   9437: </colgroup>
                   9438: <thead><tr>
                   9439: <th>If the package...</th>
                   9440: <th>Then...</th>
                   9441: </tr></thead>
                   9442: <tbody>
                   9443: <tr>
                   9444: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.154     rillig   9445: <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.1       dsieger  9446: </tr>
                   9447: <tr>
                   9448: <td>Installs icons under the
                   9449:         <code class="filename">share/icons/hicolor</code> hierarchy or updates
                   9450:         <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.154     rillig   9451: <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.1       dsieger  9452: </tr>
                   9453: <tr>
                   9454: <td>Installs files under
                   9455:         <code class="filename">share/mime/packages</code>.</td>
1.154     rillig   9456: <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.1       dsieger  9457: </tr>
                   9458: <tr>
                   9459: <td>Installs <code class="filename">.desktop</code> files under
                   9460:         <code class="filename">share/applications</code> and these include MIME
                   9461:         information.</td>
1.154     rillig   9462: <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.1       dsieger  9463: </tr>
                   9464: </tbody>
                   9465: </table></div>
                   9466: </div>
                   9467: <br class="table-break">
                   9468: </div>
1.41      asau     9469: <div class="sect1">
1.1       dsieger  9470: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   9471: <a name="full-update"></a>25.3. Updating GNOME to a newer version</h2></div></div></div>
1.1       dsieger  9472: <p>When seeing GNOME as a whole, there are two kinds of
                   9473: updates:</p>
1.41      asau     9474: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  9475: <dt><span class="term">Major update</span></dt>
                   9476: <dd>
                   9477: <p>Given that there is still a very long way for GNOME 3 (if it
                   9478:       ever appears), we consider a major update one that goes from a
                   9479:       <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
                   9480:       where <code class="literal">Y</code> is even and greater than
                   9481:       <code class="literal">X</code>.  These are hard to achieve because they
                   9482:       introduce lots of changes in the components' code and almost all
                   9483:       GNOME distfiles are updated to newer versions.  Some of them can
                   9484:       even break API and ABI compatibility with the previous major
                   9485:       version series.  As a result, the update needs to be done all at
                   9486:       once to minimize breakage.</p>
                   9487: <p>A major update typically consists of around 80 package
                   9488:       updates and the addition of some new ones.</p>
                   9489: </dd>
                   9490: <dt><span class="term">Minor update</span></dt>
                   9491: <dd>
                   9492: <p>We consider a minor update one that goes from a
                   9493:       <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
                   9494:       one where <code class="literal">Y</code> is greater than
                   9495:       <code class="literal">X</code>.  These are easy to achieve because they do
                   9496:       not update all GNOME components, can be done in an incremental way
                   9497:       and do not break API nor ABI compatibility.</p>
                   9498: <p>A minor update typically consists of around 50 package
                   9499:       updates, although the numbers here may vary a lot.</p>
                   9500: </dd>
                   9501: </dl></div>
                   9502: <p>In order to update the GNOME components in pkgsrc to a new stable
                   9503: release (either major or minor), the following steps should be
                   9504: followed:</p>
1.23      wiz      9505: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9506: <li class="listitem">
1.1       dsieger  9507: <p>Get a list of all the tarballs that form the new release by
                   9508:     using the following commands.  These will leave the full list of the
1.18      snj      9509:     components' distfiles into the <code class="filename">list.txt</code>
1.1       dsieger  9510:     file:</p>
                   9511: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
                   9512:     ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
                   9513:     awk '{ print $9 }' &gt;list.txt</code></strong>
                   9514: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
                   9515:     ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
                   9516:     awk '{ print $9 }' &gt;&gt;list.txt</code></strong></pre>
                   9517: </li>
1.23      wiz      9518: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
1.1       dsieger  9519:     bump their version to the release you are updating them to.  The
                   9520:     three meta packages should be always consistent with versioning.
                   9521:     Obviously remove any <code class="varname">PKGREVISION</code>s that might be
                   9522:     in them.</p></li>
1.23      wiz      9523: <li class="listitem">
1.1       dsieger  9524: <p>For each meta package, update all its
                   9525:     <code class="varname">DEPENDS</code> lines to match the latest versions as
                   9526:     shown by the above commands.  Do <span class="emphasis"><em>not</em></span> list any
                   9527:     newer version (even if found in the FTP) because the meta packages
                   9528:     are supposed to list the exact versions that form a specific GNOME
                   9529:     release.  Exceptions are permitted here if a newer version solves a
                   9530:     serious issue in the overall desktop experience; these typically
                   9531:     come in the form of a revision bump in pkgsrc, not in newer versions
                   9532:     from the developers.</p>
                   9533: <p>Packages not listed in the <code class="filename">list.txt</code> file
                   9534:     should be updated to the latest version available (if found in
                   9535:     pkgsrc).  This is the case, for example, of the dependencies on the
1.137     leot     9536:     GNU Autotools in the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/gnome-devel/README.html" target="_top"><code class="filename">meta-pkgs/gnome-devel</code></a> meta package.</p>
1.1       dsieger  9537: </li>
1.23      wiz      9538: <li class="listitem">
1.1       dsieger  9539: <p>Generate a patch from the modified meta packages and extract the
                   9540:     list of "new" lines.  This will provide you an outline on what
                   9541:     packages need to be updated in pkgsrc and in what order:</p>
                   9542: <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>
                   9543: </li>
1.23      wiz      9544: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
1.1       dsieger  9545:     installed packages and start over from scratch at this point.</p></li>
1.23      wiz      9546: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
1.1       dsieger  9547:     of <code class="filename">todo.txt</code> and update the packages listed in
                   9548:     it in order.  For major desktop updates none of these should be
                   9549:     committed until the entire set is completed because there are chances
                   9550:     of breaking not-yet-updated packages.</p></li>
1.23      wiz      9551: <li class="listitem"><p>Once the packages are up to date and working, commit them to
1.1       dsieger  9552:     the tree one by one with appropriate log messages.  At the end,
                   9553:     commit the three meta package updates and all the corresponding
                   9554:     changes to the <code class="filename">doc/CHANGES-&lt;YEAR&gt;</code> and
                   9555:     <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>
                   9556: </ol></div>
                   9557: </div>
1.41      asau     9558: <div class="sect1">
1.1       dsieger  9559: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   9560: <a name="patching"></a>25.4. Patching guidelines</h2></div></div></div>
1.1       dsieger  9561: <p>GNOME is a very big component in pkgsrc which approaches 100
                   9562: packages.  Please, it is very important that you always, always,
                   9563: <span class="strong"><strong>always</strong></span> feed back any portability
1.154     rillig   9564: 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.1       dsieger  9565: their attention on portability issues and to ensure that future versions
                   9566: can be built out-of-the box on NetBSD.  The less custom patches in
                   9567: pkgsrc, the easier further updates are.  Those developers in charge of
                   9568: issuing major GNOME updates will be grateful if you do that.</p>
1.10      hubertf  9569: <p>The most common places to report bugs are the <a class="ulink" href="http://bugzilla.gnome.org/" target="_top">GNOME's Bugzilla</a> and the <a class="ulink" href="http://bugzilla.freedesktop.org/" target="_top">freedesktop.org's
1.1       dsieger  9570: Bugzilla</a>.  Not all components use these to track bugs, but most
                   9571: of them do.  Do not be short on your reports: always provide detailed
                   9572: explanations of the current failure, how it can be improved to achieve
                   9573: maximum portability and, if at all possible, provide a patch against CVS
                   9574: head.  The more verbose you are, the higher chances of your patch being
                   9575: accepted.</p>
                   9576: <p>Also, please avoid using preprocessor magic to fix portability
                   9577: issues.  While the FreeBSD GNOME people are doing a great job in porting
                   9578: GNOME to their operating system, the official GNOME sources are now
                   9579: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
                   9580: and similar macros.  This hurts portability.  Please see our patching
1.154     rillig   9581: 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.1       dsieger  9582: details.</p>
                   9583: </div>
                   9584: </div>
                   9585: </div>
1.41      asau     9586: <div class="part">
1.1       dsieger  9587: <div class="titlepage"><div><div><h1 class="title">
                   9588: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.41      asau     9589: <div class="partintro">
1.1       dsieger  9590: <div></div>
                   9591: <p>This part of the guide deals with everything
                   9592:        from the infrastructure that is behind the interfaces described
                   9593:        in the developer's guide. A casual package maintainer should not
                   9594:        need anything from this part.</p>
                   9595: <div class="toc">
                   9596: <p><b>Table of Contents</b></p>
1.100     leot     9597: <dl class="toc">
1.154     rillig   9598: <dt><span class="chapter"><a href="#infr.design">26. Design of the pkgsrc infrastructure</a></span></dt>
1.1       dsieger  9599: <dd><dl>
1.154     rillig   9600: <dt><span class="sect1"><a href="#infr.vardef">26.1. The meaning of variable definitions</a></span></dt>
                   9601: <dt><span class="sect1"><a href="#infr.vardef.problems">26.2. Avoiding problems before they arise</a></span></dt>
                   9602: <dt><span class="sect1"><a href="#infr.var">26.3. Variable evaluation</a></span></dt>
1.1       dsieger  9603: <dd><dl>
1.154     rillig   9604: <dt><span class="sect2"><a href="#infr.var.load">26.3.1. At load time</a></span></dt>
                   9605: <dt><span class="sect2"><a href="#infr.var.run">26.3.2. At runtime</a></span></dt>
1.1       dsieger  9606: </dl></dd>
1.154     rillig   9607: <dt><span class="sect1"><a href="#infr.varspec">26.4. How can variables be specified?</a></span></dt>
                   9608: <dt><span class="sect1"><a href="#infr.design.intf">26.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1       dsieger  9609: <dd><dl>
1.154     rillig   9610: <dt><span class="sect2"><a href="#infr.design.intf.proc">26.5.1. Procedures with parameters</a></span></dt>
                   9611: <dt><span class="sect2"><a href="#infr.design.intf.action">26.5.2. Actions taken on behalf of parameters</a></span></dt>
1.1       dsieger  9612: </dl></dd>
1.154     rillig   9613: <dt><span class="sect1"><a href="#infr.order">26.6. The order in which files are loaded</a></span></dt>
1.1       dsieger  9614: <dd><dl>
1.154     rillig   9615: <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>
                   9616: <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.1       dsieger  9617: </dl></dd>
                   9618: </dl></dd>
1.154     rillig   9619: <dt><span class="chapter"><a href="#regression">27. Regression tests</a></span></dt>
1.1       dsieger  9620: <dd><dl>
1.154     rillig   9621: <dt><span class="sect1"><a href="#regression.run">27.1. Running the regression tests</a></span></dt>
                   9622: <dt><span class="sect1"><a href="#regression.new">27.2. Adding a new regression test</a></span></dt>
1.1       dsieger  9623: <dd><dl>
1.154     rillig   9624: <dt><span class="sect2"><a href="#regression.fun.override">27.2.1. Overridable functions</a></span></dt>
                   9625: <dt><span class="sect2"><a href="#regression.fun.helper">27.2.2. Helper functions</a></span></dt>
1.1       dsieger  9626: </dl></dd>
                   9627: </dl></dd>
1.154     rillig   9628: <dt><span class="chapter"><a href="#porting">28. Porting pkgsrc</a></span></dt>
                   9629: <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.1       dsieger  9630: </dl>
                   9631: </div>
                   9632: </div>
1.41      asau     9633: <div class="chapter">
1.1       dsieger  9634: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   9635: <a name="infr.design"></a>Chapter 26. Design of the pkgsrc infrastructure</h2></div></div></div>
1.1       dsieger  9636: <div class="toc">
                   9637: <p><b>Table of Contents</b></p>
1.100     leot     9638: <dl class="toc">
1.154     rillig   9639: <dt><span class="sect1"><a href="#infr.vardef">26.1. The meaning of variable definitions</a></span></dt>
                   9640: <dt><span class="sect1"><a href="#infr.vardef.problems">26.2. Avoiding problems before they arise</a></span></dt>
                   9641: <dt><span class="sect1"><a href="#infr.var">26.3. Variable evaluation</a></span></dt>
1.1       dsieger  9642: <dd><dl>
1.154     rillig   9643: <dt><span class="sect2"><a href="#infr.var.load">26.3.1. At load time</a></span></dt>
                   9644: <dt><span class="sect2"><a href="#infr.var.run">26.3.2. At runtime</a></span></dt>
1.1       dsieger  9645: </dl></dd>
1.154     rillig   9646: <dt><span class="sect1"><a href="#infr.varspec">26.4. How can variables be specified?</a></span></dt>
                   9647: <dt><span class="sect1"><a href="#infr.design.intf">26.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1       dsieger  9648: <dd><dl>
1.154     rillig   9649: <dt><span class="sect2"><a href="#infr.design.intf.proc">26.5.1. Procedures with parameters</a></span></dt>
                   9650: <dt><span class="sect2"><a href="#infr.design.intf.action">26.5.2. Actions taken on behalf of parameters</a></span></dt>
1.1       dsieger  9651: </dl></dd>
1.154     rillig   9652: <dt><span class="sect1"><a href="#infr.order">26.6. The order in which files are loaded</a></span></dt>
1.1       dsieger  9653: <dd><dl>
1.154     rillig   9654: <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>
                   9655: <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.1       dsieger  9656: </dl></dd>
                   9657: </dl>
                   9658: </div>
                   9659: <p>The pkgsrc infrastructure consists of many small Makefile
                   9660:        fragments. Each such fragment needs a properly specified
                   9661:        interface. This chapter explains how such an interface looks
                   9662:        like.</p>
1.41      asau     9663: <div class="sect1">
1.1       dsieger  9664: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   9665: <a name="infr.vardef"></a>26.1. The meaning of variable definitions</h2></div></div></div>
1.1       dsieger  9666: <p>Whenever a variable is defined in the pkgsrc
                   9667:        infrastructure, the location and the way of definition provide
                   9668:        much information about the intended use of that variable.
                   9669:        Additionally, more documentation may be found in a header
                   9670:        comment or in this pkgsrc guide.</p>
                   9671: <p>A special file is
                   9672:        <code class="filename">mk/defaults/mk.conf</code>, which lists all
                   9673:        variables that are intended to be user-defined. They are either
                   9674:        defined using the <code class="literal">?=</code> operator or they are
                   9675:        left undefined because defining them to anything would
1.23      wiz      9676:        effectively mean <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. All these variables may be
1.1       dsieger  9677:        overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
                   9678:        file.</p>
                   9679: <p>Outside this file, the following conventions apply:
                   9680:        Variables that are defined using the <code class="literal">?=</code>
                   9681:        operator may be overridden by a package.</p>
                   9682: <p>Variables that are defined using the <code class="literal">=</code>
                   9683:        operator may be used read-only at run-time.</p>
                   9684: <p>Variables whose name starts with an underscore must not be
                   9685:        accessed outside the pkgsrc infrastructure at all. They may
                   9686:        change without further notice.</p>
1.41      asau     9687: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  9688: <h3 class="title">Note</h3>
                   9689: <p>These conventions are currently not applied
                   9690:        consistently to the complete pkgsrc
                   9691:        infrastructure.</p>
                   9692: </div>
                   9693: </div>
1.41      asau     9694: <div class="sect1">
1.1       dsieger  9695: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   9696: <a name="infr.vardef.problems"></a>26.2. Avoiding problems before they arise</h2></div></div></div>
1.1       dsieger  9697: <p>All variables that contain lists of things should default
                   9698:        to being empty. Two examples that do not follow this rule are
                   9699:        <code class="varname">USE_LANGUAGES</code> and
                   9700:        <code class="varname">DISTFILES</code>. These variables cannot simply be
                   9701:        modified using the <code class="literal">+=</code> operator in package
                   9702:        <code class="filename">Makefile</code>s (or other files included by
                   9703:        them), since there is no guarantee whether the variable is
                   9704:        already set or not, and what its value is. In the case of
1.23      wiz      9705:        <code class="varname">DISTFILES</code>, the packages <span class="quote">&#8220;<span class="quote">know</span>&#8221;</span>
1.1       dsieger  9706:        the default value and just define it as in the following
                   9707:        example.</p>
                   9708: <pre class="programlisting">
                   9709: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
                   9710: </pre>
                   9711: <p>Because of the selection of this default value, the same
                   9712:        value appears in many package Makefiles. Similarly for
                   9713:        <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.23      wiz      9714:        value (<span class="quote">&#8220;<span class="quote"><code class="literal">c</code></span>&#8221;</span>) is so short that it
1.1       dsieger  9715:        doesn't stand out. Nevertheless it is mentioned in many
                   9716:        files.</p>
                   9717: </div>
1.41      asau     9718: <div class="sect1">
1.1       dsieger  9719: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   9720: <a name="infr.var"></a>26.3. Variable evaluation</h2></div></div></div>
1.41      asau     9721: <div class="sect2">
1.1       dsieger  9722: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   9723: <a name="infr.var.load"></a>26.3.1. At load time</h3></div></div></div>
1.1       dsieger  9724: <p>Variable evaluation takes place either at load time or at
                   9725:        runtime, depending on the context in which they occur. The
                   9726:        contexts where variables are evaluated at load time are:</p>
1.41      asau     9727: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      9728: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.1       dsieger  9729:        and <code class="literal">!=</code> operators,</p></li>
1.23      wiz      9730: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.1       dsieger  9731:        <code class="literal">.for</code>,</p></li>
1.23      wiz      9732: <li class="listitem"><p>Dependency lines.</p></li>
1.1       dsieger  9733: </ul></div>
                   9734: <p>A special exception are references to the iteration
                   9735:        variables of <code class="literal">.for</code> loops, which are expanded
                   9736:        inline, no matter in which context they appear.</p>
                   9737: <p>As the values of variables may change during load time,
                   9738:        care must be taken not to evaluate them by accident. Typical
                   9739:        examples for variables that should not be evaluated at load time
                   9740:        are <code class="varname">DEPENDS</code> and
                   9741:        <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
                   9742:        clear, here is an example:</p>
                   9743: <pre class="programlisting">
                   9744: CONFIGURE_ARGS=         # none
                   9745: CFLAGS=                 -O
                   9746: CONFIGURE_ARGS+=        CFLAGS=${CFLAGS:Q}
                   9747: 
                   9748: CONFIGURE_ARGS:=        ${CONFIGURE_ARGS}
                   9749: 
                   9750: CFLAGS+=                -Wall
1.111     sevan    9751: </pre>
1.1       dsieger  9752: <p>This code shows how the use of the <code class="literal">:=</code>
                   9753:        operator can quickly lead to unexpected results. The first
                   9754:        paragraph is fairly common code. The second paragraph evaluates
                   9755:        the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
                   9756:        <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
                   9757:        <code class="literal">-Wall</code> is appended to the
                   9758:        <code class="varname">CFLAGS</code>, but this addition will not appear in
                   9759:        <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
                   9760:        paragraphs from above typically occur in completely unrelated
                   9761:        files.</p>
                   9762: </div>
1.41      asau     9763: <div class="sect2">
1.1       dsieger  9764: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   9765: <a name="infr.var.run"></a>26.3.2. At runtime</h3></div></div></div>
1.1       dsieger  9766: <p>After all the files have been loaded, the values of the
                   9767:        variables cannot be changed anymore. Variables that are used in
                   9768:        the shell commands are expanded at this point.</p>
                   9769: </div>
                   9770: </div>
1.41      asau     9771: <div class="sect1">
1.1       dsieger  9772: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   9773: <a name="infr.varspec"></a>26.4. How can variables be specified?</h2></div></div></div>
1.1       dsieger  9774: <p>There are many ways in which the definition and use of a
1.108     rillig   9775:        variable can be restricted in order to detect bugs and violations
                   9776:        of the (mostly unwritten) policies. A package can be checked with
                   9777:        <code class="literal">pkglint -Wall</code> to see whether it meets these
                   9778:        rules.</p>
1.1       dsieger  9779: </div>
1.41      asau     9780: <div class="sect1">
1.1       dsieger  9781: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   9782: <a name="infr.design.intf"></a>26.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.1       dsieger  9783: <p>Most of the <code class="filename">.mk</code> files fall into one
                   9784:        of the following classes. Cases where a file falls into more
                   9785:        than one class should be avoided as it often leads to subtle
                   9786:        bugs.</p>
1.41      asau     9787: <div class="sect2">
1.1       dsieger  9788: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   9789: <a name="infr.design.intf.proc"></a>26.5.1. Procedures with parameters</h3></div></div></div>
1.1       dsieger  9790: <p>In a traditional imperative programming language some of
                   9791:        the <code class="filename">.mk</code> files could be described as
1.14      jmcneill 9792:        procedures. They take some input parameters and&mdash;after
                   9793:        inclusion&mdash;provide a result in output parameters. Since all
1.1       dsieger  9794:        variables in <code class="filename">Makefile</code>s have global scope
                   9795:        care must be taken not to use parameter names that have already
                   9796:        another meaning. For example, <code class="varname">PKGNAME</code> is a
                   9797:        bad choice for a parameter name.</p>
                   9798: <p>Procedures are completely evaluated at preprocessing time.
                   9799:        That is, when calling a procedure all input parameters must be
                   9800:        completely resolvable. For example,
                   9801:        <code class="varname">CONFIGURE_ARGS</code> should never be an input
                   9802:        parameter since it is very likely that further text will be
                   9803:        added after calling the procedure, which would effectively apply
                   9804:        the procedure to only a part of the variable. Also, references
1.108     rillig   9805:        to other variables will be modified after calling the
1.1       dsieger  9806:        procedure.</p>
                   9807: <p>A procedure can declare its output parameters either as
                   9808:        suitable for use in preprocessing directives or as only
                   9809:        available at runtime. The latter alternative is for variables
                   9810:        that contain references to other runtime variables.</p>
                   9811: <p>Procedures shall be written such that it is possible to
                   9812:        call the procedure more than once. That is, the file must not
                   9813:        contain multiple-inclusion guards.</p>
                   9814: <p>Examples for procedures are
                   9815:        <code class="filename">mk/bsd.options.mk</code> and
                   9816:        <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
                   9817:        that the parameters are evaluated at load time, they should be
                   9818:        assigned using the <code class="literal">:=</code> operator, which should
                   9819:        be used only for this purpose.</p>
                   9820: </div>
1.41      asau     9821: <div class="sect2">
1.1       dsieger  9822: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   9823: <a name="infr.design.intf.action"></a>26.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.1       dsieger  9824: <p>Action files take some input parameters and may define
                   9825:        runtime variables. They shall not define loadtime variables.
                   9826:        There are action files that are included implicitly by the
                   9827:        pkgsrc infrastructure, while other must be included
                   9828:        explicitly.</p>
                   9829: <p>An example for action files is
                   9830:        <code class="filename">mk/subst.mk</code>.</p>
                   9831: </div>
                   9832: </div>
1.41      asau     9833: <div class="sect1">
1.1       dsieger  9834: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   9835: <a name="infr.order"></a>26.6. The order in which files are loaded</h2></div></div></div>
1.1       dsieger  9836: <p>Package <code class="filename">Makefile</code>s usually consist of
                   9837:        a set of variable definitions, and include the file
                   9838:        <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
                   9839:        Before that, they may also include various other
                   9840:        <code class="filename">*.mk</code> files if they need to query the
                   9841:        availability of certain features like the type of compiler or
                   9842:        the X11 implementation. Due to the heavy use of preprocessor
                   9843:        directives like <code class="literal">.if</code> and
                   9844:        <code class="literal">.for</code>, the order in which the files are loaded
                   9845:        matters.</p>
                   9846: <p>This section describes at which point the various files
                   9847:        are loaded and gives reasons for that order.</p>
1.41      asau     9848: <div class="sect2">
1.1       dsieger  9849: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   9850: <a name="infr.order.prefs"></a>26.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.1       dsieger  9851: </h3></div></div></div>
                   9852: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
                   9853:        is to define some essential variables like
                   9854:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
                   9855:        <code class="varname">MACHINE_ARCH</code>.</p>
                   9856: <p>Then, the user settings are loaded from the file specified
1.10      hubertf  9857:        in <code class="varname">MAKECONF</code>, which is usually <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.
1.4       rillig   9858:        After that, those variables
1.1       dsieger  9859:        that have not been overridden by the user are loaded from
                   9860:        <code class="filename">mk/defaults/mk.conf</code>.</p>
                   9861: <p>After the user settings, the system settings and platform
                   9862:        settings are loaded, which may override the user
                   9863:        settings.</p>
                   9864: <p>Then, the tool definitions are loaded. The tool wrappers
                   9865:        are not yet in effect. This only happens when building a
                   9866:        package, so the proper variables must be used instead of the
                   9867:        direct tool names.</p>
                   9868: <p>As the last steps, some essential variables from the
                   9869:        wrapper and the package system flavor are loaded, as well as the
                   9870:        variables that have been cached in earlier phases of a package
                   9871:        build.</p>
                   9872: </div>
1.41      asau     9873: <div class="sect2">
1.1       dsieger  9874: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   9875: <a name="infr.order.pkg"></a>26.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.1       dsieger  9876: </h3></div></div></div>
                   9877: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
                   9878: <p>Then, the various <code class="filename">*-vars.mk</code> files are
                   9879:        loaded, which fill default values for those variables that have
                   9880:        not been defined by the package. These variables may later
                   9881:        be used even in unrelated files.</p>
                   9882: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
                   9883:        provides the target <code class="literal">error-check</code> that is added
                   9884:        as a special dependency to all other targets that use
                   9885:        <code class="varname">DELAYED_ERROR_MSG</code> or
                   9886:        <code class="varname">DELAYED_WARNING_MSG</code>.</p>
                   9887: <p>Then, the package-specific hacks from
                   9888:        <code class="filename">hacks.mk</code> are included.</p>
                   9889: <p>Then, various other files follow. Most of them don't have
                   9890:        any dependencies on what they need to have included before or
                   9891:        after them, though some do.</p>
                   9892: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
                   9893:        <code class="varname">PKG_SKIP_REASON</code> is then executed, which
                   9894:        restricts the use of these variables to all the files that have
                   9895:        been included before. Appearances in later files will be
                   9896:        silently ignored.</p>
                   9897: <p>Then, the files for the main targets are included, in the
                   9898:        order of later execution, though the actual order should not
                   9899:        matter.</p>
                   9900: <p>At last, some more files are included that don't set any
                   9901:        interesting variables but rather just define make targets to be
                   9902:        executed.</p>
                   9903: </div>
                   9904: </div>
                   9905: </div>
1.41      asau     9906: <div class="chapter">
1.1       dsieger  9907: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   9908: <a name="regression"></a>Chapter 27. Regression tests</h2></div></div></div>
1.1       dsieger  9909: <div class="toc">
                   9910: <p><b>Table of Contents</b></p>
1.100     leot     9911: <dl class="toc">
1.154     rillig   9912: <dt><span class="sect1"><a href="#regression.run">27.1. Running the regression tests</a></span></dt>
                   9913: <dt><span class="sect1"><a href="#regression.new">27.2. Adding a new regression test</a></span></dt>
1.1       dsieger  9914: <dd><dl>
1.154     rillig   9915: <dt><span class="sect2"><a href="#regression.fun.override">27.2.1. Overridable functions</a></span></dt>
                   9916: <dt><span class="sect2"><a href="#regression.fun.helper">27.2.2. Helper functions</a></span></dt>
1.1       dsieger  9917: </dl></dd>
                   9918: </dl>
                   9919: </div>
                   9920: <p>The pkgsrc infrastructure consists of a large codebase,
                   9921:        and there are many corners where every little bit of a file is
                   9922:        well thought out, making pkgsrc likely to fail as soon as
                   9923:        anything is changed near those parts. To prevent most changes
                   9924:        from breaking anything, a suite of regression tests should go
                   9925:        along with every important part of the pkgsrc infrastructure.
                   9926:        This chapter describes how regression tests work in pkgsrc and
                   9927:        how you can add new tests.</p>
1.41      asau     9928: <div class="sect1">
1.1       dsieger  9929: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   9930: <a name="regression.run"></a>27.1. Running the regression tests</h2></div></div></div>
1.137     leot     9931: <p>You first need to install the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkg_regress/README.html" target="_top"><code class="filename">pkgtools/pkg_regress</code></a> package, which
1.10      hubertf  9932:        provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.1       dsieger  9933:        can simply run that command, which will run all tests in the
                   9934:        <code class="filename">regress</code> category.</p>
                   9935: </div>
1.41      asau     9936: <div class="sect1">
1.1       dsieger  9937: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   9938: <a name="regression.new"></a>27.2. Adding a new regression test</h2></div></div></div>
1.1       dsieger  9939: <p>Every directory in the <code class="filename">regress</code>
                   9940:        category that contains a file called <code class="filename">spec</code>
                   9941:        is considered a regression test. This file is a shell program
1.10      hubertf  9942:        that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.1       dsieger  9943:        The following functions can be overridden to suit your
                   9944:        needs.</p>
1.41      asau     9945: <div class="sect2">
1.1       dsieger  9946: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   9947: <a name="regression.fun.override"></a>27.2.1. Overridable functions</h3></div></div></div>
1.108     rillig   9948: <p>These functions do not take any parameters. Although they
                   9949:        are called in <span class="quote">&#8220;<span class="quote">set -e</span>&#8221;</span> mode, they don't stop at the
                   9950:        first failing command. See <a class="ulink" href="http://stackoverflow.com/q/4072984" target="_top">this StackOverflow
                   9951:        question</a> for details.</p>
1.41      asau     9952: <div class="variablelist"><dl class="variablelist">
1.108     rillig   9953: <dt><span class="term"><code class="varname">do_setup</code></span></dt>
1.1       dsieger  9954: <dd><p>This function prepares the environment for the
                   9955:        test. By default it does nothing.</p></dd>
1.108     rillig   9956: <dt><span class="term"><code class="varname">do_test</code></span></dt>
                   9957: <dd>
                   9958: <p>This function runs the actual test. By default,
1.1       dsieger  9959:        it calls <code class="varname">TEST_MAKE</code> with the arguments
                   9960:        <code class="varname">MAKEARGS_TEST</code> and writes its output including
                   9961:        error messages into the file
1.108     rillig   9962:        <code class="varname">TEST_OUTFILE</code>.</p>
                   9963: <p>When defining this function, make sure that all output that
                   9964:        needs to be checked is written to the correct output file.
                   9965:        Example:</p>
                   9966: <pre class="programlisting">
                   9967: do_test() {
1.112     rillig   9968:         echo "Example output"
1.108     rillig   9969: } 1&gt;$TEST_OUTFILE 2&gt;&amp;1
                   9970: </pre>
                   9971: </dd>
                   9972: <dt><span class="term"><code class="varname">check_result</code></span></dt>
                   9973: <dd>
                   9974: <p>This function is run after the test and is
1.1       dsieger  9975:        typically used to compare the actual output from the one that is
                   9976:        expected. It can make use of the various helper functions from
1.108     rillig   9977:        the next section. Example:</p>
                   9978: <pre class="programlisting">
                   9979: check_result() {
1.112     rillig   9980:         exit_status 0
                   9981:         output_require "Example"
                   9982:         output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
                   9983:         output_prohibit "no such file or directory"
1.108     rillig   9984: }
                   9985: </pre>
                   9986: </dd>
                   9987: <dt><span class="term"><code class="varname">do_cleanup</code></span></dt>
1.1       dsieger  9988: <dd><p>This function cleans everything up after the
                   9989:        test has been run. By default it does nothing.</p></dd>
                   9990: </dl></div>
                   9991: </div>
1.41      asau     9992: <div class="sect2">
1.1       dsieger  9993: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   9994: <a name="regression.fun.helper"></a>27.2.2. Helper functions</h3></div></div></div>
1.41      asau     9995: <div class="variablelist"><dl class="variablelist">
1.108     rillig   9996: <dt><span class="term"><code class="varname">exit_status expected</code></span></dt>
1.1       dsieger  9997: <dd><p>This function compares the exitcode of the
1.108     rillig   9998:        <span class="command"><strong>do_test</strong></span> function with its first parameter.
1.1       dsieger  9999:        If they differ, the test will fail.</p></dd>
1.108     rillig   10000: <dt><span class="term"><code class="varname">output_require regex...</code></span></dt>
                   10001: <dd>
                   10002: <p>This function checks for each of its parameters
                   10003:        if the output from <span class="command"><strong>do_test</strong></span> matches the
1.1       dsieger  10004:        extended regular expression. If it does not, the test will
1.108     rillig   10005:        fail. Example:</p>
                   10006: <pre class="programlisting">
                   10007: output_require "looks fine"
                   10008: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
                   10009: </pre>
                   10010: </dd>
1.1       dsieger  10011: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
                   10012: <dd><p>This function checks for each of its parameters
1.10      hubertf  10013:        if the output from <span class="command"><strong>do_test()</strong></span> does
1.1       dsieger  10014:        <span class="emphasis"><em>not</em></span> match the extended regular expression.
                   10015:        If any of the regular expressions matches, the test will
                   10016:        fail.</p></dd>
                   10017: </dl></div>
                   10018: </div>
                   10019: </div>
                   10020: </div>
1.41      asau     10021: <div class="chapter">
1.1       dsieger  10022: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   10023: <a name="porting"></a>Chapter 28. Porting pkgsrc</h2></div></div></div>
1.1       dsieger  10024: <div class="toc">
                   10025: <p><b>Table of Contents</b></p>
1.154     rillig   10026: <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.1       dsieger  10027: </div>
                   10028: <p>The pkgsrc system has already been ported to many
                   10029:        operating systems, hardware architectures and compilers. This
                   10030:        chapter explains the necessary steps to make pkgsrc even more
                   10031:        portable.</p>
1.41      asau     10032: <div class="sect1">
1.1       dsieger  10033: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   10034: <a name="porting.opsys"></a>28.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.1       dsieger  10035: <p>To port pkgsrc to a new operating system (called
                   10036:        <code class="literal">MyOS</code> in this example), you need to touch the
                   10037:        following files:</p>
1.41      asau     10038: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  10039: <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>
                   10040: <dd><p>This file contains some basic definitions, for
                   10041:        example the name of the C
                   10042:        compiler.</p></dd>
                   10043: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
                   10044: <dd><p>Insert code that defines the variables
                   10045:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
                   10046:        <code class="varname">LOWER_OS_VERSION</code>,
                   10047:        <code class="varname">LOWER_VENDOR</code>,
                   10048:        <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
                   10049:        <code class="varname">APPEND_ELF</code>, and the other variables that
                   10050:        appear in this file.</p></dd>
                   10051: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
                   10052: <dd><p>This file contains the platform-specific
                   10053:        definitions that are used by pkgsrc. Start by copying one of the
                   10054:        other files and edit it to your
                   10055:        needs.</p></dd>
                   10056: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
                   10057: <dd><p>This file defines the paths to all the tools
                   10058:        that are needed by one or the other package in pkgsrc, as well
                   10059:        as by pkgsrc itself. Find out where these tools are on your
                   10060:        platform and add them.</p></dd>
                   10061: </dl></div>
                   10062: <p>Now, you should be able to build some basic packages, like
1.137     leot     10063:        <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/lang/perl5/README.html" target="_top"><code class="filename">lang/perl5</code></a>, <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/shells/bash/README.html" target="_top"><code class="filename">shells/bash</code></a>.</p>
1.1       dsieger  10064: </div>
                   10065: </div>
                   10066: </div>
1.41      asau     10067: <div class="appendix">
                   10068: <div class="titlepage"><div><div><h1 class="title">
                   10069: <a name="examples"></a>Appendix A. A simple example package: bison</h1></div></div></div>
1.1       dsieger  10070: <div class="toc">
                   10071: <p><b>Table of Contents</b></p>
1.100     leot     10072: <dl class="toc">
1.1       dsieger  10073: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
                   10074: <dd><dl>
                   10075: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
                   10076: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
                   10077: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.23      wiz      10078: <dt><span class="sect2"><a href="#checking-package-with-pkglint">A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span></a></span></dt>
1.1       dsieger  10079: </dl></dd>
                   10080: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
                   10081: </dl>
                   10082: </div>
                   10083: <p>We checked to find a piece of software that wasn't in the packages
                   10084:     collection, and picked GNU bison. Quite why someone would want to have
1.10      hubertf  10085:     <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.1       dsieger  10086:     present in the tree is beyond us, but it's useful for the purposes of
                   10087:     this exercise.</p>
1.41      asau     10088: <div class="sect1">
1.1       dsieger  10089: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10090: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.41      asau     10091: <div class="sect2">
1.1       dsieger  10092: <div class="titlepage"><div><div><h3 class="title">
                   10093: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
                   10094: <pre class="programlisting">
                   10095: # $NetBSD$
                   10096: #
                   10097: 
                   10098: DISTNAME=       bison-1.25
                   10099: CATEGORIES=     devel
                   10100: MASTER_SITES=   ${MASTER_SITE_GNU}
                   10101: 
1.29      dholland 10102: MAINTAINER=     pkgsrc-users@NetBSD.org
1.1       dsieger  10103: HOMEPAGE=       http://www.gnu.org/software/bison/bison.html
                   10104: COMMENT=        GNU yacc clone
                   10105: 
                   10106: GNU_CONFIGURE=  yes
1.46      wiz      10107: INFO_FILES=     yes
1.1       dsieger  10108: 
                   10109: .include "../../mk/bsd.pkg.mk"
                   10110: </pre>
                   10111: </div>
1.41      asau     10112: <div class="sect2">
1.1       dsieger  10113: <div class="titlepage"><div><div><h3 class="title">
                   10114: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
                   10115: <pre class="programlisting">
                   10116: GNU version of yacc.  Can make re-entrant parsers, and numerous other
1.167   ! leot     10117: improvements.  Why you would want this when Berkeley <a class="citerefentry" href="https://netbsd.gw.com/cgi-bin/man-cgi?yacc+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">yacc</span>(1)</span></a> is part
1.1       dsieger  10118: of the NetBSD source tree is beyond me.
                   10119: </pre>
                   10120: </div>
1.41      asau     10121: <div class="sect2">
1.1       dsieger  10122: <div class="titlepage"><div><div><h3 class="title">
                   10123: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
                   10124: <pre class="programlisting">
                   10125: @comment $NetBSD$
                   10126: bin/bison
                   10127: man/man1/bison.1.gz
                   10128: share/bison.simple
                   10129: share/bison.hairy
                   10130: </pre>
                   10131: </div>
1.41      asau     10132: <div class="sect2">
1.1       dsieger  10133: <div class="titlepage"><div><div><h3 class="title">
1.10      hubertf  10134: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span>
1.1       dsieger  10135: </h3></div></div></div>
                   10136: <p>The NetBSD package system comes with
1.137     leot     10137:         <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/pkgtools/pkglint/README.html" target="_top"><code class="filename">pkgtools/pkglint</code></a>
1.1       dsieger  10138:        which helps to check the contents of these
                   10139:        files. After installation it is quite easy to use, just change to the
                   10140:        directory of the package you wish to examine and execute
1.10      hubertf  10141:        <span class="command"><strong>pkglint</strong></span>:</p>
1.1       dsieger  10142: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
                   10143: looks fine.</pre>
                   10144: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.10      hubertf  10145:        more checks will be performed. Use e.g. <span class="command"><strong>pkglint -Call
1.1       dsieger  10146:        -Wall</strong></span> for a very thorough check.</p>
                   10147: </div>
                   10148: </div>
1.41      asau     10149: <div class="sect1">
1.1       dsieger  10150: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10151: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
                   10152: <p>Create the directory where the package lives,
                   10153:       plus any auxiliary directories:</p>
                   10154: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
                   10155: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
                   10156: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
                   10157: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
                   10158: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.154     rillig   10159:       <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.1       dsieger  10160:       then continue with fetching the distfile:</p>
                   10161: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
                   10162: &gt;&gt; bison-1.25.tar.gz doesn't seem to exist on this system.
                   10163: &gt;&gt; Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
                   10164: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   10165: ftp: Error retrieving file: 500 Internal error
                   10166: 
                   10167: &gt;&gt; Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
                   10168: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   10169: ftp: Error retrieving file: 500 Internal error
                   10170: 
                   10171: &gt;&gt; Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
                   10172: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   10173: Successfully retrieved file.</pre>
                   10174: <p>Generate the checksum of the distfile into
                   10175:       <code class="filename">distinfo</code>:</p>
                   10176: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
                   10177: <p>Now compile:</p>
                   10178: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
                   10179: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10180: ===&gt;  Extracting for bison-1.25
                   10181: ===&gt;  Patching for bison-1.25
                   10182: ===&gt;   Ignoring empty patch directory
                   10183: ===&gt;  Configuring for bison-1.25
                   10184: creating cache ./config.cache
                   10185: checking for gcc... cc
                   10186: checking whether we are using GNU C... yes
                   10187: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
                   10188: checking how to run the C preprocessor... cc -E
                   10189: checking for minix/config.h... no
                   10190: checking for POSIXized ISC... no
                   10191: checking whether cross-compiling... no
                   10192: checking for ANSI C header files... yes
                   10193: checking for string.h... yes
                   10194: checking for stdlib.h... yes
                   10195: checking for memory.h... yes
                   10196: checking for working const... yes
                   10197: checking for working alloca.h... no
                   10198: checking for alloca... yes
                   10199: checking for strerror... yes
                   10200: updating cache ./config.cache
                   10201: creating ./config.status
                   10202: creating Makefile
                   10203: ===&gt;  Building for bison-1.25
                   10204: 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
                   10205: 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
                   10206: 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
                   10207: 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
                   10208: 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
                   10209: 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
                   10210: 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
                   10211: 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
                   10212: 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
                   10213: 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
                   10214: 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
                   10215: 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
                   10216: 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
                   10217: 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
                   10218: 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
                   10219: 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
                   10220: 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
                   10221: 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
                   10222: 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
                   10223: 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
                   10224: 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
                   10225: 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
                   10226: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
                   10227: rm -f bison.s1
                   10228: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" &lt; ./bison.simple &gt; bison.s1</pre>
                   10229: <p>Everything seems OK, so install the files:</p>
                   10230: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   10231: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10232: ===&gt;  Installing for bison-1.25
                   10233: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share  /usr/pkg/info /usr/pkg/man/man1
                   10234: rm -f /usr/pkg/bin/bison
                   10235: cd /usr/pkg/share; rm -f bison.simple bison.hairy
                   10236: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
                   10237: install -c  -o bin -g bin -m 555 bison /usr/pkg/bin/bison
                   10238: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
                   10239: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
                   10240: cd .; for f in bison.info*;  do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
                   10241: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
                   10242: ===&gt;  Registering installation for bison-1.25</pre>
                   10243: <p>You can now use bison, and also - if you decide so - remove it with
1.10      hubertf  10244:       <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.1       dsieger  10245:       binary package, do this now:</p>
                   10246: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
                   10247: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10248: ===&gt;  Building package for bison-1.25
                   10249: Creating package bison-1.25.tgz
                   10250: Registering depends:.
                   10251: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
                   10252: <p>Now that you don't need the source and object files
                   10253:       any more, clean up:</p>
                   10254: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
                   10255: ===&gt;  Cleaning for bison-1.25</pre>
                   10256: </div>
                   10257: </div>
1.41      asau     10258: <div class="appendix">
                   10259: <div class="titlepage"><div><div><h1 class="title">
                   10260: <a name="logs"></a>Appendix B. Build logs</h1></div></div></div>
1.1       dsieger  10261: <div class="toc">
                   10262: <p><b>Table of Contents</b></p>
1.100     leot     10263: <dl class="toc">
1.1       dsieger  10264: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
                   10265: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
                   10266: </dl>
                   10267: </div>
1.41      asau     10268: <div class="sect1">
1.1       dsieger  10269: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10270: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
                   10271: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
                   10272: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10273: =&gt; figlet221.tar.gz doesn't seem to exist on this system.
                   10274: =&gt; Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
                   10275: =&gt; [172219 bytes]
                   10276: Connected to ftp.plig.net.
                   10277: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
                   10278: 331 Guest login ok, send your complete e-mail address as password.
                   10279: 230-You are user #5 of 500 simultaneous users allowed.
                   10280: 230-
                   10281: 230-  ___ _             _ _
                   10282: 230- |  _| |_ ___   ___| |_|___   ___ ___ ___
                   10283: 230- |  _|  _| . |_| . | | | . |_| . |  _| . |
                   10284: 230- |_| |_| |  _|_|  _|_|_|_  |_|___|_| |_  |
                   10285: 230-         |_|   |_|     |___|         |___|
                   10286: 230-
                   10287: 230-** Welcome to ftp.plig.org **
                   10288: 230-
                   10289: 230-Please note that all transfers from this FTP site are logged. If you
                   10290: 230-do not like this, please disconnect now.
                   10291: 230-
1.18      snj      10292: 230-This archive is available via
1.1       dsieger  10293: 230-
                   10294: 230-HTTP:  http://ftp.plig.org/
                   10295: 230-FTP:   ftp://ftp.plig.org/     (max 500 connections)
                   10296: 230-RSYNC: rsync://ftp.plig.org/   (max  30 connections)
                   10297: 230-
                   10298: 230-Please email comments, bug reports and requests for packages to be
                   10299: 230-mirrored to ftp-admin@plig.org.
                   10300: 230-
                   10301: 230-
                   10302: 230 Logged in anonymously.
                   10303: Remote system type is UNIX.
                   10304: Using binary mode to transfer files.
                   10305: 200 Type okay.
                   10306: 250 "/pub" is new cwd.
                   10307: 250-"/pub/figlet" is new cwd.
                   10308: 250-
                   10309: 250-Welcome to the figlet archive at ftp.figlet.org
                   10310: 250-
                   10311: 250-   ftp://ftp.figlet.org/pub/figlet/
                   10312: 250-
                   10313: 250-The official FIGlet web page is:
                   10314: 250-   http://www.figlet.org/
                   10315: 250-
                   10316: 250-If you have questions, please mailto:info@figlet.org. If you want to
                   10317: 250-contribute a font or something else, you can email us.
                   10318: 250
                   10319: 250 "/pub/figlet/program" is new cwd.
                   10320: 250 "/pub/figlet/program/unix" is new cwd.
                   10321: local: figlet221.tar.gz remote: figlet221.tar.gz
                   10322: 502 Unimplemented command.
                   10323: 227 Entering Passive Mode (195,40,6,41,246,104)
                   10324: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
                   10325: 38% |**************                       | 65800      64.16 KB/s    00:01 ETA
                   10326: 226 Transfer completed.
                   10327: 172219 bytes received in 00:02 (75.99 KB/s)
                   10328: 221 Goodbye.
                   10329: =&gt; Checksum OK for figlet221.tar.gz.
                   10330: ===&gt; Extracting for figlet-2.2.1nb2
                   10331: ===&gt; Required installed package ccache-[0-9]*: ccache-2.3nb1 found
                   10332: ===&gt; Patching for figlet-2.2.1nb2
                   10333: ===&gt; Applying pkgsrc patches for figlet-2.2.1nb2
                   10334: ===&gt; Overriding tools for figlet-2.2.1nb2
                   10335: ===&gt; Creating toolchain wrappers for figlet-2.2.1nb2
                   10336: ===&gt; Configuring for figlet-2.2.1nb2
                   10337: ===&gt; Building for figlet-2.2.1nb2
                   10338: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\"  -DDEFAULTFONTFILE=\"standard.flf\"  figlet.c zipio.c crc.c inflate.c -o figlet
                   10339: chmod a+x figlet
                   10340: gcc -O2 -o chkfont chkfont.c
                   10341: =&gt; Unwrapping files-to-be-installed.
                   10342: <code class="prompt">#</code>
                   10343: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   10344: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10345: ===&gt; Installing for figlet-2.2.1nb2
                   10346: install -d -o root -g wheel -m 755 /usr/pkg/bin
                   10347: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
                   10348: mkdir -p /usr/pkg/share/figlet
                   10349: cp figlet /usr/pkg/bin
                   10350: cp chkfont /usr/pkg/bin
                   10351: chmod 555 figlist showfigfonts
                   10352: cp figlist /usr/pkg/bin
                   10353: cp showfigfonts /usr/pkg/bin
                   10354: cp fonts/*.flf /usr/pkg/share/figlet
                   10355: cp fonts/*.flc /usr/pkg/share/figlet
                   10356: cp figlet.6 /usr/pkg/man/man6
                   10357: ===&gt; Registering installation for figlet-2.2.1nb2
                   10358: <code class="prompt">#</code></pre>
                   10359: </div>
1.41      asau     10360: <div class="sect1">
1.1       dsieger  10361: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10362: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
                   10363: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
                   10364: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10365: ===&gt; Packaging figlet-2.2.1nb2
                   10366: ===&gt; Building binary package for figlet-2.2.1nb2
                   10367: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
                   10368: Using SrcDir value of /usr/pkg
                   10369: Registering depends:.
                   10370: <code class="prompt">#</code></pre>
                   10371: </div>
                   10372: </div>
1.41      asau     10373: <div class="appendix">
                   10374: <div class="titlepage"><div><div><h1 class="title">
                   10375: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h1></div></div></div>
1.1       dsieger  10376: <div class="toc">
                   10377: <p><b>Table of Contents</b></p>
1.100     leot     10378: <dl class="toc">
1.23      wiz      10379: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
                   10380: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
                   10381: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
                   10382: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
                   10383: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
1.148     leot     10384: <code class="filename">stable</code>,
1.23      wiz      10385: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1       dsieger  10386: source packages</a></span></dt>
                   10387: </dl>
                   10388: </div>
                   10389: <p>As in other big projects, the directory layout of pkgsrc
                   10390:        is quite complex for newbies. This chapter explains where you
                   10391:        find things on the FTP server. The base directory on
1.10      hubertf  10392:        <code class="filename">ftp.NetBSD.org</code> is <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top"><code class="filename">/pub/pkgsrc/</code></a>.
1.1       dsieger  10393:        On other servers it may be different, but inside this directory,
                   10394:        everything should look the same, no matter on which server you
                   10395:        are. This directory contains some subdirectories, which are
                   10396:        explained below.</p>
1.41      asau     10397: <div class="sect1">
1.1       dsieger  10398: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22      jakllsch 10399: <a name="ftp-distfiles"></a>C.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
1.1       dsieger  10400: <p>The directory <code class="filename">distfiles</code> contains lots
                   10401:        of archive files from all pkgsrc packages, which are mirrored
                   10402:        here. The subdirectories are called after their package names
                   10403:        and are used when the distributed files have names that don't
                   10404:        explicitly contain a version number or are otherwise too generic
                   10405:        (for example <code class="filename">release.tar.gz</code>).</p>
                   10406: </div>
1.41      asau     10407: <div class="sect1">
1.1       dsieger  10408: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22      jakllsch 10409: <a name="ftp-misc"></a>C.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
1.1       dsieger  10410: <p>This directory contains things that individual pkgsrc
                   10411:        developers find worth publishing.</p>
                   10412: </div>
1.41      asau     10413: <div class="sect1">
1.1       dsieger  10414: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22      jakllsch 10415: <a name="ftp-packages"></a>C.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
1.3       rillig   10416: <p>This directory contains binary packages for the various
                   10417:        platforms that are supported by pkgsrc.
                   10418:        Each subdirectory is of the form <em class="replaceable"><code>OPSYS</code></em>/<em class="replaceable"><code>ARCH</code></em>/<em class="replaceable"><code>OSVERSION_TAG</code></em>. The meaning of these variables is:</p>
1.41      asau     10419: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      10420: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
1.9       rillig   10421:        operating system for which the packages have been built. The
1.10      hubertf  10422:        name is taken from the output of the <span class="command"><strong>uname</strong></span>
1.9       rillig   10423:        command, so it may differ from the one you are used to
                   10424:        hear.</p></li>
1.23      wiz      10425: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
1.8       rillig   10426:        architecture of the platform for which the packages have been
1.10      hubertf  10427:        built. It also includes the <code class="varname">ABI</code> (Application
                   10428:        Binary Interface) for platforms that have several of
                   10429:        them.</p></li>
1.23      wiz      10430: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
1.8       rillig   10431:        the operating system. For version numbers that change often (for
                   10432:        example NetBSD-current), the often-changing part should be
                   10433:        replaced with an <code class="literal">x</code>, for example
                   10434:        <code class="literal">4.99.x</code>.</p></li>
1.23      wiz      10435: <li class="listitem"><p><code class="varname">TAG</code> is either
1.22      jakllsch 10436:        <code class="literal">20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
1.8       rillig   10437:        for a stable branch, or <code class="literal">head</code> for packages
                   10438:        built from the HEAD branch. The latter should only be used when
                   10439:        the packages are updated on a regular basis. Otherwise the date
                   10440:        from checking out pkgsrc should be appended, for example
                   10441:        <code class="literal">head_20071015</code>.</p></li>
1.3       rillig   10442: </ul></div>
                   10443: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
                   10444:        can quickly click through the directories on the
                   10445:        server and find the best binary packages for their machines. Since they
                   10446:        usually know the operating system and the hardware architecture, OPSYS
                   10447:        and ARCH are placed first. After these choices, they can select the
                   10448:        best combination of OSVERSION and TAG together, since it is usually the
                   10449:        case that packages stay compatible between different version of the
                   10450:        operating system.</p>
                   10451: <p>In each of these directories, there is a
                   10452:        whole binary packages collection for a specific platform. It has a directory called
1.1       dsieger  10453:        <code class="filename">All</code> which contains all binary packages.
                   10454:        Besides that, there are various category directories that
                   10455:        contain symbolic links to the real binary packages.</p>
                   10456: </div>
1.41      asau     10457: <div class="sect1">
1.1       dsieger  10458: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22      jakllsch 10459: <a name="ftp-reports"></a>C.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.8       rillig   10460: <p>Here are the reports from bulk builds, for those who want
                   10461:        to fix packages that didn't build on some of the platforms. The
1.23      wiz      10462:        structure of subdirectories should look like the one in <a class="xref" href="#ftp-packages" title="C.3. packages: Binary packages">Section C.3, &#8220;<code class="filename">packages</code>: Binary packages&#8221;</a>.</p>
1.8       rillig   10463: </div>
1.41      asau     10464: <div class="sect1">
1.8       rillig   10465: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22      jakllsch 10466: <a name="ftp-source"></a>C.5. <code class="filename">current</code>,
1.148     leot     10467: <code class="filename">stable</code>,
1.22      jakllsch 10468: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1       dsieger  10469: source packages</h2></div></div></div>
1.23      wiz      10470: <p>These directories contain the <span class="quote">&#8220;<span class="quote">real</span>&#8221;</span> pkgsrc,
1.1       dsieger  10471:        that is the files that define how to create binary packages from
                   10472:        source archives.</p>
1.149     leot     10473: <p>Each of the <code class="filename">current</code>,
                   10474:        <code class="filename">stable</code> and
                   10475:        <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
                   10476:        directories share the same structure.  They each contain a
                   10477:        <code class="filename">pkgsrc</code> directory and
                   10478:        <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> file.</p>
1.1       dsieger  10479: <p>The directory <code class="filename">pkgsrc</code> contains a
                   10480:        snapshot of the CVS repository, which is updated regularly. The
1.149     leot     10481:        file <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> contains the same
                   10482:        as the directory, ready to be downloaded as a whole.</p>
                   10483: <p>The <code class="filename">current</code> directory contains files
                   10484:        related to the HEAD branch of the CVS repository.
                   10485:        In this directory there is an additional file called
                   10486:        <code class="filename">pkgsrc-readmes.tar.{bz,gz,xz}</code> that contains
                   10487:        all pkgsrc <code class="filename">README</code>s with information about
                   10488:        categories and packages.
                   10489:        </p>
                   10490: <p>The <code class="filename">stable</code> directory is a symlink to
                   10491:        the latest 
                   10492:        <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
                   10493:        </p>
                   10494: <p>The
                   10495:        <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
                   10496:        directories contain files related to the 
                   10497:        <code class="filename">-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
                   10498:        stable branch of the CVS repository. In these directories there is
                   10499:        an additional file called
                   10500:        <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em>.tar.{bz,gz,xz}</code>,
1.1       dsieger  10501:        which contains the state of pkgsrc when it was branched.</p>
                   10502: </div>
                   10503: </div>
1.41      asau     10504: <div class="appendix">
                   10505: <div class="titlepage"><div><div><h1 class="title">
1.154     rillig   10506: <a name="help-topics"></a>Appendix D. Help topics</h1></div></div></div>
                   10507: <p>
                   10508:        The following list contains all help topics that are available
                   10509:        when running <span class="command"><strong>bmake help topic=:index</strong></span>.
                   10510: </p>
1.156     leot     10511: <table border="0" summary="Simple list" class="simplelist">
                   10512: <tr>
                   10513: <td>#!</td>
                   10514: <td>-lintl</td>
                   10515: </tr>
                   10516: <tr>
                   10517: <td>64bit</td>
                   10518: <td>ABI</td>
                   10519: </tr>
                   10520: <tr>
                   10521: <td>ACCEPTABLE_LICENSES</td>
                   10522: <td>ACROREAD_FONTPATH</td>
                   10523: </tr>
                   10524: <tr>
                   10525: <td>ADDITIONAL</td>
                   10526: <td>AFAIK</td>
                   10527: </tr>
                   10528: <tr>
                   10529: <td>AIX</td>
                   10530: <td>ALLOW_VULNERABLE_PACKAGES</td>
                   10531: </tr>
                   10532: <tr>
                   10533: <td>ALL_ENV</td>
1.161     leot     10534: <td>ALSA_PC</td>
                   10535: </tr>
                   10536: <tr>
1.160     brook    10537: <td>ALTERNATIVES_SRC</td>
1.161     leot     10538: <td>AMANDA_TMP</td>
1.159     rillig   10539: </tr>
                   10540: <tr>
1.160     brook    10541: <td>AMANDA_USER</td>
1.161     leot     10542: <td>AMANDA_VAR</td>
1.156     leot     10543: </tr>
                   10544: <tr>
1.160     brook    10545: <td>APACHE_GROUP</td>
1.161     leot     10546: <td>APACHE_MODULE_NAME</td>
1.156     leot     10547: </tr>
                   10548: <tr>
1.160     brook    10549: <td>APACHE_MODULE_SRC</td>
1.161     leot     10550: <td>APACHE_MODULE_SRCDIR</td>
1.156     leot     10551: </tr>
                   10552: <tr>
1.160     brook    10553: <td>APACHE_PKG_PREFIX</td>
1.161     leot     10554: <td>APACHE_SUEXEC_CONFIGURE_ARGS</td>
1.156     leot     10555: </tr>
                   10556: <tr>
1.160     brook    10557: <td>APACHE_SUEXEC_DOCROOT</td>
1.161     leot     10558: <td>APACHE_USER</td>
1.156     leot     10559: </tr>
                   10560: <tr>
1.160     brook    10561: <td>APPEND_ABI</td>
1.161     leot     10562: <td>APPEND_ELF</td>
1.156     leot     10563: </tr>
                   10564: <tr>
1.160     brook    10565: <td>ARLA_CACHE</td>
1.161     leot     10566: <td>AUDIT_PACKAGES_FLAGS</td>
1.156     leot     10567: </tr>
                   10568: <tr>
1.160     brook    10569: <td>AUTOCONF_REQD</td>
1.161     leot     10570: <td>AUTOMAKE_OVERRIDE</td>
1.156     leot     10571: </tr>
                   10572: <tr>
1.160     brook    10573: <td>AUTOMAKE_REQD</td>
1.161     leot     10574: <td>AUTO_MKDIRS</td>
1.156     leot     10575: </tr>
                   10576: <tr>
1.160     brook    10577: <td>BDB185_DEFAULT</td>
1.161     leot     10578: <td>BDBBASE</td>
1.156     leot     10579: </tr>
                   10580: <tr>
1.160     brook    10581: <td>BDB_ACCEPTED</td>
1.161     leot     10582: <td>BDB_DEFAULT</td>
1.156     leot     10583: </tr>
                   10584: <tr>
1.160     brook    10585: <td>BDB_LIBS</td>
1.161     leot     10586: <td>BDB_TYPE</td>
1.156     leot     10587: </tr>
                   10588: <tr>
1.160     brook    10589: <td>BIND_DIR</td>
1.161     leot     10590: <td>BIND_GROUP</td>
1.156     leot     10591: </tr>
                   10592: <tr>
1.160     brook    10593: <td>BIND_USER</td>
1.161     leot     10594: <td>BINPKG_SITES</td>
1.156     leot     10595: </tr>
                   10596: <tr>
1.160     brook    10597: <td>BIN_INSTALL_FLAGS</td>
1.161     leot     10598: <td>BISON_PKGDATADIR</td>
                   10599: </tr>
                   10600: <tr>
                   10601: <td>BLAS_ACCEPTED</td>
                   10602: <td>BLAS_LIBS</td>
1.156     leot     10603: </tr>
                   10604: <tr>
1.161     leot     10605: <td>BLAS_TYPE</td>
1.156     leot     10606: <td>BOOTSTRAP_DEPENDS</td>
                   10607: </tr>
                   10608: <tr>
                   10609: <td>BOOTSTRAP_SETUPTOOLS</td>
                   10610: <td>BROKEN</td>
                   10611: </tr>
                   10612: <tr>
                   10613: <td>BROKEN_EXCEPT_ON_PLATFORM</td>
                   10614: <td>BROKEN_ON_PLATFORM</td>
                   10615: </tr>
                   10616: <tr>
                   10617: <td>BSDSRCDIR</td>
                   10618: <td>BSDXSRCDIR</td>
                   10619: </tr>
                   10620: <tr>
                   10621: <td>BSD_MAKE_ENV</td>
                   10622: <td>BUILDLINK_AUTO_DIRS</td>
                   10623: </tr>
                   10624: <tr>
                   10625: <td>BUILDLINK_AUTO_VARS</td>
                   10626: <td>BUILDLINK_CFLAGS</td>
                   10627: </tr>
                   10628: <tr>
                   10629: <td>BUILDLINK_CONTENTS_FILTER</td>
                   10630: <td>BUILDLINK_CPPFLAGS</td>
                   10631: </tr>
                   10632: <tr>
                   10633: <td>BUILDLINK_DEPMETHOD</td>
                   10634: <td>BUILDLINK_FILES</td>
                   10635: </tr>
                   10636: <tr>
                   10637: <td>BUILDLINK_FILES_CMD</td>
                   10638: <td>BUILDLINK_FNAME_TRANSFORM</td>
                   10639: </tr>
                   10640: <tr>
                   10641: <td>BUILDLINK_LDFLAGS</td>
                   10642: <td>BUILDLINK_LIBS</td>
                   10643: </tr>
                   10644: <tr>
                   10645: <td>BUILDLINK_OPSYS_SUPPORT_PTHREAD</td>
                   10646: <td>BUILDLINK_PKGNAME</td>
                   10647: </tr>
                   10648: <tr>
                   10649: <td>BUILDLINK_PREFIX</td>
                   10650: <td>BUILDLINK_RPATHDIRS</td>
                   10651: </tr>
                   10652: <tr>
                   10653: <td>BUILDLINK_TREE</td>
                   10654: <td>BUILD_DEFS</td>
                   10655: </tr>
                   10656: <tr>
                   10657: <td>BUILD_DEFS_EFFECTS</td>
                   10658: <td>BUILD_DEPENDS</td>
                   10659: </tr>
                   10660: <tr>
                   10661: <td>BUILD_DIRS</td>
                   10662: <td>BUILD_ENV_SHELL</td>
                   10663: </tr>
                   10664: <tr>
                   10665: <td>BUILD_MAKE_CMD</td>
                   10666: <td>BUILD_MAKE_FLAGS</td>
                   10667: </tr>
                   10668: <tr>
                   10669: <td>BUILD_TARGET</td>
                   10670: <td>BUILTIN_FIND_FILES</td>
                   10671: </tr>
                   10672: <tr>
                   10673: <td>BUILTIN_FIND_FILES_VAR</td>
                   10674: <td>BUILTIN_FIND_GREP</td>
                   10675: </tr>
                   10676: <tr>
                   10677: <td>BUILTIN_FIND_HEADERS</td>
                   10678: <td>BUILTIN_FIND_HEADERS_VAR</td>
                   10679: </tr>
                   10680: <tr>
                   10681: <td>BUILTIN_PKG</td>
                   10682: <td>BUILTIN_TEST_CURSES_DEFINES</td>
                   10683: </tr>
                   10684: <tr>
                   10685: <td>BUILTIN_TEST_CURSES_FUNCS</td>
                   10686: <td>BUILTIN_VERSION_SCRIPT</td>
                   10687: </tr>
                   10688: <tr>
                   10689: <td>BUILTIN_X11_TYPE</td>
                   10690: <td>BUILTIN_X11_VERSION</td>
                   10691: </tr>
                   10692: <tr>
                   10693: <td>CACTI_GROUP</td>
                   10694: <td>CACTI_USER</td>
                   10695: </tr>
                   10696: <tr>
                   10697: <td>CANNA_GROUP</td>
                   10698: <td>CANNA_USER</td>
                   10699: </tr>
                   10700: <tr>
                   10701: <td>CAT</td>
                   10702: <td>CCACHE_BASE</td>
                   10703: </tr>
                   10704: <tr>
                   10705: <td>CCACHE_DIR</td>
                   10706: <td>CCACHE_LOGFILE</td>
                   10707: </tr>
                   10708: <tr>
                   10709: <td>CC_VERSION</td>
                   10710: <td>CC_VERSION_STRING</td>
                   10711: </tr>
                   10712: <tr>
                   10713: <td>CDRECORD_CONF</td>
                   10714: <td>CDROM_PKG_URL_DIR</td>
                   10715: </tr>
                   10716: <tr>
                   10717: <td>CDROM_PKG_URL_HOST</td>
1.161     leot     10718: <td>CHECKOUT_DATE</td>
                   10719: </tr>
                   10720: <tr>
1.160     brook    10721: <td>CHECK_FAKEHOME</td>
1.161     leot     10722: <td>CHECK_FILES</td>
1.159     rillig   10723: </tr>
                   10724: <tr>
1.160     brook    10725: <td>CHECK_FILES_SKIP</td>
1.161     leot     10726: <td>CHECK_FILES_STRICT</td>
1.156     leot     10727: </tr>
                   10728: <tr>
1.160     brook    10729: <td>CHECK_HEADERS</td>
1.161     leot     10730: <td>CHECK_HEADERS_SKIP</td>
1.156     leot     10731: </tr>
                   10732: <tr>
1.160     brook    10733: <td>CHECK_INTERPRETER</td>
1.161     leot     10734: <td>CHECK_INTERPRETER_SKIP</td>
1.156     leot     10735: </tr>
                   10736: <tr>
1.160     brook    10737: <td>CHECK_PERMS</td>
1.161     leot     10738: <td>CHECK_PERMS_AUTOFIX</td>
1.156     leot     10739: </tr>
                   10740: <tr>
1.160     brook    10741: <td>CHECK_PERMS_SKIP</td>
1.161     leot     10742: <td>CHECK_PORTABILITY</td>
1.156     leot     10743: </tr>
                   10744: <tr>
1.160     brook    10745: <td>CHECK_PORTABILITY_SKIP</td>
1.161     leot     10746: <td>CHECK_RELRO</td>
1.156     leot     10747: </tr>
                   10748: <tr>
1.160     brook    10749: <td>CHECK_RELRO_SKIP</td>
1.161     leot     10750: <td>CHECK_RELRO_SUPPORTED</td>
1.156     leot     10751: </tr>
                   10752: <tr>
1.160     brook    10753: <td>CHECK_SHLIBS</td>
1.161     leot     10754: <td>CHECK_SHLIBS_BLACKLIST</td>
1.156     leot     10755: </tr>
                   10756: <tr>
1.160     brook    10757: <td>CHECK_SHLIBS_SKIP</td>
1.161     leot     10758: <td>CHECK_SHLIBS_SUPPORTED</td>
1.156     leot     10759: </tr>
                   10760: <tr>
1.160     brook    10761: <td>CHECK_SSP</td>
1.161     leot     10762: <td>CHECK_SSP_SKIP</td>
1.156     leot     10763: </tr>
                   10764: <tr>
1.160     brook    10765: <td>CHECK_SSP_SUPPORTED</td>
1.161     leot     10766: <td>CHECK_STRIPPED</td>
1.156     leot     10767: </tr>
                   10768: <tr>
1.160     brook    10769: <td>CHECK_STRIPPED_SKIP</td>
1.161     leot     10770: <td>CHECK_WRKREF</td>
1.156     leot     10771: </tr>
                   10772: <tr>
1.160     brook    10773: <td>CHECK_WRKREF_EXTRA_DIRS</td>
1.161     leot     10774: <td>CHECK_WRKREF_SKIP</td>
1.156     leot     10775: </tr>
                   10776: <tr>
1.160     brook    10777: <td>CLAMAV_DBDIR</td>
1.161     leot     10778: <td>CLAMAV_GROUP</td>
1.156     leot     10779: </tr>
                   10780: <tr>
1.160     brook    10781: <td>CLAMAV_USER</td>
1.161     leot     10782: <td>CLANGBASE</td>
1.156     leot     10783: </tr>
                   10784: <tr>
1.160     brook    10785: <td>CLEANDEPENDS</td>
1.161     leot     10786: <td>CMAKE_DEPENDENCIES_REWRITE</td>
1.156     leot     10787: </tr>
                   10788: <tr>
1.160     brook    10789: <td>CMAKE_INSTALL_PREFIX</td>
1.161     leot     10790: <td>CMAKE_MODULE_PATH_OVERRIDE</td>
1.156     leot     10791: </tr>
                   10792: <tr>
1.160     brook    10793: <td>CMAKE_PKGSRC_BUILD_FLAGS</td>
1.161     leot     10794: <td>CMAKE_PREFIX_PATH</td>
1.156     leot     10795: </tr>
                   10796: <tr>
                   10797: <td>CMAKE_USE_GNU_INSTALL_DIRS</td>
1.161     leot     10798: <td>COMMON_LISP_DOCFILES</td>
                   10799: </tr>
                   10800: <tr>
                   10801: <td>COMMON_LISP_EXAMPLES</td>
                   10802: <td>COMMON_LISP_EXTRAFILES</td>
                   10803: </tr>
                   10804: <tr>
                   10805: <td>COMMON_LISP_PACKAGES</td>
                   10806: <td>COMMON_LISP_SYSTEM</td>
1.156     leot     10807: </tr>
                   10808: <tr>
                   10809: <td>COMPILER_RPATH_FLAG</td>
                   10810: <td>COMPILER_USE_SYMLINKS</td>
                   10811: </tr>
                   10812: <tr>
                   10813: <td>CONFIGURE_ARGS</td>
                   10814: <td>CONFIGURE_DIRS</td>
                   10815: </tr>
                   10816: <tr>
                   10817: <td>CONFIGURE_ENV</td>
                   10818: <td>CONFIGURE_HAS_INFODIR</td>
                   10819: </tr>
                   10820: <tr>
                   10821: <td>CONFIGURE_HAS_MANDIR</td>
                   10822: <td>CONFIGURE_SCRIPT</td>
                   10823: </tr>
                   10824: <tr>
                   10825: <td>CONFIG_SHELL</td>
                   10826: <td>CONFIG_SHELL_FLAGS</td>
                   10827: </tr>
                   10828: <tr>
                   10829: <td>CONF_FILES</td>
                   10830: <td>CONF_FILES_MODE</td>
                   10831: </tr>
                   10832: <tr>
                   10833: <td>CONF_FILES_PERMS</td>
                   10834: <td>CONSERVER_DEFAULTHOST</td>
                   10835: </tr>
                   10836: <tr>
                   10837: <td>CONSERVER_DEFAULTPORT</td>
                   10838: <td>CP</td>
                   10839: </tr>
                   10840: <tr>
                   10841: <td>CPP</td>
                   10842: <td>CPP_PRECOMP_FLAGS</td>
                   10843: </tr>
                   10844: <tr>
                   10845: <td>CREATE_WRKDIR_SYMLINK</td>
                   10846: <td>CROSSBASE</td>
                   10847: </tr>
                   10848: <tr>
                   10849: <td>CTFCONVERT</td>
                   10850: <td>CTF_FILES_SKIP</td>
                   10851: </tr>
                   10852: <tr>
                   10853: <td>CTF_SUPPORTED</td>
                   10854: <td>CTYPE</td>
                   10855: </tr>
                   10856: <tr>
                   10857: <td>CUPS_GROUP</td>
                   10858: <td>CUPS_SYSTEM_GROUPS</td>
                   10859: </tr>
                   10860: <tr>
                   10861: <td>CUPS_USER</td>
                   10862: <td>CURSES_DEFAULT</td>
                   10863: </tr>
                   10864: <tr>
                   10865: <td>CURSES_TYPE</td>
1.161     leot     10866: <td>CVS_EXTRACTDIR</td>
                   10867: </tr>
                   10868: <tr>
                   10869: <td>CVS_MODULE</td>
                   10870: <td>CVS_PROJECT</td>
                   10871: </tr>
                   10872: <tr>
                   10873: <td>CVS_REPOSITORIES</td>
                   10874: <td>CVS_ROOT</td>
                   10875: </tr>
                   10876: <tr>
                   10877: <td>CVS_ROOT_GNU</td>
                   10878: <td>CVS_ROOT_NONGNU</td>
                   10879: </tr>
                   10880: <tr>
                   10881: <td>CVS_ROOT_SOURCEFORGE</td>
                   10882: <td>CVS_TAG</td>
                   10883: </tr>
                   10884: <tr>
1.160     brook    10885: <td>CXX</td>
1.161     leot     10886: <td>CYRUS_GROUP</td>
1.159     rillig   10887: </tr>
                   10888: <tr>
1.160     brook    10889: <td>CYRUS_IDLE</td>
1.161     leot     10890: <td>CYRUS_USER</td>
1.156     leot     10891: </tr>
                   10892: <tr>
1.160     brook    10893: <td>DAEMONTOOLS_GROUP</td>
1.161     leot     10894: <td>DAEMONTOOLS_LOG_USER</td>
1.156     leot     10895: </tr>
                   10896: <tr>
1.160     brook    10897: <td>DBUS_GROUP</td>
1.161     leot     10898: <td>DBUS_USER</td>
1.156     leot     10899: </tr>
                   10900: <tr>
1.160     brook    10901: <td>DEFANG_GROUP</td>
1.161     leot     10902: <td>DEFANG_USER</td>
1.156     leot     10903: </tr>
                   10904: <tr>
1.160     brook    10905: <td>DEFAULT_ACCEPTABLE_LICENSES</td>
1.161     leot     10906: <td>DEFAULT_DISTFILES</td>
1.156     leot     10907: </tr>
                   10908: <tr>
1.160     brook    10909: <td>DEFAULT_IRC_SERVER</td>
1.161     leot     10910: <td>DEFAULT_SERIAL_DEVICE</td>
1.156     leot     10911: </tr>
                   10912: <tr>
1.160     brook    10913: <td>DEF_UMASK</td>
1.161     leot     10914: <td>DEINSTALLDEPENDS</td>
1.156     leot     10915: </tr>
                   10916: <tr>
1.160     brook    10917: <td>DEINSTALL_SRC</td>
1.161     leot     10918: <td>DEINSTALL_TEMPLATES</td>
1.156     leot     10919: </tr>
                   10920: <tr>
1.160     brook    10921: <td>DELAYED_ERROR_MSG</td>
1.161     leot     10922: <td>DELAYED_WARNING_MSG</td>
1.156     leot     10923: </tr>
                   10924: <tr>
1.160     brook    10925: <td>DEPENDS</td>
1.161     leot     10926: <td>DEPENDS_TARGET</td>
1.156     leot     10927: </tr>
                   10928: <tr>
1.160     brook    10929: <td>DEPENDS_TYPE</td>
1.161     leot     10930: <td>DESTDIR</td>
1.156     leot     10931: </tr>
                   10932: <tr>
1.160     brook    10933: <td>DESTDIR_VARNAME</td>
1.161     leot     10934: <td>DIALER_GROUP</td>
1.156     leot     10935: </tr>
                   10936: <tr>
1.160     brook    10937: <td>DIGEST_REQD</td>
1.161     leot     10938: <td>DISTDIR</td>
1.156     leot     10939: </tr>
                   10940: <tr>
1.160     brook    10941: <td>DISTFILES</td>
1.161     leot     10942: <td>DISTINFO_FILE</td>
1.156     leot     10943: </tr>
                   10944: <tr>
1.160     brook    10945: <td>DISTNAME</td>
1.161     leot     10946: <td>DIST_PATH</td>
1.156     leot     10947: </tr>
                   10948: <tr>
1.160     brook    10949: <td>DIST_SUBDIR</td>
1.161     leot     10950: <td>DJBDNS_AXFR_USER</td>
1.156     leot     10951: </tr>
                   10952: <tr>
1.160     brook    10953: <td>DJBDNS_CACHE_USER</td>
1.161     leot     10954: <td>DJBDNS_DJBDNS_GROUP</td>
1.156     leot     10955: </tr>
                   10956: <tr>
1.160     brook    10957: <td>DJBDNS_LOG_USER</td>
1.161     leot     10958: <td>DJBDNS_RBL_USER</td>
1.156     leot     10959: </tr>
                   10960: <tr>
1.160     brook    10961: <td>DJBDNS_TINY_USER</td>
1.161     leot     10962: <td>DLOPEN_REQUIRE_PTHREADS</td>
1.156     leot     10963: </tr>
                   10964: <tr>
1.160     brook    10965: <td>DL_AUTO_VARS</td>
1.161     leot     10966: <td>DL_CFLAGS</td>
1.156     leot     10967: </tr>
                   10968: <tr>
1.160     brook    10969: <td>DL_LDFLAGS</td>
1.161     leot     10970: <td>DL_LIBS</td>
1.156     leot     10971: </tr>
                   10972: <tr>
1.160     brook    10973: <td>DNS</td>
1.161     leot     10974: <td>DOWNLOADED_DISTFILE</td>
1.156     leot     10975: </tr>
                   10976: <tr>
1.160     brook    10977: <td>DT_LAYOUT</td>
1.161     leot     10978: <td>DYNAMIC_SITES_CMD</td>
1.156     leot     10979: </tr>
                   10980: <tr>
1.160     brook    10981: <td>DYNAMIC_SITES_SCRIPT</td>
1.161     leot     10982: <td>ECHO</td>
1.156     leot     10983: </tr>
                   10984: <tr>
1.160     brook    10985: <td>ECHO_N</td>
1.161     leot     10986: <td>ELK_GUI</td>
1.156     leot     10987: </tr>
                   10988: <tr>
1.160     brook    10989: <td>EMACS_TYPE</td>
1.161     leot     10990: <td>EMULDIR</td>
1.156     leot     10991: </tr>
                   10992: <tr>
1.160     brook    10993: <td>EMULSUBDIR</td>
1.161     leot     10994: <td>EMULSUBDIRSLASH</td>
1.156     leot     10995: </tr>
                   10996: <tr>
1.160     brook    10997: <td>EMUL_ARCH</td>
1.161     leot     10998: <td>EMUL_DISTRO</td>
1.156     leot     10999: </tr>
                   11000: <tr>
1.160     brook    11001: <td>EMUL_EXEC_FMT</td>
1.161     leot     11002: <td>EMUL_IS_NATIVE</td>
1.156     leot     11003: </tr>
                   11004: <tr>
1.160     brook    11005: <td>EMUL_MODULES</td>
1.161     leot     11006: <td>EMUL_OPSYS</td>
1.156     leot     11007: </tr>
                   11008: <tr>
1.160     brook    11009: <td>EMUL_PKG_FMT</td>
1.161     leot     11010: <td>EMUL_PLATFORM</td>
1.156     leot     11011: </tr>
                   11012: <tr>
1.160     brook    11013: <td>EMUL_PLATFORMS</td>
1.161     leot     11014: <td>EMUL_PREFER</td>
1.156     leot     11015: </tr>
                   11016: <tr>
1.160     brook    11017: <td>EMUL_REQD</td>
1.161     leot     11018: <td>EMUL_TYPE</td>
1.156     leot     11019: </tr>
                   11020: <tr>
1.160     brook    11021: <td>ERROR_MSG</td>
1.161     leot     11022: <td>EXIM_GROUP</td>
1.156     leot     11023: </tr>
                   11024: <tr>
1.160     brook    11025: <td>EXIM_USER</td>
1.161     leot     11026: <td>EXPORT_SYMBOLS_LDFLAGS</td>
1.156     leot     11027: </tr>
                   11028: <tr>
1.160     brook    11029: <td>EXTRACTOR</td>
1.161     leot     11030: <td>EXTRACT_CMD</td>
1.156     leot     11031: </tr>
                   11032: <tr>
1.160     brook    11033: <td>EXTRACT_CMD_DEFAULT</td>
1.161     leot     11034: <td>EXTRACT_DIR</td>
1.156     leot     11035: </tr>
                   11036: <tr>
1.160     brook    11037: <td>EXTRACT_ELEMENTS</td>
1.161     leot     11038: <td>EXTRACT_ENV</td>
1.156     leot     11039: </tr>
                   11040: <tr>
1.160     brook    11041: <td>EXTRACT_ONLY</td>
1.161     leot     11042: <td>EXTRACT_OPTS</td>
1.156     leot     11043: </tr>
                   11044: <tr>
1.160     brook    11045: <td>EXTRACT_SUFX</td>
1.161     leot     11046: <td>EXTRACT_USING</td>
1.156     leot     11047: </tr>
                   11048: <tr>
1.160     brook    11049: <td>FAILOVER_FETCH</td>
1.161     leot     11050: <td>FAIL_MSG</td>
1.156     leot     11051: </tr>
                   11052: <tr>
1.160     brook    11053: <td>FAKE_NCURSES</td>
1.161     leot     11054: <td>FAM</td>
1.156     leot     11055: </tr>
                   11056: <tr>
1.160     brook    11057: <td>FAM_ACCEPTED</td>
1.161     leot     11058: <td>FAM_DEFAULT</td>
1.156     leot     11059: </tr>
                   11060: <tr>
1.160     brook    11061: <td>FAM_SERVER</td>
1.161     leot     11062: <td>FCPATH</td>
1.156     leot     11063: </tr>
                   11064: <tr>
1.160     brook    11065: <td>FEATURE_CPPFLAGS</td>
1.161     leot     11066: <td>FEATURE_LDFLAGS</td>
1.156     leot     11067: </tr>
                   11068: <tr>
1.160     brook    11069: <td>FEATURE_LIBS</td>
1.161     leot     11070: <td>FETCH_AFTER_ARGS</td>
1.156     leot     11071: </tr>
                   11072: <tr>
1.160     brook    11073: <td>FETCH_BEFORE_ARGS</td>
1.161     leot     11074: <td>FETCH_CMD</td>
1.156     leot     11075: </tr>
                   11076: <tr>
1.160     brook    11077: <td>FETCH_OUTPUT_ARGS</td>
1.161     leot     11078: <td>FETCH_PROXY</td>
1.156     leot     11079: </tr>
                   11080: <tr>
1.160     brook    11081: <td>FETCH_RESUME_ARGS</td>
1.161     leot     11082: <td>FETCH_USING</td>
1.156     leot     11083: </tr>
                   11084: <tr>
1.160     brook    11085: <td>FILES_SUBST</td>
1.161     leot     11086: <td>FILES_SUBST_SED</td>
1.156     leot     11087: </tr>
                   11088: <tr>
1.160     brook    11089: <td>FIX_SYSTEM_HEADERS</td>
1.161     leot     11090: <td>FLUXBOX_USE_GNOME</td>
1.156     leot     11091: </tr>
                   11092: <tr>
1.160     brook    11093: <td>FLUXBOX_USE_KDE</td>
1.161     leot     11094: <td>FLUXBOX_USE_XFT</td>
1.156     leot     11095: </tr>
                   11096: <tr>
                   11097: <td>FLUXBOX_USE_XINERAMA</td>
1.161     leot     11098: <td>FONTDIR</td>
1.156     leot     11099: </tr>
                   11100: <tr>
                   11101: <td>FONTS_DIRS</td>
                   11102: <td>FONTS_VERBOSE</td>
                   11103: </tr>
                   11104: <tr>
                   11105: <td>FOO_HACKS_MK</td>
1.161     leot     11106: <td>FOSSIL_EXTRACTDIR</td>
                   11107: </tr>
                   11108: <tr>
                   11109: <td>FOSSIL_REPO</td>
                   11110: <td>FOSSIL_REPOSITORIES</td>
                   11111: </tr>
                   11112: <tr>
                   11113: <td>FOSSIL_VERSION</td>
1.156     leot     11114: <td>FOX_USE_XUNICODE</td>
                   11115: </tr>
                   11116: <tr>
                   11117: <td>FREEWNN_GROUP</td>
                   11118: <td>FREEWNN_USER</td>
                   11119: </tr>
                   11120: <tr>
                   11121: <td>FTP_PKG_URL_DIR</td>
                   11122: <td>FTP_PKG_URL_HOST</td>
                   11123: </tr>
                   11124: <tr>
                   11125: <td>GAMEDATAMODE</td>
                   11126: <td>GAMEDATA_PERMS</td>
                   11127: </tr>
                   11128: <tr>
                   11129: <td>GAMEDIRMODE</td>
                   11130: <td>GAMEDIR_PERMS</td>
                   11131: </tr>
                   11132: <tr>
                   11133: <td>GAMEGRP</td>
                   11134: <td>GAMEMODE</td>
                   11135: </tr>
                   11136: <tr>
                   11137: <td>GAMEOWN</td>
                   11138: <td>GAMES_GROUP</td>
                   11139: </tr>
                   11140: <tr>
                   11141: <td>GAMES_USER</td>
                   11142: <td>GCC</td>
                   11143: </tr>
                   11144: <tr>
                   11145: <td>GCCBASE</td>
                   11146: <td>GCC_REQD</td>
                   11147: </tr>
                   11148: <tr>
                   11149: <td>GCC_VERSION_SUFFIX</td>
                   11150: <td>GEM_BUILD</td>
                   11151: </tr>
                   11152: <tr>
                   11153: <td>GEM_CLEANBUILD</td>
                   11154: <td>GEM_CLEANBUILD_EXTENSIONS</td>
                   11155: </tr>
                   11156: <tr>
                   11157: <td>GEM_DOCDIR</td>
                   11158: <td>GEM_EXTSDIR</td>
                   11159: </tr>
                   11160: <tr>
                   11161: <td>GEM_HOME</td>
                   11162: <td>GEM_LIBDIR</td>
                   11163: </tr>
                   11164: <tr>
                   11165: <td>GEM_NAME</td>
                   11166: <td>GEM_PATH</td>
                   11167: </tr>
                   11168: <tr>
                   11169: <td>GEM_SPECFILE</td>
                   11170: <td>GENERATE_PLIST</td>
                   11171: </tr>
                   11172: <tr>
                   11173: <td>GHOSTSCRIPT_REQD</td>
                   11174: <td>GITHUB_PROJECT</td>
                   11175: </tr>
                   11176: <tr>
                   11177: <td>GITHUB_RELEASE</td>
                   11178: <td>GITHUB_TAG</td>
                   11179: </tr>
                   11180: <tr>
                   11181: <td>GITHUB_TYPE</td>
1.161     leot     11182: <td>GIT_BRANCH</td>
                   11183: </tr>
                   11184: <tr>
                   11185: <td>GIT_ENV</td>
                   11186: <td>GIT_EXTRACTDIR</td>
                   11187: </tr>
                   11188: <tr>
                   11189: <td>GIT_REPO</td>
                   11190: <td>GIT_REPOSITORIES</td>
                   11191: </tr>
                   11192: <tr>
                   11193: <td>GIT_REVISION</td>
                   11194: <td>GIT_TAG</td>
                   11195: </tr>
                   11196: <tr>
1.160     brook    11197: <td>GNU</td>
1.161     leot     11198: <td>GNU_CONFIGURE</td>
1.159     rillig   11199: </tr>
                   11200: <tr>
1.160     brook    11201: <td>GNU_CONFIGURE_INFODIR</td>
1.161     leot     11202: <td>GNU_CONFIGURE_MANDIR</td>
1.156     leot     11203: </tr>
                   11204: <tr>
1.160     brook    11205: <td>GNU_CONFIGURE_STRICT</td>
1.161     leot     11206: <td>GODEP_REDIRECTS</td>
1.156     leot     11207: </tr>
                   11208: <tr>
1.160     brook    11209: <td>GO_BUILD_PATTERN</td>
1.161     leot     11210: <td>GO_DEPS</td>
1.156     leot     11211: </tr>
                   11212: <tr>
1.160     brook    11213: <td>GO_DIST_BASE</td>
1.161     leot     11214: <td>GO_SRCPATH</td>
1.156     leot     11215: </tr>
                   11216: <tr>
1.161     leot     11217: <td>GO_VERSION_DEFAULT</td>
1.160     brook    11218: <td>GROUP_SPECIFIC_PKGS</td>
1.156     leot     11219: </tr>
                   11220: <tr>
1.159     rillig   11221: <td>GRUB_NETWORK_CARDS</td>
1.160     brook    11222: <td>GRUB_PRESET_COMMAND</td>
1.156     leot     11223: </tr>
                   11224: <tr>
1.159     rillig   11225: <td>GRUB_SCAN_ARGS</td>
1.160     brook    11226: <td>GZIP</td>
1.156     leot     11227: </tr>
                   11228: <tr>
1.159     rillig   11229: <td>HASKELL_COMPILER</td>
1.160     brook    11230: <td>HASKELL_ENABLE_HADDOCK_DOCUMENTATION</td>
1.156     leot     11231: </tr>
                   11232: <tr>
1.159     rillig   11233: <td>HASKELL_ENABLE_LIBRARY_PROFILING</td>
1.160     brook    11234: <td>HASKELL_ENABLE_SHARED_LIBRARY</td>
1.156     leot     11235: </tr>
                   11236: <tr>
1.159     rillig   11237: <td>HAS_CONFIGURE</td>
1.156     leot     11238: <td>HEADER_TEMPLATES</td>
                   11239: </tr>
                   11240: <tr>
1.161     leot     11241: <td>HG_REPO</td>
                   11242: <td>HG_REPOSITORIES</td>
                   11243: </tr>
                   11244: <tr>
                   11245: <td>HG_TAG</td>
1.156     leot     11246: <td>HOST_PKGTOOLS_ARGS</td>
1.161     leot     11247: </tr>
                   11248: <tr>
1.156     leot     11249: <td>HOST_SPECIFIC_PKGS</td>
1.161     leot     11250: <td>HOWL_GROUP</td>
1.156     leot     11251: </tr>
                   11252: <tr>
                   11253: <td>HOWL_USER</td>
1.161     leot     11254: <td>ICCBASE</td>
1.156     leot     11255: </tr>
                   11256: <tr>
                   11257: <td>ICECAST_CHROOTDIR</td>
1.161     leot     11258: <td>ICON_THEMES</td>
1.156     leot     11259: </tr>
                   11260: <tr>
                   11261: <td>IDOBASE</td>
1.161     leot     11262: <td>IGNORE_CCACHE</td>
1.156     leot     11263: </tr>
                   11264: <tr>
                   11265: <td>IGNORE_INFO_DIRS</td>
1.161     leot     11266: <td>IGNORE_INTERACTIVE_FETCH</td>
1.156     leot     11267: </tr>
                   11268: <tr>
                   11269: <td>IMAKE</td>
1.161     leot     11270: <td>IMAKEOPTS</td>
1.156     leot     11271: </tr>
                   11272: <tr>
                   11273: <td>IMAKE_MAKE</td>
1.161     leot     11274: <td>IMAKE_MANINSTALL</td>
1.156     leot     11275: </tr>
                   11276: <tr>
                   11277: <td>IMAP_UW_CCLIENT_MBOX_FMT</td>
1.161     leot     11278: <td>IMDICTDIR</td>
1.156     leot     11279: </tr>
                   11280: <tr>
                   11281: <td>INCOMPAT_CURSES</td>
1.161     leot     11282: <td>INFO_DIR</td>
1.156     leot     11283: </tr>
                   11284: <tr>
                   11285: <td>INFO_FILES</td>
1.161     leot     11286: <td>INFO_FILES_VERBOSE</td>
1.156     leot     11287: </tr>
                   11288: <tr>
                   11289: <td>INFO_MSG</td>
1.161     leot     11290: <td>INIT_SYSTEM</td>
1.156     leot     11291: </tr>
                   11292: <tr>
                   11293: <td>INN_DATA_DIR</td>
1.161     leot     11294: <td>INN_GROUP</td>
1.156     leot     11295: </tr>
                   11296: <tr>
                   11297: <td>INN_USER</td>
1.161     leot     11298: <td>INSTALLATION_DIRS</td>
1.156     leot     11299: </tr>
                   11300: <tr>
                   11301: <td>INSTALLATION_DIRS_FROM_PLIST</td>
1.161     leot     11302: <td>INSTALL_ENV</td>
1.156     leot     11303: </tr>
                   11304: <tr>
                   11305: <td>INSTALL_SH_OVERRIDE</td>
1.161     leot     11306: <td>INSTALL_SRC</td>
1.156     leot     11307: </tr>
                   11308: <tr>
                   11309: <td>INSTALL_TEMPLATES</td>
1.161     leot     11310: <td>INSTALL_UNSTRIPPED</td>
1.156     leot     11311: </tr>
                   11312: <tr>
                   11313: <td>IRCD_HYBRID_IRC_GROUP</td>
1.161     leot     11314: <td>IRCD_HYBRID_IRC_USER</td>
1.156     leot     11315: </tr>
                   11316: <tr>
                   11317: <td>IRCD_HYBRID_MAXCONN</td>
1.161     leot     11318: <td>IRCD_HYBRID_NICLEN</td>
1.156     leot     11319: </tr>
                   11320: <tr>
                   11321: <td>IRCD_HYBRID_SYSLOG_EVENTS</td>
1.161     leot     11322: <td>IRCD_HYBRID_SYSLOG_FACILITY</td>
1.156     leot     11323: </tr>
                   11324: <tr>
                   11325: <td>IRCD_HYBRID_TOPICLEN</td>
1.161     leot     11326: <td>IRIX</td>
1.156     leot     11327: </tr>
                   11328: <tr>
                   11329: <td>IRRD_USE_PGP</td>
1.161     leot     11330: <td>JABBERD_GROUP</td>
1.156     leot     11331: </tr>
                   11332: <tr>
                   11333: <td>JABBERD_LOGDIR</td>
1.161     leot     11334: <td>JABBERD_PIDDIR</td>
1.156     leot     11335: </tr>
                   11336: <tr>
                   11337: <td>JABBERD_SPOOLDIR</td>
1.161     leot     11338: <td>JABBERD_USER</td>
1.156     leot     11339: </tr>
                   11340: <tr>
                   11341: <td>JAKARTA_HOME</td>
1.161     leot     11342: <td>JAVA_APP_PATH</td>
1.156     leot     11343: </tr>
                   11344: <tr>
1.161     leot     11345: <td>JAVA_APP_TARGETS</td>
1.156     leot     11346: <td>JAVA_BINPREFIX</td>
1.161     leot     11347: </tr>
                   11348: <tr>
1.156     leot     11349: <td>JAVA_CLASSPATH</td>
1.161     leot     11350: <td>JAVA_HOME</td>
1.156     leot     11351: </tr>
                   11352: <tr>
                   11353: <td>JAVA_LD_LIBRARY_PATH</td>
1.161     leot     11354: <td>JAVA_NAME</td>
1.156     leot     11355: </tr>
                   11356: <tr>
                   11357: <td>JAVA_UNLIMIT</td>
1.161     leot     11358: <td>JAVA_WRAPPERS</td>
1.156     leot     11359: </tr>
                   11360: <tr>
                   11361: <td>JPEG_ACCEPTED</td>
1.161     leot     11362: <td>JPEG_DEFAULT</td>
1.156     leot     11363: </tr>
                   11364: <tr>
                   11365: <td>KERBEROS</td>
1.161     leot     11366: <td>KERMIT_SUID_UUCP</td>
1.156     leot     11367: </tr>
                   11368: <tr>
                   11369: <td>KJS_USE_PCRE</td>
1.161     leot     11370: <td>KNEWS_DOMAIN_FILE</td>
1.156     leot     11371: </tr>
                   11372: <tr>
                   11373: <td>KNEWS_DOMAIN_NAME</td>
1.161     leot     11374: <td>KRB5_ACCEPTED</td>
1.156     leot     11375: </tr>
                   11376: <tr>
                   11377: <td>KRB5_DEFAULT</td>
1.161     leot     11378: <td>LANGUAGES</td>
1.156     leot     11379: </tr>
                   11380: <tr>
1.161     leot     11381: <td>LAPACK_LIBS</td>
1.160     brook    11382: <td>LATEX2HTML_ICONPATH</td>
1.156     leot     11383: </tr>
                   11384: <tr>
                   11385: <td>LDCONFIG_ADD_CMD</td>
1.160     brook    11386: <td>LDCONFIG_REMOVE_CMD</td>
1.156     leot     11387: </tr>
                   11388: <tr>
                   11389: <td>LEAFNODE_DATA_DIR</td>
1.160     brook    11390: <td>LEAFNODE_GROUP</td>
1.156     leot     11391: </tr>
                   11392: <tr>
                   11393: <td>LEAFNODE_USER</td>
1.160     brook    11394: <td>LIBDVDCSS_HOMEPAGE</td>
1.156     leot     11395: </tr>
                   11396: <tr>
                   11397: <td>LIBDVDCSS_MASTER_SITES</td>
1.160     brook    11398: <td>LIBRSVG_TYPE</td>
1.157     leot     11399: </tr>
                   11400: <tr>
1.156     leot     11401: <td>LIBTOOL</td>
1.160     brook    11402: <td>LIBTOOLIZE_PLIST</td>
1.156     leot     11403: </tr>
                   11404: <tr>
                   11405: <td>LIBTOOL_M4_OVERRIDE</td>
1.160     brook    11406: <td>LIBUSB_TYPE</td>
1.156     leot     11407: </tr>
                   11408: <tr>
                   11409: <td>LICENSE</td>
1.160     brook    11410: <td>LINKER_RPATH_FLAG</td>
1.156     leot     11411: </tr>
                   11412: <tr>
                   11413: <td>LINK_RPATH_FLAG</td>
1.161     leot     11414: <td>LINUX_BASE_NODEPS</td>
                   11415: </tr>
                   11416: <tr>
                   11417: <td>LINUX_BASE_PREFERRED</td>
                   11418: <td>LINUX_BASE_REQUIRED</td>
                   11419: </tr>
                   11420: <tr>
1.159     rillig   11421: <td>LINUX_LOCALES</td>
1.161     leot     11422: <td>LOCALBASE</td>
1.156     leot     11423: </tr>
                   11424: <tr>
1.158     brook    11425: <td>LOCALBASE_LOCKTYPE</td>
1.161     leot     11426: <td>LOCALPATCHES</td>
1.156     leot     11427: </tr>
                   11428: <tr>
1.158     brook    11429: <td>LOVE_DATA</td>
1.161     leot     11430: <td>LOVE_GAME</td>
1.156     leot     11431: </tr>
                   11432: <tr>
1.158     brook    11433: <td>LOVE_VERSION</td>
1.161     leot     11434: <td>LP64PLATFORMS</td>
1.156     leot     11435: </tr>
                   11436: <tr>
1.158     brook    11437: <td>MACHINE_PLATFORM</td>
1.161     leot     11438: <td>MAILAGENT_DOMAIN</td>
1.156     leot     11439: </tr>
                   11440: <tr>
1.158     brook    11441: <td>MAILAGENT_EMAIL</td>
1.161     leot     11442: <td>MAILAGENT_FQDN</td>
1.156     leot     11443: </tr>
                   11444: <tr>
1.158     brook    11445: <td>MAILAGENT_ORGANIZATION</td>
1.161     leot     11446: <td>MAJORDOMO_HOMEDIR</td>
1.156     leot     11447: </tr>
                   11448: <tr>
1.161     leot     11449: <td>MAJOR_OS_VERSION</td>
1.160     brook    11450: <td>MAKEINFO_ARGS</td>
1.159     rillig   11451: </tr>
                   11452: <tr>
                   11453: <td>MAKE_DIRS</td>
1.160     brook    11454: <td>MAKE_DIRS_PERMS</td>
1.156     leot     11455: </tr>
                   11456: <tr>
1.159     rillig   11457: <td>MAKE_ENV</td>
1.160     brook    11458: <td>MAKE_FILE</td>
1.156     leot     11459: </tr>
                   11460: <tr>
1.159     rillig   11461: <td>MAKE_FLAGS</td>
1.160     brook    11462: <td>MAKE_JOBS</td>
1.156     leot     11463: </tr>
                   11464: <tr>
1.159     rillig   11465: <td>MAKE_JOBS_SAFE</td>
1.160     brook    11466: <td>MAKE_PROGRAM</td>
1.156     leot     11467: </tr>
                   11468: <tr>
1.159     rillig   11469: <td>MANINSTALL</td>
1.160     brook    11470: <td>MANZ</td>
1.156     leot     11471: </tr>
                   11472: <tr>
1.159     rillig   11473: <td>MASTER_SITES</td>
1.160     brook    11474: <td>MASTER_SITE_BACKUP</td>
1.156     leot     11475: </tr>
                   11476: <tr>
1.159     rillig   11477: <td>MASTER_SITE_CYGWIN</td>
1.160     brook    11478: <td>MASTER_SITE_GNOME</td>
1.156     leot     11479: </tr>
                   11480: <tr>
1.159     rillig   11481: <td>MASTER_SITE_GNU</td>
1.160     brook    11482: <td>MASTER_SITE_LOCAL</td>
1.156     leot     11483: </tr>
                   11484: <tr>
1.159     rillig   11485: <td>MASTER_SITE_MOZILLA</td>
1.160     brook    11486: <td>MASTER_SITE_OPENOFFICE</td>
1.156     leot     11487: </tr>
                   11488: <tr>
1.159     rillig   11489: <td>MASTER_SITE_OVERRIDE</td>
1.160     brook    11490: <td>MASTER_SITE_PERL_CPAN</td>
1.156     leot     11491: </tr>
                   11492: <tr>
1.159     rillig   11493: <td>MASTER_SITE_SUNSITE</td>
1.160     brook    11494: <td>MASTER_SITE_SUSE</td>
1.156     leot     11495: </tr>
                   11496: <tr>
1.159     rillig   11497: <td>MASTER_SITE_TEX_CTAN</td>
1.160     brook    11498: <td>MASTER_SITE_XCONTRIB</td>
1.156     leot     11499: </tr>
                   11500: <tr>
1.159     rillig   11501: <td>MASTER_SITE_XEMACS</td>
1.160     brook    11502: <td>MASTER_SORT</td>
1.156     leot     11503: </tr>
                   11504: <tr>
1.159     rillig   11505: <td>MASTER_SORT_RANDOM</td>
1.160     brook    11506: <td>MASTER_SORT_REGEX</td>
1.156     leot     11507: </tr>
                   11508: <tr>
1.159     rillig   11509: <td>MECAB_CHARSET</td>
1.160     brook    11510: <td>MEDIATOMB_GROUP</td>
1.156     leot     11511: </tr>
                   11512: <tr>
1.159     rillig   11513: <td>MEDIATOMB_USER</td>
1.160     brook    11514: <td>MIPSPROBASE</td>
1.156     leot     11515: </tr>
                   11516: <tr>
1.159     rillig   11517: <td>MIREDO_GROUP</td>
1.160     brook    11518: <td>MIREDO_USER</td>
1.156     leot     11519: </tr>
                   11520: <tr>
1.159     rillig   11521: <td>MISSING_FEATURES</td>
1.160     brook    11522: <td>MKDIR</td>
1.156     leot     11523: </tr>
                   11524: <tr>
1.159     rillig   11525: <td>MLDONKEY_GROUP</td>
1.160     brook    11526: <td>MLDONKEY_HOME</td>
1.156     leot     11527: </tr>
                   11528: <tr>
1.159     rillig   11529: <td>MLDONKEY_USER</td>
1.160     brook    11530: <td>MONOTONE_GROUP</td>
1.156     leot     11531: </tr>
                   11532: <tr>
1.159     rillig   11533: <td>MONOTONE_USER</td>
1.160     brook    11534: <td>MOTIFBASE</td>
1.156     leot     11535: </tr>
                   11536: <tr>
1.159     rillig   11537: <td>MOTIF_TYPE</td>
1.160     brook    11538: <td>MOTIF_TYPE_DEFAULT</td>
1.156     leot     11539: </tr>
                   11540: <tr>
1.159     rillig   11541: <td>MPI_TYPE</td>
1.160     brook    11542: <td>MSGFMT_STRIP_MSGCTXT</td>
1.156     leot     11543: </tr>
                   11544: <tr>
1.159     rillig   11545: <td>MSGFMT_STRIP_MSGID_PLURAL</td>
1.160     brook    11546: <td>MTOOLS_ENABLE_FLOPPYD</td>
1.156     leot     11547: </tr>
                   11548: <tr>
1.159     rillig   11549: <td>MUST</td>
1.160     brook    11550: <td>MV</td>
1.156     leot     11551: </tr>
                   11552: <tr>
1.159     rillig   11553: <td>MYSQL_CHARSET</td>
1.160     brook    11554: <td>MYSQL_DATADIR</td>
1.156     leot     11555: </tr>
                   11556: <tr>
1.159     rillig   11557: <td>MYSQL_EXTRA_CHARSET</td>
1.160     brook    11558: <td>MYSQL_GROUP</td>
1.156     leot     11559: </tr>
                   11560: <tr>
1.159     rillig   11561: <td>MYSQL_PKGSRCDIR</td>
1.160     brook    11562: <td>MYSQL_USER</td>
1.156     leot     11563: </tr>
                   11564: <tr>
1.159     rillig   11565: <td>MYSQL_VERSIONS_ACCEPTED</td>
1.160     brook    11566: <td>MYSQL_VERSION_DEFAULT</td>
1.156     leot     11567: </tr>
                   11568: <tr>
1.159     rillig   11569: <td>NAGIOSCMD_GROUP</td>
1.160     brook    11570: <td>NAGIOSDIR</td>
1.156     leot     11571: </tr>
                   11572: <tr>
1.159     rillig   11573: <td>NAGIOS_GROUP</td>
1.160     brook    11574: <td>NAGIOS_USER</td>
1.156     leot     11575: </tr>
                   11576: <tr>
1.159     rillig   11577: <td>NATIVE_APPEND_ABI</td>
1.160     brook    11578: <td>NATIVE_APPEND_ELF</td>
1.156     leot     11579: </tr>
                   11580: <tr>
1.159     rillig   11581: <td>NATIVE_EXEC_FMT</td>
1.160     brook    11582: <td>NATIVE_MACHINE_PLATFORM</td>
1.156     leot     11583: </tr>
                   11584: <tr>
1.159     rillig   11585: <td>NATIVE_OBJECT_FMT</td>
1.160     brook    11586: <td>NBPAX_PROGRAM_PREFIX</td>
1.156     leot     11587: </tr>
                   11588: <tr>
1.159     rillig   11589: <td>NETBSD_LOGIN_NAME</td>
1.160     brook    11590: <td>NMH_EDITOR</td>
1.156     leot     11591: </tr>
                   11592: <tr>
1.159     rillig   11593: <td>NMH_MTA</td>
1.160     brook    11594: <td>NMH_PAGER</td>
1.156     leot     11595: </tr>
                   11596: <tr>
1.159     rillig   11597: <td>NOLOGIN</td>
1.160     brook    11598: <td>NONZERO_FILESIZE_P</td>
1.156     leot     11599: </tr>
                   11600: <tr>
1.159     rillig   11601: <td>NOTE</td>
1.160     brook    11602: <td>NOT_FOR_PLATFORM</td>
1.156     leot     11603: </tr>
                   11604: <tr>
1.159     rillig   11605: <td>NOT_PAX_ASLR_SAFE</td>
1.160     brook    11606: <td>NOT_PAX_MPROTECT_SAFE</td>
1.156     leot     11607: </tr>
                   11608: <tr>
1.159     rillig   11609: <td>NO_BUILD</td>
1.160     brook    11610: <td>NO_CHECKSUM</td>
1.156     leot     11611: </tr>
                   11612: <tr>
1.159     rillig   11613: <td>NO_CONFIGURE</td>
1.160     brook    11614: <td>NO_SKIP</td>
1.156     leot     11615: </tr>
                   11616: <tr>
1.159     rillig   11617: <td>NS_PREFERRED</td>
1.160     brook    11618: <td>NULLMAILER_GROUP</td>
1.156     leot     11619: </tr>
                   11620: <tr>
1.159     rillig   11621: <td>NULLMAILER_USER</td>
1.160     brook    11622: <td>OASIS</td>
1.156     leot     11623: </tr>
                   11624: <tr>
1.159     rillig   11625: <td>OASIS_BUILD_ARGS</td>
1.160     brook    11626: <td>OBJHOSTNAME</td>
1.156     leot     11627: </tr>
                   11628: <tr>
1.159     rillig   11629: <td>OBJMACHINE</td>
1.160     brook    11630: <td>OCAML_FINDLIB_DIRS</td>
1.156     leot     11631: </tr>
                   11632: <tr>
1.159     rillig   11633: <td>OCAML_FINDLIB_REGISTER</td>
1.160     brook    11634: <td>OCAML_FINDLIB_REGISTER_VERBOSE</td>
1.156     leot     11635: </tr>
                   11636: <tr>
1.159     rillig   11637: <td>OCAML_SITELIBDIR</td>
1.160     brook    11638: <td>OCAML_TOPKG_DOCDIR</td>
1.156     leot     11639: </tr>
                   11640: <tr>
1.159     rillig   11641: <td>OCAML_USE_DUNE</td>
1.160     brook    11642: <td>OCAML_USE_FINDLIB</td>
1.156     leot     11643: </tr>
                   11644: <tr>
1.159     rillig   11645: <td>OCAML_USE_JBUILDER</td>
1.160     brook    11646: <td>OCAML_USE_OASIS</td>
1.156     leot     11647: </tr>
                   11648: <tr>
1.159     rillig   11649: <td>OCAML_USE_OASIS_DYNRUN</td>
1.160     brook    11650: <td>OCAML_USE_OPAM</td>
1.156     leot     11651: </tr>
                   11652: <tr>
1.159     rillig   11653: <td>OCAML_USE_OPT_COMPILER</td>
1.160     brook    11654: <td>OCAML_USE_TOPKG</td>
1.156     leot     11655: </tr>
                   11656: <tr>
1.159     rillig   11657: <td>OMF</td>
1.160     brook    11658: <td>ONLY_FOR_COMPILER</td>
1.156     leot     11659: </tr>
                   11660: <tr>
1.159     rillig   11661: <td>ONLY_FOR_PLATFORM</td>
1.160     brook    11662: <td>OPENSSH_CHROOT</td>
1.156     leot     11663: </tr>
                   11664: <tr>
1.159     rillig   11665: <td>OPENSSH_GROUP</td>
1.160     brook    11666: <td>OPENSSH_USER</td>
1.156     leot     11667: </tr>
                   11668: <tr>
1.159     rillig   11669: <td>OPSYS</td>
1.160     brook    11670: <td>OPSYS_EMULDIR</td>
1.156     leot     11671: </tr>
                   11672: <tr>
1.159     rillig   11673: <td>OSS_TYPE</td>
1.160     brook    11674: <td>OSX</td>
1.156     leot     11675: </tr>
                   11676: <tr>
1.159     rillig   11677: <td>OSX_TOLERATE_SDK_SKEW</td>
1.161     leot     11678: <td>OS_HAVE_ALSA</td>
                   11679: </tr>
                   11680: <tr>
                   11681: <td>OS_HAVE_RCD</td>
1.160     brook    11682: <td>OS_VARIANT</td>
1.159     rillig   11683: </tr>
                   11684: <tr>
                   11685: <td>OS_VERSION</td>
1.160     brook    11686: <td>OTF_FONTS_DIR</td>
1.156     leot     11687: </tr>
                   11688: <tr>
1.159     rillig   11689: <td>OVERRIDE_DIRDEPTH</td>
1.160     brook    11690: <td>OVERRIDE_GEMSPEC</td>
1.156     leot     11691: </tr>
                   11692: <tr>
1.159     rillig   11693: <td>OVERRIDE_GNU_CONFIG_SCRIPTS</td>
1.161     leot     11694: <td>OVERRIDE_ROCKSPEC</td>
                   11695: </tr>
                   11696: <tr>
1.158     brook    11697: <td>OWN_DIRS</td>
1.161     leot     11698: <td>OWN_DIRS_PERMS</td>
1.156     leot     11699: </tr>
                   11700: <tr>
1.158     brook    11701: <td>P4GROUP</td>
1.161     leot     11702: <td>P4PORT</td>
1.156     leot     11703: </tr>
                   11704: <tr>
1.158     brook    11705: <td>P4ROOT</td>
1.161     leot     11706: <td>P4USER</td>
1.156     leot     11707: </tr>
                   11708: <tr>
1.158     brook    11709: <td>PACKAGES</td>
1.161     leot     11710: <td>PALMOS_DEFAULT_SDK</td>
1.156     leot     11711: </tr>
                   11712: <tr>
1.158     brook    11713: <td>PAMBASE</td>
1.161     leot     11714: <td>PAM_DEFAULT</td>
1.156     leot     11715: </tr>
                   11716: <tr>
1.158     brook    11717: <td>PAPERSIZE</td>
1.161     leot     11718: <td>PASSIVE_FETCH</td>
1.156     leot     11719: </tr>
                   11720: <tr>
1.158     brook    11721: <td>PATCHDIR</td>
1.161     leot     11722: <td>PATCHFILES</td>
1.156     leot     11723: </tr>
                   11724: <tr>
1.158     brook    11725: <td>PATCH_ARGS</td>
1.161     leot     11726: <td>PATCH_DEBUG</td>
1.156     leot     11727: </tr>
                   11728: <tr>
1.158     brook    11729: <td>PATCH_DIST_ARGS</td>
1.161     leot     11730: <td>PATCH_DIST_CAT</td>
1.156     leot     11731: </tr>
                   11732: <tr>
1.158     brook    11733: <td>PATCH_DIST_STRIP</td>
1.161     leot     11734: <td>PATCH_FUZZ_FACTOR</td>
1.156     leot     11735: </tr>
                   11736: <tr>
1.158     brook    11737: <td>PATCH_STRIP</td>
1.161     leot     11738: <td>PATH</td>
1.156     leot     11739: </tr>
                   11740: <tr>
                   11741: <td>PCCBASE</td>
1.161     leot     11742: <td>PEAR</td>
1.156     leot     11743: </tr>
                   11744: <tr>
1.161     leot     11745: <td>PEAR_CHANNEL</td>
                   11746: <td>PEAR_CHANNEL_ALIAS</td>
                   11747: </tr>
                   11748: <tr>
                   11749: <td>PEAR_CHANNEL_VERSION</td>
1.157     leot     11750: <td>PEAR_CMD</td>
1.161     leot     11751: </tr>
                   11752: <tr>
1.158     brook    11753: <td>PEAR_LIB</td>
1.161     leot     11754: <td>PEAR_PACKAGE_XML</td>
1.156     leot     11755: </tr>
                   11756: <tr>
1.158     brook    11757: <td>PERL5</td>
1.161     leot     11758: <td>PERL5_CONFIGURE</td>
1.156     leot     11759: </tr>
                   11760: <tr>
1.158     brook    11761: <td>PERL5_CONFIGURE_DIRS</td>
1.161     leot     11762: <td>PERL5_LDFLAGS</td>
1.156     leot     11763: </tr>
                   11764: <tr>
1.158     brook    11765: <td>PERL5_LICENSE</td>
1.161     leot     11766: <td>PERL5_MODULE_TYPE</td>
1.156     leot     11767: </tr>
                   11768: <tr>
1.158     brook    11769: <td>PERL5_PACKLIST</td>
1.161     leot     11770: <td>PERL5_PACKLIST_DIR</td>
1.156     leot     11771: </tr>
                   11772: <tr>
1.158     brook    11773: <td>PERL5_PERLBASE</td>
1.161     leot     11774: <td>PERL5_SITEBASE</td>
1.156     leot     11775: </tr>
                   11776: <tr>
1.158     brook    11777: <td>PERL5_USE_PACKLIST</td>
1.161     leot     11778: <td>PERL5_VENDORBASE</td>
1.156     leot     11779: </tr>
                   11780: <tr>
1.158     brook    11781: <td>PFCTL</td>
1.161     leot     11782: <td>PFVAR_H</td>
1.156     leot     11783: </tr>
                   11784: <tr>
1.158     brook    11785: <td>PF_VERSION</td>
1.161     leot     11786: <td>PGGROUP</td>
1.156     leot     11787: </tr>
                   11788: <tr>
1.158     brook    11789: <td>PGHOME</td>
1.161     leot     11790: <td>PGPKGSRCDIR</td>
1.156     leot     11791: </tr>
                   11792: <tr>
1.158     brook    11793: <td>PGSQL_TYPE</td>
1.161     leot     11794: <td>PGSQL_VERSIONS_ACCEPTED</td>
1.156     leot     11795: </tr>
                   11796: <tr>
1.158     brook    11797: <td>PGSQL_VERSION_DEFAULT</td>
1.161     leot     11798: <td>PGUSER</td>
1.156     leot     11799: </tr>
                   11800: <tr>
1.158     brook    11801: <td>PG_LIB_EXT</td>
1.161     leot     11802: <td>PHP</td>
1.156     leot     11803: </tr>
                   11804: <tr>
1.158     brook    11805: <td>PHPCOMMON_MK</td>
1.161     leot     11806: <td>PHPPKGSRCDIR</td>
1.156     leot     11807: </tr>
                   11808: <tr>
1.158     brook    11809: <td>PHP_BASE_VERS</td>
1.161     leot     11810: <td>PHP_CHECK_INSTALLED</td>
1.156     leot     11811: </tr>
                   11812: <tr>
1.158     brook    11813: <td>PHP_EXTENSION_DIR</td>
1.161     leot     11814: <td>PHP_INITIAL_TEENY</td>
1.156     leot     11815: </tr>
                   11816: <tr>
1.158     brook    11817: <td>PHP_PKG_PREFIX</td>
1.161     leot     11818: <td>PHP_VERSION</td>
1.156     leot     11819: </tr>
                   11820: <tr>
1.158     brook    11821: <td>PHP_VERSIONS_ACCEPTED</td>
1.161     leot     11822: <td>PHP_VERSIONS_INCOMPATIBLE</td>
1.156     leot     11823: </tr>
                   11824: <tr>
1.158     brook    11825: <td>PHP_VERSION_DEFAULT</td>
1.161     leot     11826: <td>PHP_VERSION_REQD</td>
1.156     leot     11827: </tr>
                   11828: <tr>
1.158     brook    11829: <td>PILRC_USE_GTK</td>
1.161     leot     11830: <td>PKGCONFIG_BASE</td>
1.156     leot     11831: </tr>
                   11832: <tr>
1.158     brook    11833: <td>PKGCONFIG_FILE</td>
1.161     leot     11834: <td>PKGCONFIG_OVERRIDE</td>
1.156     leot     11835: </tr>
                   11836: <tr>
1.158     brook    11837: <td>PKGCONFIG_OVERRIDE_STAGE</td>
1.161     leot     11838: <td>PKGDIR</td>
1.156     leot     11839: </tr>
                   11840: <tr>
1.158     brook    11841: <td>PKGGNUDIR</td>
1.161     leot     11842: <td>PKGINFODIR</td>
1.156     leot     11843: </tr>
                   11844: <tr>
1.158     brook    11845: <td>PKGLOCALEDIR</td>
1.161     leot     11846: <td>PKGMANDIR</td>
1.156     leot     11847: </tr>
                   11848: <tr>
1.158     brook    11849: <td>PKGNAME</td>
1.161     leot     11850: <td>PKGNAME_REQD</td>
1.156     leot     11851: </tr>
                   11852: <tr>
1.158     brook    11853: <td>PKGPATH</td>
1.161     leot     11854: <td>PKGREVISION</td>
1.156     leot     11855: </tr>
                   11856: <tr>
1.161     leot     11857: <td>PKGSRC_BLAS_TYPES</td>
1.160     brook    11858: <td>PKGSRC_CHANGES</td>
1.159     rillig   11859: </tr>
                   11860: <tr>
                   11861: <td>PKGSRC_COMPILER</td>
1.160     brook    11862: <td>PKGSRC_KEEP_BIN_PKGS</td>
1.156     leot     11863: </tr>
                   11864: <tr>
1.159     rillig   11865: <td>PKGSRC_LOCKTYPE</td>
1.160     brook    11866: <td>PKGSRC_MAKE_ENV</td>
1.156     leot     11867: </tr>
                   11868: <tr>
1.159     rillig   11869: <td>PKGSRC_MESSAGE_RECIPIENTS</td>
1.160     brook    11870: <td>PKGSRC_MKPIE</td>
1.156     leot     11871: </tr>
                   11872: <tr>
1.159     rillig   11873: <td>PKGSRC_MKREPRO</td>
1.160     brook    11874: <td>PKGSRC_RUN_TEST</td>
1.156     leot     11875: </tr>
                   11876: <tr>
1.159     rillig   11877: <td>PKGSRC_SETENV</td>
1.160     brook    11878: <td>PKGSRC_SLEEPSECS</td>
1.156     leot     11879: </tr>
                   11880: <tr>
1.159     rillig   11881: <td>PKGSRC_TODO</td>
1.160     brook    11882: <td>PKGSRC_USE_CTF</td>
1.156     leot     11883: </tr>
                   11884: <tr>
1.159     rillig   11885: <td>PKGSRC_USE_FORTIFY</td>
1.160     brook    11886: <td>PKGSRC_USE_RELRO</td>
1.156     leot     11887: </tr>
                   11888: <tr>
1.159     rillig   11889: <td>PKGSRC_USE_SSP</td>
1.160     brook    11890: <td>PKGSRC_USE_STACK_CHECK</td>
1.156     leot     11891: </tr>
                   11892: <tr>
1.159     rillig   11893: <td>PKGTASKS_DATAFILE</td>
1.160     brook    11894: <td>PKGTOOLS_ARGS</td>
1.156     leot     11895: </tr>
                   11896: <tr>
1.159     rillig   11897: <td>PKGTOOLS_ENV</td>
1.160     brook    11898: <td>PKG_ALTERNATIVES</td>
1.156     leot     11899: </tr>
                   11900: <tr>
1.159     rillig   11901: <td>PKG_APACHE</td>
1.160     brook    11902: <td>PKG_APACHE_ACCEPTED</td>
1.156     leot     11903: </tr>
                   11904: <tr>
1.159     rillig   11905: <td>PKG_APACHE_DEFAULT</td>
1.160     brook    11906: <td>PKG_BEST_EXISTS</td>
1.156     leot     11907: </tr>
                   11908: <tr>
1.159     rillig   11909: <td>PKG_BUILD_OPTIONS</td>
1.160     brook    11910: <td>PKG_COMPRESSION</td>
1.156     leot     11911: </tr>
                   11912: <tr>
1.159     rillig   11913: <td>PKG_CONFIG</td>
1.160     brook    11914: <td>PKG_CONFIG_PERMS</td>
1.156     leot     11915: </tr>
                   11916: <tr>
1.159     rillig   11917: <td>PKG_CREATE_USERGROUP</td>
1.160     brook    11918: <td>PKG_DB_TMPDIR</td>
1.156     leot     11919: </tr>
                   11920: <tr>
1.159     rillig   11921: <td>PKG_DEBUG_LEVEL</td>
1.160     brook    11922: <td>PKG_DEFAULT_OPTIONS</td>
1.156     leot     11923: </tr>
                   11924: <tr>
1.159     rillig   11925: <td>PKG_DESTDIR_SUPPORT</td>
1.160     brook    11926: <td>PKG_DEVELOPER</td>
1.156     leot     11927: </tr>
                   11928: <tr>
1.159     rillig   11929: <td>PKG_DISABLED_OPTIONS</td>
1.160     brook    11930: <td>PKG_FATAL_ERRORS</td>
1.156     leot     11931: </tr>
                   11932: <tr>
1.159     rillig   11933: <td>PKG_FC</td>
1.160     brook    11934: <td>PKG_FILELIST_CMD</td>
1.156     leot     11935: </tr>
                   11936: <tr>
1.159     rillig   11937: <td>PKG_GECOS</td>
1.160     brook    11938: <td>PKG_GID</td>
1.156     leot     11939: </tr>
                   11940: <tr>
1.159     rillig   11941: <td>PKG_GROUPS</td>
1.160     brook    11942: <td>PKG_GROUPS_VARS</td>
1.156     leot     11943: </tr>
                   11944: <tr>
1.159     rillig   11945: <td>PKG_HOME</td>
1.160     brook    11946: <td>PKG_INIT_SCRIPTS</td>
1.156     leot     11947: </tr>
                   11948: <tr>
1.159     rillig   11949: <td>PKG_JAVA_HOME</td>
1.160     brook    11950: <td>PKG_JVM</td>
1.156     leot     11951: </tr>
                   11952: <tr>
1.159     rillig   11953: <td>PKG_JVMS_ACCEPTED</td>
1.160     brook    11954: <td>PKG_JVM_DEFAULT</td>
1.156     leot     11955: </tr>
                   11956: <tr>
1.159     rillig   11957: <td>PKG_LEGACY_OPTIONS</td>
1.160     brook    11958: <td>PKG_LIBTOOL</td>
1.156     leot     11959: </tr>
                   11960: <tr>
1.159     rillig   11961: <td>PKG_OPTIONS</td>
1.160     brook    11962: <td>PKG_OPTIONS_DEPRECATED_WARNINGS</td>
1.156     leot     11963: </tr>
                   11964: <tr>
1.159     rillig   11965: <td>PKG_OPTIONS_LEGACY_OPTS</td>
1.160     brook    11966: <td>PKG_OPTIONS_LEGACY_VARS</td>
1.156     leot     11967: </tr>
                   11968: <tr>
1.159     rillig   11969: <td>PKG_OPTIONS_NONEMPTY_SETS</td>
1.160     brook    11970: <td>PKG_OPTIONS_OPTIONAL_GROUPS</td>
1.156     leot     11971: </tr>
                   11972: <tr>
1.159     rillig   11973: <td>PKG_OPTIONS_REQUIRED_GROUPS</td>
1.160     brook    11974: <td>PKG_OPTIONS_VAR</td>
1.156     leot     11975: </tr>
                   11976: <tr>
1.159     rillig   11977: <td>PKG_PHP</td>
1.160     brook    11978: <td>PKG_PHP_MAJOR_VERS</td>
1.156     leot     11979: </tr>
                   11980: <tr>
1.159     rillig   11981: <td>PKG_PHP_VERSION</td>
1.160     brook    11982: <td>PKG_RCD_SCRIPTS</td>
1.156     leot     11983: </tr>
                   11984: <tr>
1.159     rillig   11985: <td>PKG_REFCOUNT_DBDIR</td>
1.160     brook    11986: <td>PKG_REGISTER_SHELLS</td>
1.156     leot     11987: </tr>
                   11988: <tr>
1.159     rillig   11989: <td>PKG_RESUME_TRANSFERS</td>
1.160     brook    11990: <td>PKG_SHELL</td>
1.156     leot     11991: </tr>
                   11992: <tr>
1.159     rillig   11993: <td>PKG_SUGGESTED_OPTIONS</td>
1.160     brook    11994: <td>PKG_SUPPORTED_OPTIONS</td>
1.156     leot     11995: </tr>
                   11996: <tr>
1.159     rillig   11997: <td>PKG_SYSCONFBASE</td>
1.160     brook    11998: <td>PKG_SYSCONFBASEDIR</td>
1.156     leot     11999: </tr>
                   12000: <tr>
1.159     rillig   12001: <td>PKG_SYSCONFDIR</td>
1.160     brook    12002: <td>PKG_SYSCONFDIR_PERMS</td>
1.156     leot     12003: </tr>
                   12004: <tr>
1.159     rillig   12005: <td>PKG_SYSCONFSUBDIR</td>
1.160     brook    12006: <td>PKG_SYSCONFVAR</td>
1.156     leot     12007: </tr>
                   12008: <tr>
1.159     rillig   12009: <td>PKG_TOOLS_BIN</td>
1.160     brook    12010: <td>PKG_UID</td>
1.156     leot     12011: </tr>
                   12012: <tr>
1.159     rillig   12013: <td>PKG_UPDATE_FONTS_DB</td>
1.160     brook    12014: <td>PKG_USERS</td>
1.156     leot     12015: </tr>
                   12016: <tr>
1.159     rillig   12017: <td>PKG_USERS_VARS</td>
1.160     brook    12018: <td>PKG_VERBOSE</td>
1.156     leot     12019: </tr>
                   12020: <tr>
1.159     rillig   12021: <td>PLIST</td>
1.160     brook    12022: <td>PLIST_AWK</td>
1.156     leot     12023: </tr>
                   12024: <tr>
1.159     rillig   12025: <td>PLIST_AWK_ENV</td>
1.160     brook    12026: <td>PLIST_SRC</td>
1.156     leot     12027: </tr>
                   12028: <tr>
1.159     rillig   12029: <td>PLIST_SUBST</td>
1.160     brook    12030: <td>PLIST_TYPE</td>
1.156     leot     12031: </tr>
                   12032: <tr>
1.159     rillig   12033: <td>PLIST_VARS</td>
1.160     brook    12034: <td>POPTOP_USE_MPPE</td>
1.156     leot     12035: </tr>
                   12036: <tr>
1.159     rillig   12037: <td>POST_FETCH_HOOK</td>
1.160     brook    12038: <td>PREFER</td>
1.156     leot     12039: </tr>
                   12040: <tr>
1.159     rillig   12041: <td>PREFER_NATIVE</td>
1.160     brook    12042: <td>PREFER_NATIVE_PTHREADS</td>
1.156     leot     12043: </tr>
                   12044: <tr>
1.159     rillig   12045: <td>PREFER_PKGSRC</td>
1.160     brook    12046: <td>PREFIX</td>
1.156     leot     12047: </tr>
                   12048: <tr>
1.159     rillig   12049: <td>PREPEND_PATH</td>
1.160     brook    12050: <td>PRE_ROOT_CMD</td>
1.156     leot     12051: </tr>
                   12052: <tr>
1.159     rillig   12053: <td>PRIVILEGED_STAGES</td>
1.160     brook    12054: <td>PS</td>
1.156     leot     12055: </tr>
                   12056: <tr>
1.159     rillig   12057: <td>PTHREAD_AUTO_VARS</td>
1.160     brook    12058: <td>PTHREAD_CFLAGS</td>
1.156     leot     12059: </tr>
                   12060: <tr>
1.159     rillig   12061: <td>PTHREAD_LDFLAGS</td>
1.160     brook    12062: <td>PTHREAD_LIBS</td>
1.156     leot     12063: </tr>
                   12064: <tr>
1.159     rillig   12065: <td>PTHREAD_OPTS</td>
1.160     brook    12066: <td>PTHREAD_TYPE</td>
1.156     leot     12067: </tr>
                   12068: <tr>
1.159     rillig   12069: <td>PVM_SSH</td>
1.160     brook    12070: <td>PYPKGPREFIX</td>
1.156     leot     12071: </tr>
                   12072: <tr>
1.159     rillig   12073: <td>PYTHON_FOR_BUILD_ONLY</td>
1.160     brook    12074: <td>PYTHON_SELF_CONFLICT</td>
1.156     leot     12075: </tr>
                   12076: <tr>
1.159     rillig   12077: <td>PYTHON_VERSIONED_DEPENDENCIES</td>
1.160     brook    12078: <td>PYTHON_VERSIONS_ACCEPTED</td>
1.156     leot     12079: </tr>
                   12080: <tr>
1.159     rillig   12081: <td>PYTHON_VERSIONS_INCOMPATIBLE</td>
1.160     brook    12082: <td>PYTHON_VERSION_DEFAULT</td>
1.156     leot     12083: </tr>
                   12084: <tr>
1.159     rillig   12085: <td>PYTHON_VERSION_REQD</td>
1.160     brook    12086: <td>PYVERSSUFFIX</td>
1.156     leot     12087: </tr>
                   12088: <tr>
1.159     rillig   12089: <td>PY_NO_EGG</td>
1.160     brook    12090: <td>QMAILDIR</td>
1.156     leot     12091: </tr>
                   12092: <tr>
1.159     rillig   12093: <td>QMAIL_ALIAS_USER</td>
1.160     brook    12094: <td>QMAIL_DAEMON_USER</td>
1.156     leot     12095: </tr>
                   12096: <tr>
1.159     rillig   12097: <td>QMAIL_LOG_USER</td>
1.160     brook    12098: <td>QMAIL_NOFILES_GROUP</td>
1.156     leot     12099: </tr>
                   12100: <tr>
1.159     rillig   12101: <td>QMAIL_PASSWD_USER</td>
1.160     brook    12102: <td>QMAIL_QMAIL_GROUP</td>
1.156     leot     12103: </tr>
                   12104: <tr>
1.159     rillig   12105: <td>QMAIL_QUEUE_DIR</td>
1.160     brook    12106: <td>QMAIL_QUEUE_EXTRA</td>
1.156     leot     12107: </tr>
                   12108: <tr>
1.159     rillig   12109: <td>QMAIL_QUEUE_USER</td>
1.160     brook    12110: <td>QMAIL_REMOTE_USER</td>
1.156     leot     12111: </tr>
                   12112: <tr>
1.159     rillig   12113: <td>QMAIL_ROOT_USER</td>
1.160     brook    12114: <td>QMAIL_SEND_USER</td>
1.156     leot     12115: </tr>
                   12116: <tr>
1.159     rillig   12117: <td>QPOPPER_FAC</td>
1.160     brook    12118: <td>QPOPPER_SPOOL_DIR</td>
1.156     leot     12119: </tr>
                   12120: <tr>
1.159     rillig   12121: <td>QPOPPER_USER</td>
1.160     brook    12122: <td>RAKE_NAME</td>
1.156     leot     12123: </tr>
                   12124: <tr>
1.159     rillig   12125: <td>RASMOL_DEPTH</td>
1.161     leot     12126: <td>RCD_DIR</td>
                   12127: </tr>
                   12128: <tr>
                   12129: <td>RCD_ORDER</td>
1.160     brook    12130: <td>RCD_SCRIPTS</td>
1.159     rillig   12131: </tr>
                   12132: <tr>
                   12133: <td>RCD_SCRIPTS_DIR</td>
1.160     brook    12134: <td>RCD_SCRIPTS_EXAMPLEDIR</td>
1.156     leot     12135: </tr>
                   12136: <tr>
1.159     rillig   12137: <td>RCD_SCRIPTS_MODE</td>
1.160     brook    12138: <td>RCD_SCRIPTS_SHELL</td>
1.156     leot     12139: </tr>
                   12140: <tr>
1.159     rillig   12141: <td>RCD_SCRIPT_SRC</td>
1.161     leot     12142: <td>RCD_SUBR</td>
                   12143: </tr>
                   12144: <tr>
1.157     leot     12145: <td>RDOC</td>
1.161     leot     12146: <td>READLINE_DEFAULT</td>
1.156     leot     12147: </tr>
                   12148: <tr>
1.157     leot     12149: <td>READLINE_TYPE</td>
1.161     leot     12150: <td>REAL_ROOT_GROUP</td>
1.156     leot     12151: </tr>
                   12152: <tr>
1.157     leot     12153: <td>REAL_ROOT_USER</td>
1.161     leot     12154: <td>RECURSIVE_MAKE</td>
1.156     leot     12155: </tr>
                   12156: <tr>
1.157     leot     12157: <td>RELAY_CTRL_DIR</td>
1.161     leot     12158: <td>REPLACE_AWK</td>
1.156     leot     12159: </tr>
                   12160: <tr>
1.157     leot     12161: <td>REPLACE_BASH</td>
1.161     leot     12162: <td>REPLACE_CSH</td>
1.156     leot     12163: </tr>
                   12164: <tr>
1.157     leot     12165: <td>REPLACE_KSH</td>
1.161     leot     12166: <td>REPLACE_PERL</td>
1.156     leot     12167: </tr>
                   12168: <tr>
1.157     leot     12169: <td>REPLACE_PERL6</td>
1.166     leot     12170: <td>REPLACE_PHP</td>
                   12171: </tr>
                   12172: <tr>
1.161     leot     12173: <td>REPLACE_PYTHON</td>
1.166     leot     12174: <td>REPLACE_RUBY</td>
1.156     leot     12175: </tr>
                   12176: <tr>
1.161     leot     12177: <td>REPLACE_RUBY_DIRS</td>
1.166     leot     12178: <td>REPLACE_RUBY_PAT</td>
1.156     leot     12179: </tr>
                   12180: <tr>
1.161     leot     12181: <td>REPLACE_SH</td>
1.166     leot     12182: <td>REPLACE_TEXLUA</td>
1.156     leot     12183: </tr>
                   12184: <tr>
1.161     leot     12185: <td>REQD_DIRS</td>
1.166     leot     12186: <td>REQD_DIRS_PERMS</td>
1.156     leot     12187: </tr>
                   12188: <tr>
1.161     leot     12189: <td>REQD_FILES</td>
1.166     leot     12190: <td>REQD_FILES_MODE</td>
1.156     leot     12191: </tr>
                   12192: <tr>
1.161     leot     12193: <td>REQD_FILES_PERMS</td>
1.166     leot     12194: <td>RESOLV_AUTO_VARS</td>
1.156     leot     12195: </tr>
                   12196: <tr>
1.161     leot     12197: <td>RESOLV_LDFLAGS</td>
1.166     leot     12198: <td>RESOLV_LIBS</td>
1.156     leot     12199: </tr>
                   12200: <tr>
1.161     leot     12201: <td>RM</td>
1.166     leot     12202: <td>ROCKSPEC_NAME</td>
1.161     leot     12203: </tr>
                   12204: <tr>
                   12205: <td>ROCKSPEC_SPECFILE</td>
1.166     leot     12206: <td>ROOT_CMD</td>
1.156     leot     12207: </tr>
                   12208: <tr>
1.161     leot     12209: <td>ROOT_GROUP</td>
1.166     leot     12210: <td>ROOT_USER</td>
1.156     leot     12211: </tr>
                   12212: <tr>
1.161     leot     12213: <td>RPCGEN</td>
1.166     leot     12214: <td>RPM</td>
1.156     leot     12215: </tr>
                   12216: <tr>
1.161     leot     12217: <td>RPM2PKG_PLIST</td>
1.166     leot     12218: <td>RPM2PKG_PREFIX</td>
1.156     leot     12219: </tr>
                   12220: <tr>
1.161     leot     12221: <td>RPM2PKG_STAGE</td>
1.166     leot     12222: <td>RPM2PKG_STRIP</td>
1.156     leot     12223: </tr>
                   12224: <tr>
1.161     leot     12225: <td>RPM2PKG_SUBPREFIX</td>
1.166     leot     12226: <td>RPMFILES</td>
1.156     leot     12227: </tr>
                   12228: <tr>
1.161     leot     12229: <td>RPMIGNOREPATH</td>
1.166     leot     12230: <td>RPM_DB_PREFIX</td>
1.156     leot     12231: </tr>
                   12232: <tr>
1.161     leot     12233: <td>RSSH_CVS_PATH</td>
1.166     leot     12234: <td>RSSH_RDIST_PATH</td>
1.156     leot     12235: </tr>
                   12236: <tr>
1.161     leot     12237: <td>RSSH_RSYNC_PATH</td>
1.166     leot     12238: <td>RSSH_SCP_PATH</td>
1.156     leot     12239: </tr>
                   12240: <tr>
1.161     leot     12241: <td>RSSH_SFTP_SERVER_PATH</td>
1.166     leot     12242: <td>RUBY</td>
1.156     leot     12243: </tr>
                   12244: <tr>
1.161     leot     12245: <td>RUBYGEM</td>
1.166     leot     12246: <td>RUBYGEM_NAME</td>
1.156     leot     12247: </tr>
                   12248: <tr>
1.161     leot     12249: <td>RUBYGEM_OPTIONS</td>
1.166     leot     12250: <td>RUBY_ABI_VERSION</td>
1.156     leot     12251: </tr>
                   12252: <tr>
1.161     leot     12253: <td>RUBY_ARCH</td>
1.166     leot     12254: <td>RUBY_ARCHINC</td>
1.156     leot     12255: </tr>
                   12256: <tr>
1.161     leot     12257: <td>RUBY_ARCHLIB</td>
1.166     leot     12258: <td>RUBY_BASE</td>
1.156     leot     12259: </tr>
                   12260: <tr>
1.161     leot     12261: <td>RUBY_BASERIDIR</td>
1.166     leot     12262: <td>RUBY_BUILD_DOCUMENT</td>
1.156     leot     12263: </tr>
                   12264: <tr>
1.162     rillig   12265: <td>RUBY_DLEXT</td>
1.166     leot     12266: <td>RUBY_DOC</td>
1.156     leot     12267: </tr>
                   12268: <tr>
1.162     rillig   12269: <td>RUBY_DYNAMIC_DIRS</td>
1.166     leot     12270: <td>RUBY_EG</td>
1.156     leot     12271: </tr>
                   12272: <tr>
1.162     rillig   12273: <td>RUBY_ENCODING_ARG</td>
1.166     leot     12274: <td>RUBY_EXTCONF</td>
1.156     leot     12275: </tr>
                   12276: <tr>
1.162     rillig   12277: <td>RUBY_EXTCONF_CHECK</td>
1.166     leot     12278: <td>RUBY_EXTCONF_DEBUG</td>
1.156     leot     12279: </tr>
                   12280: <tr>
1.162     rillig   12281: <td>RUBY_EXTCONF_MAKEFILE</td>
1.166     leot     12282: <td>RUBY_GEM_BASE</td>
1.156     leot     12283: </tr>
                   12284: <tr>
1.162     rillig   12285: <td>RUBY_INC</td>
1.166     leot     12286: <td>RUBY_LIB</td>
1.156     leot     12287: </tr>
                   12288: <tr>
1.162     rillig   12289: <td>RUBY_LIB_BASE</td>
1.166     leot     12290: <td>RUBY_NAME</td>
1.156     leot     12291: </tr>
                   12292: <tr>
1.162     rillig   12293: <td>RUBY_NOVERSION</td>
1.166     leot     12294: <td>RUBY_PKGPREFIX</td>
1.156     leot     12295: </tr>
                   12296: <tr>
1.162     rillig   12297: <td>RUBY_RAILS</td>
1.166     leot     12298: <td>RUBY_RAILS42_VERSION</td>
1.156     leot     12299: </tr>
                   12300: <tr>
1.162     rillig   12301: <td>RUBY_RAILS51_VERSION</td>
1.166     leot     12302: <td>RUBY_RAILS52_VERSION</td>
1.156     leot     12303: </tr>
                   12304: <tr>
1.162     rillig   12305: <td>RUBY_RAILS_ACCEPTED</td>
1.166     leot     12306: <td>RUBY_RAILS_DEFAULT</td>
1.156     leot     12307: </tr>
                   12308: <tr>
1.162     rillig   12309: <td>RUBY_RAILS_REQD</td>
1.166     leot     12310: <td>RUBY_RAILS_STRICT_DEP</td>
1.156     leot     12311: </tr>
                   12312: <tr>
1.162     rillig   12313: <td>RUBY_RIDIR</td>
1.166     leot     12314: <td>RUBY_SETUP</td>
1.156     leot     12315: </tr>
                   12316: <tr>
1.162     rillig   12317: <td>RUBY_SHLIB</td>
1.166     leot     12318: <td>RUBY_SHLIBALIAS</td>
1.156     leot     12319: </tr>
                   12320: <tr>
1.162     rillig   12321: <td>RUBY_SHLIBVER</td>
1.166     leot     12322: <td>RUBY_SIMPLE_INSTALL</td>
1.156     leot     12323: </tr>
                   12324: <tr>
1.162     rillig   12325: <td>RUBY_SITEARCHLIB</td>
1.166     leot     12326: <td>RUBY_SITELIB</td>
1.156     leot     12327: </tr>
                   12328: <tr>
1.162     rillig   12329: <td>RUBY_SITELIB_BASE</td>
1.166     leot     12330: <td>RUBY_SITERIDIR</td>
1.156     leot     12331: </tr>
                   12332: <tr>
1.162     rillig   12333: <td>RUBY_SLEXT</td>
1.166     leot     12334: <td>RUBY_SRCDIR</td>
1.156     leot     12335: </tr>
                   12336: <tr>
1.162     rillig   12337: <td>RUBY_STATICLIB</td>
1.166     leot     12338: <td>RUBY_SUFFIX</td>
1.156     leot     12339: </tr>
                   12340: <tr>
1.162     rillig   12341: <td>RUBY_SYSRIDIR</td>
1.166     leot     12342: <td>RUBY_USE_PTHREAD</td>
1.156     leot     12343: </tr>
                   12344: <tr>
1.162     rillig   12345: <td>RUBY_VENDORARCHLIB</td>
1.166     leot     12346: <td>RUBY_VENDORLIB</td>
1.156     leot     12347: </tr>
                   12348: <tr>
1.162     rillig   12349: <td>RUBY_VENDORLIB_BASE</td>
1.166     leot     12350: <td>RUBY_VER</td>
1.156     leot     12351: </tr>
                   12352: <tr>
1.162     rillig   12353: <td>RUBY_VERSION</td>
1.166     leot     12354: <td>RUBY_VERSIONS_ACCEPTED</td>
1.156     leot     12355: </tr>
                   12356: <tr>
1.162     rillig   12357: <td>RUBY_VERSION_DEFAULT</td>
1.166     leot     12358: <td>RUBY_VERSION_REQD</td>
1.156     leot     12359: </tr>
                   12360: <tr>
1.162     rillig   12361: <td>RUBY_VER_DIR</td>
1.166     leot     12362: <td>RUN</td>
1.156     leot     12363: </tr>
                   12364: <tr>
1.162     rillig   12365: <td>RUN_LDCONFIG</td>
1.166     leot     12366: <td>SAWFISH_THEMES</td>
1.156     leot     12367: </tr>
                   12368: <tr>
1.162     rillig   12369: <td>SCO</td>
1.166     leot     12370: <td>SCREWS_GROUP</td>
1.156     leot     12371: </tr>
                   12372: <tr>
1.162     rillig   12373: <td>SCREWS_USER</td>
1.166     leot     12374: <td>SCRIPTS_ENV</td>
1.156     leot     12375: </tr>
                   12376: <tr>
1.162     rillig   12377: <td>SCROLLKEEPER_DATADIR</td>
1.166     leot     12378: <td>SCROLLKEEPER_REBUILDDB</td>
1.156     leot     12379: </tr>
                   12380: <tr>
1.162     rillig   12381: <td>SCROLLKEEPER_UPDATEDB</td>
1.166     leot     12382: <td>SDIST_PAWD</td>
1.156     leot     12383: </tr>
                   12384: <tr>
1.162     rillig   12385: <td>SERIAL_DEVICES</td>
1.166     leot     12386: <td>SETGIDGAME</td>
1.156     leot     12387: </tr>
                   12388: <tr>
1.162     rillig   12389: <td>SETGID_GAMES_PERMS</td>
1.166     leot     12390: <td>SETUID_ROOT_PERMS</td>
1.156     leot     12391: </tr>
                   12392: <tr>
1.162     rillig   12393: <td>SH</td>
1.166     leot     12394: <td>SHLIB</td>
1.156     leot     12395: </tr>
                   12396: <tr>
1.162     rillig   12397: <td>SHORTNAME</td>
1.166     leot     12398: <td>SIGN_PACKAGES</td>
1.156     leot     12399: </tr>
                   12400: <tr>
1.162     rillig   12401: <td>SILC_CLIENT_WITH_PERL</td>
1.166     leot     12402: <td>SITE_SPECIFIC_PKGS</td>
1.159     rillig   12403: </tr>
                   12404: <tr>
                   12405: <td>SKIP_DEPENDS</td>
1.166     leot     12406: <td>SMF_INSTANCES</td>
1.156     leot     12407: </tr>
                   12408: <tr>
1.160     brook    12409: <td>SMF_MANIFEST</td>
1.166     leot     12410: <td>SMF_METHODS</td>
1.156     leot     12411: </tr>
                   12412: <tr>
1.160     brook    12413: <td>SMF_METHOD_SHELL</td>
1.166     leot     12414: <td>SMF_METHOD_SRC</td>
1.156     leot     12415: </tr>
                   12416: <tr>
1.160     brook    12417: <td>SMF_NAME</td>
1.166     leot     12418: <td>SMF_PREFIX</td>
1.156     leot     12419: </tr>
                   12420: <tr>
1.160     brook    12421: <td>SMF_SRCDIR</td>
1.166     leot     12422: <td>SNIPROXY_GROUP</td>
1.156     leot     12423: </tr>
                   12424: <tr>
1.160     brook    12425: <td>SNIPROXY_USER</td>
1.166     leot     12426: <td>SOURCE_BUFFSIZE</td>
1.156     leot     12427: </tr>
                   12428: <tr>
1.160     brook    12429: <td>SPECIAL_PERMS</td>
1.166     leot     12430: <td>SPECIFIC_PKGS</td>
1.156     leot     12431: </tr>
                   12432: <tr>
1.160     brook    12433: <td>SSH_SUID</td>
1.166     leot     12434: <td>SSP_SUPPORTED</td>
1.156     leot     12435: </tr>
                   12436: <tr>
1.159     rillig   12437: <td>SSYNC_PAWD</td>
1.160     brook    12438: <td>STEP_MSG</td>
1.156     leot     12439: </tr>
                   12440: <tr>
1.159     rillig   12441: <td>STRIP</td>
1.160     brook    12442: <td>STRIP_DBG</td>
1.156     leot     12443: </tr>
                   12444: <tr>
1.159     rillig   12445: <td>STRIP_DEBUG</td>
1.160     brook    12446: <td>STRIP_DEBUG_SUPPORTED</td>
1.156     leot     12447: </tr>
                   12448: <tr>
1.159     rillig   12449: <td>STRIP_FILES_SKIP</td>
1.160     brook    12450: <td>SU</td>
1.156     leot     12451: </tr>
                   12452: <tr>
1.159     rillig   12453: <td>SUBDIR</td>
1.160     brook    12454: <td>SUBST_CLASSES</td>
1.156     leot     12455: </tr>
                   12456: <tr>
1.159     rillig   12457: <td>SUBST_FILES</td>
1.160     brook    12458: <td>SUBST_FILTER_CMD</td>
1.156     leot     12459: </tr>
                   12460: <tr>
1.159     rillig   12461: <td>SUBST_MESSAGE</td>
1.160     brook    12462: <td>SUBST_SED</td>
1.156     leot     12463: </tr>
                   12464: <tr>
1.159     rillig   12465: <td>SUBST_SHOW_DIFF</td>
1.160     brook    12466: <td>SUBST_SKIP_TEXT_CHECK</td>
1.156     leot     12467: </tr>
                   12468: <tr>
1.159     rillig   12469: <td>SUBST_STAGE</td>
1.160     brook    12470: <td>SUBST_VARS</td>
1.156     leot     12471: </tr>
                   12472: <tr>
1.159     rillig   12473: <td>SUNWSPROBASE</td>
1.160     brook    12474: <td>SUSE_PREFER</td>
1.156     leot     12475: </tr>
                   12476: <tr>
1.159     rillig   12477: <td>SU_CMD</td>
1.161     leot     12478: <td>SVN_EXTRACTDIR</td>
                   12479: </tr>
                   12480: <tr>
                   12481: <td>SVN_REPO</td>
                   12482: <td>SVN_REPOSITORIES</td>
                   12483: </tr>
                   12484: <tr>
                   12485: <td>SVN_REVISION</td>
1.160     brook    12486: <td>TERMCAP_TYPE</td>
1.159     rillig   12487: </tr>
                   12488: <tr>
                   12489: <td>TERMINFO_DEFAULT</td>
1.160     brook    12490: <td>TERMINFO_TYPE</td>
1.156     leot     12491: </tr>
                   12492: <tr>
1.159     rillig   12493: <td>TEST</td>
1.160     brook    12494: <td>TEST_DEPENDS</td>
1.156     leot     12495: </tr>
                   12496: <tr>
1.159     rillig   12497: <td>TEST_DIRS</td>
1.160     brook    12498: <td>TEST_ENV</td>
1.156     leot     12499: </tr>
                   12500: <tr>
1.159     rillig   12501: <td>TEST_MAKE_CMD</td>
1.160     brook    12502: <td>TEST_MAKE_FLAGS</td>
1.156     leot     12503: </tr>
                   12504: <tr>
1.159     rillig   12505: <td>TEST_TARGET</td>
1.160     brook    12506: <td>TEXLIVE_IGNORE_PATTERNS</td>
1.156     leot     12507: </tr>
                   12508: <tr>
1.159     rillig   12509: <td>TEXLIVE_REV</td>
1.166     leot     12510: <td>TEXLIVE_UNVERSIONED</td>
1.156     leot     12511: </tr>
                   12512: <tr>
1.166     leot     12513: <td>TEXMFSITE</td>
1.159     rillig   12514: <td>TEX_FORMATS</td>
1.156     leot     12515: </tr>
                   12516: <tr>
1.166     leot     12517: <td>TEX_HYPHEN_DAT</td>
1.159     rillig   12518: <td>TEX_HYPHEN_DEF</td>
1.156     leot     12519: </tr>
                   12520: <tr>
1.166     leot     12521: <td>TEX_TEXMF_DIRS</td>
1.159     rillig   12522: <td>THTTPD_LOG_FACILITY</td>
1.156     leot     12523: </tr>
                   12524: <tr>
1.166     leot     12525: <td>TO</td>
1.159     rillig   12526: <td>TOOLS_ALIASES</td>
1.156     leot     12527: </tr>
                   12528: <tr>
1.166     leot     12529: <td>TOOLS_ARGS</td>
1.159     rillig   12530: <td>TOOLS_BROKEN</td>
1.156     leot     12531: </tr>
                   12532: <tr>
1.166     leot     12533: <td>TOOLS_CMD</td>
1.159     rillig   12534: <td>TOOLS_CREATE</td>
1.156     leot     12535: </tr>
                   12536: <tr>
1.166     leot     12537: <td>TOOLS_DIR</td>
1.159     rillig   12538: <td>TOOLS_FAIL</td>
1.156     leot     12539: </tr>
                   12540: <tr>
1.166     leot     12541: <td>TOOLS_GNU_MISSING</td>
1.159     rillig   12542: <td>TOOLS_LDCONFIG</td>
1.156     leot     12543: </tr>
                   12544: <tr>
1.166     leot     12545: <td>TOOLS_NOOP</td>
1.159     rillig   12546: <td>TOOLS_PATH</td>
1.156     leot     12547: </tr>
                   12548: <tr>
1.166     leot     12549: <td>TOOLS_SCRIPT</td>
1.159     rillig   12550: <td>TOOL_DEPENDS</td>
1.161     leot     12551: </tr>
                   12552: <tr>
1.166     leot     12553: <td>TTF_FONTDIR</td>
1.157     leot     12554: <td>TTF_FONTS_DIR</td>
1.156     leot     12555: </tr>
                   12556: <tr>
1.166     leot     12557: <td>TYPE</td>
1.157     leot     12558: <td>UAC_REQD_EXECS</td>
1.156     leot     12559: </tr>
                   12560: <tr>
1.166     leot     12561: <td>UCSPI_SSL_GROUP</td>
1.157     leot     12562: <td>UCSPI_SSL_USER</td>
1.156     leot     12563: </tr>
                   12564: <tr>
1.166     leot     12565: <td>UNLIMIT_RESOURCES</td>
1.157     leot     12566: <td>UNPRIVILEGED</td>
1.156     leot     12567: </tr>
                   12568: <tr>
1.166     leot     12569: <td>UNPRIVILEGED_GROUP</td>
1.157     leot     12570: <td>UNPRIVILEGED_GROUPS</td>
1.156     leot     12571: </tr>
                   12572: <tr>
1.166     leot     12573: <td>UNPRIVILEGED_USER</td>
1.157     leot     12574: <td>UNWRAP_FILES</td>
1.156     leot     12575: </tr>
                   12576: <tr>
1.166     leot     12577: <td>UNWRAP_PATTERNS</td>
1.157     leot     12578: <td>UPDATE_GEMSPEC</td>
1.156     leot     12579: </tr>
                   12580: <tr>
1.166     leot     12581: <td>UPDATE_TARGET</td>
1.157     leot     12582: <td>URI</td>
1.156     leot     12583: </tr>
                   12584: <tr>
1.166     leot     12585: <td>USA</td>
1.157     leot     12586: <td>USERGROUP_PHASE</td>
1.156     leot     12587: </tr>
                   12588: <tr>
1.166     leot     12589: <td>USERPPP_GROUP</td>
1.157     leot     12590: <td>USER_SPECIFIC_PKGS</td>
1.156     leot     12591: </tr>
                   12592: <tr>
1.166     leot     12593: <td>USE_ABI_DEPENDS</td>
1.157     leot     12594: <td>USE_APR</td>
1.156     leot     12595: </tr>
                   12596: <tr>
1.166     leot     12597: <td>USE_BSD_MAKEFILE</td>
1.157     leot     12598: <td>USE_BUILTIN</td>
1.156     leot     12599: </tr>
                   12600: <tr>
1.166     leot     12601: <td>USE_CROSS_COMPILE</td>
1.157     leot     12602: <td>USE_CURSES</td>
1.156     leot     12603: </tr>
                   12604: <tr>
1.166     leot     12605: <td>USE_CWRAPPERS</td>
1.157     leot     12606: <td>USE_DB185</td>
1.156     leot     12607: </tr>
                   12608: <tr>
1.166     leot     12609: <td>USE_FEATURES</td>
1.157     leot     12610: <td>USE_GAMESGROUP</td>
1.156     leot     12611: </tr>
                   12612: <tr>
1.166     leot     12613: <td>USE_GCC_RUNTIME</td>
1.157     leot     12614: <td>USE_IMAKE</td>
1.156     leot     12615: </tr>
                   12616: <tr>
1.166     leot     12617: <td>USE_JAVA</td>
1.157     leot     12618: <td>USE_JAVA2</td>
1.156     leot     12619: </tr>
                   12620: <tr>
1.166     leot     12621: <td>USE_LANGUAGES</td>
1.157     leot     12622: <td>USE_LIBTOOL</td>
1.156     leot     12623: </tr>
                   12624: <tr>
1.166     leot     12625: <td>USE_NATIVE_GCC</td>
1.157     leot     12626: <td>USE_NETBSD_REPO</td>
1.156     leot     12627: </tr>
                   12628: <tr>
1.166     leot     12629: <td>USE_PKGSRC_GCC</td>
1.157     leot     12630: <td>USE_PKGSRC_GCC_RUNTIME</td>
1.156     leot     12631: </tr>
                   12632: <tr>
1.166     leot     12633: <td>USE_PKGTASKS</td>
1.157     leot     12634: <td>USE_RUBY_EXTCONF</td>
1.156     leot     12635: </tr>
                   12636: <tr>
1.166     leot     12637: <td>USE_RUBY_INSTALL</td>
1.157     leot     12638: <td>USE_RUBY_SETUP</td>
1.156     leot     12639: </tr>
                   12640: <tr>
1.166     leot     12641: <td>USE_RUBY_SETUP_PKG</td>
1.157     leot     12642: <td>USE_TOOLS</td>
1.156     leot     12643: </tr>
                   12644: <tr>
1.166     leot     12645: <td>UUCP_GROUP</td>
1.157     leot     12646: <td>UUCP_USER</td>
1.156     leot     12647: </tr>
                   12648: <tr>
1.166     leot     12649: <td>VARBASE</td>
1.157     leot     12650: <td>VARNAME</td>
1.156     leot     12651: </tr>
                   12652: <tr>
1.166     leot     12653: <td>VIM_EXTRA_OPTS</td>
1.157     leot     12654: <td>WARNING_MSG</td>
1.156     leot     12655: </tr>
                   12656: <tr>
1.166     leot     12657: <td>WCALC_CGIDIR</td>
1.157     leot     12658: <td>WCALC_CGIPATH</td>
1.156     leot     12659: </tr>
                   12660: <tr>
1.166     leot     12661: <td>WCALC_HTMLDIR</td>
1.157     leot     12662: <td>WCALC_HTMLPATH</td>
1.156     leot     12663: </tr>
                   12664: <tr>
1.166     leot     12665: <td>WDM_MANAGERS</td>
1.157     leot     12666: <td>WRAPPER_REORDER_CMDS</td>
1.156     leot     12667: </tr>
                   12668: <tr>
1.166     leot     12669: <td>WRKDIR</td>
1.157     leot     12670: <td>WRKDIR_BASENAME</td>
1.156     leot     12671: </tr>
                   12672: <tr>
1.166     leot     12673: <td>WRKDIR_LOCKTYPE</td>
1.157     leot     12674: <td>WRKLOG</td>
1.156     leot     12675: </tr>
                   12676: <tr>
1.166     leot     12677: <td>WRKOBJDIR</td>
1.157     leot     12678: <td>WRKSRC</td>
1.156     leot     12679: </tr>
                   12680: <tr>
1.166     leot     12681: <td>WXGTK_ACCEPTED</td>
1.157     leot     12682: <td>WXGTK_DEFAULT</td>
1.156     leot     12683: </tr>
                   12684: <tr>
1.166     leot     12685: <td>X10_PORT</td>
1.157     leot     12686: <td>X11</td>
1.156     leot     12687: </tr>
                   12688: <tr>
1.166     leot     12689: <td>X11BASE</td>
1.157     leot     12690: <td>X11_PKGSRCDIR</td>
1.156     leot     12691: </tr>
                   12692: <tr>
1.166     leot     12693: <td>X11_TYPE</td>
1.157     leot     12694: <td>X509_CERTIFICATE</td>
1.156     leot     12695: </tr>
                   12696: <tr>
1.166     leot     12697: <td>X509_KEY</td>
1.157     leot     12698: <td>XAW_TYPE</td>
1.156     leot     12699: </tr>
                   12700: <tr>
1.166     leot     12701: <td>XLOCK_DEFAULT_MODE</td>
1.157     leot     12702: <td>XMKMF_FLAGS</td>
1.156     leot     12703: </tr>
                   12704: <tr>
1.166     leot     12705: <td>XXX</td>
1.161     leot     12706: <td>XXXX</td>
1.159     rillig   12707: </tr>
                   12708: <tr>
1.166     leot     12709: <td>YES</td>
1.159     rillig   12710: <td>ZERO_FILESIZE_P</td>
1.156     leot     12711: </tr>
                   12712: <tr>
1.166     leot     12713: <td>ZSH_STATIC</td>
1.159     rillig   12714: <td>__stdc__</td>
1.156     leot     12715: </tr>
                   12716: <tr>
1.166     leot     12717: <td>_vargroups</td>
1.159     rillig   12718: <td>add</td>
1.156     leot     12719: </tr>
                   12720: <tr>
1.166     leot     12721: <td>all</td>
1.159     rillig   12722: <td>alternatives</td>
1.156     leot     12723: </tr>
                   12724: <tr>
1.166     leot     12725: <td>aslr</td>
1.159     rillig   12726: <td>asprintf</td>
1.161     leot     12727: </tr>
                   12728: <tr>
1.166     leot     12729: <td>atlas</td>
1.158     brook    12730: <td>autoconf</td>
1.156     leot     12731: </tr>
                   12732: <tr>
1.166     leot     12733: <td>automake</td>
1.158     brook    12734: <td>autoreconf</td>
1.156     leot     12735: </tr>
                   12736: <tr>
1.166     leot     12737: <td>awk</td>
1.158     brook    12738: <td>bash</td>
1.156     leot     12739: </tr>
                   12740: <tr>
1.166     leot     12741: <td>big-endian</td>
1.158     brook    12742: <td>bin-install</td>
1.156     leot     12743: </tr>
                   12744: <tr>
1.166     leot     12745: <td>binpkg-list</td>
1.161     leot     12746: <td>blas</td>
1.159     rillig   12747: </tr>
                   12748: <tr>
1.166     leot     12749: <td>bootstrap-depends</td>
1.159     rillig   12750: <td>broken</td>
1.156     leot     12751: </tr>
                   12752: <tr>
1.166     leot     12753: <td>broken_on_platform</td>
1.159     rillig   12754: <td>build</td>
1.156     leot     12755: </tr>
                   12756: <tr>
1.166     leot     12757: <td>build-env</td>
1.159     rillig   12758: <td>buildlink-directories</td>
1.156     leot     12759: </tr>
                   12760: <tr>
1.166     leot     12761: <td>buildlink-oss-soundcard-h</td>
1.159     rillig   12762: <td>c</td>
1.156     leot     12763: </tr>
                   12764: <tr>
1.166     leot     12765: <td>c++</td>
1.159     rillig   12766: <td>ccache</td>
1.156     leot     12767: </tr>
                   12768: <tr>
1.166     leot     12769: <td>cce</td>
1.159     rillig   12770: <td>cdefs</td>
1.156     leot     12771: </tr>
                   12772: <tr>
1.166     leot     12773: <td>changes</td>
1.159     rillig   12774: <td>changes-entry</td>
1.156     leot     12775: </tr>
                   12776: <tr>
1.166     leot     12777: <td>changes-entry-noupdate</td>
1.159     rillig   12778: <td>check</td>
1.156     leot     12779: </tr>
                   12780: <tr>
1.166     leot     12781: <td>check-clean</td>
1.159     rillig   12782: <td>check-files</td>
1.156     leot     12783: </tr>
                   12784: <tr>
1.166     leot     12785: <td>check-files-clean</td>
1.159     rillig   12786: <td>check-vulnerable</td>
1.156     leot     12787: </tr>
                   12788: <tr>
1.166     leot     12789: <td>checksum</td>
1.159     rillig   12790: <td>checksum-phase</td>
1.156     leot     12791: </tr>
                   12792: <tr>
1.166     leot     12793: <td>clean</td>
1.159     rillig   12794: <td>clean-depends</td>
1.156     leot     12795: </tr>
                   12796: <tr>
1.166     leot     12797: <td>cleandir</td>
1.159     rillig   12798: <td>commit</td>
1.156     leot     12799: </tr>
                   12800: <tr>
1.166     leot     12801: <td>commit-changes-entry</td>
1.159     rillig   12802: <td>compact</td>
1.156     leot     12803: </tr>
                   12804: <tr>
1.166     leot     12805: <td>compiler</td>
1.159     rillig   12806: <td>conf</td>
1.156     leot     12807: </tr>
                   12808: <tr>
1.166     leot     12809: <td>config.guess</td>
1.159     rillig   12810: <td>config.sub</td>
1.156     leot     12811: </tr>
                   12812: <tr>
1.166     leot     12813: <td>configuration</td>
1.159     rillig   12814: <td>configure</td>
1.156     leot     12815: </tr>
                   12816: <tr>
1.166     leot     12817: <td>configure-help</td>
1.159     rillig   12818: <td>configure_args</td>
1.156     leot     12819: </tr>
                   12820: <tr>
1.166     leot     12821: <td>cputime</td>
1.159     rillig   12822: <td>create-usergroup</td>
1.156     leot     12823: </tr>
                   12824: <tr>
1.166     leot     12825: <td>csh</td>
1.159     rillig   12826: <td>ctf</td>
1.161     leot     12827: </tr>
                   12828: <tr>
1.166     leot     12829: <td>cvs</td>
1.157     leot     12830: <td>debug</td>
1.156     leot     12831: </tr>
                   12832: <tr>
1.166     leot     12833: <td>declaration</td>
1.157     leot     12834: <td>declare</td>
1.156     leot     12835: </tr>
                   12836: <tr>
1.166     leot     12837: <td>defined</td>
1.157     leot     12838: <td>depend</td>
1.156     leot     12839: </tr>
                   12840: <tr>
1.166     leot     12841: <td>dependencies</td>
1.157     leot     12842: <td>depends</td>
1.156     leot     12843: </tr>
                   12844: <tr>
1.166     leot     12845: <td>depends-checksum</td>
1.157     leot     12846: <td>depends-fetch</td>
1.156     leot     12847: </tr>
                   12848: <tr>
1.166     leot     12849: <td>deps</td>
1.157     leot     12850: <td>describe</td>
1.156     leot     12851: </tr>
                   12852: <tr>
1.166     leot     12853: <td>destdir</td>
1.162     rillig   12854: <td>disable</td>
                   12855: </tr>
                   12856: <tr>
1.166     leot     12857: <td>distclean</td>
1.161     leot     12858: <td>distinfo</td>
1.156     leot     12859: </tr>
                   12860: <tr>
1.166     leot     12861: <td>dl</td>
1.161     leot     12862: <td>dlopen</td>
1.156     leot     12863: </tr>
                   12864: <tr>
1.166     leot     12865: <td>do-build</td>
1.161     leot     12866: <td>do-buildlink</td>
1.156     leot     12867: </tr>
                   12868: <tr>
1.166     leot     12869: <td>do-clean</td>
1.161     leot     12870: <td>do-configure-post-hook</td>
1.156     leot     12871: </tr>
                   12872: <tr>
1.166     leot     12873: <td>do-extract</td>
1.161     leot     12874: <td>do-fetch</td>
1.156     leot     12875: </tr>
                   12876: <tr>
1.166     leot     12877: <td>do-install</td>
1.160     brook    12878: <td>emul</td>
1.159     rillig   12879: </tr>
                   12880: <tr>
1.166     leot     12881: <td>emulation</td>
1.160     brook    12882: <td>emulator</td>
1.156     leot     12883: </tr>
                   12884: <tr>
1.166     leot     12885: <td>enable</td>
1.159     rillig   12886: <td>endian</td>
1.156     leot     12887: </tr>
                   12888: <tr>
1.166     leot     12889: <td>enomem</td>
1.159     rillig   12890: <td>err</td>
1.156     leot     12891: </tr>
                   12892: <tr>
1.166     leot     12893: <td>errx</td>
1.159     rillig   12894: <td>etc</td>
1.156     leot     12895: </tr>
                   12896: <tr>
1.166     leot     12897: <td>feature</td>
1.159     rillig   12898: <td>features</td>
1.156     leot     12899: </tr>
                   12900: <tr>
1.166     leot     12901: <td>fetch</td>
1.159     rillig   12902: <td>fetch-list</td>
1.156     leot     12903: </tr>
                   12904: <tr>
1.166     leot     12905: <td>follows</td>
1.159     rillig   12906: <td>forbids</td>
1.156     leot     12907: </tr>
                   12908: <tr>
1.166     leot     12909: <td>form</td>
1.159     rillig   12910: <td>format</td>
1.156     leot     12911: </tr>
                   12912: <tr>
1.166     leot     12913: <td>fortify</td>
1.159     rillig   12914: <td>fortify_source</td>
1.161     leot     12915: </tr>
                   12916: <tr>
1.166     leot     12917: <td>fossil</td>
1.157     leot     12918: <td>friend</td>
1.156     leot     12919: </tr>
                   12920: <tr>
1.166     leot     12921: <td>from</td>
1.157     leot     12922: <td>fts</td>
1.156     leot     12923: </tr>
                   12924: <tr>
1.166     leot     12925: <td>fts_close</td>
1.157     leot     12926: <td>fts_open</td>
1.156     leot     12927: </tr>
                   12928: <tr>
1.166     leot     12929: <td>fts_read</td>
1.157     leot     12930: <td>fts_set</td>
1.156     leot     12931: </tr>
                   12932: <tr>
1.166     leot     12933: <td>full</td>
1.157     leot     12934: <td>gcc</td>
1.156     leot     12935: </tr>
                   12936: <tr>
1.166     leot     12937: <td>getopt_long</td>
1.157     leot     12938: <td>getprogname</td>
1.156     leot     12939: </tr>
                   12940: <tr>
1.166     leot     12941: <td>gettext</td>
1.161     leot     12942: <td>git</td>
1.159     rillig   12943: </tr>
                   12944: <tr>
1.166     leot     12945: <td>github</td>
1.159     rillig   12946: <td>glob</td>
1.156     leot     12947: </tr>
                   12948: <tr>
1.166     leot     12949: <td>gnu</td>
1.159     rillig   12950: <td>gnu_configure_strict</td>
1.156     leot     12951: </tr>
                   12952: <tr>
1.166     leot     12953: <td>go</td>
1.159     rillig   12954: <td>go-deps</td>
1.156     leot     12955: </tr>
                   12956: <tr>
1.166     leot     12957: <td>golang</td>
1.159     rillig   12958: <td>guess-license</td>
1.156     leot     12959: </tr>
                   12960: <tr>
1.166     leot     12961: <td>hashbang</td>
1.159     rillig   12962: <td>heimdal</td>
1.156     leot     12963: </tr>
                   12964: <tr>
1.166     leot     12965: <td>help</td>
1.161     leot     12966: <td>hg</td>
                   12967: </tr>
                   12968: <tr>
1.166     leot     12969: <td>imake</td>
1.157     leot     12970: <td>increment</td>
1.156     leot     12971: </tr>
                   12972: <tr>
1.166     leot     12973: <td>interp</td>
1.157     leot     12974: <td>interpreter</td>
1.156     leot     12975: </tr>
                   12976: <tr>
1.166     leot     12977: <td>intl</td>
1.157     leot     12978: <td>iso</td>
1.156     leot     12979: </tr>
                   12980: <tr>
1.166     leot     12981: <td>kerberos</td>
1.157     leot     12982: <td>krb</td>
1.156     leot     12983: </tr>
                   12984: <tr>
1.166     leot     12985: <td>krb5</td>
1.157     leot     12986: <td>ksh</td>
1.156     leot     12987: </tr>
                   12988: <tr>
1.166     leot     12989: <td>lapack</td>
1.156     leot     12990: <td>latex</td>
1.159     rillig   12991: </tr>
                   12992: <tr>
1.166     leot     12993: <td>libnbcompat</td>
1.159     rillig   12994: <td>libs</td>
1.156     leot     12995: </tr>
                   12996: <tr>
1.166     leot     12997: <td>libtool</td>
1.159     rillig   12998: <td>licence</td>
1.156     leot     12999: </tr>
                   13000: <tr>
1.166     leot     13001: <td>license</td>
1.159     rillig   13002: <td>lintl</td>
1.156     leot     13003: </tr>
                   13004: <tr>
1.166     leot     13005: <td>little-endian</td>
1.159     rillig   13006: <td>lock</td>
1.156     leot     13007: </tr>
                   13008: <tr>
1.166     leot     13009: <td>locking</td>
1.159     rillig   13010: <td>lvalue</td>
1.156     leot     13011: </tr>
                   13012: <tr>
1.166     leot     13013: <td>make</td>
1.159     rillig   13014: <td>makesum</td>
1.156     leot     13015: </tr>
                   13016: <tr>
1.166     leot     13017: <td>memory</td>
1.161     leot     13018: <td>mercurial</td>
                   13019: </tr>
                   13020: <tr>
1.166     leot     13021: <td>meta</td>
1.158     brook    13022: <td>meta-package</td>
1.156     leot     13023: </tr>
                   13024: <tr>
1.166     leot     13025: <td>meta_package</td>
1.158     brook    13026: <td>mit-krb5</td>
1.156     leot     13027: </tr>
                   13028: <tr>
1.166     leot     13029: <td>mk.conf</td>
1.161     leot     13030: <td>mkl</td>
1.159     rillig   13031: </tr>
                   13032: <tr>
1.166     leot     13033: <td>mount</td>
1.159     rillig   13034: <td>mprotect</td>
1.156     leot     13035: </tr>
                   13036: <tr>
1.166     leot     13037: <td>mremap</td>
1.159     rillig   13038: <td>nb</td>
1.156     leot     13039: </tr>
                   13040: <tr>
1.166     leot     13041: <td>nbcompat</td>
1.159     rillig   13042: <td>no</td>
1.156     leot     13043: </tr>
                   13044: <tr>
1.166     leot     13045: <td>obstack</td>
1.159     rillig   13046: <td>obstack_ptr_grow</td>
1.156     leot     13047: </tr>
                   13048: <tr>
1.166     leot     13049: <td>occurs</td>
1.159     rillig   13050: <td>only</td>
1.161     leot     13051: </tr>
                   13052: <tr>
1.166     leot     13053: <td>openblas</td>
1.158     brook    13054: <td>options</td>
1.156     leot     13055: </tr>
                   13056: <tr>
1.166     leot     13057: <td>options.mk</td>
1.158     brook    13058: <td>order</td>
1.156     leot     13059: </tr>
                   13060: <tr>
1.166     leot     13061: <td>override</td>
1.158     brook    13062: <td>override-intltool</td>
1.156     leot     13063: </tr>
                   13064: <tr>
1.166     leot     13065: <td>override-message-intltool</td>
1.158     brook    13066: <td>package</td>
1.156     leot     13067: </tr>
                   13068: <tr>
1.166     leot     13069: <td>parallel</td>
1.158     brook    13070: <td>partial</td>
1.156     leot     13071: </tr>
                   13072: <tr>
1.166     leot     13073: <td>path</td>
1.158     brook    13074: <td>pax</td>
1.156     leot     13075: </tr>
                   13076: <tr>
1.166     leot     13077: <td>paxctl</td>
1.158     brook    13078: <td>pbulk-index</td>
1.156     leot     13079: </tr>
                   13080: <tr>
1.166     leot     13081: <td>pc</td>
1.158     brook    13082: <td>perl</td>
1.156     leot     13083: </tr>
                   13084: <tr>
1.166     leot     13085: <td>perl5</td>
1.158     brook    13086: <td>perms</td>
1.156     leot     13087: </tr>
                   13088: <tr>
1.166     leot     13089: <td>php</td>
1.158     brook    13090: <td>pkg-build-options</td>
1.156     leot     13091: </tr>
                   13092: <tr>
1.166     leot     13093: <td>pkg-config</td>
1.158     brook    13094: <td>pkg_build_options</td>
1.156     leot     13095: </tr>
                   13096: <tr>
1.166     leot     13097: <td>platform</td>
1.158     brook    13098: <td>plist</td>
1.156     leot     13099: </tr>
                   13100: <tr>
1.166     leot     13101: <td>post-extract</td>
1.158     brook    13102: <td>post-fetch</td>
1.156     leot     13103: </tr>
                   13104: <tr>
1.166     leot     13105: <td>post-wrapper</td>
1.158     brook    13106: <td>pre-configure</td>
1.156     leot     13107: </tr>
                   13108: <tr>
1.166     leot     13109: <td>pre-extract</td>
1.158     brook    13110: <td>pre-fetch</td>
1.156     leot     13111: </tr>
                   13112: <tr>
1.166     leot     13113: <td>print-go-deps</td>
1.158     brook    13114: <td>print-plist</td>
1.156     leot     13115: </tr>
                   13116: <tr>
1.166     leot     13117: <td>print-summary-data</td>
1.158     brook    13118: <td>privileged-install-hook</td>
1.156     leot     13119: </tr>
                   13120: <tr>
1.166     leot     13121: <td>pypi</td>
1.158     brook    13122: <td>python</td>
1.156     leot     13123: </tr>
                   13124: <tr>
1.166     leot     13125: <td>readme-all</td>
1.158     brook    13126: <td>regcomp</td>
1.156     leot     13127: </tr>
                   13128: <tr>
1.166     leot     13129: <td>relro</td>
1.158     brook    13130: <td>rename</td>
1.156     leot     13131: </tr>
                   13132: <tr>
1.166     leot     13133: <td>reorder</td>
1.158     brook    13134: <td>replace</td>
1.156     leot     13135: </tr>
                   13136: <tr>
1.166     leot     13137: <td>replace_interpreter</td>
1.158     brook    13138: <td>reproducible</td>
1.156     leot     13139: </tr>
                   13140: <tr>
1.166     leot     13141: <td>resolv</td>
1.158     brook    13142: <td>root</td>
1.156     leot     13143: </tr>
                   13144: <tr>
1.166     leot     13145: <td>ruby</td>
1.158     brook    13146: <td>setenv</td>
1.156     leot     13147: </tr>
                   13148: <tr>
1.166     leot     13149: <td>setgid</td>
1.158     brook    13150: <td>setprogname</td>
1.156     leot     13151: </tr>
                   13152: <tr>
1.166     leot     13153: <td>setuid</td>
1.158     brook    13154: <td>sh</td>
1.156     leot     13155: </tr>
                   13156: <tr>
1.166     leot     13157: <td>show</td>
1.158     brook    13158: <td>show-all</td>
1.156     leot     13159: </tr>
                   13160: <tr>
1.166     leot     13161: <td>show-build-defs</td>
1.158     brook    13162: <td>show-depends</td>
1.156     leot     13163: </tr>
                   13164: <tr>
1.166     leot     13165: <td>show-deps</td>
1.158     brook    13166: <td>show-distfiles</td>
1.156     leot     13167: </tr>
                   13168: <tr>
1.166     leot     13169: <td>show-downlevel</td>
1.158     brook    13170: <td>show-subdir-var</td>
1.156     leot     13171: </tr>
                   13172: <tr>
1.166     leot     13173: <td>show-tools</td>
1.158     brook    13174: <td>show-var</td>
1.156     leot     13175: </tr>
                   13176: <tr>
1.166     leot     13177: <td>show-vars</td>
1.158     brook    13178: <td>snprintf</td>
1.156     leot     13179: </tr>
                   13180: <tr>
1.166     leot     13181: <td>ssp</td>
1.158     brook    13182: <td>st_mode</td>
1.156     leot     13183: </tr>
                   13184: <tr>
1.166     leot     13185: <td>stage-install</td>
1.162     rillig   13186: <td>strict</td>
                   13187: </tr>
                   13188: <tr>
1.166     leot     13189: <td>strip</td>
1.161     leot     13190: <td>strnlen</td>
1.156     leot     13191: </tr>
                   13192: <tr>
1.166     leot     13193: <td>strong</td>
1.161     leot     13194: <td>subst</td>
1.156     leot     13195: </tr>
                   13196: <tr>
1.166     leot     13197: <td>subversion</td>
1.160     brook    13198: <td>sun</td>
1.159     rillig   13199: </tr>
                   13200: <tr>
1.166     leot     13201: <td>sunpro</td>
1.156     leot     13202: <td>sunwspro</td>
                   13203: </tr>
                   13204: <tr>
1.166     leot     13205: <td>svn</td>
1.161     leot     13206: <td>symlink</td>
                   13207: </tr>
                   13208: <tr>
1.166     leot     13209: <td>test</td>
1.157     leot     13210: <td>tex</td>
1.156     leot     13211: </tr>
                   13212: <tr>
1.166     leot     13213: <td>texlive</td>
1.157     leot     13214: <td>tmp</td>
1.156     leot     13215: </tr>
                   13216: <tr>
1.166     leot     13217: <td>tool</td>
1.157     leot     13218: <td>tools</td>
1.156     leot     13219: </tr>
                   13220: <tr>
1.166     leot     13221: <td>tools-libtool-m4-override</td>
1.157     leot     13222: <td>type</td>
1.156     leot     13223: </tr>
                   13224: <tr>
1.166     leot     13225: <td>ulimit</td>
1.157     leot     13226: <td>undefined</td>
1.156     leot     13227: </tr>
                   13228: <tr>
1.166     leot     13229: <td>undo-replace</td>
1.157     leot     13230: <td>unlimit</td>
1.156     leot     13231: </tr>
                   13232: <tr>
1.166     leot     13233: <td>unprivileged</td>
1.157     leot     13234: <td>unprivileged-install-hook</td>
1.156     leot     13235: </tr>
                   13236: <tr>
1.166     leot     13237: <td>unstripped</td>
1.157     leot     13238: <td>update</td>
1.156     leot     13239: </tr>
                   13240: <tr>
1.166     leot     13241: <td>upload</td>
1.157     leot     13242: <td>upload-distfiles</td>
1.156     leot     13243: </tr>
                   13244: <tr>
1.166     leot     13245: <td>usage</td>
1.157     leot     13246: <td>use_tools</td>
1.156     leot     13247: </tr>
                   13248: <tr>
1.166     leot     13249: <td>user</td>
1.157     leot     13250: <td>utimes</td>
1.156     leot     13251: </tr>
                   13252: <tr>
1.166     leot     13253: <td>vasprintf</td>
1.157     leot     13254: <td>verbose</td>
1.156     leot     13255: </tr>
                   13256: <tr>
1.166     leot     13257: <td>vsnprintf</td>
1.157     leot     13258: <td>warn</td>
1.156     leot     13259: </tr>
                   13260: <tr>
1.166     leot     13261: <td>warning</td>
1.157     leot     13262: <td>warnings</td>
1.156     leot     13263: </tr>
                   13264: <tr>
1.166     leot     13265: <td>warnx</td>
1.157     leot     13266: <td>weak</td>
1.156     leot     13267: </tr>
                   13268: <tr>
1.166     leot     13269: <td>work</td>
1.157     leot     13270: <td>wrapper</td>
1.156     leot     13271: </tr>
                   13272: <tr>
1.166     leot     13273: <td>wrkdir</td>
1.156     leot     13274: <td>yes</td>
                   13275: </tr>
                   13276: </table>
1.154     rillig   13277: </div>
                   13278: <div class="appendix">
                   13279: <div class="titlepage"><div><div><h1 class="title">
                   13280: <a name="editing"></a>Appendix E. Editing guidelines for the pkgsrc guide</h1></div></div></div>
1.1       dsieger  13281: <div class="toc">
                   13282: <p><b>Table of Contents</b></p>
1.100     leot     13283: <dl class="toc">
1.154     rillig   13284: <dt><span class="sect1"><a href="#targets">E.1. Make targets</a></span></dt>
                   13285: <dt><span class="sect1"><a href="#procedure">E.2. Procedure</a></span></dt>
1.1       dsieger  13286: </dl>
                   13287: </div>
                   13288: <p>This section contains information on editing the pkgsrc
                   13289:        guide itself.</p>
1.41      asau     13290: <div class="sect1">
1.1       dsieger  13291: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   13292: <a name="targets"></a>E.1. Make targets</h2></div></div></div>
1.1       dsieger  13293: <p>The pkgsrc guide's source code is stored in
                   13294:        <code class="filename">pkgsrc/doc/guide/files</code>, and several files
                   13295:        are created from it:</p>
1.41      asau     13296: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      13297: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
                   13298: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
                   13299: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/docs/pkgsrc/" target="_top">http://www.NetBSD.org/docs/pkgsrc/</a></p></li>
                   13300: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf" target="_top">http://www.NetBSD.org/docs/pkgsrc/pkgsrc.pdf</a>:
1.1       dsieger  13301:        The PDF version of the pkgsrc guide.</p></li>
1.23      wiz      13302: <li class="listitem"><p><a class="ulink" href="http://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps" target="_top">http://www.NetBSD.org/docs/pkgsrc/pkgsrc.ps</a>:
1.1       dsieger  13303:        PostScript version of the pkgsrc guide.</p></li>
                   13304: </ul></div>
                   13305: </div>
1.41      asau     13306: <div class="sect1">
1.1       dsieger  13307: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   13308: <a name="procedure"></a>E.2. Procedure</h2></div></div></div>
1.1       dsieger  13309: <p>The procedure to edit the pkgsrc guide is:</p>
1.23      wiz      13310: <div class="procedure"><ol class="procedure" type="1">
1.41      asau     13311: <li class="step"><p>Make sure you have the packages needed to
1.1       dsieger  13312:        regenerate the pkgsrc guide (and other XML-based NetBSD
1.45      obache   13313:        documentation) installed. These are automatically installed when
1.137     leot     13314:        you install the <a href="https://cdn.NetBSD.org/pub/pkgsrc/current/pkgsrc/meta-pkgs/pkgsrc-guide-tools/README.html" target="_top"><code class="filename">meta-pkgs/pkgsrc-guide-tools</code></a> package.</p></li>
1.41      asau     13315: <li class="step"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.1       dsieger  13316:        right directory. All further steps will take place
                   13317:        here.</p></li>
1.41      asau     13318: <li class="step"><p>Edit the XML file(s) in
1.1       dsieger  13319:        <code class="filename">files/</code>.</p></li>
1.41      asau     13320: <li class="step"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.1       dsieger  13321:        guide for valid XML and to build the final output files. If you
                   13322:        get any errors at this stage, you can just edit the files, as
                   13323:        there are only symbolic links in the working directory, pointing
                   13324:        to the files in <code class="filename">files/</code>.</p></li>
1.41      asau     13325: <li class="step"><p><span class="command"><strong>(cd files &amp;&amp; cvs
1.1       dsieger  13326:        commit)</strong></span></p></li>
1.41      asau     13327: <li class="step"><p>Run <span class="command"><strong>bmake clean &amp;&amp; bmake</strong></span> to
1.1       dsieger  13328:        regenerate the output files with the proper RCS
                   13329:        Ids.</p></li>
1.41      asau     13330: <li class="step">
1.10      hubertf  13331: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.1       dsieger  13332:        commit the files in both <code class="filename">pkgsrc/doc</code> and
                   13333:        <code class="filename">htdocs</code>.</p>
1.41      asau     13334: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  13335: <h3 class="title">Note</h3>
                   13336: <p>If you have added, removed or renamed some chapters,
1.10      hubertf  13337:        you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
                   13338:        <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.1       dsieger  13339:        directory.</p>
                   13340: </div>
                   13341: </li>
                   13342: </ol></div>
                   13343: </div>
                   13344: </div>
                   13345: </div></body>
                   13346: </html>

CVSweb <webmaster@jp.NetBSD.org>