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

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.146     jnemeth    33: <div><p class="copyright">Copyright © 1994-2019 The NetBSD Foundation, Inc</p></div>
1.155     sevan      34: <div><p class="pubdate">$NetBSD: pkgsrc.xml,v 1.35 2019/04/28 15:22:24 rillig 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>
                    922:        The pkgsrc-users mailing list, to which
                    923:        <a class="ulink" href="https://www.NetBSD.org/mailinglists/#pkgsrc-users" target="_top">you
                    924:        can subscribe</a> and then <a class="ulink" href="mailto:pkgsrc-users@NetBSD.org" target="_top">ask your
                    925:        questions</a>.</p></li>
                    926: <li class="listitem"><p>The #pkgsrc IRC channel, which is accessible
                    927:        <a class="ulink" href="https://webchat.freenode.net/" target="_top">via a web browser</a>
                    928:        or by using a specialized chat program such as
                    929:        <a class="ulink" href="http://xchat.org/" target="_top">XChat</a>.
                    930:        Pick any user name and join the channel #pkgsrc.</p></li>
                    931: </ul></div>
                    932: </div>
                    933: <div class="chapter">
                    934: <div class="titlepage"><div><div><h2 class="title">
                    935: <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   936: <div class="toc">
                    937: <p><b>Table of Contents</b></p>
1.100     leot      938: <dl class="toc">
1.154     rillig    939: <dt><span class="sect1"><a href="#getting-first">3.1. Getting pkgsrc for the first time</a></span></dt>
1.1       dsieger   940: <dd><dl>
1.154     rillig    941: <dt><span class="sect2"><a href="#getting-via-tar">3.1.1. As tar archive</a></span></dt>
                    942: <dt><span class="sect2"><a href="#getting-via-cvs">3.1.2. Via anonymous CVS</a></span></dt>
1.1       dsieger   943: </dl></dd>
1.154     rillig    944: <dt><span class="sect1"><a href="#uptodate">3.2. Keeping pkgsrc up-to-date</a></span></dt>
1.1       dsieger   945: <dd><dl>
1.154     rillig    946: <dt><span class="sect2"><a href="#uptodate-tar">3.2.1. Via tar files</a></span></dt>
                    947: <dt><span class="sect2"><a href="#uptodate-cvs">3.2.2. Via CVS</a></span></dt>
1.1       dsieger   948: </dl></dd>
                    949: </dl>
                    950: </div>
                    951: <p>Before you download and extract the files, you need to decide
                    952: where you want to extract them. When using pkgsrc as root user, pkgsrc
                    953: is usually installed in <code class="filename">/usr/pkgsrc</code>. You are though
                    954: free to install the sources and binary packages wherever you want in
                    955: your filesystem, provided that the pathname does not contain white-space
                    956: or other characters that are interpreted specially by the shell and some
                    957: other programs. A safe bet is to use only letters, digits, underscores
                    958: and dashes.</p>
1.41      asau      959: <div class="sect1">
1.1       dsieger   960: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig    961: <a name="getting-first"></a>3.1. Getting pkgsrc for the first time</h2></div></div></div>
1.1       dsieger   962: <p>Before you download any pkgsrc files, you should decide
                    963:        whether you want the <span class="emphasis"><em>current</em></span> branch or the
                    964:        <span class="emphasis"><em>stable</em></span> branch. The latter is forked on a
                    965:        quarterly basis from the current branch and only gets modified
                    966:        for security updates. The names of the stable branches are built
                    967:        from the year and the quarter, for example
1.157     leot      968:        <code class="literal">2019Q2</code>.</p>
1.1       dsieger   969: <p>The second step is to decide <span class="emphasis"><em>how</em></span> you
1.23      wiz       970:        want to download pkgsrc. You can get it as a tar file or via CVS.
                    971:        Both ways are described here.</p>
1.51      asau      972: <p>Note that tar archive contains CVS working copy.
                    973:        Thus you can switch to using CVS at any later time.</p>
1.41      asau      974: <div class="sect2">
1.1       dsieger   975: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig    976: <a name="getting-via-tar"></a>3.1.1. As tar archive</h3></div></div></div>
1.1       dsieger   977: <p>The primary download location for all pkgsrc files is
1.151     sevan     978:        <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/" target="_top">https://cdn.NetBSD.org/pub/pkgsrc/</a> or
1.51      asau      979:        <a class="ulink" href="ftp://ftp.NetBSD.org/pub/pkgsrc/" target="_top">ftp://ftp.NetBSD.org/pub/pkgsrc/</a>
                    980:        (it points to the same location).
                    981:        There are a number of subdirectories for different purposes,
                    982:        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>
                    983: <p>The tar archive for the current branch is in the directory
1.151     sevan     984:        <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     985:        It is autogenerated weekly.</p>
1.51      asau      986: <p>To save download time we provide bzip2- and
                    987:        xz-compressed archives which are published at
1.151     sevan     988:        <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      989:        and
1.151     sevan     990:        <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      991:        respectively.
                    992:        </p>
                    993: <p>You can fetch the same files using FTP.</p>
1.157     leot      994: <p>The tar file for the stable branch 2019Q2 is in the
                    995:        directory <code class="filename">pkgsrc-2019Q2</code> and is also called <a class="ulink" href="https://cdn.NetBSD.org/pub/pkgsrc/pkgsrc-2019Q2/pkgsrc.tar.gz" target="_top"><code class="filename">pkgsrc.tar.gz</code></a>.</p>
1.136     leot      996: <p>To download the latest pkgsrc stable tarball, run:</p>
1.12      weinem    997: <pre class="screen">
1.157     leot      998: <code class="prompt">$</code> <strong class="userinput"><code>ftp ftp://ftp.NetBSD.org/pub/pkgsrc/pkgsrc-2019Q2/pkgsrc.tar.gz</code></strong></pre>
1.78      snj       999: <p>If you prefer, you can also fetch it using "wget", "curl",
1.51      asau     1000:        or your web browser.</p>
1.12      weinem   1001: <p>Then, extract it with:</p>
1.78      snj      1002: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>tar -xzf pkgsrc.tar.gz -C /usr</code></strong></pre>
1.12      weinem   1003: <p>This will create the directory <code class="filename">pkgsrc/</code>
                   1004:        in <code class="filename">/usr/</code> and all the package source will be 
                   1005:        stored under <code class="filename">/usr/pkgsrc/</code>.</p>
                   1006: <p>To download pkgsrc-current, run:</p>
                   1007: <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  1008: </div>
1.41      asau     1009: <div class="sect2">
1.1       dsieger  1010: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   1011: <a name="getting-via-cvs"></a>3.1.2. Via anonymous CVS</h3></div></div></div>
1.23      wiz      1012: <p>To fetch a specific pkgsrc stable branch, run:</p>
1.157     leot     1013: <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-2019Q2 -P pkgsrc</code></strong>
1.23      wiz      1014: </pre>
                   1015: <p>This will create the directory <code class="filename">pkgsrc/</code> 
                   1016:        in your <code class="filename">/usr/</code> directory and all the package source 
                   1017:        will be stored under <code class="filename">/usr/pkgsrc/</code>.</p>
                   1018: <p>To fetch the pkgsrc current branch, run:</p>
1.39      wiz      1019: <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  1020: </pre>
1.78      snj      1021: <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      1022: <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      1023: <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      1024: </pre>
                   1025: <p>Refer to documentation on your command shell how to set CVS_RSH=ssh permanently.
                   1026:        For Bourne shells, you can set it in your <code class="filename">.profile</code>
                   1027:        or better globally in <code class="filename">/etc/profile</code>:</p>
                   1028: <pre class="programlisting">
                   1029: # set CVS remote shell command
                   1030: CVS_RSH=ssh
                   1031: export CVS_RSH
                   1032: </pre>
                   1033: <p>By default, CVS doesn't do things like most people would expect it to do.
                   1034:        But there is a way to convince CVS, by creating a file called <code class="filename">.cvsrc</code>
                   1035:        in your home directory and saving the following lines to it.
                   1036:        This file will save you lots of headache and some bug reports, so we strongly recommend it.
                   1037:        You can find an explanation of this file in the CVS documentation.</p>
1.2       rillig   1038: <pre class="programlisting">
                   1039: # recommended CVS configuration file from the pkgsrc guide
1.155     sevan    1040: cvs -q
1.2       rillig   1041: checkout -P
1.4       rillig   1042: update -dP
                   1043: diff -upN
1.2       rillig   1044: rdiff -u
1.23      wiz      1045: release -d
1.2       rillig   1046: </pre>
1.1       dsieger  1047: </div>
                   1048: </div>
1.41      asau     1049: <div class="sect1">
1.1       dsieger  1050: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   1051: <a name="uptodate"></a>3.2. Keeping pkgsrc up-to-date</h2></div></div></div>
1.1       dsieger  1052: <p>The preferred way to keep pkgsrc up-to-date is via CVS
                   1053:        (which also works if you have first installed it via a tar
                   1054:        file). It saves bandwidth and hard disk activity, compared to
                   1055:        downloading the tar file again.</p>
1.41      asau     1056: <div class="sect2">
1.1       dsieger  1057: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   1058: <a name="uptodate-tar"></a>3.2.1. Via tar files</h3></div></div></div>
1.41      asau     1059: <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  1060: <h3 class="title">Warning</h3>
                   1061: <p>When updating from a tar file, you first need to
                   1062:        completely remove the old pkgsrc directory. Otherwise those
                   1063:        files that have been removed from pkgsrc in the mean time will
                   1064:        not be removed on your local disk, resulting in inconsistencies.
                   1065:        When removing the old files, any changes that you have done to
                   1066:        the pkgsrc files will be lost after updating. Therefore updating
                   1067:        via CVS is strongly recommended.</p>
                   1068: </div>
                   1069: <p>Note that by default the distfiles and the binary packages
                   1070:        are saved in the pkgsrc tree, so don't forget to rescue them
1.78      snj      1071:        before updating. You can also configure pkgsrc to store distfiles
                   1072:         and packages in directories outside the pkgsrc tree by setting the
1.1       dsieger  1073:        <code class="varname">DISTDIR</code> and <code class="varname">PACKAGES</code>
1.154     rillig   1074:        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  1075: <p>To update pkgsrc from a tar file, download the tar file as
                   1076:        explained above. Then, make sure that you have not made any
                   1077:        changes to the files in the pkgsrc directory. Remove the pkgsrc
                   1078:        directory and extract the new tar file. Done.</p>
                   1079: </div>
1.41      asau     1080: <div class="sect2">
1.1       dsieger  1081: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   1082: <a name="uptodate-cvs"></a>3.2.2. Via CVS</h3></div></div></div>
1.25      spz      1083: <p>To update pkgsrc via CVS, change to the <code class="filename">pkgsrc</code> directory and run cvs:</p>
                   1084: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>cd /usr/pkgsrc &amp;&amp; cvs update -dP</code></strong>
                   1085: </pre>
                   1086: <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>
                   1087: <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>
                   1088: </pre>
1.41      asau     1089: <div class="sect3">
1.1       dsieger  1090: <div class="titlepage"><div><div><h4 class="title">
1.154     rillig   1091: <a name="uptodate-cvs-switch"></a>3.2.2.1. Switching between different pkgsrc branches</h4></div></div></div>
1.1       dsieger  1092: <p>When updating pkgsrc, the CVS program keeps track of the
                   1093:        branch you selected. But if you, for whatever reason, want to
                   1094:        switch from the stable branch to the current one, you can do it
1.23      wiz      1095:        by adding the option <span class="quote">&#8220;<span class="quote">-A</span>&#8221;</span> after the
                   1096:        <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> keyword. To switch from the current branch
1.1       dsieger  1097:        back to the stable branch, add the
1.157     leot     1098:        <span class="quote">&#8220;<span class="quote">-rpkgsrc-2019Q2</span>&#8221;</span> option.</p>
1.1       dsieger  1099: </div>
1.41      asau     1100: <div class="sect3">
1.1       dsieger  1101: <div class="titlepage"><div><div><h4 class="title">
1.154     rillig   1102: <a name="uptodate-cvs-changes"></a>3.2.2.2. What happens to my changes when updating?</h4></div></div></div>
1.1       dsieger  1103: <p>When you update pkgsrc, the CVS program will only touch
                   1104:        those files that are registered in the CVS repository. That
                   1105:        means that any packages that you created on your own will stay
                   1106:        unmodified. If you change files that are managed by CVS, later
                   1107:        updates will try to merge your changes with those that have been
                   1108:        done by others. See the CVS manual, chapter
1.23      wiz      1109:        <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> for details.</p>
1.1       dsieger  1110: </div>
                   1111: </div>
                   1112: </div>
                   1113: </div>
1.41      asau     1114: <div class="chapter">
1.1       dsieger  1115: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   1116: <a name="platforms"></a>Chapter 4. Using pkgsrc on systems other than NetBSD</h2></div></div></div>
1.1       dsieger  1117: <div class="toc">
                   1118: <p><b>Table of Contents</b></p>
1.100     leot     1119: <dl class="toc">
1.154     rillig   1120: <dt><span class="sect1"><a href="#binarydist">4.1. Binary distribution</a></span></dt>
                   1121: <dt><span class="sect1"><a href="#bootstrapping-pkgsrc">4.2. Bootstrapping pkgsrc</a></span></dt>
1.1       dsieger  1122: </dl>
                   1123: </div>
1.41      asau     1124: <div class="sect1">
1.1       dsieger  1125: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   1126: <a name="binarydist"></a>4.1. Binary distribution</h2></div></div></div>
                   1127: <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  1128: </div>
1.41      asau     1129: <div class="sect1">
1.1       dsieger  1130: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   1131: <a name="bootstrapping-pkgsrc"></a>4.2. Bootstrapping pkgsrc</h2></div></div></div>
1.43      asau     1132: <p>pkgsrc can be bootstrapped for use in two different modes:
                   1133:     privileged and unprivileged one. In unprivileged mode in contrast
1.44      asau     1134:     to privileged one all programs are installed under one particular user
1.43      asau     1135:     and cannot utilise privileged operations (packages don't create
                   1136:     special users and all special file permissions like setuid are ignored).
                   1137:     </p>
1.1       dsieger  1138: <p>Installing the bootstrap kit from source should be as simple as:</p>
                   1139: <pre class="screen">
1.60      asau     1140: <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  1141: <code class="prompt">#</code> <strong class="userinput"><code>cd pkgsrc/bootstrap</code></strong>
                   1142: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap</code></strong>
                   1143:     </pre>
1.43      asau     1144: <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>
                   1145: <p>By default, in privileged mode pkgsrc uses
                   1146:     <code class="filename">/usr/pkg</code> for <span class="emphasis"><em>prefix</em></span>
                   1147:     where programs will be installed in,
1.118     sevan    1148:     and <code class="filename">/usr/pkg/pkgdb</code> for the package database
1.43      asau     1149:     directory where pkgsrc will do its internal bookkeeping,
                   1150:     <code class="filename">/var</code> is used as <span class="emphasis"><em>varbase</em></span>,
                   1151:     where packages install their persistent data.
                   1152:     In unprivileged mode pkgsrc uses
                   1153:     <code class="filename">~/pkg</code> for <span class="emphasis"><em>prefix</em></span>,
1.118     sevan    1154:     <code class="filename">~/pkg/pkgdb</code> for the package database,
1.43      asau     1155:     and <code class="filename">~/pkg/var</code> for <span class="emphasis"><em>varbase</em></span>.
                   1156:     </p>
                   1157: <p>You can change default layout using command-line arguments.
                   1158:     Run <span class="quote">&#8220;<span class="quote">./bootstrap --help</span>&#8221;</span> to get details.
                   1159:     </p>
1.41      asau     1160: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  1161: <h3 class="title">Note</h3>
1.10      hubertf  1162: <p>The bootstrap installs a <span class="command"><strong>bmake</strong></span> tool.
                   1163:       Use this <span class="command"><strong>bmake</strong></span> when building via pkgsrc.
                   1164:       For examples in this guide, use <span class="command"><strong>bmake</strong></span>
1.23      wiz      1165:       instead of <span class="quote">&#8220;<span class="quote">make</span>&#8221;</span>.</p>
1.1       dsieger  1166: </div>
1.43      asau     1167: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   1168: <h3 class="title">Note</h3>
                   1169: <p>It is possible to bootstrap multiple instances of pkgsrc
                   1170:       using non-intersecting directories. Use <span class="command"><strong>bmake</strong></span>
                   1171:       corresponding to the installation you're working with to build
                   1172:       and install packages.
                   1173:       </p>
                   1174: </div>
1.1       dsieger  1175: </div>
                   1176: </div>
1.41      asau     1177: <div class="chapter">
1.1       dsieger  1178: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   1179: <a name="using"></a>Chapter 5. Using pkgsrc</h2></div></div></div>
1.1       dsieger  1180: <div class="toc">
                   1181: <p><b>Table of Contents</b></p>
1.100     leot     1182: <dl class="toc">
1.154     rillig   1183: <dt><span class="sect1"><a href="#using-pkg">5.1. Using binary packages</a></span></dt>
1.1       dsieger  1184: <dd><dl>
1.154     rillig   1185: <dt><span class="sect2"><a href="#finding-binary-packages">5.1.1. Finding binary packages</a></span></dt>
                   1186: <dt><span class="sect2"><a href="#installing-binary-packages">5.1.2. Installing binary packages</a></span></dt>
                   1187: <dt><span class="sect2"><a href="#using.pkg_delete">5.1.3. Deinstalling packages</a></span></dt>
                   1188: <dt><span class="sect2"><a href="#using.pkg_info">5.1.4. Getting information about installed packages</a></span></dt>
                   1189: <dt><span class="sect2"><a href="#vulnerabilities">5.1.5. Checking for security vulnerabilities in installed packages</a></span></dt>
                   1190: <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>
                   1191: <dt><span class="sect2"><a href="#using.pkg_admin">5.1.7. Other administrative functions</a></span></dt>
                   1192: </dl></dd>
                   1193: <dt><span class="sect1"><a href="#building-packages-from-source">5.2. Building packages from source</a></span></dt>
                   1194: <dd><dl>
                   1195: <dt><span class="sect2"><a href="#requirements">5.2.1. Requirements</a></span></dt>
                   1196: <dt><span class="sect2"><a href="#fetching-distfiles">5.2.2. Fetching distfiles</a></span></dt>
                   1197: <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  1198: </dl></dd>
                   1199: </dl>
                   1200: </div>
                   1201: <p>Basically, there are two ways of using pkgsrc. The first
                   1202: is to only install the package tools and to use binary packages
1.23      wiz      1203: that someone else has prepared. This is the <span class="quote">&#8220;<span class="quote">pkg</span>&#8221;</span>
                   1204: in pkgsrc. The second way is to install the <span class="quote">&#8220;<span class="quote">src</span>&#8221;</span>
1.1       dsieger  1205: of pkgsrc, too. Then you are able to build your own packages,
                   1206: and you can still use binary packages from someone else.</p>
1.41      asau     1207: <div class="sect1">
1.1       dsieger  1208: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   1209: <a name="using-pkg"></a>5.1. Using binary packages</h2></div></div></div>
1.151     sevan    1210: <p>On the <a class="ulink" href="https://cdn.NetBSD.org/" target="_top">cdn.NetBSD.org</a>
                   1211:   site and mirrors, there are collections of binary packages,
1.9       rillig   1212:   ready to be installed. These binary packages have been built using the
                   1213:   default settings for the directories, that is:</p>
1.41      asau     1214: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      1215: <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>
                   1216: <li class="listitem"><p><code class="filename">/usr/pkg/etc</code> for configuration files,</p></li>
                   1217: <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   1218: </ul></div>
                   1219: <p>If you cannot use these directories for whatever reasons (maybe
                   1220:   because you're not root), you cannot use these binary packages, but
1.154     rillig   1221:   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     1222: <div class="sect2">
1.1       dsieger  1223: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   1224: <a name="finding-binary-packages"></a>5.1.1. Finding binary packages</h3></div></div></div>
1.5       weinem   1225: <p>To install binary packages, you first need to know from where
                   1226:     to get them. The first place where you should look is on the main
1.151     sevan    1227:     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   1228: <p>This directory contains binary packages for multiple
                   1229:     platforms. First, select your operating system. (Ignore the
                   1230:     directories with version numbers attached to it, they just exist for
                   1231:     legacy reasons.) Then, select your hardware architecture, and in the
1.23      wiz      1232:     third step, the OS version and the <span class="quote">&#8220;<span class="quote">version</span>&#8221;</span> of pkgsrc.</p>
1.9       rillig   1233: <p>In this directory, you often find a file called
                   1234:     <code class="filename">bootstrap.tar.gz</code> which contains the package
                   1235:     management tools. If the file is missing, it is likely that your
                   1236:     operating system already provides those tools. Download the file and
                   1237:     extract it in the <code class="filename">/</code> directory. It will create
                   1238:     the directories <code class="filename">/usr/pkg</code> (containing the tools
1.118     sevan    1239:     for managing binary packages and the database of installed packages).</p>
1.1       dsieger  1240: </div>
1.41      asau     1241: <div class="sect2">
1.1       dsieger  1242: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   1243: <a name="installing-binary-packages"></a>5.1.2. Installing binary packages</h3></div></div></div>
1.9       rillig   1244: <p>In the directory from the last section, there is a
1.85      wiz      1245:     subdirectory called <code class="filename">All/</code>, which contains all the
1.9       rillig   1246:     binary packages that are available for the platform, excluding those
                   1247:     that may not be distributed via FTP or CDROM (depending on which
1.23      wiz      1248:     medium you are using).</p>
1.9       rillig   1249: <p>To install packages directly from an FTP or HTTP server, run
                   1250:     the following commands in a Bourne-compatible shell (be sure to
1.10      hubertf  1251:     <span class="command"><strong>su</strong></span> to root first):</p>
1.9       rillig   1252: <pre class="screen">
                   1253: <code class="prompt">#</code> <strong class="userinput"><code>PATH="/usr/pkg/sbin:$PATH"</code></strong>
1.151     sevan    1254: <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   1255: <code class="prompt">#</code> <strong class="userinput"><code>export PATH PKG_PATH</code></strong>
                   1256: </pre>
                   1257: <p>Instead of URLs, you can also use local paths, for example if
                   1258:     you are installing from a set of CDROMs, DVDs or an NFS-mounted
                   1259:     repository. If you want to install packages from multiple sources,
                   1260:     you can separate them by a semicolon in
                   1261:     <code class="varname">PKG_PATH</code>.</p>
                   1262: <p>After these preparations, installing a package is very
                   1263:     easy:</p>
                   1264: <pre class="screen">
1.118     sevan    1265: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add libreoffice</code></strong>
                   1266: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add ap24-php71-*</code></strong>
1.9       rillig   1267: </pre>
1.1       dsieger  1268: <p>Note that any prerequisite packages needed to run the
                   1269:     package in question will be installed, too, assuming they are
                   1270:     present where you install from.</p>
1.23      wiz      1271: <p>Adding packages might install vulnerable packages.
                   1272:     Thus you should run <span class="command"><strong>pkg_admin audit</strong></span>
1.14      jmcneill 1273:     regularly, especially after installing new packages, and verify
                   1274:     that the vulnerabilities are acceptable for your configuration.</p>
1.1       dsieger  1275: <p>After you've installed packages, be sure to have
                   1276:     <code class="filename">/usr/pkg/bin</code> and <code class="filename">/usr/pkg/sbin</code> in your
                   1277:     <code class="varname">PATH</code> so you can actually start the just
                   1278:     installed program.</p>
                   1279: </div>
1.41      asau     1280: <div class="sect2">
1.1       dsieger  1281: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   1282: <a name="using.pkg_delete"></a>5.1.3. Deinstalling packages</h3></div></div></div>
1.1       dsieger  1283: <p>To deinstall a package, it does not matter whether it was
                   1284:     installed from source code or from a binary package. The
1.10      hubertf  1285:     <span class="command"><strong>pkg_delete</strong></span> command does not know it anyway.
                   1286:     To delete a package, you can just run <span class="command"><strong>pkg_delete
1.1       dsieger  1287:     <em class="replaceable"><code>package-name</code></em></strong></span>. The package
                   1288:     name can be given with or without version number. Wildcards can
                   1289:     also be used to deinstall a set of packages, for example
                   1290:     <code class="literal">*emacs*</code>. Be sure to include them in quotes,
                   1291:     so that the shell does not expand them before
                   1292:     <code class="literal">pkg_delete</code> sees them.</p>
                   1293: <p>The <code class="option">-r</code> option is very powerful: it
                   1294:     removes all the packages that require the package in question
                   1295:     and then removes the package itself. For example:
                   1296: 
                   1297:     </p>
                   1298: <pre class="screen">
                   1299: <code class="prompt">#</code> <strong class="userinput"><code>pkg_delete -r jpeg</code></strong>
                   1300:     </pre>
                   1301: <p>
                   1302: 
                   1303:     will remove jpeg and all the packages that used it; this allows
                   1304:     upgrading the jpeg package.</p>
                   1305: </div>
1.41      asau     1306: <div class="sect2">
1.1       dsieger  1307: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   1308: <a name="using.pkg_info"></a>5.1.4. Getting information about installed packages</h3></div></div></div>
1.10      hubertf  1309: <p>The <span class="command"><strong>pkg_info</strong></span> shows information about
1.1       dsieger  1310:     installed packages or binary package files.</p>
                   1311: </div>
1.41      asau     1312: <div class="sect2">
1.1       dsieger  1313: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   1314: <a name="vulnerabilities"></a>5.1.5. Checking for security vulnerabilities in installed packages</h3></div></div></div>
1.1       dsieger  1315: <p>
                   1316:       The NetBSD Security-Officer and Packages Groups maintain a list of
                   1317:       known security vulnerabilities to packages which are (or have been)
                   1318:       included in pkgsrc.  The list is available from the NetBSD
1.151     sevan    1319:       FTP site at <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">http://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities</a>.
1.1       dsieger  1320:     </p>
                   1321: <p>
1.22      jakllsch 1322:       Through <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
1.1       dsieger  1323:       this list can be downloaded
                   1324:       automatically, and a security audit of all packages installed on a system
                   1325:       can take place.
                   1326:     </p>
                   1327: <p>
1.22      jakllsch 1328:       There are two components to auditing.  The first
                   1329:       step, <span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>,
                   1330:       is for downloading
1.1       dsieger  1331:       the list of vulnerabilities from the NetBSD FTP site.  The second
1.22      jakllsch 1332:       step, <span class="command"><strong>pkg_admin audit</strong></span>, checks to see if any of your
1.1       dsieger  1333:       installed packages are vulnerable.  If a package is vulnerable, you
                   1334:       will see output similar to the following:
                   1335:     </p>
                   1336: <pre class="screen">Package samba-2.0.9 has a local-root-shell vulnerability, see
                   1337:     http://www.samba.org/samba/whatsnew/macroexploit.html</pre>
                   1338: <p>
1.22      jakllsch 1339:       You may wish to have the
1.151     sevan    1340:       <a class="ulink" href="http://ftp.NetBSD.org/pub/pkgsrc/distfiles/vulnerabilities" target="_top">vulnerabilities</a>
1.22      jakllsch 1341:       file downloaded daily so that
                   1342:       it remains current.  This may be done by adding an appropriate entry
1.157     leot     1343:       to the root users <a class="citerefentry" href="http://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 1344:       </p>
                   1345: <pre class="screen">
1.121     sevan    1346: # Download vulnerabilities file
1.118     sevan    1347: 0 3 * * * /usr/pkg/sbin/pkg_admin fetch-pkg-vulnerabilities &gt;/dev/null 2&gt;&amp;1
1.121     sevan    1348: # Audit the installed packages and email results to root
                   1349: 9 3 * * * /usr/pkg/sbin/pkg_admin audit |mail -s "Installed package audit result" \
                   1350:            root &gt;/dev/null 2&gt;&amp;1
1.22      jakllsch 1351:       </pre>
                   1352: <p>
1.118     sevan    1353:       will update the vulnerability list every day at 3AM, followed by an audit
                   1354:       at 3:09AM. The result of the audit are then emailed to root.
1.22      jakllsch 1355: 
1.118     sevan    1356:       On NetBSD this may be accomplished instead by adding the following
                   1357:       line to <code class="filename">/etc/daily.conf</code>:
                   1358:       </p>
                   1359: <pre class="screen">
                   1360: fetch_pkg_vulnerabilities=YES
                   1361:       </pre>
                   1362: <p>
                   1363:       to fetch the vulnerability list from the daily security script. The system
                   1364:       is set to audit the packages by default but can be set explicitly, if
1.123     wiz      1365:       desired (not required), by adding the following line to
1.118     sevan    1366: <code class="filename">/etc/security.conf</code>:
1.22      jakllsch 1367:       </p>
                   1368: <pre class="screen">
1.118     sevan    1369: check_pkg_vulnerabilities=YES
1.22      jakllsch 1370:       </pre>
                   1371: <p>
1.157     leot     1372:       see <a class="citerefentry" href="http://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="http://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  1373:     </p>
                   1374: </div>
1.41      asau     1375: <div class="sect2">
1.1       dsieger  1376: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   1377: <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  1378: <p>
1.137     leot     1379:       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      1380:       <span class="command"><strong>lintpkgsrc</strong></span> with the <span class="quote">&#8220;<span class="quote">-i</span>&#8221;</span>
1.1       dsieger  1381:       argument to check if your packages are up-to-date, e.g.
                   1382:     </p>
                   1383: <pre class="screen">
                   1384: <code class="prompt">%</code> <strong class="userinput"><code>lintpkgsrc -i</code></strong>
                   1385: ...
                   1386: Version mismatch: 'tcsh' 6.09.00 vs 6.10.00
                   1387:     </pre>
1.10      hubertf  1388: <p>You can then use <span class="command"><strong>make update</strong></span> to update the
1.1       dsieger  1389:     package on your system and rebuild any dependencies.
                   1390:     </p>
                   1391: </div>
1.41      asau     1392: <div class="sect2">
1.1       dsieger  1393: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   1394: <a name="using.pkg_admin"></a>5.1.7. Other administrative functions</h3></div></div></div>
1.10      hubertf  1395: <p>The <span class="command"><strong>pkg_admin</strong></span> executes various
1.1       dsieger  1396:     administrative functions on the package system.</p>
                   1397: </div>
                   1398: </div>
1.41      asau     1399: <div class="sect1">
1.1       dsieger  1400: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   1401: <a name="building-packages-from-source"></a>5.2. Building packages from source</h2></div></div></div>
1.1       dsieger  1402: <p>After obtaining pkgsrc, the <code class="filename">pkgsrc</code>
                   1403:   directory now contains a set of packages, organized into
                   1404:   categories. You can browse the online index of packages, or run
1.10      hubertf  1405:   <span class="command"><strong>make readme</strong></span> from the <code class="filename">pkgsrc</code>
1.1       dsieger  1406:   directory to build local <code class="filename">README.html</code> files for
1.137     leot     1407:   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  1408: <p>The default <span class="emphasis"><em>prefix</em></span> for installed packages
                   1409:   is <code class="filename">/usr/pkg</code>. If you wish to change this, you
                   1410:   should do so by setting <code class="varname">LOCALBASE</code> in
1.10      hubertf  1411:   <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. You should not try to use multiple
1.1       dsieger  1412:   different <code class="varname">LOCALBASE</code> definitions on the same
                   1413:   system (inside a chroot is an exception). </p>
                   1414: <p>The rest of this chapter assumes that the package is already
1.10      hubertf  1415:   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  1416:   instructions how to create your own packages.</p>
1.41      asau     1417: <div class="sect2">
1.1       dsieger  1418: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   1419: <a name="requirements"></a>5.2.1. Requirements</h3></div></div></div>
1.1       dsieger  1420: <p>To build packages from source, you need a working C
                   1421:     compiler. On NetBSD, you need to install the
1.23      wiz      1422:     <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  1423:     sets. If you want to build X11-related packages, the
1.23      wiz      1424:     <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  1425:     sets are required, too.</p>
                   1426: </div>
1.41      asau     1427: <div class="sect2">
1.1       dsieger  1428: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   1429: <a name="fetching-distfiles"></a>5.2.2. Fetching distfiles</h3></div></div></div>
1.1       dsieger  1430: <p>The first step for building a package is downloading the
                   1431:     distfiles (i.e. the unmodified source). If they have not yet been
                   1432:     downloaded, pkgsrc will fetch them automatically.</p>
                   1433: <p>If you have all files that you need in the
                   1434:     <code class="filename">distfiles</code> directory,
                   1435:     you don't need to connect. If the distfiles are on CD-ROM, you can
                   1436:     mount the CD-ROM on <code class="filename">/cdrom</code> and add:
                   1437:     </p>
                   1438: <pre class="screen">DISTDIR=/cdrom/pkgsrc/distfiles</pre>
                   1439: <p>
1.10      hubertf  1440:     to your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1       dsieger  1441: <p>By default a list of distribution sites will be randomly
                   1442:     intermixed to prevent huge load on servers which holding popular
                   1443:     packages (for example, SourceForge.net mirrors). Thus, every
                   1444:     time when you need to fetch yet another distfile all the mirrors
                   1445:     will be tried in new (random) order. You can turn this feature
                   1446:     off by setting <code class="varname">MASTER_SORT_RANDOM=NO</code> (for
                   1447:     <code class="varname">PKG_DEVELOPER</code>s it's already disabled).</p>
                   1448: <p>You can overwrite some of the major distribution sites to
                   1449:     fit to sites that are close to your own.  By setting one or two
                   1450:     variables you can modify the order in which the master sites are
                   1451:     accessed.  <code class="varname">MASTER_SORT</code> contains a whitespace
                   1452:     delimited list of domain suffixes.
                   1453:     <code class="varname">MASTER_SORT_REGEX</code> is even more flexible, it
                   1454:     contains a whitespace delimited list of regular expressions.  It
                   1455:     has higher priority than <code class="varname">MASTER_SORT</code>.  Have a
                   1456:     look at <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to find
                   1457:     some examples.  This may save some of your bandwidth and
                   1458:     time.</p>
                   1459: <p>You can change these settings either in your shell's environment, or,
                   1460:     if you want to keep the settings, by editing the
1.10      hubertf  1461:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file,
1.1       dsieger  1462:     and adding the definitions there.</p>
                   1463: <p>
                   1464:       If a package depends on many other packages (such as
1.137     leot     1465:       <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  1466:       alternate between periods of
                   1467:       downloading source, and compiling. To ensure you have all the source
                   1468:       downloaded initially you can run the command:
                   1469:       </p>
                   1470: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch-list | sh</code></strong></pre>
                   1471: <p>
                   1472:       which will output and run a set of shell commands to fetch the
                   1473:       necessary files into the <code class="filename">distfiles</code> directory.  You can
                   1474:       also choose to download the files manually.
                   1475:     </p>
                   1476: </div>
1.41      asau     1477: <div class="sect2">
1.1       dsieger  1478: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   1479: <a name="how-to-build-and-install"></a>5.2.3. How to build and install</h3></div></div></div>
1.1       dsieger  1480: <p>
                   1481:       Once the software has downloaded, any patches will be applied, then it
                   1482:       will be compiled for you. This may take some time depending on your
                   1483:       computer, and how many other packages the software depends on and their
                   1484:       compile time.
                   1485:     </p>
1.41      asau     1486: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  1487: <h3 class="title">Note</h3>
                   1488: <p>If using bootstrap or pkgsrc on a non-NetBSD system,
1.10      hubertf  1489:     use the pkgsrc <span class="command"><strong>bmake</strong></span> command instead of
1.23      wiz      1490:     <span class="quote">&#8220;<span class="quote">make</span>&#8221;</span> in the examples in this guide.</p>
1.1       dsieger  1491: </div>
                   1492: <p>For example, type</p>
                   1493: <pre class="screen">
                   1494: <code class="prompt">%</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
                   1495: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   1496:     </pre>
                   1497: <p>at the shell prompt to build the various components of the
                   1498:     package.</p>
                   1499: <p>The next stage is to actually install the newly compiled
                   1500:     program onto your system. Do this by entering:
                   1501: 
                   1502:     </p>
                   1503: <pre class="screen">
                   1504: <code class="prompt">%</code> <strong class="userinput"><code>make install</code></strong>
                   1505:     </pre>
                   1506: <p>
                   1507: 
                   1508:     while you are still in the directory for whatever package you
                   1509:     are installing.</p>
                   1510: <p>Installing the package on your system may require you to
                   1511:     be root.  However, pkgsrc has a
                   1512:     <span class="emphasis"><em>just-in-time-su</em></span> feature, which allows you
                   1513:     to only become root for the actual installation step.</p>
                   1514: <p>That's it, the software should now be installed and setup for use.
                   1515:     You can now enter:
                   1516: 
                   1517:     </p>
                   1518: <pre class="screen">
                   1519: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong>
                   1520:     </pre>
                   1521: <p>
                   1522: 
                   1523:     to remove the compiled files in the work directory, as you shouldn't need
                   1524:     them any more. If other packages were also added to your system
                   1525:     (dependencies) to allow your program to compile, you can tidy these up
                   1526:     also with the command:</p>
                   1527: <pre class="screen">
                   1528: <code class="prompt">%</code> <strong class="userinput"><code>make clean-depends</code></strong>
                   1529:     </pre>
                   1530: <p>Taking the figlet utility as an example, we can install it on our
1.10      hubertf  1531:     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  1532: <p>The program is installed under the default root of the
                   1533:     packages tree - <code class="filename">/usr/pkg</code>. Should this not
                   1534:     conform to your tastes, set the <code class="varname">LOCALBASE</code>
                   1535:     variable in your environment, and it will use that value as the
                   1536:     root of your packages tree. So, to use
                   1537:     <code class="filename">/usr/local</code>, set
                   1538:     <code class="varname">LOCALBASE=/usr/local</code> in your environment.
                   1539:     Please note that you should use a directory which is dedicated to
                   1540:     packages and not shared with other programs (i.e., do not try and
                   1541:     use <code class="varname">LOCALBASE=/usr</code>).  Also, you should not try
                   1542:     to add any of your own files or directories (such as
                   1543:     <code class="filename">src/</code>, <code class="filename">obj/</code>, or
                   1544:     <code class="filename">pkgsrc/</code>) below the
                   1545:     <code class="varname">LOCALBASE</code> tree.  This is to prevent possible
                   1546:     conflicts between programs and other files installed by the
                   1547:     package system and whatever else may have been installed
                   1548:     there.</p>
1.10      hubertf  1549: <p>Some packages look in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1       dsieger  1550:     alter some configuration options at build time.  Have a look at
                   1551:     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> to get an overview
                   1552:     of what will be set there by default.  Environment variables such
                   1553:     as <code class="varname">LOCALBASE</code> can be set in
1.10      hubertf  1554:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to save having to remember to
1.1       dsieger  1555:     set them each time you want to use pkgsrc.</p>
1.23      wiz      1556: <p>Occasionally, people want to <span class="quote">&#8220;<span class="quote">look under the
                   1557:     covers</span>&#8221;</span> to see what is going on when a package is building
1.1       dsieger  1558:     or being installed. This may be for debugging purposes, or out of
                   1559:     simple curiosity. A number of utility values have been added to
                   1560:     help with this.</p>
1.23      wiz      1561: <div class="orderedlist"><ol class="orderedlist" type="1">
                   1562: <li class="listitem">
1.157     leot     1563: <p>If you invoke the <a class="citerefentry" href="http://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  1564:        <code class="varname">PKG_DEBUG_LEVEL=2</code>, then a huge amount of
                   1565:        information will be displayed. For example,</p>
                   1566: <pre class="screen"><strong class="userinput"><code>make patch PKG_DEBUG_LEVEL=2</code></strong></pre>
                   1567: <p>will show all the commands that are invoked, up to and
1.23      wiz      1568:        including the <span class="quote">&#8220;<span class="quote">patch</span>&#8221;</span> stage.</p>
1.1       dsieger  1569: </li>
1.23      wiz      1570: <li class="listitem">
1.157     leot     1571: <p>If you want to know the value of a certain <a class="citerefentry" href="http://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  1572:        definition, then the <code class="varname">VARNAME</code> definition
                   1573:        should be used, in conjunction with the show-var
1.157     leot     1574:        target. e.g. to show the expansion of the <a class="citerefentry" href="http://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  1575:        variable <code class="varname">LOCALBASE</code>:</p>
                   1576: <pre class="screen">
                   1577: <code class="prompt">%</code> <strong class="userinput"><code>make show-var VARNAME=LOCALBASE</code></strong>
                   1578: /usr/pkg
                   1579: <code class="prompt">%</code>
                   1580:        </pre>
                   1581: </li>
                   1582: </ol></div>
                   1583: <p>If you want to install a binary package that you've either
                   1584:     created yourself (see next section), that you put into
                   1585:     pkgsrc/packages manually or that is located on a remote FTP
                   1586:     server, you can use the "bin-install" target. This target will
1.157     leot     1587:     install a binary package - if available - via <a class="citerefentry" href="http://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  1588:     else do a <span class="command"><strong>make package</strong></span>.  The list of remote FTP
1.1       dsieger  1589:     sites searched is kept in the variable
                   1590:     <code class="varname">BINPKG_SITES</code>, which defaults to
1.157     leot     1591:     ftp.NetBSD.org. Any flags that should be added to <a class="citerefentry" href="http://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  1592:     can be put into <code class="varname">BIN_INSTALL_FLAGS</code>.  See
                   1593:     <code class="filename">pkgsrc/mk/defaults/mk.conf</code> for more
                   1594:     details.</p>
                   1595: <p>A final word of warning: If you set up a system that has a
                   1596:     non-standard setting for <code class="varname">LOCALBASE</code>, be sure to
                   1597:     set that before any packages are installed, as you cannot use
                   1598:     several directories for the same purpose. Doing so will result in
                   1599:     pkgsrc not being able to properly detect your installed packages,
                   1600:     and fail miserably. Note also that precompiled binary packages are
                   1601:     usually built with the default <code class="varname">LOCALBASE</code> of
                   1602:     <code class="filename">/usr/pkg</code>, and that you should
                   1603:     <span class="emphasis"><em>not</em></span> install any if you use a non-standard
                   1604:     <code class="varname">LOCALBASE</code>.</p>
                   1605: </div>
                   1606: </div>
                   1607: </div>
1.41      asau     1608: <div class="chapter">
1.1       dsieger  1609: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   1610: <a name="configuring"></a>Chapter 6. Configuring pkgsrc</h2></div></div></div>
1.1       dsieger  1611: <div class="toc">
                   1612: <p><b>Table of Contents</b></p>
1.100     leot     1613: <dl class="toc">
1.154     rillig   1614: <dt><span class="sect1"><a href="#general-configuration">6.1. General configuration</a></span></dt>
                   1615: <dt><span class="sect1"><a href="#variables-affecting-build">6.2. Variables affecting the build process</a></span></dt>
                   1616: <dt><span class="sect1"><a href="#variables-affecting-installation">6.3. Variables affecting the installation process</a></span></dt>
                   1617: <dt><span class="sect1"><a href="#conf.compiler">6.4. Selecting and configuring the compiler</a></span></dt>
                   1618: <dd><dl>
                   1619: <dt><span class="sect2"><a href="#selecting-the-compiler">6.4.1. Selecting the compiler</a></span></dt>
                   1620: <dt><span class="sect2"><a href="#conf.cflags">6.4.2. Additional flags to the compiler (<code class="varname">CFLAGS</code>)</a></span></dt>
                   1621: <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  1622: </dl></dd>
1.154     rillig   1623: <dt><span class="sect1"><a href="#developer-advanced-settings">6.5. Developer/advanced settings</a></span></dt>
                   1624: <dt><span class="sect1"><a href="#selecting-build-options">6.6. Selecting Build Options</a></span></dt>
1.1       dsieger  1625: </dl>
                   1626: </div>
1.4       rillig   1627: <a name="mk.conf"></a><p>The whole pkgsrc system is configured in a single file, usually
1.1       dsieger  1628: called <code class="filename">mk.conf</code>. In which directory pkgsrc looks for
                   1629: that file depends on the installation. On NetBSD, when you use
1.157     leot     1630: <a class="citerefentry" href="http://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  1631: <code class="filename">/etc/</code>. In all other cases the default location is
                   1632: <code class="literal">${PREFIX}/etc/</code>, depending on where you told the
                   1633: bootstrap program to install the binary packages.</p>
                   1634: <p>The format of the configuration file is that of the usual
                   1635: BSD-style <code class="filename">Makefile</code>s. The whole pkgsrc configuration
                   1636: is done by setting variables in this file. Note that you can define all
                   1637: kinds of variables, and no special error checking (for example for
1.112     rillig   1638: spelling mistakes) takes place.</p>
1.41      asau     1639: <div class="sect1">
1.1       dsieger  1640: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   1641: <a name="general-configuration"></a>6.1. General configuration</h2></div></div></div>
1.112     rillig   1642: <p>The following variables apply to all
1.1       dsieger  1643:     pkgsrc packages. A complete list of the variables that can be
                   1644:     configured by the user is available in
                   1645:     <code class="filename">mk/defaults/mk.conf</code>, together with some
                   1646:     comments that describe each variable's intent.</p>
1.41      asau     1647: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      1648: <li class="listitem"><p><code class="varname">LOCALBASE</code>: Where
1.1       dsieger  1649:            packages will be installed. The default is
                   1650:            <code class="filename">/usr/pkg</code>. Do not mix binary packages
                   1651:            with different <code class="varname">LOCALBASE</code>s!</p></li>
1.23      wiz      1652: <li class="listitem"><p><code class="varname">CROSSBASE</code>: Where
                   1653:            <span class="quote">&#8220;<span class="quote">cross</span>&#8221;</span> category packages will be
1.1       dsieger  1654:            installed. The default is
                   1655:            <code class="filename">${LOCALBASE}/cross</code>.</p></li>
1.23      wiz      1656: <li class="listitem"><p><code class="varname">X11BASE</code>: Where
1.1       dsieger  1657:            X11 is installed on the system. The default is
1.84      wiz      1658:            <code class="filename">/usr/X11R7</code>.</p></li>
1.23      wiz      1659: <li class="listitem"><p><code class="varname">DISTDIR</code>: Where to store the
1.1       dsieger  1660:            downloaded copies of the original source distributions used
                   1661:            for building pkgsrc packages. The default is
                   1662:            <code class="filename">${PKGSRCDIR}/distfiles</code>.</p></li>
1.23      wiz      1663: <li class="listitem"><p><code class="varname">PKG_DBDIR</code>: Where the
1.1       dsieger  1664:            database about installed packages is stored.  The default is
1.118     sevan    1665:            <code class="filename">/usr/pkg/pkgdb</code>.</p></li>
1.23      wiz      1666: <li class="listitem"><p><code class="varname">MASTER_SITE_OVERRIDE</code>:
1.1       dsieger  1667:            If set, override the packages'
                   1668:            <code class="varname">MASTER_SITES</code> with this value.</p></li>
1.23      wiz      1669: <li class="listitem"><p><code class="varname">MASTER_SITE_BACKUP</code>:
1.1       dsieger  1670:            Backup location(s) for distribution files and patch files
                   1671:            if not found locally or in
                   1672:            <code class="filename">${MASTER_SITES}</code> or
                   1673:            <code class="filename">${PATCH_SITES}</code> respectively.
1.118     sevan    1674:            The defaults is
                   1675:            <code class="filename">ftp://ftp.NetBSD.org/pub/pkgsrc/distfiles/${DIST_SUBDIR}/</code>.</p></li>
1.23      wiz      1676: <li class="listitem"><p><code class="varname">BINPKG_SITES</code>:
1.1       dsieger  1677:            List of sites carrying binary pkgs. <em class="replaceable"><code>rel</code></em> and
                   1678:            <em class="replaceable"><code>arch</code></em> are replaced with OS
1.23      wiz      1679:            release (<span class="quote">&#8220;<span class="quote">2.0</span>&#8221;</span>, etc.) and architecture
                   1680:            (<span class="quote">&#8220;<span class="quote">mipsel</span>&#8221;</span>, etc.).</p></li>
                   1681: <li class="listitem"><p><code class="varname">ACCEPTABLE_LICENSES</code>:
1.22      jakllsch 1682:            List of acceptable licenses. License names are case-sensitive.
                   1683:            Whenever you try to build a package whose license is not in this
                   1684:            list, you will get an error message. If the license condition is
                   1685:            simple enough, the error message will include specific
                   1686:            instructions on how to change this variable.</p></li>
1.1       dsieger  1687: </ul></div>
                   1688: </div>
1.41      asau     1689: <div class="sect1">
1.1       dsieger  1690: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   1691: <a name="variables-affecting-build"></a>6.2. Variables affecting the build process</h2></div></div></div>
1.108     rillig   1692: <p>
1.1       dsieger  1693:       </p>
1.41      asau     1694: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      1695: <li class="listitem"><p><code class="varname">PACKAGES</code>: The top level
1.1       dsieger  1696:            directory for the binary packages. The default is
                   1697:            <code class="filename">${PKGSRCDIR}/packages</code>.</p></li>
1.23      wiz      1698: <li class="listitem"><p><code class="varname">WRKOBJDIR</code>:
1.1       dsieger  1699:            The top level directory where, if defined, the separate
                   1700:            working directories will get created, and symbolically
                   1701:            linked to from <code class="filename">${WRKDIR}</code> (see below).
                   1702:            This is useful for building packages on several
                   1703:            architectures, then <code class="filename">${PKGSRCDIR}</code>
                   1704:            can be NFS-mounted while <code class="filename">${WRKOBJDIR}</code>
                   1705:            is local to every architecture. (It should be noted that
                   1706:            <code class="varname">PKGSRCDIR</code> should not be set by the user
1.14      jmcneill 1707:            &mdash; it is an internal definition which refers to the
1.1       dsieger  1708:            root of the pkgsrc tree. It is possible to have many
                   1709:            pkgsrc tree instances.)</p></li>
1.23      wiz      1710: <li class="listitem"><p><code class="varname">LOCALPATCHES</code>:
1.1       dsieger  1711:            Directory for local patches that aren't part of pkgsrc.
1.154     rillig   1712:            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  1713:            information.</p></li>
1.23      wiz      1714: <li class="listitem"><p><code class="varname">PKGMAKECONF</code>: Location of
1.10      hubertf  1715:            the <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file used by a package's
1.1       dsieger  1716:            BSD-style Makefile. If this is not set,
                   1717:            <code class="varname">MAKECONF</code> is set to
                   1718:            <code class="filename">/dev/null</code> to avoid picking up
                   1719:            settings used by builds in <code class="filename">/usr/src</code>.</p></li>
                   1720: </ul></div>
                   1721: </div>
1.41      asau     1722: <div class="sect1">
1.1       dsieger  1723: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   1724: <a name="variables-affecting-installation"></a>6.3. Variables affecting the installation process</h2></div></div></div>
1.143     maya     1725: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem"><p><code class="varname">PKGSRC_KEEP_BIN_PKGSRC</code>:
                   1726:                 By default, binary packages of built packages are
1.150     leot     1727:                 preserved in <code class="filename">${PACKAGES}/All</code>. Setting
1.143     maya     1728:                this variable to "no" prevents this.</p></li></ul></div>
1.107     jnemeth  1729: <p>Packages have to support installation into a
1.4       rillig   1730:     subdirectory of <code class="varname">WRKDIR</code>. This allows a package
                   1731:     to be built, before the actual filesystem is touched. DESTDIR
                   1732:     support exists in two variations:</p>
1.41      asau     1733: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      1734: <li class="listitem"><p>Basic DESTDIR support means that the package
1.24      wiz      1735:       installation and packaging is still run as root.</p></li>
                   1736: <li class="listitem"><p>Full DESTDIR support can run the complete
                   1737:       build, installation and packaging as normal user. Root
                   1738:       privileges are only needed to add packages.</p></li>
                   1739: </ul></div>
1.4       rillig   1740: <p>With basic DESTDIR support, <strong class="userinput"><code>make
                   1741:     clean</code></strong> needs to be run as root.</p>
1.17      imil     1742: <p>Considering the <code class="filename">foo/bar</code> package,
                   1743:     DESTDIR full support can be tested using the following commands
                   1744: 
                   1745: </p>
                   1746: <pre class="programlisting">
                   1747: <code class="prompt">$</code> id
                   1748: uid=1000(myusername) gid=100(users) groups=100(users),0(wheel)
                   1749: <code class="prompt">$</code> mkdir $HOME/packages
                   1750: <code class="prompt">$</code> cd $PKGSRCDIR/foo/bar
                   1751: </pre>
                   1752: <p>
                   1753: 
                   1754:     Verify <code class="varname">DESTDIR</code> full support, no root privileges
                   1755:     should be needed
                   1756: 
                   1757: </p>
                   1758: <pre class="programlisting">
1.66      asau     1759: <code class="prompt">$</code> make stage-install
1.17      imil     1760: </pre>
                   1761: <p>
                   1762: 
                   1763:     Create a package without root privileges
                   1764: 
                   1765: </p>
                   1766: <pre class="programlisting">
1.66      asau     1767: <code class="prompt">$</code> make PACKAGES=$HOME/packages package
1.17      imil     1768: </pre>
                   1769: <p>
                   1770: 
                   1771:     For the following command, you must be able to gain root
1.157     leot     1772:     privileges using <a class="citerefentry" href="http://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     1773: 
                   1774: </p>
                   1775: <pre class="programlisting">
1.66      asau     1776: <code class="prompt">$</code> make PACKAGES=$HOME/packages install
1.17      imil     1777: </pre>
                   1778: <p>
                   1779: 
                   1780:     Then, as a simple user
                   1781: 
                   1782: </p>
                   1783: <pre class="programlisting">
                   1784: <code class="prompt">$</code> make clean
                   1785: </pre>
                   1786: <p>
                   1787: 
                   1788:     </p>
1.4       rillig   1789: </div>
1.41      asau     1790: <div class="sect1">
1.4       rillig   1791: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   1792: <a name="conf.compiler"></a>6.4. Selecting and configuring the compiler</h2></div></div></div>
1.41      asau     1793: <div class="sect2">
1.1       dsieger  1794: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   1795: <a name="selecting-the-compiler"></a>6.4.1. Selecting the compiler</h3></div></div></div>
1.1       dsieger  1796: <p>By default, pkgsrc will use GCC to build packages.  This may be
                   1797:     overridden by setting the following variables in /etc/mk.conf:</p>
1.41      asau     1798: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  1799: <dt><span class="term"><code class="varname">PKGSRC_COMPILER</code>:</span></dt>
                   1800: <dd>
                   1801: <p>This is a list of values specifying the chain of
                   1802:          compilers to invoke when building packages.  Valid values
                   1803:          are:</p>
1.41      asau     1804: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.66      asau     1805: <li class="listitem"><p><code class="varname">ccc</code>:
                   1806:            Compaq C Compilers (Tru64)</p></li>
                   1807: <li class="listitem"><p><code class="varname">ccache</code>:
                   1808:            compiler cache (chainable)</p></li>
                   1809: <li class="listitem"><p><code class="varname">clang</code>:
                   1810:            Clang C and Objective-C compiler</p></li>
1.23      wiz      1811: <li class="listitem"><p><code class="varname">distcc</code>:
1.1       dsieger  1812:            distributed C/C++ (chainable)</p></li>
1.66      asau     1813: <li class="listitem"><p><code class="varname">f2c</code>:
                   1814:            Fortran 77 to C compiler (chainable)</p></li>
                   1815: <li class="listitem"><p><code class="varname">icc</code>:
                   1816:            Intel C++ Compiler (Linux)</p></li>
                   1817: <li class="listitem"><p><code class="varname">ido</code>:
                   1818:            SGI IRIS Development Option cc (IRIX 5)</p></li>
1.23      wiz      1819: <li class="listitem"><p><code class="varname">gcc</code>:
1.1       dsieger  1820:            GNU C/C++ Compiler</p></li>
1.66      asau     1821: <li class="listitem"><p><code class="varname">hp</code>:
                   1822:            HP-UX C/aC++ compilers</p></li>
1.23      wiz      1823: <li class="listitem"><p><code class="varname">mipspro</code>:
1.1       dsieger  1824:            Silicon Graphics, Inc. MIPSpro (n32/n64)</p></li>
1.66      asau     1825: <li class="listitem"><p><code class="varname">mipspro-ucode</code>:
1.1       dsieger  1826:            Silicon Graphics, Inc. MIPSpro (o32)</p></li>
1.23      wiz      1827: <li class="listitem"><p><code class="varname">sunpro</code>:
1.1       dsieger  1828:            Sun Microsystems, Inc. WorkShip/Forte/Sun ONE Studio</p></li>
1.66      asau     1829: <li class="listitem"><p><code class="varname">xlc</code>:
1.118     sevan    1830:            IBM's XL C/C++ compiler suite</p></li>
1.1       dsieger  1831: </ul></div>
                   1832: <p>The default is
1.23      wiz      1833:          <span class="quote">&#8220;<span class="quote"><code class="varname">gcc</code></span>&#8221;</span>.  You can use
1.1       dsieger  1834:          <code class="varname">ccache</code> and/or
                   1835:          <code class="varname">distcc</code> with an appropriate
                   1836:          <code class="varname">PKGSRC_COMPILER</code> setting,
1.23      wiz      1837:          e.g. <span class="quote">&#8220;<span class="quote"><code class="varname">ccache gcc</code></span>&#8221;</span>.  This
1.1       dsieger  1838:          variable should always be terminated with a value for
                   1839:          a real compiler.  Note that only one real compiler
1.23      wiz      1840:          should be listed (e.g. <span class="quote">&#8220;<span class="quote"><code class="varname">sunpro gcc</code></span>&#8221;</span>
1.1       dsieger  1841:          is not allowed).</p>
                   1842: </dd>
                   1843: <dt><span class="term"><code class="varname">GCC_REQD</code>:</span></dt>
                   1844: <dd><p>This specifies the minimum version of GCC to use
                   1845:          when building packages.  If the system GCC doesn't
                   1846:          satisfy this requirement, then pkgsrc will build and
                   1847:          install one of the GCC packages to use instead.</p></dd>
1.153     leot     1848: <dt><span class="term"><code class="varname">PYTHON_VERSION_DEFAULT</code>:</span></dt>
1.114     maya     1849: <dd><p>Specifies which version of python to use when several
                   1850:          options are available.</p></dd>
                   1851: <dt><span class="term"><code class="varname">PKGSRC_FORTRAN</code>:</span></dt>
                   1852: <dd><p>Specifies the fortran compiler to use.
                   1853:          The default is <code class="varname">g95</code>, and
                   1854:          <code class="varname">gfortran</code> is an alternative.</p></dd>
                   1855: <dt><span class="term"><code class="varname">GFORTRAN_VERSION</code>:</span></dt>
                   1856: <dd><p>If <code class="varname">PKGSRC_FORTRAN</code><code class="literal">=</code>
                   1857:          <code class="varname">gfortran</code> is used, this option specifies which
                   1858:          version to use.</p></dd>
1.1       dsieger  1859: </dl></div>
                   1860: </div>
1.41      asau     1861: <div class="sect2">
1.1       dsieger  1862: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   1863: <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  1864: <p>If you wish to set the <code class="varname">CFLAGS</code> variable,
                   1865:        please make sure to use the <code class="literal">+=</code> operator
                   1866:        instead of the <code class="literal">=</code> operator:</p>
                   1867: <pre class="programlisting">
                   1868: CFLAGS+=        -your -flags
                   1869: </pre>
                   1870: <p>Using <code class="varname">CFLAGS=</code> (i.e. without the
1.23      wiz      1871:        <span class="quote">&#8220;<span class="quote">+</span>&#8221;</span>) may lead to problems with packages that
1.16      jnemeth  1872:        need to add their own flags.  You may want to take a look
1.137     leot     1873:        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      1874:        package if you're interested in optimization specifically
                   1875:        for the current CPU. </p>
1.1       dsieger  1876: </div>
1.41      asau     1877: <div class="sect2">
1.1       dsieger  1878: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   1879: <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  1880: <p>If you want to pass flags to the linker, both in the configure
                   1881: step and the build step, you can do this in two ways.  Either set
                   1882: <code class="varname">LDFLAGS</code> or <code class="varname">LIBS</code>.  The difference
                   1883: between the two is that <code class="varname">LIBS</code> will be appended to
                   1884: the command line, while <code class="varname">LDFLAGS</code> come earlier.
                   1885: <code class="varname">LDFLAGS</code> is pre-loaded with rpath settings for ELF
                   1886: machines depending on the setting of <code class="varname">USE_IMAKE</code> or
                   1887: the inclusion of <code class="filename">mk/x11.buildlink3.mk</code>.  As with
                   1888: <code class="varname">CFLAGS</code>, if you do not wish to override these
                   1889: settings, use the <code class="literal">+=</code> operator:</p>
                   1890: <pre class="programlisting">
                   1891: LDFLAGS+=        -your -linkerflags
                   1892: </pre>
                   1893: </div>
                   1894: </div>
1.41      asau     1895: <div class="sect1">
1.1       dsieger  1896: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   1897: <a name="developer-advanced-settings"></a>6.5. Developer/advanced settings</h2></div></div></div>
1.84      wiz      1898: <p>
1.1       dsieger  1899:       </p>
1.41      asau     1900: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      1901: <li class="listitem">
1.1       dsieger  1902: <p><code class="varname">PKG_DEVELOPER</code>:
                   1903:            Run some sanity checks that package developers want:
                   1904:            </p>
1.41      asau     1905: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: circle; ">
1.23      wiz      1906: <li class="listitem"><p>make sure patches apply with zero
1.1       dsieger  1907:              fuzz</p></li>
1.23      wiz      1908: <li class="listitem"><p>run check-shlibs to see that all
1.1       dsieger  1909:              binaries will find their shared libs.</p></li>
                   1910: </ul></div>
                   1911: <p>
                   1912:        </p>
                   1913: </li>
1.23      wiz      1914: <li class="listitem"><p><code class="varname">PKG_DEBUG_LEVEL</code>: The level
1.1       dsieger  1915:        of debugging output which is displayed whilst making and
                   1916:        installing the package.  The default value for this is 0,
                   1917:        which will not display the commands as they are executed
                   1918:        (normal, default, quiet operation); the value 1 will display
                   1919:        all shell commands before their invocation, and the value 2
                   1920:        will display both the shell commands before their invocation,
1.112     rillig   1921:        as well as their actual execution progress with <span class="command"><strong>set
                   1922:        -x</strong></span>.</p></li>
1.1       dsieger  1923: </ul></div>
                   1924: <p>
                   1925:     </p>
                   1926: </div>
1.41      asau     1927: <div class="sect1">
1.1       dsieger  1928: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   1929: <a name="selecting-build-options"></a>6.6. Selecting Build Options</h2></div></div></div>
1.1       dsieger  1930: <p>Some packages have build time options, usually to select
                   1931:     between different dependencies, enable optional support for big
                   1932:     dependencies or enable experimental features.</p>
                   1933: <p>To see which options, if any, a package supports, and which
1.10      hubertf  1934:     options are mutually exclusive, run <span class="command"><strong>make
1.1       dsieger  1935:     show-options</strong></span>, for example:</p>
                   1936: <pre class="programlisting">
                   1937:     The following options are supported by this package:
                   1938:         ssl      Enable SSL support.
                   1939:     Exactly one of the following gecko options is required:
                   1940:         firefox  Use firefox as gecko rendering engine.
                   1941:         mozilla  Use mozilla as gecko rendering engine.
                   1942:     At most one of the following database options may be selected:
                   1943:         mysql    Enable support for MySQL database.
                   1944:         pgsql    Enable support for PostgreSQL database.
                   1945: 
                   1946:     These options are enabled by default: firefox
                   1947:     These options are currently enabled: mozilla ssl
                   1948: </pre>
                   1949: <p>The following variables can be defined in
1.10      hubertf  1950:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to select which options to
1.1       dsieger  1951:     enable for a package: <code class="varname">PKG_DEFAULT_OPTIONS</code>,
                   1952:     which can be used to select or disable options for all packages
                   1953:     that support them, and
                   1954:     <code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>,
                   1955:     which can be used to select or disable options specifically for
                   1956:     package <em class="replaceable"><code>pkgbase</code></em>.  Options listed in
1.23      wiz      1957:     these variables are selected, options preceded by <span class="quote">&#8220;<span class="quote">-</span>&#8221;</span>
1.1       dsieger  1958:     are disabled. A few examples:</p>
                   1959: <pre class="screen">
1.10      hubertf  1960: <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  1961: PKG_DEFAULT_OPTIONS=    -arts -dvdread -esound
                   1962: PKG_OPTIONS.kdebase=    debug -sasl
                   1963: PKG_OPTIONS.apache=     suexec </pre>
1.11      rillig   1964: <p>It is important to note that options that were specifically
1.18      snj      1965:     suggested by the package maintainer must be explicitly removed if
1.11      rillig   1966:     you do not wish to include the option.  If you are unsure you can view
                   1967:     the current state with <span class="command"><strong>make show-options</strong></span>.</p>
1.1       dsieger  1968: <p>The following settings are consulted in the order given, and
                   1969:     the last setting that selects or disables an option is
                   1970:     used:</p>
1.23      wiz      1971: <div class="orderedlist"><ol class="orderedlist" type="1">
                   1972: <li class="listitem"><p>the default options as suggested by the package
1.1       dsieger  1973:       maintainer</p></li>
1.23      wiz      1974: <li class="listitem"><p>the options implied by the settings of legacy
1.1       dsieger  1975:       variables (see below)</p></li>
1.23      wiz      1976: <li class="listitem"><p><code class="varname">PKG_DEFAULT_OPTIONS</code></p></li>
                   1977: <li class="listitem"><p><code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code></p></li>
1.1       dsieger  1978: </ol></div>
                   1979: <p>For groups of mutually exclusive options, the last option
                   1980:     selected is used, all others are automatically disabled.  If an
                   1981:     option of the group is explicitly disabled, the previously
                   1982:     selected option, if any, is used.  It is an error if no option
                   1983:     from a required group of options is selected, and building the
                   1984:     package will fail.</p>
                   1985: <p>Before the options framework was introduced, build options
                   1986:     were selected by setting a variable (often named
                   1987:     <code class="varname">USE_<em class="replaceable"><code>FOO</code></em></code>) in
1.10      hubertf  1988:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> for each option.  To ease
1.1       dsieger  1989:     transition to the options framework for the user, these legacy
                   1990:     variables are converted to the appropriate options setting
                   1991:     (<code class="varname">PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em></code>)
                   1992:     automatically.  A warning is issued to prompt the user to update
1.10      hubertf  1993:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to use the options framework
1.1       dsieger  1994:     directly.  Support for the legacy variables will be removed
                   1995:     eventually.</p>
                   1996: </div>
                   1997: </div>
1.41      asau     1998: <div class="chapter">
1.1       dsieger  1999: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   2000: <a name="binary"></a>Chapter 7. Creating binary packages</h2></div></div></div>
1.1       dsieger  2001: <div class="toc">
                   2002: <p><b>Table of Contents</b></p>
1.100     leot     2003: <dl class="toc">
1.154     rillig   2004: <dt><span class="sect1"><a href="#building-a-single-binary-package">7.1. Building a single binary package</a></span></dt>
                   2005: <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  2006: </dl>
                   2007: </div>
1.41      asau     2008: <div class="sect1">
1.1       dsieger  2009: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2010: <a name="building-a-single-binary-package"></a>7.1. Building a single binary package</h2></div></div></div>
1.1       dsieger  2011: <p>Once you have built and installed a package, you can create
                   2012:     a <span class="emphasis"><em>binary package</em></span> which can be installed on
1.157     leot     2013:     another system with <a class="citerefentry" href="http://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  2014:     the same package on a group of hosts and wasting CPU time. It also
                   2015:     provides a simple means for others to install your package, should
                   2016:     you distribute it.</p>
                   2017: <p>To create a binary package, change into the appropriate
1.10      hubertf  2018:     directory in pkgsrc, and run <span class="command"><strong>make
1.1       dsieger  2019:     package</strong></span>:</p>
                   2020: <pre class="screen">
1.112     rillig   2021: <code class="prompt">$</code> <strong class="userinput"><code>cd misc/figlet</code></strong>
                   2022: <code class="prompt">$</code> <strong class="userinput"><code>make package</code></strong>
                   2023: </pre>
1.1       dsieger  2024: <p>This will build and install your package (if not already done),
                   2025:     and then build a binary package from what was installed. You can
1.10      hubertf  2026:     then use the <span class="command"><strong>pkg_*</strong></span> tools to manipulate
1.1       dsieger  2027:     it. Binary packages are created by default in
                   2028:     <code class="filename">/usr/pkgsrc/packages</code>, in the form of a
1.10      hubertf  2029:     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     2030:     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   2031: <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  2032:     such a binary package.</p>
                   2033: </div>
1.41      asau     2034: <div class="sect1">
1.1       dsieger  2035: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2036: <a name="settings-for-creationg-of-binary-packages"></a>7.2. Settings for creation of binary packages</h2></div></div></div>
                   2037: <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   2038: </div>
                   2039: </div>
1.41      asau     2040: <div class="chapter">
1.6       rillig   2041: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   2042: <a name="bulk"></a>Chapter 8. Creating binary packages for everything in pkgsrc (bulk
1.6       rillig   2043: builds)</h2></div></div></div>
                   2044: <div class="toc">
                   2045: <p><b>Table of Contents</b></p>
1.100     leot     2046: <dl class="toc">
1.154     rillig   2047: <dt><span class="sect1"><a href="#bulk.pre">8.1. Preparations</a></span></dt>
                   2048: <dt><span class="sect1"><a href="#bulk.pbulk">8.2. Running a pbulk-style bulk build</a></span></dt>
                   2049: <dd><dl><dt><span class="sect2"><a href="#bulk.pbulk.conf">8.2.1. Configuration</a></span></dt></dl></dd>
                   2050: <dt><span class="sect1"><a href="#bulk.req">8.3. Requirements of a full bulk build</a></span></dt>
                   2051: <dt><span class="sect1"><a href="#creating-cdroms">8.4. Creating a multiple CD-ROM packages collection</a></span></dt>
                   2052: <dd><dl><dt><span class="sect2"><a href="#cdpack-example">8.4.1. Example of cdpack</a></span></dt></dl></dd>
1.6       rillig   2053: </dl>
                   2054: </div>
1.71      wiz      2055: <p>For a number of reasons you may want to build binary packages
                   2056: for a large selected set of packages in pkgsrc or even for all pkgsrc packages.
                   2057: For instance, when you have multiple machines that should run the same software,
                   2058: it is wasted time if they all build their packages themselves from source.
                   2059: Or you may want to build a list of packages you want and check them before
                   2060: deploying onto production system.
                   2061: There is a way of getting a set of binary packages:
1.112     rillig   2062: The bulk build system, or pbulk ("p" stands for "parallel").
                   2063: This chapter describes how to set it up.</p>
1.41      asau     2064: <div class="sect1">
1.6       rillig   2065: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2066: <a name="bulk.pre"></a>8.1. Preparations</h2></div></div></div>
1.71      wiz      2067: <p>First of all, you have to decide whether you build all packages
                   2068: or a limited set of them. Full bulk builds usually consume a lot more resources,
                   2069: both space and time, than builds for some practical sets of packages.
                   2070: There exists a number of particularly heavy packages that are not actually
                   2071: interesting to a wide audience.
                   2072: 
                   2073: For a limited bulk builds you need to make a list of packages you want to build.
1.112     rillig   2074: Note that all their dependencies will be built, so you don't need to track them manually.
1.71      wiz      2075: </p>
                   2076: <p>During bulk builds various packages are installed and deinstalled
                   2077: in <code class="filename">/usr/pkg</code> (or whatever <code class="filename">LOCALBASE</code> is),
                   2078: so make sure that you don't need any package during the builds.
1.112     rillig   2079: Essentially, you should provide a fresh system, either a chroot environment
1.71      wiz      2080: or something even more restrictive, depending on what the operating system provides,
                   2081: or dedicate the whole physical machine.
                   2082: As a useful side effect this makes sure that bulk builds cannot
                   2083: break anything in your system. There have been numerous cases where
1.6       rillig   2084: certain packages tried to install files outside the
                   2085: <code class="filename">LOCALBASE</code> or wanted to edit some files in
1.71      wiz      2086: <code class="filename">/etc</code>.
                   2087: </p>
1.6       rillig   2088: </div>
1.41      asau     2089: <div class="sect1">
1.6       rillig   2090: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2091: <a name="bulk.pbulk"></a>8.2. Running a pbulk-style bulk build</h2></div></div></div>
1.15      rillig   2092: <p>Running a pbulk-style bulk build works roughly as follows:</p>
1.41      asau     2093: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      2094: <li class="listitem"><p>First, build the pbulk infrastructure in a fresh pkgsrc location.</p></li>
                   2095: <li class="listitem"><p>Then, build each of the packages from a clean installation directory using the infrastructure.</p></li>
1.15      rillig   2096: </ul></div>
1.41      asau     2097: <div class="sect2">
1.15      rillig   2098: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   2099: <a name="bulk.pbulk.conf"></a>8.2.1. Configuration</h3></div></div></div>
1.112     rillig   2100: <p>To simplify configuration, we provide the helper script <code class="filename">mk/pbulk/pbulk.sh</code>.</p>
1.68      asau     2101: <p>In order to use it, prepare a clear system (real one, chroot environment, jail, zone, virtual machine).
                   2102: Configure network access to fetch distribution files.
1.112     rillig   2103: Create a user with name "pbulk".</p>
1.68      asau     2104: <p>Fetch and extract pkgsrc. Use a command like one of these:</p>
                   2105: <pre class="screen">
1.151     sevan    2106: <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>
                   2107: <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      2108: <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     2109: </pre>
                   2110: <p>Or any other way that fits (e.g., curl, wget).</p>
                   2111: <p>Deploy and configure pbulk tools, e.g.:</p>
                   2112: <pre class="screen">
1.118     sevan    2113: <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     2114: <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>
                   2115: <code class="prompt">#</code> <strong class="userinput"><code>sh pbulk.sh -nlc mk.conf.frag # native, apply settings, configure for limited build</code></strong>
                   2116: </pre>
                   2117: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2118: <h3 class="title">Note</h3>
                   2119: <p><code class="filename">mk.conf.frag</code> is a fragment of
                   2120: <code class="filename">mk.conf</code> that contains settings you want to
                   2121: apply to packages you build. For instance,</p>
                   2122: <pre class="programlisting">
1.112     rillig   2123: PKG_DEVELOPER=          yes     # perform more checks
                   2124: X11_TYPE=               modular # use pkgsrc X11
                   2125: SKIP_LICENSE_CHECK=     yes     # accept all licences (useful
                   2126:                                 # when building all packages)
1.68      asau     2127: </pre>
                   2128: </div>
                   2129: <p>If configured for limited list, replace the list in <code class="filename">/usr/pbulk/etc/pbulk.list</code>
1.112     rillig   2130: with your list of packages, one per line without empty lines or comments. E.g.:</p>
1.68      asau     2131: <pre class="programlisting">
                   2132: www/firefox
                   2133: mail/thunderbird
                   2134: misc/libreoffice4
                   2135: </pre>
1.69      asau     2136: <p>At this point you can also review configuration in <code class="filename">/usr/pbulk/etc</code>
                   2137: and make final amendments, if wanted.</p>
1.68      asau     2138: <p>Start it:</p>
                   2139: <pre class="screen">
                   2140: <code class="prompt">#</code> <strong class="userinput"><code>/usr/pbulk/bin/bulkbuild</code></strong>
                   2141: </pre>
                   2142: <p>After it finishes, you'll have <code class="filename">/mnt</code> filled with distribution files, binary packages, and reports,
                   2143: plain text summary in <code class="filename">/mnt/bulklog/meta/report.txt</code>
                   2144: </p>
                   2145: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2146: <h3 class="title">Note</h3>
                   2147: <p>The <code class="filename">pbulk.sh</code> script does not cover all possible use cases.
                   2148: While being ready to run, it serves as a good starting point to understand and build more complex setups.
                   2149: The script is kept small enough for better understanding.</p>
                   2150: </div>
                   2151: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
                   2152: <h3 class="title">Note</h3>
                   2153: <p>The <code class="filename">pbulk.sh</code> script supports running
                   2154: unprivileged bulk build and helps configuring distributed bulk builds.</p>
                   2155: </div>
1.6       rillig   2156: </div>
                   2157: </div>
1.41      asau     2158: <div class="sect1">
1.6       rillig   2159: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2160: <a name="bulk.req"></a>8.3. Requirements of a full bulk build</h2></div></div></div>
1.71      wiz      2161: <p>A complete bulk build requires lots of disk space. Some of the
                   2162: disk space can be read-only, some other must be writable. Some can be on
                   2163: remote filesystems (such as NFS) and some should be local. Some can be
                   2164: temporary filesystems, others must survive a sudden reboot.</p>
                   2165: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   2166: <li class="listitem"><p>40 GB for the distfiles (read-write, remote, temporary)</p></li>
                   2167: <li class="listitem"><p>30 GB for the binary packages (read-write, remote, permanent)</p></li>
                   2168: <li class="listitem"><p>1 GB for the pkgsrc tree (read-only, remote, permanent)</p></li>
                   2169: <li class="listitem"><p>5 GB for <code class="filename">LOCALBASE</code> (read-write, local, temporary)</p></li>
                   2170: <li class="listitem"><p>10 GB for the log files (read-write, remote, permanent)</p></li>
                   2171: <li class="listitem"><p>5 GB for temporary files (read-write, local, temporary)</p></li>
                   2172: </ul></div>
                   2173: </div>
                   2174: <div class="sect1">
                   2175: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2176: <a name="creating-cdroms"></a>8.4. Creating a multiple CD-ROM packages collection</h2></div></div></div>
1.1       dsieger  2177: <p>After your pkgsrc bulk-build has completed, you may wish to
                   2178:     create a CD-ROM set of the resulting binary packages to assist
                   2179:     in installing packages on other machines.  The
1.137     leot     2180:     <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  2181:     a simple tool for creating the ISO 9660 images.
1.10      hubertf  2182:     <span class="command"><strong>cdpack</strong></span> arranges the packages on the CD-ROMs in a
1.1       dsieger  2183:     way that keeps all the dependencies for a given package on the same
                   2184:     CD as that package.</p>
1.41      asau     2185: <div class="sect2">
1.1       dsieger  2186: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   2187: <a name="cdpack-example"></a>8.4.1. Example of cdpack</h3></div></div></div>
1.1       dsieger  2188: <p>Complete documentation for cdpack is found in the cdpack(1)
                   2189:       man page. The following short example assumes that the binary
                   2190:       packages are left in
                   2191:       <code class="filename">/usr/pkgsrc/packages/All</code> and that
                   2192:       sufficient disk space exists in <code class="filename">/u2</code> to
                   2193:       hold the ISO 9660 images.</p>
                   2194: <pre class="screen">
                   2195: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /u2/images</code></strong>
                   2196: <code class="prompt">#</code> <strong class="userinput"><code>pkg_add /usr/pkgsrc/packages/All/cdpack</code></strong>
                   2197: <code class="prompt">#</code> <strong class="userinput"><code>cdpack /usr/pkgsrc/packages/All /u2/images</code></strong>
                   2198:       </pre>
                   2199: <p>If you wish to include a common set of files
                   2200:       (<code class="filename">COPYRIGHT</code>, <code class="filename">README</code>,
                   2201:       etc.) on each CD in the collection, then you need to create a
                   2202:       directory which contains these files. e.g.</p>
                   2203: <pre class="screen">
                   2204: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common</code></strong>
                   2205: <code class="prompt">#</code> <strong class="userinput"><code>echo "This is a README" &gt; /tmp/common/README</code></strong>
                   2206: <code class="prompt">#</code> <strong class="userinput"><code>echo "Another file" &gt; /tmp/common/COPYING</code></strong>
                   2207: <code class="prompt">#</code> <strong class="userinput"><code>mkdir /tmp/common/bin</code></strong>
                   2208: <code class="prompt">#</code> <strong class="userinput"><code>echo "#!/bin/sh" &gt; /tmp/common/bin/myscript</code></strong>
                   2209: <code class="prompt">#</code> <strong class="userinput"><code>echo "echo Hello world" &gt;&gt; /tmp/common/bin/myscript</code></strong>
                   2210: <code class="prompt">#</code> <strong class="userinput"><code>chmod 755 /tmp/common/bin/myscript</code></strong>
                   2211:       </pre>
                   2212: <p>Now create the images:</p>
                   2213: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cdpack -x /tmp/common /usr/pkgsrc/packages/All /u2/images</code></strong></pre>
                   2214: <p>Each image will contain <code class="filename">README</code>,
                   2215:       <code class="filename">COPYING</code>, and <code class="filename">bin/myscript</code>
                   2216:       in their root directories.</p>
                   2217: </div>
                   2218: </div>
                   2219: </div>
1.41      asau     2220: <div class="chapter">
1.1       dsieger  2221: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   2222: <a name="files"></a>Chapter 9. Directory layout of the installed files</h2></div></div></div>
1.1       dsieger  2223: <div class="toc">
                   2224: <p><b>Table of Contents</b></p>
1.100     leot     2225: <dl class="toc">
1.154     rillig   2226: <dt><span class="sect1"><a href="#files.localbase">9.1. File system layout in <code class="literal">${LOCALBASE}</code></a></span></dt>
                   2227: <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  2228: </dl>
                   2229: </div>
                   2230: <p>The files that are installed by pkgsrc are organized in a way that
                   2231: is similar to what you find in the <code class="filename">/usr</code> directory
                   2232: of the base system. But some details are different. This is because
                   2233: pkgsrc initially came from FreeBSD and had adopted its file system
                   2234: hierarchy. Later it was largely influenced by NetBSD. But no matter
                   2235: which operating system you are using pkgsrc with, you can expect the
                   2236: same layout for pkgsrc.</p>
                   2237: <p>There are mainly four root directories for pkgsrc, which are all
                   2238: configurable in the <code class="filename">bootstrap/bootstrap</code> script.
                   2239: When pkgsrc has been installed as root, the default locations
                   2240: are:</p>
                   2241: <pre class="programlisting">
                   2242: LOCALBASE=              /usr/pkg
                   2243: PKG_SYSCONFBASE=        /usr/pkg/etc
                   2244: VARBASE=                /var
1.119     sevan    2245: PKG_DBDIR=              /usr/pkg/pkgdb
1.1       dsieger  2246: </pre>
                   2247: <p>In unprivileged mode (when pkgsrc has been installed as any other
                   2248: user), the default locations are:</p>
                   2249: <pre class="programlisting">
                   2250: LOCALBASE=              ${HOME}/pkg
                   2251: PKG_SYSCONFBASE=        ${HOME}/pkg/etc
                   2252: VARBASE=                ${HOME}/pkg/var
1.119     sevan    2253: PKG_DBDIR=              ${HOME}/pkg/pkgdb
1.1       dsieger  2254: </pre>
                   2255: <p>What these four directories are for, and what they look like is
                   2256: explained below.</p>
1.41      asau     2257: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      2258: <li class="listitem"><p><code class="varname">LOCALBASE</code> corresponds to the
1.1       dsieger  2259: <code class="filename">/usr</code> directory in the base system. It is the
1.23      wiz      2260: <span class="quote">&#8220;<span class="quote">main</span>&#8221;</span> directory where the files are installed and contains
1.1       dsieger  2261: the well-known subdirectories like <code class="filename">bin</code>,
                   2262: <code class="filename">include</code>, <code class="filename">lib</code>,
                   2263: <code class="filename">share</code> and
                   2264: <code class="filename">sbin</code>.</p></li>
1.23      wiz      2265: <li class="listitem"><p><code class="varname">VARBASE</code> corresponds to
1.1       dsieger  2266: <code class="filename">/var</code> in the base system. Some programs (especially
                   2267: games, network daemons) need write access to it during normal
                   2268: operation.</p></li>
1.23      wiz      2269: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR</code> corresponds to
1.1       dsieger  2270: <code class="filename">/etc</code> in the base system. It contains configuration
1.10      hubertf  2271: 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  2272: itself.</p></li>
                   2273: </ul></div>
1.41      asau     2274: <div class="sect1">
1.1       dsieger  2275: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2276: <a name="files.localbase"></a>9.1. File system layout in <code class="literal">${LOCALBASE}</code>
1.1       dsieger  2277: </h2></div></div></div>
                   2278: <p>The following directories exist in a typical pkgsrc installation
                   2279: in <code class="filename">${LOCALBASE}</code>.</p>
1.41      asau     2280: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  2281: <dt><span class="term"><code class="filename">bin</code></span></dt>
                   2282: <dd><p>Contains executable programs that are intended to be
                   2283: directly used by the end user.</p></dd>
                   2284: <dt><span class="term"><code class="filename">emul</code></span></dt>
                   2285: <dd><p>Contains files for the emulation layers of various other
                   2286: operating systems, especially for
                   2287: NetBSD.</p></dd>
                   2288: <dt><span class="term"><code class="filename">etc</code> (the usual location of
                   2289: <code class="filename">${PKG_SYSCONFDIR}</code>)</span></dt>
                   2290: <dd><p>Contains
                   2291: the configuration files.</p></dd>
                   2292: <dt><span class="term"><code class="filename">include</code></span></dt>
                   2293: <dd><p>Contains headers for the C and C++ programming
                   2294: languages.</p></dd>
                   2295: <dt><span class="term"><code class="filename">info</code></span></dt>
                   2296: <dd><p>Contains GNU info files of various
                   2297: packages.</p></dd>
                   2298: <dt><span class="term"><code class="filename">lib</code></span></dt>
                   2299: <dd><p>Contains shared and static
                   2300: libraries.</p></dd>
                   2301: <dt><span class="term"><code class="filename">libdata</code></span></dt>
                   2302: <dd><p>Contains data files that don't change after
                   2303: installation. Other data files belong into
                   2304: <code class="filename">${VARBASE}</code>.</p></dd>
                   2305: <dt><span class="term"><code class="filename">libexec</code></span></dt>
                   2306: <dd><p>Contains programs that are not intended to be used by
                   2307: end users, such as helper programs or network
                   2308: daemons.</p></dd>
                   2309: <dt><span class="term"><code class="filename">libexec/cgi-bin</code></span></dt>
                   2310: <dd><p>Contains programs that are intended to be executed as
                   2311: CGI scripts by a web server.</p></dd>
                   2312: <dt><span class="term"><code class="filename">man</code> (the usual value of
                   2313: <code class="filename">${PKGMANDIR}</code>)</span></dt>
                   2314: <dd><p>Contains brief
                   2315: documentation in form of manual pages.</p></dd>
                   2316: <dt><span class="term"><code class="filename">sbin</code></span></dt>
                   2317: <dd><p>Contains programs that are intended to be used only by
                   2318: the super-user.</p></dd>
                   2319: <dt><span class="term"><code class="filename">share</code></span></dt>
                   2320: <dd><p>Contains platform-independent data files that don't
                   2321: change after installation.</p></dd>
                   2322: <dt><span class="term"><code class="filename">share/doc</code></span></dt>
                   2323: <dd><p>Contains documentation files provided by the
                   2324: packages.</p></dd>
                   2325: <dt><span class="term"><code class="filename">share/examples</code></span></dt>
                   2326: <dd><p>Contains example files provided by the packages. Among
                   2327: others, the original configuration files are saved here and copied to
                   2328: <code class="filename">${PKG_SYSCONFDIR}</code> during
                   2329: installation.</p></dd>
                   2330: <dt><span class="term"><code class="filename">share/examples/rc.d</code></span></dt>
                   2331: <dd><p>Contains the original files for rc.d
                   2332: scripts.</p></dd>
                   2333: <dt><span class="term"><code class="filename">var</code> (the usual location of
                   2334: <code class="filename">${VARBASE}</code>)</span></dt>
                   2335: <dd><p>Contains files
                   2336: that may be modified after
                   2337: installation.</p></dd>
                   2338: </dl></div>
                   2339: </div>
1.41      asau     2340: <div class="sect1">
1.1       dsieger  2341: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2342: <a name="files.varbase"></a>9.2. File system layout in <code class="literal">${VARBASE}</code>
1.1       dsieger  2343: </h2></div></div></div>
1.41      asau     2344: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  2345: <dt><span class="term"><code class="filename">db/pkg</code> (the usual location of
                   2346: <code class="filename">${PKG_DBDIR}</code>)</span></dt>
                   2347: <dd><p>Contains
                   2348: information about the currently installed
                   2349: packages.</p></dd>
                   2350: <dt><span class="term"><code class="filename">games</code></span></dt>
                   2351: <dd><p>Contains highscore
                   2352: files.</p></dd>
                   2353: <dt><span class="term"><code class="filename">log</code></span></dt>
                   2354: <dd><p>Contains log files.</p></dd>
                   2355: <dt><span class="term"><code class="filename">run</code></span></dt>
                   2356: <dd><p>Contains informational files about daemons that are
                   2357: currently running.</p></dd>
                   2358: </dl></div>
                   2359: </div>
                   2360: </div>
1.41      asau     2361: <div class="chapter">
1.1       dsieger  2362: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   2363: <a name="faq"></a>Chapter 10. Frequently Asked Questions</h2></div></div></div>
1.1       dsieger  2364: <div class="toc">
                   2365: <p><b>Table of Contents</b></p>
1.100     leot     2366: <dl class="toc">
1.154     rillig   2367: <dt><span class="sect1"><a href="#mailing-list-pointers">10.1. Are there any mailing lists for pkg-related discussion?</a></span></dt>
                   2368: <dt><span class="sect1"><a href="#faq-pkgtools">10.2. Utilities for package management (pkgtools)</a></span></dt>
                   2369: <dt><span class="sect1"><a href="#non-root-pkgsrc">10.3. How to use pkgsrc as non-root</a></span></dt>
                   2370: <dt><span class="sect1"><a href="#resume-transfers">10.4. How to resume transfers when fetching distfiles?</a></span></dt>
                   2371: <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>
                   2372: <dt><span class="sect1"><a href="#fetch-behind-firewall">10.6. How to fetch files from behind a firewall</a></span></dt>
                   2373: <dt><span class="sect1"><a href="#fetch-https">10.7. How to fetch files from HTTPS sites</a></span></dt>
                   2374: <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>
                   2375: <dt><span class="sect1"><a href="#fetching-all-distfiles">10.9. How to fetch all distfiles at once</a></span></dt>
                   2376: <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      2377: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</a></span></dt>
1.154     rillig   2378: <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>
                   2379: <dt><span class="sect1"><a href="#using-sudo-with-pkgsrc">10.12. Using 'sudo' with pkgsrc</a></span></dt>
                   2380: <dt><span class="sect1"><a href="#faq.conf">10.13. How do I change the location of configuration files?</a></span></dt>
                   2381: <dt><span class="sect1"><a href="#audit-packages">10.14. Automated security checks</a></span></dt>
                   2382: <dt><span class="sect1"><a href="#ufaq-cflags">10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</a></span></dt>
                   2383: <dt><span class="sect1"><a href="#ufaq-fail">10.16. A package does not build.  What shall I do?</a></span></dt>
                   2384: <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  2385: </dl>
                   2386: </div>
                   2387: <p>This section contains hints, tips &amp; tricks on special things in
                   2388: pkgsrc that we didn't find a better place for in the previous chapters, and
                   2389: it contains items for both pkgsrc users and developers.</p>
1.41      asau     2390: <div class="sect1">
1.1       dsieger  2391: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2392: <a name="mailing-list-pointers"></a>10.1. Are there any mailing lists for pkg-related discussion?</h2></div></div></div>
1.1       dsieger  2393: <p>The following mailing lists may be of interest to pkgsrc users:</p>
1.41      asau     2394: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      2395: <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  2396:          This is a general purpose list for most issues regarding
                   2397:          pkgsrc, regardless of platform, e.g. soliciting user help
                   2398:          for pkgsrc configuration, unexpected build failures, using
                   2399:          particular packages, upgrading pkgsrc installations,
                   2400:          questions regarding the pkgsrc release branches, etc.  General announcements or
                   2401:          proposals for changes that impact the pkgsrc user community,
                   2402:          e.g. major infrastructure changes, new features, package
                   2403:          removals, etc., may also be posted.</p></li>
1.23      wiz      2404: <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  2405:          A list where the results of pkgsrc bulk builds are sent and
                   2406:          discussed.</p></li>
1.23      wiz      2407: <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  2408:          This list is for those who are interested in getting a
                   2409:          commit message for every change committed to pkgsrc. It is
                   2410:          also available in digest form, meaning one daily message
                   2411:          containing all commit messages for changes to the package
                   2412:          source tree in that 24 hour period.</p></li>
                   2413: </ul></div>
                   2414: <p>To subscribe, do:</p>
                   2415: <pre class="programlisting">
                   2416: <code class="prompt">%</code> echo subscribe <em class="replaceable"><code>listname</code></em> | mail majordomo@NetBSD.org
                   2417: </pre>
                   2418: <p>Archives for all these mailing lists are available from
1.10      hubertf  2419: <a class="ulink" href="http://mail-index.NetBSD.org/" target="_top">http://mail-index.NetBSD.org/</a>.</p>
1.1       dsieger  2420: </div>
1.41      asau     2421: <div class="sect1">
1.1       dsieger  2422: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2423: <a name="faq-pkgtools"></a>10.2. Utilities for package management (pkgtools)</h2></div></div></div>
1.1       dsieger  2424: <p>The directory <code class="filename">pkgsrc/pkgtools</code> contains
                   2425: a number of useful utilities for both users and developers of pkgsrc.  This
1.121     sevan    2426: section attempts only to make the reader aware of some of the utilities and when
1.1       dsieger  2427: they might be useful, and not to duplicate the documentation that comes
                   2428: with each package.</p>
                   2429: <p>Utilities used by pkgsrc (automatically installed when needed):</p>
1.137     leot     2430: <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  2431:       Symlinks for use by buildlink.</p></li></ul></div>
                   2432: <p>OS tool augmentation (automatically installed when needed):</p>
1.41      asau     2433: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.137     leot     2434: <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    2435:       Calculates various kinds of checksums (including SHA3).</p></li>
1.137     leot     2436: <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  2437:       Compatibility library for pkgsrc tools.</p></li>
1.137     leot     2438: <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  2439:       non-BSD systems due to lack of native mtree.</p></li>
1.137     leot     2440: <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  2441:       Up-to-date replacement for
                   2442:       <code class="filename">/usr/sbin/pkg_install</code>, or for use on operating
                   2443:       systems where pkg_install is not present.</p></li>
                   2444: </ul></div>
                   2445: <p>Utilities used by pkgsrc (not automatically installed):</p>
1.41      asau     2446: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.137     leot     2447: <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  2448:       Create a binary package from an
1.10      hubertf  2449:       already-installed package.  Used by <span class="command"><strong>make replace</strong></span> to
1.1       dsieger  2450:       save the old package.</p></li>
1.137     leot     2451: <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  2452:       Adds extra functionality to pkgsrc, allowing it to fetch distfiles
                   2453:       from multiple locations. It currently supports the following
                   2454:       methods: multiple CD-ROMs and network FTP/HTTP connections.</p></li>
1.137     leot     2455: <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  2456:       the best compiler flags to optimise code for your current
1.23      wiz      2457:       CPU and compiler. </p></li>
1.1       dsieger  2458: </ul></div>
                   2459: <p>Utilities for keeping track of installed packages, being up to date,
                   2460: etc:</p>
1.41      asau     2461: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.137     leot     2462: <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      2463:     update tool similar to apt(1). Download, install, and upgrade
                   2464:     binary packages easily.</p></li>
1.137     leot     2465: <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  2466:       packages whose installed versions do not match the latest pkgsrc
                   2467:       entries.</p></li>
1.137     leot     2468: <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  2469:       dependency graphs of packages, to aid in choosing a strategy for
                   2470:       updating.</p></li>
1.137     leot     2471: <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
                   2472:       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>
                   2473: <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   2474:       pkglint(1) program checks a pkgsrc entry for errors.</p></li>
1.137     leot     2475: <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  2476:       does various checks on the complete pkgsrc system.</p></li>
1.137     leot     2477: <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  2478:       packages you have installed.</p></li>
                   2479: </ul></div>
                   2480: <p>Utilities for people maintaining or creating individual packages:</p>
1.41      asau     2481: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.137     leot     2482: <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  2483:       making and maintaining patches for a package (includes pkgdiff,
                   2484:       pkgvi, mkpatches, etc.).</p></li>
1.137     leot     2485: <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  2486:       converting to pkgsrc.</p></li>
                   2487: </ul></div>
                   2488: <p>Utilities for people maintaining pkgsrc (or: more obscure pkg
                   2489: utilities)</p>
1.41      asau     2490: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.137     leot     2491: <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  2492:       packages in a chrooted area.</p></li>
1.137     leot     2493: <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  2494:       kernel version for chrooted cross builds.</p></li>
                   2495: </ul></div>
                   2496: </div>
1.41      asau     2497: <div class="sect1">
1.1       dsieger  2498: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2499: <a name="non-root-pkgsrc"></a>10.3. How to use pkgsrc as non-root</h2></div></div></div>
1.108     rillig   2500: <p>To install packages from source as a non-root user, download
1.154     rillig   2501: 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   2502: directory and run the command <span class="command"><strong>./bootstrap/bootstrap
                   2503: --unprivileged</strong></span>.</p>
                   2504: <p>This will install the binary part of pkgsrc to
                   2505: <code class="filename">~/pkg</code> and put the pkgsrc configuration <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>
                   2506: into <code class="filename">~/pkg/etc</code>.</p>
                   2507: <p>For more details, see <code class="filename">mk/unprivileged.mk</code>.</p>
1.1       dsieger  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="resume-transfers"></a>10.4. How to resume transfers when fetching distfiles?</h2></div></div></div>
1.1       dsieger  2512: <p>By default, resuming transfers in pkgsrc is disabled, but you can
                   2513: enable this feature by adding the option
                   2514: <code class="varname">PKG_RESUME_TRANSFERS=YES</code> into
1.10      hubertf  2515: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  If, during a fetch step, an incomplete
1.1       dsieger  2516: distfile is found, pkgsrc will try to resume it.</p>
                   2517: <p>You can also
1.61      wiz      2518: use a different program than the platform default program by changing the
1.16      jnemeth  2519: <code class="varname">FETCH_USING</code> variable.  You can specify the program by
                   2520: using of ftp, fetch, wget or curl.  Alternatively, fetching can be disabled
                   2521: by using the value manual.  A value of custom disables the system defaults
                   2522: and dependency tracking for the fetch program.  In that case you have to
                   2523: provide <code class="varname">FETCH_CMD</code>, <code class="varname">FETCH_BEFORE_ARGS</code>,
                   2524: <code class="varname">FETCH_RESUME_ARGS</code>, <code class="varname">FETCH_OUTPUT_ARGS</code>,
                   2525: <code class="varname">FETCH_AFTER_ARGS</code>.</p>
1.1       dsieger  2526: <p>For example, if you want to use
1.16      jnemeth  2527: <code class="filename">wget</code> to download, you'll have to use something
1.1       dsieger  2528: like:</p>
                   2529: <pre class="programlisting">
1.112     rillig   2530: FETCH_USING=    wget
1.1       dsieger  2531: </pre>
                   2532: </div>
1.41      asau     2533: <div class="sect1">
1.1       dsieger  2534: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2535: <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   2536: <p>If you want to use modular X.org from pkgsrc instead of your system's own X11
1.1       dsieger  2537: (<code class="filename">/usr/X11R6</code>, <code class="filename">/usr/openwin</code>, ...)
                   2538: you will have to add the following line into
1.10      hubertf  2539: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>:</p>
1.1       dsieger  2540: <pre class="programlisting">
1.4       rillig   2541: X11_TYPE=modular
1.1       dsieger  2542: </pre>
                   2543: </div>
1.41      asau     2544: <div class="sect1">
1.1       dsieger  2545: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2546: <a name="fetch-behind-firewall"></a>10.6. How to fetch files from behind a firewall</h2></div></div></div>
1.1       dsieger  2547: <p>If you are sitting behind a firewall which does not allow direct
                   2548: connections to Internet hosts (i.e. non-NAT), you may specify the
                   2549: relevant proxy hosts.  This is done using an environment variable in the
                   2550: form of a URL, e.g. in Amdahl, the machine
1.23      wiz      2551: <span class="quote">&#8220;<span class="quote">orpheus.amdahl.com</span>&#8221;</span> is one of the firewalls, and it uses
1.1       dsieger  2552: port 80 as the proxy port number.  So the proxy environment variables
                   2553: are:</p>
                   2554: <pre class="programlisting">
                   2555: ftp_proxy=ftp://orpheus.amdahl.com:80/
                   2556: http_proxy=http://orpheus.amdahl.com:80/
                   2557: </pre>
                   2558: </div>
1.41      asau     2559: <div class="sect1">
1.1       dsieger  2560: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2561: <a name="fetch-https"></a>10.7. How to fetch files from HTTPS sites</h2></div></div></div>
1.65      wiz      2562: <p>Some fetch tools are not prepared to support HTTPS by default
                   2563: (for example, the one in NetBSD 6.0), or the one installed by the
                   2564: pkgsrc bootstrap (to avoid an openssl dependency that low in the
                   2565: dependency graph).</p>
                   2566: <p>Usually you won't notice, because distribution files are
                   2567: mirrored weekly to <span class="quote">&#8220;<span class="quote">ftp.NetBSD.org</span>&#8221;</span>, but that might not
                   2568: be often enough if you are following pkgsrc-current. In that case, set
                   2569: <code class="varname">FETCH_USING</code> in your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file to
                   2570: <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
                   2571: with HTTPS support by default. Of course, these tools need to be
                   2572: installed before you can use them this way.</p>
                   2573: </div>
                   2574: <div class="sect1">
                   2575: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2576: <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  2577: <p>This depends on which utility is used to retrieve distfiles.  From
                   2578: <code class="filename">bsd.pkg.mk</code>, <code class="varname">FETCH_CMD</code> is assigned
                   2579: the first available command from the following list:</p>
1.41      asau     2580: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      2581: <li class="listitem"><p><code class="filename">${LOCALBASE}/bin/ftp</code></p></li>
                   2582: <li class="listitem"><p><code class="filename">/usr/bin/ftp</code></p></li>
1.1       dsieger  2583: </ul></div>
                   2584: <p>On a default NetBSD installation, this will be
                   2585: <code class="filename">/usr/bin/ftp</code>, which automatically tries passive
                   2586: connections first, and falls back to active connections if the server
                   2587: refuses to do passive.  For the other tools, add the following to your
1.10      hubertf  2588: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> file:
1.1       dsieger  2589: <code class="varname">PASSIVE_FETCH=1</code>.</p>
                   2590: <p>Having that option present will prevent
                   2591: <code class="filename">/usr/bin/ftp</code> from falling back to active
                   2592: transfers.</p>
                   2593: </div>
1.41      asau     2594: <div class="sect1">
1.1       dsieger  2595: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2596: <a name="fetching-all-distfiles"></a>10.9. How to fetch all distfiles at once</h2></div></div></div>
1.1       dsieger  2597: <p>You would like to download all the distfiles in a single batch
1.10      hubertf  2598: from work or university, where you can't run a <span class="command"><strong>make
1.25      spz      2599: 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  2600: but downloading the entire directory may not be appropriate.</p>
1.10      hubertf  2601: <p>The answer here is to do a <span class="command"><strong>make fetch-list</strong></span> in
1.1       dsieger  2602: <code class="filename">/usr/pkgsrc</code> or one of its subdirectories, carry the
                   2603: resulting list to your machine at work/school and use it there.  If you
1.157     leot     2604: don't have a NetBSD-compatible <a class="citerefentry" href="http://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  2605: forget to set <code class="varname">FETCH_CMD</code> to something that fetches a
                   2606: URL:</p>
                   2607: <p>At home:</p>
                   2608: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   2609: <code class="prompt">%</code> <strong class="userinput"><code>make fetch-list FETCH_CMD=wget DISTDIR=/tmp/distfiles &gt;/tmp/fetch.sh</code></strong>
                   2610: <code class="prompt">%</code> <strong class="userinput"><code>scp /tmp/fetch.sh work:/tmp</code></strong></pre>
                   2611: <p>At work:</p>
                   2612: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>sh /tmp/fetch.sh</code></strong></pre>
                   2613: <p>then tar up <code class="filename">/tmp/distfiles</code> and take it
                   2614: home.</p>
                   2615: <p>If you have a machine running NetBSD, and you want to get
                   2616: <span class="emphasis"><em>all</em></span> distfiles (even ones that aren't for your
                   2617: machine architecture), you can do so by using the above-mentioned
1.10      hubertf  2618: <span class="command"><strong>make fetch-list</strong></span> approach, or fetch the distfiles
1.1       dsieger  2619: directly by running:</p>
                   2620: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make mirror-distfiles</code></strong></pre>
                   2621: <p>If you even decide to ignore
                   2622: <code class="varname">NO_{SRC,BIN}_ON_{FTP,CDROM}</code>, then you can get everything
                   2623: by running:</p>
                   2624: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make fetch NO_SKIP=yes</code></strong></pre>
                   2625: </div>
1.41      asau     2626: <div class="sect1">
1.1       dsieger  2627: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2628: <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      2629: /usr/share/tmac/tmac.andoc</span>&#8221;</span> mean?</h2></div></div></div>
1.137     leot     2630: <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  2631: package, you get the error from make that it doesn't know how to make
                   2632: <code class="filename">/usr/share/tmac/tmac.andoc</code>? This indicates that
1.23      wiz      2633: you don't have installed the <span class="quote">&#8220;<span class="quote">text</span>&#8221;</span> set (nroff, ...) from
1.1       dsieger  2634: the NetBSD base distribution on your machine.  It is recommended to do
                   2635: that to format man pages.</p>
1.137     leot     2636: <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  2637: can get away with setting <code class="varname">NOMAN=YES</code> either in the
1.10      hubertf  2638: environment or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1       dsieger  2639: </div>
1.41      asau     2640: <div class="sect1">
1.1       dsieger  2641: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2642: <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  2643: <p>You didn't install the compiler set, <code class="filename">comp.tgz</code>,
                   2644: when you installed your NetBSD machine.  Please get and install it, by
                   2645: extracting it in <code class="filename">/</code>:</p>
                   2646: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /</code></strong>
                   2647: <code class="prompt">#</code> <strong class="userinput"><code>tar --unlink -zxvpf .../comp.tgz</code></strong></pre>
                   2648: <p><code class="filename">comp.tgz</code> is part of every NetBSD release.  Get
1.10      hubertf  2649: the one that corresponds to your release (determine via <span class="command"><strong>uname
1.1       dsieger  2650: -r</strong></span>).</p>
                   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="using-sudo-with-pkgsrc"></a>10.12. Using 'sudo' with pkgsrc</h2></div></div></div>
1.1       dsieger  2655: <p>When installing packages as non-root user and using the just-in-time
1.157     leot     2656: <a class="citerefentry" href="http://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  2657: password for each required package installed.  To avoid this, the sudo
                   2658: package can be used, which does password caching over a limited time.  To
                   2659: use it, install sudo (either as binary package or from
1.137     leot     2660: <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  2661: following into your <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, somewhere
1.1       dsieger  2662: <span class="emphasis"><em>after</em></span> the definition of the
                   2663: <code class="varname">LOCALBASE</code> variable:</p>
                   2664: <pre class="programlisting">
                   2665: .if exists(${LOCALBASE}/bin/sudo)
                   2666: SU_CMD=        ${LOCALBASE}/bin/sudo /bin/sh -c
                   2667: .endif
                   2668: </pre>
                   2669: </div>
1.41      asau     2670: <div class="sect1">
1.1       dsieger  2671: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2672: <a name="faq.conf"></a>10.13. How do I change the location of configuration files?</h2></div></div></div>
1.1       dsieger  2673: <p>As the system administrator, you can choose where configuration files
                   2674: are installed.  The default settings make all these files go into
                   2675: <code class="filename">${PREFIX}/etc</code> or some of its subdirectories; this may
                   2676: be suboptimal depending on your expectations (e.g., a read-only,
                   2677: NFS-exported <code class="varname">PREFIX</code> with a need of per-machine
                   2678: configuration of the provided packages).</p>
                   2679: <p>In order to change the defaults, you can modify the
                   2680: <code class="varname">PKG_SYSCONFBASE</code> variable (in
1.10      hubertf  2681: <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>) to point to your preferred configuration
1.1       dsieger  2682: directory; some common examples include <code class="filename">/etc</code> or
                   2683: <code class="filename">/etc/pkg</code>.</p>
                   2684: <p>Furthermore, you can change this value on a per-package basis by
                   2685: setting the <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> variable.
                   2686: <code class="varname">PKG_SYSCONFVAR</code>'s value usually matches the name of the
                   2687: package you would like to modify, that is, the contents of
                   2688: <code class="varname">PKGBASE</code>.</p>
                   2689: <p>Note that after changing these settings, you must rebuild and
                   2690: reinstall any affected packages.</p>
                   2691: </div>
1.41      asau     2692: <div class="sect1">
1.1       dsieger  2693: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2694: <a name="audit-packages"></a>10.14. Automated security checks</h2></div></div></div>
1.1       dsieger  2695: <p>Please be aware that there can often be bugs in third-party software,
                   2696: and some of these bugs can leave a machine vulnerable to exploitation by
                   2697: attackers.  In an effort to lessen the exposure, the NetBSD packages team
                   2698: maintains a database of known-exploits to packages which have at one time
                   2699: been included in pkgsrc.  The database can be downloaded automatically, and
                   2700: a security audit of all packages installed on a system can take place.  To
1.14      jmcneill 2701: do this, refer to the following two tools (installed as part of the
1.137     leot     2702: <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      2703: <div class="orderedlist"><ol class="orderedlist" type="1">
                   2704: <li class="listitem">
1.20      snj      2705: <p><span class="command"><strong>pkg_admin fetch-pkg-vulnerabilities</strong></span>, an easy way to
1.1       dsieger  2706:     download a list of the security vulnerabilities information.  This list
1.25      spz      2707:     is kept up to date by the pkgsrc security team, and is distributed
                   2708:     from the NetBSD ftp server:</p>
                   2709: <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  2710: </li>
1.23      wiz      2711: <li class="listitem"><p><span class="command"><strong>pkg_admin audit</strong></span>, an easy way to audit the
                   2712:     current machine, checking each known vulnerability.  If a
1.1       dsieger  2713:     vulnerable package is installed, it will be shown by output to stdout,
                   2714:     including a description of the type of vulnerability, and a URL
                   2715:     containing more information.</p></li>
                   2716: </ol></div>
1.121     sevan    2717: <p>Use of these tools is strongly recommended!
1.154     rillig   2718: 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    2719: reporting.</p>
                   2720: <p>If this database is installed, pkgsrc builds will use it to
                   2721: perform a security check before building any package.</p>
1.1       dsieger  2722: </div>
1.41      asau     2723: <div class="sect1">
1.1       dsieger  2724: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2725: <a name="ufaq-cflags"></a>10.15. Why do some packages ignore my <code class="varname">CFLAGS</code>?</h2></div></div></div>
1.1       dsieger  2726: <p>When you add your own preferences to the
                   2727:        <code class="varname">CFLAGS</code> variable in your
1.10      hubertf  2728:        <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, these flags are passed in
1.1       dsieger  2729:        environment variables to the <code class="filename">./configure</code>
1.157     leot     2730:        scripts and to <a class="citerefentry" href="http://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  2731:        <code class="varname">CFLAGS</code> from the environment variable by
                   2732:        overriding them in the <code class="filename">Makefile</code>s of their
                   2733:        package.</p>
                   2734: <p>Currently there is no solution to this problem. If you
                   2735:        really need the package to use your <code class="varname">CFLAGS</code>
1.10      hubertf  2736:        you should run <span class="command"><strong>make patch</strong></span> in the package
1.1       dsieger  2737:        directory and then inspect any <code class="filename">Makefile</code> and
                   2738:        <code class="filename">Makefile.in</code> for whether they define
                   2739:        <code class="varname">CFLAGS</code> explicitly. Usually you can remove
1.23      wiz      2740:        these lines. But be aware that some <span class="quote">&#8220;<span class="quote">smart</span>&#8221;</span>
1.1       dsieger  2741:        programmers write so bad code that it only works for the
                   2742:        specific combination of <code class="varname">CFLAGS</code> they have
                   2743:        chosen.</p>
                   2744: </div>
1.41      asau     2745: <div class="sect1">
1.1       dsieger  2746: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2747: <a name="ufaq-fail"></a>10.16. A package does not build.  What shall I do?</h2></div></div></div>
1.23      wiz      2748: <div class="procedure"><ol class="procedure" type="1">
1.41      asau     2749: <li class="step"><p>Make sure that your copy of pkgsrc is consistent. A
1.1       dsieger  2750:        case that occurs often is that people only update pkgsrc in
                   2751:        parts, because of performance reasons. Since pkgsrc is one large
                   2752:        system, not a collection of many small systems, there are
                   2753:        sometimes changes that only work when the whole pkgsrc tree is
                   2754:        updated.</p></li>
1.41      asau     2755: <li class="step"><p>Make sure that you don't have any CVS conflicts.
1.23      wiz      2756:        Search for <span class="quote">&#8220;<span class="quote">&lt;&lt;&lt;&lt;&lt;&lt;</span>&#8221;</span> or
                   2757:        <span class="quote">&#8220;<span class="quote">&gt;&gt;&gt;&gt;&gt;&gt;</span>&#8221;</span> in all your pkgsrc
1.1       dsieger  2758:        files.</p></li>
1.41      asau     2759: <li class="step"><p>Make sure that you don't have old copies of the packages
1.10      hubertf  2760:        extracted. Run <span class="command"><strong>make clean clean-depends</strong></span> to
1.1       dsieger  2761:        verify this.</p></li>
1.108     rillig   2762: <li class="step"><p>If you are a package developer who wants to invest
1.154     rillig   2763:        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     2764: <li class="step"><p>If the problem still exists, write a mail to the
1.1       dsieger  2765:        <code class="literal">pkgsrc-users</code> mailing list.</p></li>
                   2766: </ol></div>
                   2767: </div>
1.41      asau     2768: <div class="sect1">
1.1       dsieger  2769: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   2770: <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  2771: <p>You have modified a file from pkgsrc, and someone else has
                   2772: modified that same file afterwards in the CVS repository. Both changes
                   2773: are in the same region of the file, so when you updated pkgsrc, the
                   2774: <code class="literal">cvs</code> command marked the conflicting changes in the
                   2775: file. Because of these markers, the file is no longer a valid
                   2776: <code class="filename">Makefile</code>.</p>
                   2777: <p>Have a look at that file, and if you don't need your local changes
1.10      hubertf  2778: anymore, you can remove that file and run <span class="command"><strong>cvs -q update
1.1       dsieger  2779: -dP</strong></span> in that directory to download the current version.</p>
                   2780: </div>
                   2781: </div>
                   2782: </div>
1.41      asau     2783: <div class="part">
1.1       dsieger  2784: <div class="titlepage"><div><div><h1 class="title">
                   2785: <a name="developers-guide"></a>Part II. The pkgsrc developer's guide</h1></div></div></div>
1.41      asau     2786: <div class="partintro">
1.1       dsieger  2787: <div></div>
                   2788: <p>This part of the book deals with creating and
1.23      wiz      2789:        modifying packages. It starts with a <span class="quote">&#8220;<span class="quote">HOWTO</span>&#8221;</span>-like
1.1       dsieger  2790:        guide on creating a new package. The remaining chapters are more
                   2791:        like a reference manual for pkgsrc.</p>
                   2792: <div class="toc">
                   2793: <p><b>Table of Contents</b></p>
1.100     leot     2794: <dl class="toc">
1.154     rillig   2795: <dt><span class="chapter"><a href="#help-devel">11. Getting help</a></span></dt>
                   2796: <dt><span class="chapter"><a href="#creating">12. Creating a new pkgsrc package from scratch</a></span></dt>
1.1       dsieger  2797: <dd><dl>
1.154     rillig   2798: <dt><span class="sect1"><a href="#creating.common">12.1. Common types of packages</a></span></dt>
1.1       dsieger  2799: <dd><dl>
1.154     rillig   2800: <dt><span class="sect2"><a href="#creating.perl-module">12.1.1. Perl modules</a></span></dt>
                   2801: <dt><span class="sect2"><a href="#creating.python-module">12.1.2. Python modules and programs</a></span></dt>
1.160   ! brook    2802: <dt><span class="sect2"><a href="#creating.R-package">12.1.3. R packages</a></span></dt>
        !          2803: <dt><span class="sect2"><a href="#creating.TeX-package">12.1.4. TeXlive packages</a></span></dt>
1.1       dsieger  2804: </dl></dd>
1.154     rillig   2805: <dt><span class="sect1"><a href="#creating.examples">12.2. Examples</a></span></dt>
                   2806: <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   2807: </dl></dd>
1.154     rillig   2808: <dt><span class="chapter"><a href="#components">13. Package components - files, directories and contents</a></span></dt>
1.6       rillig   2809: <dd><dl>
1.154     rillig   2810: <dt><span class="sect1"><a href="#components.Makefile">13.1. <code class="filename">Makefile</code></a></span></dt>
                   2811: <dt><span class="sect1"><a href="#components.distinfo">13.2. <code class="filename">distinfo</code></a></span></dt>
                   2812: <dt><span class="sect1"><a href="#components.patches">13.3. <code class="filename">patches/*</code></a></span></dt>
1.6       rillig   2813: <dd><dl>
1.154     rillig   2814: <dt><span class="sect2"><a href="#components.patch.structure">13.3.1. Structure of a single patch file</a></span></dt>
                   2815: <dt><span class="sect2"><a href="#components.patches.caveats">13.3.2. Creating patch files</a></span></dt>
                   2816: <dt><span class="sect2"><a href="#components.patches.sources">13.3.3. Sources where the patch files come from</a></span></dt>
                   2817: <dt><span class="sect2"><a href="#components.patches.guidelines">13.3.4. Patching guidelines</a></span></dt>
                   2818: <dt><span class="sect2"><a href="#components.patches.feedback">13.3.5. Feedback to the author</a></span></dt>
1.6       rillig   2819: </dl></dd>
1.154     rillig   2820: <dt><span class="sect1"><a href="#other-mandatory-files">13.4. Other mandatory files</a></span></dt>
                   2821: <dt><span class="sect1"><a href="#components.optional">13.5. Optional files</a></span></dt>
1.6       rillig   2822: <dd><dl>
1.154     rillig   2823: <dt><span class="sect2"><a href="#components.optional.bin">13.5.1. Files affecting the binary package</a></span></dt>
                   2824: <dt><span class="sect2"><a href="#components.optional.build">13.5.2. Files affecting the build process</a></span></dt>
                   2825: <dt><span class="sect2"><a href="#components.optional.none">13.5.3. Files affecting nothing at all</a></span></dt>
1.6       rillig   2826: </dl></dd>
1.154     rillig   2827: <dt><span class="sect1"><a href="#work-dir">13.6. <code class="filename">work*</code></a></span></dt>
                   2828: <dt><span class="sect1"><a href="#files-dir">13.7. <code class="filename">files/*</code></a></span></dt>
1.6       rillig   2829: </dl></dd>
1.154     rillig   2830: <dt><span class="chapter"><a href="#makefile">14. Programming in <code class="filename">Makefile</code>s</a></span></dt>
1.6       rillig   2831: <dd><dl>
1.154     rillig   2832: <dt><span class="sect1"><a href="#makefile.style">14.1. Caveats</a></span></dt>
                   2833: <dt><span class="sect1"><a href="#makefile.variables">14.2. <code class="filename">Makefile</code> variables</a></span></dt>
                   2834: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">14.2.1. Naming conventions</a></span></dt></dl></dd>
                   2835: <dt><span class="sect1"><a href="#makefile.code">14.3. Code snippets</a></span></dt>
1.6       rillig   2836: <dd><dl>
1.154     rillig   2837: <dt><span class="sect2"><a href="#adding-to-list">14.3.1. Adding things to a list</a></span></dt>
                   2838: <dt><span class="sect2"><a href="#echo-literal">14.3.2. Echoing a string exactly as-is</a></span></dt>
                   2839: <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>
                   2840: <dt><span class="sect2"><a href="#empty-variables">14.3.4. Handling possibly empty variables</a></span></dt>
1.6       rillig   2841: </dl></dd>
                   2842: </dl></dd>
1.154     rillig   2843: <dt><span class="chapter"><a href="#plist">15. PLIST issues</a></span></dt>
1.6       rillig   2844: <dd><dl>
1.154     rillig   2845: <dt><span class="sect1"><a href="#rcs-id">15.1. RCS ID</a></span></dt>
                   2846: <dt><span class="sect1"><a href="#automatic-plist-generation">15.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                   2847: <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>
                   2848: <dt><span class="sect1"><a href="#plist.misc">15.4. Variable substitution in PLIST</a></span></dt>
                   2849: <dt><span class="sect1"><a href="#manpage-compression">15.5. Man page compression</a></span></dt>
                   2850: <dt><span class="sect1"><a href="#using-PLIST_SRC">15.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
                   2851: <dt><span class="sect1"><a href="#platform-specific-plist">15.7. Platform-specific and differing PLISTs</a></span></dt>
                   2852: <dt><span class="sect1"><a href="#build-plist">15.8. Build-specific PLISTs</a></span></dt>
                   2853: <dt><span class="sect1"><a href="#faq.common-dirs">15.9. Sharing directories between packages</a></span></dt>
1.6       rillig   2854: </dl></dd>
1.154     rillig   2855: <dt><span class="chapter"><a href="#buildlink">16. Buildlink methodology</a></span></dt>
1.6       rillig   2856: <dd><dl>
1.154     rillig   2857: <dt><span class="sect1"><a href="#converting-to-buildlink3">16.1. Converting packages to use buildlink3</a></span></dt>
                   2858: <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   2859: <dd><dl>
1.154     rillig   2860: <dt><span class="sect2"><a href="#anatomy-of-bl3">16.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
                   2861: <dt><span class="sect2"><a href="#updating-buildlink-depends">16.2.2. Updating
1.26      wiz      2862:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   2863:       and
                   2864:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   2865:       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.6       rillig   2866: </dl></dd>
1.154     rillig   2867: <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   2868: <dd><dl>
1.154     rillig   2869: <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>
                   2870: <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   2871: </dl></dd>
                   2872: </dl></dd>
1.154     rillig   2873: <dt><span class="chapter"><a href="#pkginstall">17. The pkginstall framework</a></span></dt>
1.6       rillig   2874: <dd><dl>
1.154     rillig   2875: <dt><span class="sect1"><a href="#files-and-dirs-outside-prefix">17.1. Files and directories outside the installation prefix</a></span></dt>
                   2876: <dd><dl>
                   2877: <dt><span class="sect2"><a href="#dirs-outside-prefix">17.1.1. Directory manipulation</a></span></dt>
                   2878: <dt><span class="sect2"><a href="#files-outside-prefix">17.1.2. File manipulation</a></span></dt>
                   2879: </dl></dd>
                   2880: <dt><span class="sect1"><a href="#conf-files">17.2. Configuration files</a></span></dt>
                   2881: <dd><dl>
                   2882: <dt><span class="sect2"><a href="#conf-files-sysconfdir">17.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
                   2883: <dt><span class="sect2"><a href="#conf-files-configure">17.2.2. Telling the software where configuration files are</a></span></dt>
                   2884: <dt><span class="sect2"><a href="#conf-files-patching">17.2.3. Patching installations</a></span></dt>
                   2885: <dt><span class="sect2"><a href="#conf-files-disable">17.2.4. Disabling handling of configuration files</a></span></dt>
                   2886: </dl></dd>
                   2887: <dt><span class="sect1"><a href="#rcd-scripts">17.3. System startup scripts</a></span></dt>
                   2888: <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>
                   2889: <dt><span class="sect1"><a href="#users-and-groups">17.4. System users and groups</a></span></dt>
                   2890: <dt><span class="sect1"><a href="#shells">17.5. System shells</a></span></dt>
                   2891: <dd><dl><dt><span class="sect2"><a href="#shells-disable">17.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   2892: <dt><span class="sect1"><a href="#fonts">17.6. Fonts</a></span></dt>
                   2893: <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>
                   2894: </dl></dd>
                   2895: <dt><span class="chapter"><a href="#options">18. Options handling</a></span></dt>
                   2896: <dd><dl>
                   2897: <dt><span class="sect1"><a href="#global-default-options">18.1. Global default options</a></span></dt>
                   2898: <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>
                   2899: <dt><span class="sect1"><a href="#option-names">18.3. Option Names</a></span></dt>
                   2900: <dt><span class="sect1"><a href="#option-build">18.4. Determining the options of dependencies</a></span></dt>
                   2901: </dl></dd>
                   2902: <dt><span class="chapter"><a href="#build">19. The build process</a></span></dt>
                   2903: <dd><dl>
                   2904: <dt><span class="sect1"><a href="#build.intro">19.1. Introduction</a></span></dt>
                   2905: <dt><span class="sect1"><a href="#build.prefix">19.2. Program location</a></span></dt>
                   2906: <dt><span class="sect1"><a href="#build.builddirs">19.3. Directories used during the build process</a></span></dt>
                   2907: <dt><span class="sect1"><a href="#build.running">19.4. Running a phase</a></span></dt>
                   2908: <dt><span class="sect1"><a href="#build.fetch">19.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                   2909: <dd><dl>
                   2910: <dt><span class="sect2"><a href="#build.fetch.what">19.5.1. What to fetch and where to get it from</a></span></dt>
                   2911: <dt><span class="sect2"><a href="#build.fetch.how">19.5.2. How are the files fetched?</a></span></dt>
                   2912: </dl></dd>
                   2913: <dt><span class="sect1"><a href="#build.checksum">19.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                   2914: <dt><span class="sect1"><a href="#build.extract">19.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                   2915: <dt><span class="sect1"><a href="#build.patch">19.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                   2916: <dt><span class="sect1"><a href="#build.tools">19.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                   2917: <dt><span class="sect1"><a href="#build.wrapper">19.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                   2918: <dt><span class="sect1"><a href="#build.configure">19.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   2919: <dt><span class="sect1"><a href="#build.build">19.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   2920: <dt><span class="sect1"><a href="#build.test">19.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                   2921: <dt><span class="sect1"><a href="#build.install">19.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   2922: <dt><span class="sect1"><a href="#build.package">19.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
                   2923: <dt><span class="sect1"><a href="#build.clean">19.16. Cleaning up</a></span></dt>
                   2924: <dt><span class="sect1"><a href="#build.helpful-targets">19.17. Other helpful targets</a></span></dt>
                   2925: </dl></dd>
                   2926: <dt><span class="chapter"><a href="#tools">20. Tools needed for building or running</a></span></dt>
                   2927: <dd><dl>
                   2928: <dt><span class="sect1"><a href="#pkgsrc-tools">20.1. Tools for pkgsrc builds</a></span></dt>
                   2929: <dt><span class="sect1"><a href="#package-tools">20.2. Tools needed by packages</a></span></dt>
                   2930: <dt><span class="sect1"><a href="#platform-tools">20.3. Tools provided by platforms</a></span></dt>
                   2931: </dl></dd>
                   2932: <dt><span class="chapter"><a href="#fixes">21. Making your package work</a></span></dt>
                   2933: <dd><dl>
                   2934: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
                   2935: <dd><dl>
                   2936: <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>
                   2937: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
                   2938: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
                   2939: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
                   2940: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
                   2941: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
                   2942: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
                   2943: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
                   2944: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
                   2945: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
                   2946: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                   2947: </dl></dd>
                   2948: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                   2949: <dd><dl>
                   2950: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   2951: <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>
                   2952: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
                   2953: </dl></dd>
                   2954: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   2955: <dd><dl>
                   2956: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
                   2957: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   2958: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
                   2959: </dl></dd>
                   2960: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
                   2961: <dd><dl>
                   2962: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
                   2963: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
                   2964: <dt><span class="sect2"><a href="#perl-scripts">21.4.3. Packages containing perl scripts</a></span></dt>
                   2965: <dt><span class="sect2"><a href="#shell-scripts">21.4.4. Packages containing shell scripts</a></span></dt>
                   2966: <dt><span class="sect2"><a href="#other-programming-languages">21.4.5. Other programming languages</a></span></dt>
                   2967: </dl></dd>
                   2968: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   2969: <dd><dl>
                   2970: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   2971: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
                   2972: <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>
                   2973: <dt><span class="sect2"><a href="#out-of-memory">21.5.4. Running out of memory</a></span></dt>
                   2974: </dl></dd>
                   2975: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   2976: <dd><dl>
                   2977: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
                   2978: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
                   2979: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
                   2980: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
                   2981: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
                   2982: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing perl modules</a></span></dt>
                   2983: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
                   2984: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
                   2985: <dt><span class="sect2"><a href="#gconf-data-files">21.6.9. Packages installing GConf data files</a></span></dt>
                   2986: <dt><span class="sect2"><a href="#scrollkeeper-data-files">21.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
                   2987: <dt><span class="sect2"><a href="#x11-fonts">21.6.11. Packages installing X11 fonts</a></span></dt>
                   2988: <dt><span class="sect2"><a href="#gtk2-modules">21.6.12. Packages installing GTK2 modules</a></span></dt>
                   2989: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.13. Packages installing SGML or XML data</a></span></dt>
                   2990: <dt><span class="sect2"><a href="#mime-database">21.6.14. Packages installing extensions to the MIME database</a></span></dt>
                   2991: <dt><span class="sect2"><a href="#intltool">21.6.15. Packages using intltool</a></span></dt>
                   2992: <dt><span class="sect2"><a href="#startup-scripts">21.6.16. Packages installing startup scripts</a></span></dt>
                   2993: <dt><span class="sect2"><a href="#tex-packages">21.6.17. Packages installing TeX modules</a></span></dt>
                   2994: <dt><span class="sect2"><a href="#emulation-packages">21.6.18. Packages supporting running binaries in
1.1       dsieger  2995:     emulation</a></span></dt>
1.154     rillig   2996: <dt><span class="sect2"><a href="#hicolor-theme">21.6.19. Packages installing hicolor theme icons</a></span></dt>
                   2997: <dt><span class="sect2"><a href="#desktop-files">21.6.20. Packages installing desktop files</a></span></dt>
1.1       dsieger  2998: </dl></dd>
1.154     rillig   2999: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.1       dsieger  3000: </dl></dd>
1.154     rillig   3001: <dt><span class="chapter"><a href="#debug">22. Debugging</a></span></dt>
                   3002: <dt><span class="chapter"><a href="#submit">23. Submitting and Committing</a></span></dt>
1.1       dsieger  3003: <dd><dl>
1.154     rillig   3004: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
                   3005: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   3006: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
                   3007: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
                   3008: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
                   3009: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
                   3010: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
                   3011: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
                   3012: </dl></dd>
                   3013: <dt><span class="chapter"><a href="#devfaq">24. Frequently Asked Questions</a></span></dt>
                   3014: <dt><span class="chapter"><a href="#gnome">25. GNOME packaging and porting</a></span></dt>
                   3015: <dd><dl>
                   3016: <dt><span class="sect1"><a href="#meta-packages">25.1. Meta packages</a></span></dt>
                   3017: <dt><span class="sect1"><a href="#new-package">25.2. Packaging a GNOME application</a></span></dt>
                   3018: <dt><span class="sect1"><a href="#full-update">25.3. Updating GNOME to a newer version</a></span></dt>
                   3019: <dt><span class="sect1"><a href="#patching">25.4. Patching guidelines</a></span></dt>
1.1       dsieger  3020: </dl></dd>
                   3021: </dl>
                   3022: </div>
                   3023: </div>
1.41      asau     3024: <div class="chapter">
1.1       dsieger  3025: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   3026: <a name="help-devel"></a>Chapter 11. Getting help</h2></div></div></div>
                   3027: <p>
                   3028:        To get help when developing pkgsrc, the definitive source is this
                   3029:        document, the pkgsrc guide. If you don't find anything here,
                   3030:        there are alternatives:
                   3031: </p>
                   3032: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   3033: <li class="listitem">
                   3034: <p>
                   3035:        The built-in pkgsrc help, which is available after bootstrapping
                   3036:        pkgsrc. Run <span class="command"><strong>bmake help topic=&#8230;</strong></span> to get
                   3037:        help for any topic, such as a variable name like
                   3038:        <code class="varname">BUILD_DEFS</code>, a make target like
                   3039:        <span class="command"><strong>do-build</strong></span>, a missing C or C++ function like
                   3040:        <span class="command"><strong>strcasecmp</strong></span> or any other topic.</p>
                   3041: <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>
                   3042: </li>
                   3043: <li class="listitem"><p>
                   3044:        The tech-pkg mailing list, to which
                   3045:        <a class="ulink" href="https://www.NetBSD.org/mailinglists/#tech-pkg" target="_top">you
                   3046:        can subscribe</a> and then <a class="ulink" href="mailto:tech-pkg@NetBSD.org" target="_top">ask your
                   3047:        questions</a>.</p></li>
                   3048: <li class="listitem"><p>The #pkgsrc IRC channel, which is accessible
                   3049:        <a class="ulink" href="https://webchat.freenode.net/" target="_top">via a web browser</a>
                   3050:        or by using a specialized chat program such as
                   3051:        <a class="ulink" href="http://xchat.org/" target="_top">XChat</a>.
                   3052:        Pick any user name and join the channel #pkgsrc.</p></li>
                   3053: </ul></div>
                   3054: </div>
                   3055: <div class="chapter">
                   3056: <div class="titlepage"><div><div><h2 class="title">
                   3057: <a name="creating"></a>Chapter 12. Creating a new pkgsrc package from scratch</h2></div></div></div>
1.1       dsieger  3058: <div class="toc">
                   3059: <p><b>Table of Contents</b></p>
1.100     leot     3060: <dl class="toc">
1.154     rillig   3061: <dt><span class="sect1"><a href="#creating.common">12.1. Common types of packages</a></span></dt>
1.1       dsieger  3062: <dd><dl>
1.154     rillig   3063: <dt><span class="sect2"><a href="#creating.perl-module">12.1.1. Perl modules</a></span></dt>
                   3064: <dt><span class="sect2"><a href="#creating.python-module">12.1.2. Python modules and programs</a></span></dt>
1.160   ! brook    3065: <dt><span class="sect2"><a href="#creating.R-package">12.1.3. R packages</a></span></dt>
        !          3066: <dt><span class="sect2"><a href="#creating.TeX-package">12.1.4. TeXlive packages</a></span></dt>
1.1       dsieger  3067: </dl></dd>
1.154     rillig   3068: <dt><span class="sect1"><a href="#creating.examples">12.2. Examples</a></span></dt>
                   3069: <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  3070: </dl>
                   3071: </div>
                   3072: <p>When you find a package that is not yet in pkgsrc, you
                   3073: most likely have a URL from where you can download the source
                   3074: code. Starting with this URL, creating a package involves only a
                   3075: few steps.</p>
1.23      wiz      3076: <div class="procedure"><ol class="procedure" type="1">
1.137     leot     3077: <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     3078: <li class="step"><p>Then, choose one of the top-level directories as the
1.1       dsieger  3079: category in which you want to place your package. You can also create a
                   3080: directory of your own (maybe called <code class="filename">local</code>). In that
                   3081: category directory, create another directory for your package and change
                   3082: into it.</p></li>
1.41      asau     3083: <li class="step"><p>Run the program <span class="command"><strong>url2pkg</strong></span>, which will ask
1.1       dsieger  3084: you for a URL. Enter the URL of the distribution file (in most cases a
                   3085: <code class="filename">.tar.gz</code> file) and watch how the basic ingredients
                   3086: of your package are created automatically. The distribution file is
                   3087: extracted automatically to fill in some details in the
                   3088: <code class="filename">Makefile</code> that would otherwise have to be done
                   3089: manually.</p></li>
1.41      asau     3090: <li class="step">
1.1       dsieger  3091: <p>Examine the extracted files to determine the dependencies of
                   3092: your package. Ideally, this is mentioned in some
                   3093: <code class="filename">README</code> file, but things may differ. For each of
                   3094: these dependencies, look where it exists in pkgsrc, and if there is a
                   3095: file called <code class="filename">buildlink3.mk</code> in that directory, add a
                   3096: line to your package <code class="filename">Makefile</code> which includes that
                   3097: file just before the last line. If the
1.25      spz      3098: <code class="filename">buildlink3.mk</code> file does not exist, it must be
                   3099: created first. The <code class="filename">buildlink3.mk</code> file makes sure that the package's include files and libraries are provided.</p>
                   3100: <p>If you just need binaries from a package, add a
1.1       dsieger  3101: <code class="varname">DEPENDS</code> line to the Makefile, which specifies the
                   3102: version of the dependency and where it can be found in pkgsrc. This line
                   3103: should be placed in the third paragraph. If the dependency is only
                   3104: needed for building the package, but not when using it, use
1.156     leot     3105: <code class="varname">TOOL_DEPENDS</code> or <code class="varname">BUILD_DEPENDS</code>
                   3106: instead of <code class="varname">DEPENDS</code>.
                   3107: The difference between <code class="varname">TOOL_DEPENDS</code> and
                   3108: <code class="varname">BUILD_DEPENDS</code> occurs when cross-compiling:
                   3109: <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
                   3110: packages, i.e. packages for the architecture where the package
                   3111: is built;
                   3112: <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
                   3113: packages, i.e. packages for the architecture for which the package
                   3114: is built.
1.1       dsieger  3115: Your package may then look like this:</p>
                   3116: <pre class="programlisting">
                   3117: [...]
                   3118: 
1.156     leot     3119: TOOL_DEPENDS+=  libxslt-[0-9]*:../../textproc/libxslt
1.1       dsieger  3120: DEPENDS+=       screen-[0-9]*:../../misc/screen
                   3121: DEPENDS+=       screen&gt;=4.0:../../misc/screen
                   3122: 
                   3123: [...]
                   3124: 
                   3125: .include "../../<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>package</code></em>/buildlink3.mk"
                   3126: .include "../../devel/glib2/buildlink3.mk"
                   3127: .include "../../mk/bsd.pkg.mk"
                   3128: </pre>
                   3129: </li>
1.41      asau     3130: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> to see what things still need
1.23      wiz      3131: 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  3132: know what pkglint's warnings want to tell you, try <span class="command"><strong>pkglint
                   3133: --explain</strong></span> or <span class="command"><strong>pkglint
1.1       dsieger  3134: -e</strong></span>, which outputs additional
                   3135: explanations.</p></li>
1.41      asau     3136: <li class="step"><p>In many cases the package is not yet ready to build. You can
1.154     rillig   3137: 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  3138: over there, you can hopefully continue here.</p></li>
1.41      asau     3139: <li class="step"><p>Run <span class="command"><strong>bmake clean</strong></span> to clean the working
1.1       dsieger  3140: directory from the extracted files. Besides these files, a lot of cache
                   3141: files and other system information has been saved in the working
                   3142: directory, which may become wrong after you edited the
                   3143: <code class="filename">Makefile</code>.</p></li>
1.41      asau     3144: <li class="step"><p>Now, run <span class="command"><strong>bmake</strong></span> to build the package. For
1.154     rillig   3145: 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     3146: <li class="step"><p>When the package builds fine, the next step is to install
1.10      hubertf  3147: the package. Run <span class="command"><strong>bmake install</strong></span> and hope that
1.1       dsieger  3148: everything works.</p></li>
1.41      asau     3149: <li class="step"><p>Up to now, the file <code class="filename">PLIST</code>, which
1.1       dsieger  3150: contains a list of the files that are installed by the package, is
1.10      hubertf  3151: nearly empty. Run <span class="command"><strong>bmake print-PLIST
1.1       dsieger  3152: &gt;PLIST</strong></span> to generate a probably correct list. Check
                   3153: the file using your preferred text editor to see if the list of
                   3154: files looks plausible.</p></li>
1.41      asau     3155: <li class="step"><p>Run <span class="command"><strong>pkglint</strong></span> again to see if the generated
1.1       dsieger  3156: <code class="filename">PLIST</code> contains garbage or not.</p></li>
1.41      asau     3157: <li class="step"><p>When you ran <span class="command"><strong>bmake install</strong></span>, the package
1.1       dsieger  3158: has been registered in the database of installed files, but with an
1.10      hubertf  3159: empty list of files. To fix this, run <span class="command"><strong>bmake deinstall</strong></span>
                   3160: and <span class="command"><strong>bmake install</strong></span> again. Now the package is
1.1       dsieger  3161: registered with the list of files from
                   3162: <code class="filename">PLIST</code>.</p></li>
1.41      asau     3163: <li class="step"><p>Run <span class="command"><strong>bmake package</strong></span> to create a binary
1.1       dsieger  3164: package from the set of installed files.</p></li>
                   3165: </ol></div>
1.41      asau     3166: <div class="sect1">
1.1       dsieger  3167: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   3168: <a name="creating.common"></a>12.1. Common types of packages</h2></div></div></div>
1.41      asau     3169: <div class="sect2">
1.1       dsieger  3170: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   3171: <a name="creating.perl-module"></a>12.1.1. Perl modules</h3></div></div></div>
1.1       dsieger  3172: <p>Simple Perl modules are handled automatically by
1.10      hubertf  3173: <span class="command"><strong>url2pkg</strong></span>, including dependencies.</p>
1.1       dsieger  3174: </div>
1.41      asau     3175: <div class="sect2">
1.1       dsieger  3176: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   3177: <a name="creating.python-module"></a>12.1.2. Python modules and programs</h3></div></div></div>
1.17      imil     3178: <p>Python modules and programs packages are easily created using a
                   3179: set of predefined variables.</p>
                   3180: <p>
1.63      wiz      3181: If some Python versions are not supported by the software, set the
                   3182: <code class="varname">PYTHON_VERSIONS_INCOMPATIBLE</code> variable to the Python versions
                   3183: that are not supported, e.g.
1.17      imil     3184: </p>
                   3185: <pre class="programlisting">
1.93      sevan    3186: PYTHON_VERSIONS_INCOMPATIBLE=       27
1.17      imil     3187: </pre>
                   3188: <p>
1.103     wiz      3189: If the packaged software is a Python module, include one of
                   3190: <code class="filename">../../lang/python/egg.mk</code>,
                   3191: <code class="filename">../../lang/python/distutils.mk</code>, or
                   3192: <code class="filename">../../lang/python/extension.mk</code>.</p>
                   3193: <p>Most Python packages use either <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span> or
                   3194: easy-setup/setuptools (<span class="quote">&#8220;<span class="quote">eggs</span>&#8221;</span>).
                   3195: if the packaged software is using setuptools, you only need
                   3196: to include <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/egg.mk</code></span>&#8221;</span>.
                   3197: Otherwise, if the software uses <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span>, include 
                   3198: <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/distutils.mk</code></span>&#8221;</span>.
                   3199: so pkgsrc will use this framework.
                   3200: <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span> uses a script called <code class="filename">setup.py</code>,
                   3201: if the <span class="quote">&#8220;<span class="quote">distutils</span>&#8221;</span> driver is not called
                   3202: <code class="filename">setup.py</code>, set the <code class="varname">PYSETUP</code> variable
                   3203: to the name of the script.</p>
                   3204: <p>Either way, the package directory should be called
1.23      wiz      3205: <span class="quote">&#8220;<span class="quote">py-software</span>&#8221;</span> and <code class="varname">PKGNAME</code> should be set to
                   3206: <span class="quote">&#8220;<span class="quote">${PYPKGPREFIX}-${DISTNAME}</span>&#8221;</span>, e.g.
1.17      imil     3207: </p>
                   3208: <pre class="programlisting">
                   3209: DISTNAME=   foopymodule-1.2.10
                   3210: PKGNAME=    ${PYPKGPREFIX}-${DISTNAME}
                   3211: </pre>
1.63      wiz      3212: <p>If it is an application, include
                   3213: <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/application.mk</code></span>&#8221;</span>.
                   3214: In order to correctly set the path to the Python interpreter, use the
1.17      imil     3215: <code class="varname">REPLACE_PYTHON</code> variable and set it to the list of files
1.35      wiz      3216: (paths relative to <code class="varname">WRKSRC</code>) that must be corrected.
1.63      wiz      3217: For example:
1.17      imil     3218: </p>
                   3219: <pre class="programlisting">
1.35      wiz      3220: REPLACE_PYTHON=   *.py
1.17      imil     3221: </pre>
1.63      wiz      3222: <p>Some Python modules have separate distributions for Python-2.x
                   3223: and Python-3.x support. In pkgsrc this is handled by the
                   3224: <code class="filename">versioned_dependencies.mk</code> file. Set
                   3225: <code class="varname">PYTHON_VERSIONED_DEPENDENCIES</code> to the list of
                   3226: packages that should be depended upon and include
                   3227: <span class="quote">&#8220;<span class="quote"><code class="filename">../../lang/python/versioned_dependencies.mk</code></span>&#8221;</span>,
                   3228: then the pkgsrc infrastructure will depend on the appropriate package
                   3229: version. For example:
                   3230: </p>
                   3231: <pre class="programlisting">
1.135     wiz      3232: PYTHON_VERSIONED_DEPENDENCIES=dialog
1.63      wiz      3233: </pre>
                   3234: <p>
                   3235: Look inside <code class="filename">versioned_dependencies.mk</code> for a list
                   3236: of supported packages.</p>
1.17      imil     3237: </div>
1.160   ! brook    3238: <div class="sect2">
        !          3239: <div class="titlepage"><div><div><h3 class="title">
        !          3240: <a name="creating.R-package"></a>12.1.3. R packages</h3></div></div></div>
        !          3241: <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>
        !          3242: are handled automatically by <span class="command"><strong>R2pkg</strong></span>, which is
        !          3243: 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>.
        !          3244: Individual packages (and optionally their dependencies) may be created
        !          3245: and updated.  R packages generally follow the same form, and most of
        !          3246: the relevant information needed is contained in a
        !          3247: <code class="filename">DESCRIPTION</code> file as part of each R package on
        !          3248: <a class="ulink" href="https://cran.r-project.org/web/packages/available_packages_by_name.html" target="_top">CRAN</a>.
        !          3249: Consequently, <span class="command"><strong>R2pkg</strong></span> downloads that information and
        !          3250: creates or updates a package in the canonical form.  The resulting
        !          3251: package should be reviewed for correctness.</p>
        !          3252: </div>
        !          3253: <div class="sect2">
        !          3254: <div class="titlepage"><div><div><h3 class="title">
        !          3255: <a name="creating.TeX-package"></a>12.1.4. TeXlive packages</h3></div></div></div>
        !          3256: <p>TeXlive packages from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> are handled automatically by
        !          3257: <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>
        !          3258: <p>If the TeXlive package name is not known, it may be useful to
        !          3259: search <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>.  A
        !          3260: <span class="quote">&#8220;<span class="quote">Contained in</span>&#8221;</span> field on the package page typically
        !          3261: 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
        !          3262: archive</a>.</p>
        !          3263: <p>If the TeXlive package name is known, download the files from
        !          3264: the <a class="ulink" href="https://www.ctan.org/tex-archive/systems/texlive/tlnet/archive" target="_top">TeXlive
        !          3265: archive</a>.  For package <code class="filename">foo</code>, you will need
        !          3266: to download <code class="filename">foo.tar.xz</code>.  Most TeXlive packages
        !          3267: also have associated documentation packages, so download
        !          3268: <code class="filename">foo.doc.tar.xz</code> at the same time.  These files
        !          3269: should be placed in the appropriate category directory, which is often
        !          3270: but not always <code class="filename">print</code>.  Then run the following
        !          3271: command in the category directory.</p>
        !          3272: <pre class="programlisting">
        !          3273: texlive2pkg foo.tar.xz foo.doc.tar.xz
        !          3274: </pre>
        !          3275: <p>This will create two packages, <code class="filename">tex-foo</code> and
        !          3276: <code class="filename">tex-foo-doc</code>.  Be sure to check that both packages
        !          3277: are correct.</p>
        !          3278: <p>Finally, <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a>
        !          3279: currently does not include version information in package filenames
        !          3280: and changes their contents periodically when updates occur.
        !          3281: Consequently, pkgsrc avoids downloading distfiles directly from <a class="ulink" href="https://www.ctan.org/" target="_top">CTAN</a> and instead relies on the
        !          3282: pkgsrc archives.  For each new or updated TeXlive package, e.g., the
        !          3283: main one and the corresponding documentation, upload the distfiles
        !          3284: with the following command in each package directory.</p>
        !          3285: <pre class="programlisting">
        !          3286: make upload-distfiles
        !          3287: </pre>
        !          3288: </div>
1.1       dsieger  3289: </div>
1.41      asau     3290: <div class="sect1">
1.1       dsieger  3291: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   3292: <a name="creating.examples"></a>12.2. Examples</h2></div></div></div>
1.41      asau     3293: <div class="sect2">
1.1       dsieger  3294: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   3295: <a name="creating.nvu"></a>12.2.1. How the www/nvu package came into pkgsrc</h3></div></div></div>
1.41      asau     3296: <div class="sect3">
1.1       dsieger  3297: <div class="titlepage"><div><div><h4 class="title">
1.154     rillig   3298: <a name="creating.nvu.init"></a>12.2.1.1. The initial package</h4></div></div></div>
1.1       dsieger  3299: <p>Looking at the file <code class="filename">pkgsrc/doc/TODO</code>, I saw
1.23      wiz      3300: that the <span class="quote">&#8220;<span class="quote">nvu</span>&#8221;</span> package has not yet been imported into
1.1       dsieger  3301: pkgsrc. As the description says it has to do with the web, the obvious
1.23      wiz      3302: choice for the category is <span class="quote">&#8220;<span class="quote">www</span>&#8221;</span>.</p>
1.1       dsieger  3303: <pre class="programlisting">
                   3304: <code class="prompt">$</code> mkdir www/nvu
                   3305: <code class="prompt">$</code> cd www/nvu
                   3306: </pre>
                   3307: <p>The web site says that the sources are available as a tar file, so
1.10      hubertf  3308: I fed that URL to the <span class="command"><strong>url2pkg</strong></span> program:</p>
1.1       dsieger  3309: <pre class="programlisting">
                   3310: <code class="prompt">$</code> url2pkg http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
                   3311: </pre>
                   3312: <p>My editor popped up, and I added a <code class="varname">PKGNAME</code> line
                   3313: below the <code class="varname">DISTNAME</code> line, as the package name should
1.23      wiz      3314: 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  3315: <code class="varname">MAINTAINER</code>, <code class="varname">HOMEPAGE</code> and
                   3316: <code class="varname">COMMENT</code> fields. Then the package
                   3317: <code class="filename">Makefile</code> looked like that:</p>
                   3318: <pre class="programlisting">
1.121     sevan    3319: # $NetBSD $
1.1       dsieger  3320: #
                   3321: 
                   3322: DISTNAME=       nvu-1.0-sources
                   3323: PKGNAME=        nvu-1.0
                   3324: CATEGORIES=     www
                   3325: MASTER_SITES=   http://cvs.nvu.com/download/
                   3326: EXTRACT_SUFX=   .tar.bz2
                   3327: 
                   3328: MAINTAINER=     rillig@NetBSD.org
                   3329: HOMEPAGE=       http://cvs.nvu.com/
                   3330: COMMENT=        Web Authoring System
                   3331: 
                   3332: # url2pkg-marker (please do not remove this line.)
                   3333: .include "../../mk/bsd.pkg.mk"
                   3334: </pre>
1.124     wiz      3335: <p>On the first line of output above, an artificial space has been added between NetBSD and $,
1.121     sevan    3336: this is a workaround to prevent CVS expanding to the filename of the
                   3337: guide.</p>
1.1       dsieger  3338: <p>Then, I quit the editor and watched pkgsrc downloading a large
                   3339: source archive:</p>
                   3340: <pre class="programlisting">
                   3341: url2pkg&gt; Running "make makesum" ...
                   3342: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   3343: =&gt; Fetching nvu-1.0-sources.tar.bz2
                   3344: Requesting http://cvs.nvu.com/download/nvu-1.0-sources.tar.bz2
                   3345: 100% |*************************************| 28992 KB  150.77 KB/s00:00 ETA
                   3346: 29687976 bytes retrieved in 03:12 (150.77 KB/s)
                   3347: url2pkg&gt; Running "make extract" ...
                   3348: =&gt; Required installed package digest&gt;=20010302: digest-20060826 found
                   3349: =&gt; Checksum SHA1 OK for nvu-1.0-sources.tar.bz2
                   3350: =&gt; Checksum RMD160 OK for nvu-1.0-sources.tar.bz2
                   3351: work.bacc -&gt; /tmp/roland/pkgsrc/www/nvu/work.bacc
                   3352: ===&gt; Installing dependencies for nvu-1.0
                   3353: ===&gt; Overriding tools for nvu-1.0
                   3354: ===&gt; Extracting for nvu-1.0
                   3355: url2pkg&gt; Adjusting the Makefile.
                   3356: 
                   3357: Remember to correct CATEGORIES, HOMEPAGE, COMMENT, and DESCR when you're done!
                   3358: 
                   3359: Good luck! (See pkgsrc/doc/pkgsrc.txt for some more help :-)
                   3360: </pre>
                   3361: </div>
1.41      asau     3362: <div class="sect3">
1.1       dsieger  3363: <div class="titlepage"><div><div><h4 class="title">
1.154     rillig   3364: <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  3365: <p>Now that the package has been extracted, let's see what's inside
                   3366: it. The package has a <code class="filename">README.txt</code>, but that only
                   3367: says something about mozilla, so it's probably useless for seeing what
                   3368: dependencies this package has. But since there is a GNU configure script
                   3369: in the package, let's hope that it will complain about everything it
                   3370: needs.</p>
                   3371: <pre class="programlisting">
                   3372: <code class="prompt">$</code> bmake
                   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: ===&gt; Patching for nvu-1.0
                   3377: ===&gt; Creating toolchain wrappers for nvu-1.0
                   3378: ===&gt; Configuring for nvu-1.0
                   3379: [...]
                   3380: configure: error: Perl 5.004 or higher is required.
                   3381: [...]
                   3382: WARNING: Please add USE_TOOLS+=perl to the package Makefile.
                   3383: [...]
                   3384: </pre>
                   3385: <p>That worked quite well. So I opened the package Makefile in my
                   3386: editor, and since it already has a <code class="varname">USE_TOOLS</code> line, I
1.23      wiz      3387: just appended <span class="quote">&#8220;<span class="quote">perl</span>&#8221;</span> to it. Since the dependencies of the
1.1       dsieger  3388: package have changed now, and since a perl wrapper is automatically
1.23      wiz      3389: installed in the <span class="quote">&#8220;<span class="quote">tools</span>&#8221;</span> phase, I need to build the package
1.1       dsieger  3390: from scratch.</p>
                   3391: <pre class="programlisting">
                   3392: <code class="prompt">$</code> bmake clean
                   3393: ===&gt; Cleaning for nvu-1.0
                   3394: <code class="prompt">$</code> bmake
                   3395: [...]
                   3396: *** /tmp/roland/pkgsrc/www/nvu/work.bacc/.tools/bin/make is not \
                   3397: GNU Make.  You will not be able to build Mozilla without GNU Make.
                   3398: [...]
                   3399: </pre>
1.23      wiz      3400: <p>So I added <span class="quote">&#8220;<span class="quote">gmake</span>&#8221;</span> to the
1.1       dsieger  3401: <code class="varname">USE_TOOLS</code> line and tried again (from scratch).</p>
                   3402: <pre class="programlisting">
                   3403: [...]
                   3404: checking for GTK - version &gt;= 1.2.0... no
                   3405: *** Could not run GTK test program, checking why...
                   3406: [...]
                   3407: </pre>
                   3408: <p>Now to the other dependencies. The first question is: Where is the
                   3409: GTK package hidden in pkgsrc?</p>
                   3410: <pre class="programlisting">
                   3411: <code class="prompt">$</code> echo ../../*/gtk*
                   3412: [many packages ...]
                   3413: <code class="prompt">$</code> echo ../../*/gtk
                   3414: ../../x11/gtk
                   3415: <code class="prompt">$</code> echo ../../*/gtk2
                   3416: ../../x11/gtk2
                   3417: <code class="prompt">$</code> echo ../../*/gtk2/bui*
                   3418: ../../x11/gtk2/buildlink3.mk
                   3419: </pre>
                   3420: <p>The first try was definitely too broad. The second one had exactly
                   3421: one result, which is very good. But there is one pitfall with GNOME
                   3422: packages. Before GNOME 2 had been released, there were already many
                   3423: GNOME 1 packages in pkgsrc. To be able to continue to use these
                   3424: packages, the GNOME 2 packages were imported as separate packages, and
1.23      wiz      3425: their names usually have a <span class="quote">&#8220;<span class="quote">2</span>&#8221;</span> appended. So I checked
1.1       dsieger  3426: whether this was the case here, and indeed it was.</p>
                   3427: <p>Since the GTK2 package has a <code class="filename">buildlink3.mk</code>
                   3428: file, adding the dependency is very easy. I just inserted an
                   3429: <code class="literal">.include</code> line before the last line of the package
                   3430: <code class="filename">Makefile</code>, so that it now looks like this:</p>
                   3431: <pre class="programlisting">
                   3432: [...]
                   3433: .include "../../x11/gtk2/buildlink3.mk"
                   3434: .include "../../mk/bsd.pkg.mk
                   3435: </pre>
1.10      hubertf  3436: <p>After another <span class="command"><strong>bmake clean &amp;&amp; bmake</strong></span>, the answer
1.1       dsieger  3437: was:</p>
                   3438: <pre class="programlisting">
                   3439: [...]
                   3440: checking for gtk-config... /home/roland/pkg/bin/gtk-config
                   3441: checking for GTK - version &gt;= 1.2.0... no
                   3442: *** Could not run GTK test program, checking why...
                   3443: *** The test program failed to compile or link. See the file config.log for the
                   3444: *** exact error that occured. This usually means GTK was incorrectly installed
                   3445: *** or that you have moved GTK since it was installed. In the latter case, you
                   3446: *** may want to edit the gtk-config script: /home/roland/pkg/bin/gtk-config
                   3447: configure: error: Test for GTK failed.
                   3448: [...]
                   3449: </pre>
1.23      wiz      3450: <p>In this particular case, the assumption that <span class="quote">&#8220;<span class="quote">every package
                   3451: prefers GNOME 2</span>&#8221;</span> had been wrong. The first of the lines above
1.1       dsieger  3452: told me that this package really wanted to have the GNOME 1 version of
                   3453: GTK. If the package had looked for GTK2, it would have looked for
1.10      hubertf  3454: <span class="command"><strong>pkg-config</strong></span> instead of <span class="command"><strong>gtk-config</strong></span>.
1.1       dsieger  3455: So I changed the <code class="literal">x11/gtk2</code> to
                   3456: <code class="literal">x11/gtk</code> in the package <code class="filename">Makefile</code>,
                   3457: and tried again.</p>
                   3458: <pre class="programlisting">
                   3459: [...]
1.59      jnemeth  3460: cc -o xpidl.o -c -DOSTYPE=\"NetBSD3\" -DOSARCH=\"NetBSD\"  [...]
1.1       dsieger  3461: In file included from xpidl.c:42:
                   3462: xpidl.h:53:24: libIDL/IDL.h: No such file or directory
                   3463: In file included from xpidl.c:42:
                   3464: xpidl.h:132: error: parse error before "IDL_ns"
                   3465: [...]
                   3466: </pre>
                   3467: <p>The package still does not find all of its dependencies. Now the
                   3468: question is: Which package provides the
                   3469: <code class="filename">libIDL/IDL.h</code> header file?</p>
                   3470: <pre class="programlisting">
                   3471: <code class="prompt">$</code> echo ../../*/*idl*
                   3472: ../../devel/py-idle ../../wip/idled ../../x11/acidlaunch
                   3473: <code class="prompt">$</code> echo ../../*/*IDL*
                   3474: ../../net/libIDL
                   3475: </pre>
                   3476: <p>Let's take the one from the second try. So I included the
                   3477: <code class="filename">../../net/libIDL/buildlink3.mk</code> file and tried
                   3478: again. But the error didn't change. After digging through some of the
                   3479: code, I concluded that the build process of the package was broken and
                   3480: couldn't have ever worked, but since the Mozilla source tree is quite
                   3481: large, I didn't want to fix it. So I added the following to the package
                   3482: <code class="filename">Makefile</code> and tried again:</p>
                   3483: <pre class="programlisting">
                   3484: CPPFLAGS+=              -I${BUILDLINK_PREFIX.libIDL}/include/libIDL-2.0
1.139     leot     3485: BUILDLINK_TRANSFORM+=   l:IDL:IDL-2
1.1       dsieger  3486: </pre>
                   3487: <p>The latter line is needed because the package expects the library
                   3488: <code class="filename">libIDL.so</code>, but only
                   3489: <code class="filename">libIDL-2.so</code> is available. So I told the compiler
                   3490: wrapper to rewrite that on the fly.</p>
                   3491: <p>The next problem was related to a recent change of the FreeType
1.137     leot     3492: 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  3493: which patch files were relevant for this issue and copied them to the
                   3494: <code class="filename">patches</code> directory. Then I retried, fixed the
                   3495: patches so that they applied cleanly and retried again. This time,
                   3496: everything worked.</p>
                   3497: </div>
1.41      asau     3498: <div class="sect3">
1.1       dsieger  3499: <div class="titlepage"><div><div><h4 class="title">
1.154     rillig   3500: <a name="creating.nvu.inst"></a>12.2.1.3. Installing the package</h4></div></div></div>
1.1       dsieger  3501: <pre class="programlisting">
                   3502: <code class="prompt">$</code> bmake CHECK_FILES=no install
                   3503: [...]
                   3504: <code class="prompt">$</code> bmake print-PLIST &gt;PLIST
                   3505: <code class="prompt">$</code> bmake deinstall
                   3506: <code class="prompt">$</code> bmake install
                   3507: </pre>
                   3508: </div>
                   3509: </div>
                   3510: </div>
                   3511: </div>
1.41      asau     3512: <div class="chapter">
1.1       dsieger  3513: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   3514: <a name="components"></a>Chapter 13. Package components - files, directories and contents</h2></div></div></div>
1.1       dsieger  3515: <div class="toc">
                   3516: <p><b>Table of Contents</b></p>
1.100     leot     3517: <dl class="toc">
1.154     rillig   3518: <dt><span class="sect1"><a href="#components.Makefile">13.1. <code class="filename">Makefile</code></a></span></dt>
                   3519: <dt><span class="sect1"><a href="#components.distinfo">13.2. <code class="filename">distinfo</code></a></span></dt>
                   3520: <dt><span class="sect1"><a href="#components.patches">13.3. <code class="filename">patches/*</code></a></span></dt>
                   3521: <dd><dl>
                   3522: <dt><span class="sect2"><a href="#components.patch.structure">13.3.1. Structure of a single patch file</a></span></dt>
                   3523: <dt><span class="sect2"><a href="#components.patches.caveats">13.3.2. Creating patch files</a></span></dt>
                   3524: <dt><span class="sect2"><a href="#components.patches.sources">13.3.3. Sources where the patch files come from</a></span></dt>
                   3525: <dt><span class="sect2"><a href="#components.patches.guidelines">13.3.4. Patching guidelines</a></span></dt>
                   3526: <dt><span class="sect2"><a href="#components.patches.feedback">13.3.5. Feedback to the author</a></span></dt>
                   3527: </dl></dd>
                   3528: <dt><span class="sect1"><a href="#other-mandatory-files">13.4. Other mandatory files</a></span></dt>
                   3529: <dt><span class="sect1"><a href="#components.optional">13.5. Optional files</a></span></dt>
                   3530: <dd><dl>
                   3531: <dt><span class="sect2"><a href="#components.optional.bin">13.5.1. Files affecting the binary package</a></span></dt>
                   3532: <dt><span class="sect2"><a href="#components.optional.build">13.5.2. Files affecting the build process</a></span></dt>
                   3533: <dt><span class="sect2"><a href="#components.optional.none">13.5.3. Files affecting nothing at all</a></span></dt>
1.1       dsieger  3534: </dl></dd>
1.154     rillig   3535: <dt><span class="sect1"><a href="#work-dir">13.6. <code class="filename">work*</code></a></span></dt>
                   3536: <dt><span class="sect1"><a href="#files-dir">13.7. <code class="filename">files/*</code></a></span></dt>
1.1       dsieger  3537: </dl>
                   3538: </div>
                   3539: <p>Whenever you're preparing a package, there are a number of
                   3540: files involved which are described in the following
                   3541: sections.</p>
1.41      asau     3542: <div class="sect1">
1.1       dsieger  3543: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   3544: <a name="components.Makefile"></a>13.1. <code class="filename">Makefile</code>
1.1       dsieger  3545: </h2></div></div></div>
                   3546: <p>Building, installation and creation of a binary package are all
                   3547:   controlled by the package's <code class="filename">Makefile</code>.
                   3548:   The <code class="filename">Makefile</code> describes various things about
                   3549:   a package, for example from where to get it, how to configure,
                   3550:   build, and install it.</p>
                   3551: <p>A package <code class="filename">Makefile</code> contains several
                   3552:   sections that describe the package.</p>
                   3553: <p>In the first section there are the following variables, which
                   3554:   should appear exactly in the order given here.  The order and
                   3555:   grouping of the variables is mostly historical and has no further
                   3556:   meaning.</p>
1.41      asau     3557: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      3558: <li class="listitem"><p><code class="varname">DISTNAME</code> is the basename of the
1.1       dsieger  3559:     distribution file to be downloaded from the package's
                   3560:     website.</p></li>
1.23      wiz      3561: <li class="listitem"><p><code class="varname">PKGNAME</code> is the name of the
1.66      asau     3562:     package, as used by pkgsrc. You need to provide it if
1.1       dsieger  3563:     <code class="varname">DISTNAME</code> (which is the default) is not a good
1.66      asau     3564:     name for the package in pkgsrc or <code class="varname">DISTNAME</code> is not
                   3565:     provided (no distribution file is required).  Usually it is the pkgsrc
1.1       dsieger  3566:     directory name together with the version number. It must match the
                   3567:     regular expression
                   3568:     <code class="varname">^[A-Za-z0-9][A-Za-z0-9-_.+]*$</code>, that is, it
                   3569:     starts with a letter or digit, and contains only letters, digits,
                   3570:     dashes, underscores, dots and plus signs.</p></li>
1.23      wiz      3571: <li class="listitem">
1.1       dsieger  3572: <p><code class="varname">CATEGORIES</code> is a list of categories
                   3573:     which the package fits in. You can choose any of the top-level
                   3574:     directories of pkgsrc for it.</p>
                   3575: <p>Currently the following values are available for
                   3576:     <code class="varname">CATEGORIES</code>. If more than
                   3577:     one is used, they need to be separated by spaces:</p>
                   3578: <pre class="programlisting">
                   3579: archivers     cross         geography     meta-pkgs     security
                   3580: audio         databases     graphics      misc          shells
                   3581: benchmarks    devel         ham           multimedia    sysutils
                   3582: biology       editors       inputmethod   net           textproc
                   3583: cad           emulators     lang          news          time
                   3584: chat          finance       mail          parallel      wm
                   3585: comms         fonts         math          pkgtools      www
                   3586: converters    games         mbone         print         x11
                   3587: </pre>
                   3588: </li>
1.23      wiz      3589: <li class="listitem"><p><code class="varname">MASTER_SITES</code>,
1.1       dsieger  3590:     <code class="varname">DYNAMIC_MASTER_SITES</code>,
                   3591:     <code class="varname">DIST_SUBDIR</code>, <code class="varname">EXTRACT_SUFX</code>
                   3592:     and <code class="varname">DISTFILES</code> are discussed in detail in
1.154     rillig   3593:     <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  3594: </ul></div>
                   3595: <p>The second section contains information about separately
                   3596:   downloaded patches, if any.
                   3597:   </p>
1.41      asau     3598: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.80      wiz      3599: <li class="listitem"><p><code class="varname">PATCHFILES</code>:
1.1       dsieger  3600:     Name(s) of additional files that contain distribution patches.
                   3601:     There is no default. pkgsrc will look for them at
                   3602:     <code class="varname">PATCH_SITES</code>.
                   3603:     They will automatically be uncompressed before patching if
                   3604:     the names end with <code class="filename">.gz</code> or
                   3605:     <code class="filename">.Z</code>.</p></li>
1.23      wiz      3606: <li class="listitem"><p><code class="varname">PATCH_SITES</code>:
1.1       dsieger  3607:     Primary location(s) for distribution patch files (see
1.80      wiz      3608:     <code class="varname">PATCHFILES</code> above) if not found locally.</p></li>
                   3609: <li class="listitem"><p><code class="varname">PATCH_DIST_STRIP</code>:
1.157     leot     3610:     an argument to <a class="citerefentry" href="http://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      3611:     help find the correct files to patch. It defaults to
                   3612:     <span class="command"><strong>-p0</strong></span>.</p></li>
1.1       dsieger  3613: </ul></div>
                   3614: <p>The third section contains the following variables.
                   3615:   </p>
1.41      asau     3616: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      3617: <li class="listitem"><p><code class="varname">MAINTAINER</code> is the email
1.14      jmcneill 3618:     address of the person who feels responsible for this package,
                   3619:     and who is most likely to look at problems or questions regarding
1.157     leot     3620:     this package which have been reported with <a class="citerefentry" href="http://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 3621:     Other developers may contact the <code class="varname">MAINTAINER</code>
                   3622:     before making changes to the package, but are not required to
                   3623:     do so. When packaging a new program, set <code class="varname">MAINTAINER</code>
                   3624:     to yourself. If you really can't maintain the package for future
                   3625:     updates, set it to
1.10      hubertf  3626:     <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      3627: <li class="listitem"><p><code class="varname">OWNER</code> should be used instead
1.14      jmcneill 3628:     of <code class="varname">MAINTAINER</code> when you do not want other
                   3629:     developers to update or change the package without contacting
                   3630:     you first. A package Makefile should contain one of
                   3631:     <code class="varname">MAINTAINER</code> or <code class="varname">OWNER</code>, but
                   3632:     not both.  </p></li>
1.23      wiz      3633: <li class="listitem"><p><code class="varname">HOMEPAGE</code> is a URL where users can
1.1       dsieger  3634:     find more information about the package.</p></li>
1.23      wiz      3635: <li class="listitem"><p><code class="varname">COMMENT</code> is a one-line
1.1       dsieger  3636:     description of the package (should not include the package
                   3637:     name).</p></li>
1.122     leot     3638: <li class="listitem"><p><code class="varname">LICENSE</code> indicates the license(s)
1.154     rillig   3639:     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  3640: </ul></div>
                   3641: <p>Other variables that affect the build:
                   3642:   </p>
1.41      asau     3643: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.1       dsieger  3644: <p><code class="varname">WRKSRC</code>: The directory where the
                   3645:       interesting distribution files of the package are found. The
                   3646:       default is <code class="filename">${WRKDIR}/${DISTNAME}</code>, which
                   3647:       works for most packages.</p>
                   3648: <p>If a package doesn't create a subdirectory for itself
                   3649:       (most GNU software does, for instance), but extracts itself in
                   3650:       the current directory, you should set
                   3651:       <code class="varname">WRKSRC=${WRKDIR}</code>.</p>
                   3652: <p>If a package doesn't create a subdirectory with the
                   3653:       name of <code class="varname">DISTNAME</code> but some different name,
                   3654:       set <code class="varname">WRKSRC</code> to point to the proper name in
                   3655:       <code class="filename">${WRKDIR}</code>, for example
                   3656:       <code class="varname">WRKSRC=${WRKDIR}/${DISTNAME}/unix</code>. See
1.137     leot     3657:       <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  3658: <p>The name of the working directory created by pkgsrc is
                   3659:       taken from the <code class="varname">WRKDIR_BASENAME</code>
                   3660:       variable. By default, its value is
                   3661:       <code class="filename">work</code>. If you want to use the same
                   3662:       pkgsrc tree for building different kinds of binary packages,
                   3663:       you can change the variable according to your needs. Two
                   3664:       other variables handle common cases of setting
                   3665:       <code class="varname">WRKDIR_BASENAME</code> individually. If
                   3666:       <code class="varname">OBJHOSTNAME</code> is defined in
1.10      hubertf  3667:       <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>, the first component of
1.1       dsieger  3668:       the host's name is attached to the directory name. If
                   3669:       <code class="varname">OBJMACHINE</code> is defined, the platform name
                   3670:       is attached, which might look like
                   3671:       <code class="filename">work.i386</code> or
                   3672:       <code class="filename">work.sparc</code>.</p>
                   3673: </li></ul></div>
                   3674: <p>Please pay attention to the following gotchas:</p>
1.41      asau     3675: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      3676: <li class="listitem"><p>Add <code class="varname">MANCOMPRESSED</code> if man pages are
1.1       dsieger  3677:       installed in compressed form by the package.  For packages using
                   3678:       BSD-style makefiles which honor MANZ, there is
                   3679:       <code class="varname">MANCOMPRESSED_IF_MANZ</code>.</p></li>
1.23      wiz      3680: <li class="listitem"><p>Replace <code class="filename">/usr/local</code> with
                   3681:       <span class="quote">&#8220;<span class="quote">${PREFIX}</span>&#8221;</span> in all files (see patches,
1.1       dsieger  3682:       below).</p></li>
1.154     rillig   3683: <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  3684: </ul></div>
                   3685: </div>
1.41      asau     3686: <div class="sect1">
1.1       dsieger  3687: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   3688: <a name="components.distinfo"></a>13.2. <code class="filename">distinfo</code>
1.1       dsieger  3689: </h2></div></div></div>
                   3690: <p>The <code class="filename">distinfo</code> file contains the message
                   3691:   digest, or checksum, of each distfile needed for the package. This
                   3692:   ensures that the distfiles retrieved from the Internet have not been
                   3693:   corrupted during transfer or altered by a malign force to introduce
1.108     rillig   3694:   a security hole. To provide maximum security, all distfiles are
                   3695:   protected using three different message digest algorithms (SHA1,
                   3696:   RMD160, SHA512), as well as the file size.</p>
1.1       dsieger  3697: <p>The <code class="filename">distinfo</code> file also contains the
                   3698:   checksums for all the patches found in the
1.154     rillig   3699:   <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     3700:   are only applied intentionally and that they don't accidentally change,
                   3701:   e.g. when merging different changes together. They also make sure that
                   3702:   new patches are actually added to CVS and old ones are removed.
                   3703:   Too see whether the patches and the <code class="filename">distinfo</code> file
                   3704:   match, run <span class="command"><strong>pkglint</strong></span> after changing the patches.</p>
1.1       dsieger  3705: <p>To regenerate the <code class="filename">distinfo</code> file, use the
1.108     rillig   3706:   <span class="command"><strong>make distinfo</strong></span> command.</p>
1.1       dsieger  3707: <p>Some packages have different sets of distfiles depending on
1.137     leot     3708:   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  3709:   <code class="filename">distinfo</code> file and care should be taken when
                   3710:   upgrading such a package to ensure distfile information is not
                   3711:   lost.</p>
                   3712: </div>
1.41      asau     3713: <div class="sect1">
1.1       dsieger  3714: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   3715: <a name="components.patches"></a>13.3. <code class="filename">patches/*</code>
1.108     rillig   3716: </h2></div></div></div>
                   3717: <p>Some packages don't work out-of-the box on the various
                   3718:   platforms that are supported by pkgsrc. These packages need
                   3719:   to be patched to make them work. The patch files can be
1.1       dsieger  3720:   found in the <code class="filename">patches/</code> directory.</p>
                   3721: <p>In the <span class="emphasis"><em>patch</em></span> phase, these patches are
                   3722:   applied to the files in <code class="varname">WRKSRC</code> directory after
1.108     rillig   3723:   extracting them, in alphabetic order.</p>
1.41      asau     3724: <div class="sect2">
1.1       dsieger  3725: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   3726: <a name="components.patch.structure"></a>13.3.1. Structure of a single patch file</h3></div></div></div>
1.1       dsieger  3727: <p>The <code class="filename">patch-*</code> files should be in
1.10      hubertf  3728:   <span class="command"><strong>diff -bu</strong></span> format, and apply without a fuzz to avoid
1.1       dsieger  3729:   problems. (To force patches to apply with fuzz you can set
                   3730:   <code class="varname">PATCH_FUZZ_FACTOR=-F2</code>). Furthermore, each patch
                   3731:   should contain only changes for a single file, and no file should be
                   3732:   patched by more than one patch file. This helps to keep future
                   3733:   modifications simple.</p>
                   3734: <p>Each patch file is structured as follows: In the first line,
                   3735:   there is the RCS Id of the patch itself. The second line should be
                   3736:   empty for aesthetic reasons. After that, there should be a comment for
                   3737:   each change that the patch does. There are a number of standard
                   3738:   cases:</p>
1.41      asau     3739: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      3740: <li class="listitem"><p>Patches for commonly known vulnerabilities should
1.1       dsieger  3741:   mention the vulnerability ID (CAN, CVE).</p></li>
1.23      wiz      3742: <li class="listitem"><p>Patches that change source code should mention the
1.1       dsieger  3743:   platform and other environment (for example, the compiler) that the
                   3744:   patch is needed for.</p></li>
                   3745: </ul></div>
1.108     rillig   3746: <p>The patch should be commented so that any
1.1       dsieger  3747:   developer who knows the code of the application can make some use of
                   3748:   the patch. Special care should be taken for the upstream developers,
                   3749:   since we generally want that they accept our patches, so we have less
                   3750:   work in the future.</p>
                   3751: </div>
1.41      asau     3752: <div class="sect2">
1.1       dsieger  3753: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   3754: <a name="components.patches.caveats"></a>13.3.2. Creating patch files</h3></div></div></div>
1.1       dsieger  3755: <p>One important thing to mention is to pay attention that no RCS
                   3756:   IDs get stored in the patch files, as these will cause problems when
                   3757:   later checked into the NetBSD CVS tree. Use the
1.137     leot     3758:   <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  3759:   problems.</p>
                   3760: <p>For even more automation, we recommend using
1.10      hubertf  3761:   <span class="command"><strong>mkpatches</strong></span> from the same package to make a
1.1       dsieger  3762:   whole set of patches. You just have to backup files before you
                   3763:   edit them to <code class="filename">filename.orig</code>, e.g. with
1.10      hubertf  3764:   <span class="command"><strong>cp -p filename filename.orig</strong></span> or, easier, by
                   3765:   using <span class="command"><strong>pkgvi</strong></span> again from the same package. If
1.1       dsieger  3766:   you upgrade a package this way, you can easily compare the new
                   3767:   set of patches with the previously existing one with
1.24      wiz      3768:   <span class="command"><strong>patchdiff</strong></span>. The files in <code class="filename">patches</code>
                   3769:   are replaced by new files, so carefully check if you want to take all
                   3770:   the changes.</p>
1.1       dsieger  3771: <p>When you have finished a package, remember to generate
1.10      hubertf  3772:   the checksums for the patch files by using the <span class="command"><strong>make
1.154     rillig   3773:   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  3774: <p>When adding a patch that corrects a problem in the
                   3775:   distfile (rather than e.g. enforcing pkgsrc's view of where
                   3776:   man pages should go), send the patch as a bug report to the
                   3777:   maintainer.  This benefits non-pkgsrc users of the package,
                   3778:   and usually makes it possible to remove the patch in future
                   3779:   version.</p>
1.2       rillig   3780: <p>The file names of the patch files are usually of the form
1.24      wiz      3781:   <code class="filename">patch-<em class="replaceable"><code>path_to_file__with__underscores.c</code></em></code>.
                   3782:   Many packages still use the previous convention
                   3783:   <code class="filename">patch-<em class="replaceable"><code>[a-z][a-z]</code></em></code>,
                   3784:   but new patches should be of the form containing the filename.
1.137     leot     3785:   <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      3786:   automatically.</p>
1.1       dsieger  3787: </div>
1.41      asau     3788: <div class="sect2">
1.1       dsieger  3789: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   3790: <a name="components.patches.sources"></a>13.3.3. Sources where the patch files come from</h3></div></div></div>
1.1       dsieger  3791: <p>If you want to share patches between multiple packages
                   3792:   in pkgsrc, e.g. because they use the same distfiles, set
                   3793:   <code class="varname">PATCHDIR</code> to the path where the patch files
                   3794:   can be found, e.g.:</p>
                   3795: <pre class="programlisting">
1.159     rillig   3796: PATCHDIR=       ../../editors/xemacs/patches
1.1       dsieger  3797: </pre>
                   3798: <p>Patch files that are distributed by the author or other
                   3799:     maintainers can be listed in
                   3800:     <code class="varname">PATCHFILES</code>.</p>
                   3801: <p>If it is desired to store any patches that should not be
                   3802:     committed into pkgsrc, they can be kept outside the pkgsrc
                   3803:     tree in the <code class="filename">$LOCALPATCHES</code> directory. The
                   3804:     directory tree there is expected to have the same
1.23      wiz      3805:     <span class="quote">&#8220;<span class="quote">category/package</span>&#8221;</span> structure as pkgsrc, and
1.1       dsieger  3806:     patches are expected to be stored inside these dirs (also
                   3807:     known as <code class="filename">$LOCALPATCHES/$PKGPATH</code>). For
                   3808:     example, if you want to keep a private patch for
                   3809:     <code class="filename">pkgsrc/graphics/png</code>, keep it in
                   3810:     <code class="filename">$LOCALPATCHES/graphics/png/mypatch</code>. All
                   3811:     files in the named directory are expected to be patch files,
                   3812:     and <span class="emphasis"><em>they are applied after pkgsrc patches are
                   3813:     applied</em></span>.</p>
                   3814: </div>
1.41      asau     3815: <div class="sect2">
1.1       dsieger  3816: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   3817: <a name="components.patches.guidelines"></a>13.3.4. Patching guidelines</h3></div></div></div>
1.1       dsieger  3818: <p>When fixing a portability issue in the code do not use
                   3819:       preprocessor magic to check for the current operating system nor
                   3820:       platform.  Doing so hurts portability to other platforms because
                   3821:       the OS-specific details are not abstracted appropriately.</p>
                   3822: <p>The general rule to follow is: instead of checking for the
                   3823:       operating system the application is being built on, check for the
                   3824:       specific <span class="emphasis"><em>features</em></span> you need.  For example,
                   3825:       instead of assuming that kqueue is available under NetBSD and
                   3826:       using the <code class="varname">__NetBSD__</code> macro to conditionalize
1.14      jmcneill 3827:       kqueue support, add a check that detects kqueue itself &mdash;
1.1       dsieger  3828:       yes, this generally involves patching the
1.10      hubertf  3829:       <span class="command"><strong>configure</strong></span> script.  There is absolutely nothing
1.1       dsieger  3830:       that prevents some OSes from adopting interfaces from other OSes
                   3831:       (e.g. Linux implementing kqueue), something that the above checks
                   3832:       cannot take into account.</p>
                   3833: <p>Of course, checking for features generally involves more
                   3834:       work on the developer's side, but the resulting changes are
                   3835:       cleaner and there are chances they will work on many other
                   3836:       platforms.  Not to mention that there are higher chances of being
                   3837:       later integrated into the mainstream sources.  Remember:
                   3838:       <span class="emphasis"><em>It doesn't work unless it is right!</em></span></p>
                   3839: <p>Some typical examples:</p>
                   3840: <div class="table">
1.154     rillig   3841: <a name="patch-examples"></a><p class="title"><b>Table 13.1. Patching examples</b></p>
1.106     tnn      3842: <div class="table-contents"><table class="table" summary="Patching examples" border="1">
1.1       dsieger  3843: <colgroup>
                   3844: <col>
                   3845: <col>
                   3846: <col>
                   3847: </colgroup>
                   3848: <thead><tr>
                   3849: <th>Where</th>
                   3850: <th>Incorrect</th>
                   3851: <th>Correct</th>
                   3852: </tr></thead>
                   3853: <tbody>
                   3854: <tr>
                   3855: <td>configure script</td>
                   3856: <td>
                   3857: <pre class="programlisting">
                   3858: case ${target_os} in
                   3859: netbsd*) have_kvm=yes ;;
                   3860: *)       have_kvm=no  ;;
                   3861: esac
                   3862: </pre>
                   3863:              </td>
                   3864: <td>
                   3865: <pre class="programlisting">
                   3866: AC_CHECK_LIB(kvm, kvm_open, have_kvm=yes, have_kvm=no)
                   3867: </pre>
                   3868:              </td>
                   3869: </tr>
                   3870: <tr>
                   3871: <td>C source file</td>
                   3872: <td>
                   3873: <pre class="programlisting">
                   3874: #if defined(__NetBSD__)
                   3875: #  include &lt;sys/event.h&gt;
                   3876: #endif
                   3877: </pre>
                   3878:              </td>
                   3879: <td>
                   3880: <pre class="programlisting">
                   3881: #if defined(HAVE_SYS_EVENT_H)
                   3882: #  include &lt;sys/event.h&gt;
                   3883: #endif
                   3884: </pre>
                   3885:              </td>
                   3886: </tr>
                   3887: <tr>
                   3888: <td>C source file</td>
                   3889: <td>
                   3890: <pre class="programlisting">
                   3891: int
                   3892: monitor_file(...)
                   3893: {
                   3894: #if defined(__NetBSD__)
                   3895:         int fd = kqueue();
                   3896:         ...
                   3897: #else
                   3898:         ...
                   3899: #endif
                   3900: }
                   3901: </pre>
                   3902:              </td>
                   3903: <td>
                   3904: <pre class="programlisting">
                   3905: int
                   3906: monitor_file(...)
                   3907: {
                   3908: #if defined(HAVE_KQUEUE)
                   3909:         int fd = kqueue();
                   3910:         ...
                   3911: #else
1.112     rillig   3912:         ...
1.1       dsieger  3913: #endif
                   3914: }
                   3915: </pre>
                   3916:              </td>
                   3917: </tr>
                   3918: </tbody>
                   3919: </table></div>
                   3920: </div>
1.141     maya     3921: <br class="table-break">
1.1       dsieger  3922: </div>
1.41      asau     3923: <div class="sect2">
1.1       dsieger  3924: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   3925: <a name="components.patches.feedback"></a>13.3.5. Feedback to the author</h3></div></div></div>
1.1       dsieger  3926: <p>Always, always, <span class="strong"><strong>always</strong></span>
                   3927:       feed back any <span class="emphasis"><em>portability fixes</em></span> or
                   3928:       improvements you do to a package to the mainstream developers.
                   3929:       This is the only way to get their attention on portability issues
                   3930:       and to ensure that future versions can be built out-of-the box on
                   3931:       NetBSD.  Furthermore, any user that gets newer distfiles will get
                   3932:       the fixes straight from the packaged code.</p>
                   3933: <p>This generally involves cleaning up the patches
                   3934:       (because sometimes the patches that are
1.40      wiz      3935:       added to pkgsrc are quick hacks), filing bug reports in the
1.1       dsieger  3936:       appropriate trackers for the projects and working with the
                   3937:       mainstream authors to accept your changes.  It is
                   3938:       <span class="emphasis"><em>extremely important</em></span> that you do it so that
                   3939:       the packages in pkgsrc are kept simple and thus further changes
                   3940:       can be done without much hassle.</p>
1.24      wiz      3941: <p>When you have done this, please add a URL to the upstream
                   3942:       bug report to the patch comment.</p>
1.1       dsieger  3943: <p>Support the idea of free software!</p>
                   3944: </div>
                   3945: </div>
1.41      asau     3946: <div class="sect1">
1.1       dsieger  3947: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   3948: <a name="other-mandatory-files"></a>13.4. Other mandatory files</h2></div></div></div>
1.41      asau     3949: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  3950: <dt><span class="term"><code class="filename">DESCR</code></span></dt>
                   3951: <dd><p>A multi-line description of the piece of software.  This should include
                   3952:          any credits where they are due.  Please bear in mind that others do not
                   3953:          share your sense of humour (or spelling idiosyncrasies), and that others
                   3954:          will read everything that you write here.</p></dd>
                   3955: <dt><span class="term"><code class="filename">PLIST</code></span></dt>
                   3956: <dd><p>This file governs the files that are installed on your
                   3957:          system: all the binaries, manual pages, etc. There are other
                   3958:          directives which may be entered in this file, to control the
                   3959:          creation and deletion of directories, and the location of
1.154     rillig   3960:          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  3961:          information.</p></dd>
                   3962: </dl></div>
                   3963: </div>
1.41      asau     3964: <div class="sect1">
1.1       dsieger  3965: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   3966: <a name="components.optional"></a>13.5. Optional files</h2></div></div></div>
1.41      asau     3967: <div class="sect2">
1.1       dsieger  3968: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   3969: <a name="components.optional.bin"></a>13.5.1. Files affecting the binary package</h3></div></div></div>
1.41      asau     3970: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  3971: <dt><span class="term"><code class="filename">INSTALL</code></span></dt>
1.28      wiz      3972: <dd>
1.157     leot     3973: <p>This shell script is invoked twice by <a class="citerefentry" href="http://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  3974:            First time after package extraction and before files are
                   3975:            moved in place, the second time after the files to install
                   3976:            are moved in place. This can be used to do any custom
                   3977:            procedures not possible with @exec commands in
1.157     leot     3978:            <code class="filename">PLIST</code>. See <a class="citerefentry" href="http://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
                   3979:            <a class="citerefentry" href="http://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      3980:            Please note that you can modify variables in it easily by using
                   3981:            <code class="varname">FILES_SUBST</code> in the package's
                   3982:            <code class="filename">Makefile</code>:</p>
                   3983: <pre class="programlisting">
                   3984: FILES_SUBST+=  SOMEVAR="somevalue"
                   3985: </pre>
                   3986: <p>replaces "@SOMEVAR@" with <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span> in the
                   3987:            <code class="filename">INSTALL</code>.  By default, substitution is
                   3988:            performed for <code class="varname">PREFIX</code>,
                   3989:            <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
                   3990:            <code class="varname">VARBASE</code>, and a few others, type
                   3991:            <span class="command"><strong>make help topic=FILES_SUBST</strong></span> for a
                   3992:            complete list.</p>
                   3993: </dd>
1.1       dsieger  3994: <dt><span class="term"><code class="filename">DEINSTALL</code></span></dt>
                   3995: <dd><p>This script is executed before and after any files are removed.  It is
                   3996:            this script's responsibility to clean up any additional messy details
                   3997:            around the package's installation, since all pkg_delete knows is how to
                   3998:            delete the files created in the original distribution.
1.157     leot     3999:            See <a class="citerefentry" href="http://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>
                   4000:            and <a class="citerefentry" href="http://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      4001:            The same methods to replace variables can be used as for
                   4002:            the <code class="filename">INSTALL</code> file.</p></dd>
1.1       dsieger  4003: <dt><span class="term"><code class="filename">MESSAGE</code></span></dt>
                   4004: <dd>
                   4005: <p>This file is displayed after installation of the package.
                   4006:            Useful for things like legal notices on almost-free
                   4007:            software and hints for updating config files after
                   4008:            installing modules for apache, PHP etc.
                   4009:            Please note that you can modify variables in it easily by using
                   4010:            <code class="varname">MESSAGE_SUBST</code> in the package's
                   4011:            <code class="filename">Makefile</code>:</p>
                   4012: <pre class="programlisting">
                   4013: MESSAGE_SUBST+=  SOMEVAR="somevalue"
                   4014: </pre>
1.23      wiz      4015: <p>replaces "${SOMEVAR}" with <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span> in
1.1       dsieger  4016:            <code class="filename">MESSAGE</code>.  By default, substitution is
                   4017:            performed for <code class="varname">PKGNAME</code>,
                   4018:            <code class="varname">PKGBASE</code>, <code class="varname">PREFIX</code>,
1.99      sevan    4019:            <code class="varname">LOCALBASE</code>, <code class="varname">X11BASE</code>,
1.1       dsieger  4020:            <code class="varname">PKG_SYSCONFDIR</code>,
                   4021:            <code class="varname">ROOT_GROUP</code>, and
1.16      jnemeth  4022:            <code class="varname">ROOT_USER</code>.</p>
1.1       dsieger  4023: <p>You can display a different or additional files by
                   4024:            setting the <code class="varname">MESSAGE_SRC</code> variable.  Its
                   4025:            default is <code class="filename">MESSAGE</code>, if the file
                   4026:            exists.</p>
                   4027: </dd>
                   4028: <dt><span class="term"><code class="filename">ALTERNATIVES</code></span></dt>
1.66      asau     4029: <dd>
                   4030: <p>This file is used by the alternatives framework.
                   4031:            It creates, configures, and destroys generic wrappers used to
                   4032:            run programs with similar interfaces.
                   4033:            See pkg_alternatives(8) from pkgtools/pkg_alternatives
                   4034:             for more information.</p>
                   4035: <p>Each line of the file contains two filenames, first
                   4036:            the wrapper and then the alternative provided by the package.
                   4037:            Both paths are relative to <code class="varname">PREFIX</code>.</p>
                   4038: </dd>
1.1       dsieger  4039: </dl></div>
                   4040: </div>
1.41      asau     4041: <div class="sect2">
1.1       dsieger  4042: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   4043: <a name="components.optional.build"></a>13.5.2. Files affecting the build process</h3></div></div></div>
1.41      asau     4044: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  4045: <dt><span class="term"><code class="filename">Makefile.common</code></span></dt>
                   4046: <dd><p>This file contains arbitrary things that could
                   4047:        also go into a <code class="filename">Makefile</code>, but its purpose is
                   4048:        to be used by more than one package. This file should only be
                   4049:        used when the packages that will use the file are known in
                   4050:        advance. For other purposes it is often better to write a
                   4051:        <code class="filename">*.mk</code> file and give it a good name that
                   4052:        describes what it does.</p></dd>
                   4053: <dt><span class="term"><code class="filename">buildlink3.mk</code></span></dt>
                   4054: <dd><p>This file contains the dependency information
1.154     rillig   4055:        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  4056: <dt><span class="term"><code class="filename">hacks.mk</code></span></dt>
                   4057: <dd><p>This file contains workarounds for compiler bugs
                   4058:        and similar things. It is included automatically by the pkgsrc
                   4059:        infrastructure, so you don't need an extra
                   4060:        <code class="literal">.include</code> line for
                   4061:        it.</p></dd>
                   4062: <dt><span class="term"><code class="filename">options.mk</code></span></dt>
                   4063: <dd><p>This file contains the code for the
1.154     rillig   4064:        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  4065:        selected by the user. If a package has only one or two options,
                   4066:        it is equally acceptable to put the code directly into the
                   4067:        <code class="filename">Makefile</code>.</p></dd>
                   4068: </dl></div>
                   4069: </div>
1.41      asau     4070: <div class="sect2">
1.1       dsieger  4071: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   4072: <a name="components.optional.none"></a>13.5.3. Files affecting nothing at all</h3></div></div></div>
1.41      asau     4073: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  4074: <dt><span class="term"><code class="filename">README*</code></span></dt>
                   4075: <dd><p>These files do not take place in the creation of
                   4076:        a package and thus are purely informative to the package
                   4077:        developer.</p></dd>
                   4078: <dt><span class="term"><code class="filename">TODO</code></span></dt>
                   4079: <dd><p>This file contains things that need to be done
                   4080:        to make the package even
                   4081:        better.</p></dd>
                   4082: </dl></div>
                   4083: </div>
                   4084: </div>
1.41      asau     4085: <div class="sect1">
1.1       dsieger  4086: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   4087: <a name="work-dir"></a>13.6. <code class="filename">work*</code>
1.1       dsieger  4088: </h2></div></div></div>
1.10      hubertf  4089: <p>When you type <span class="command"><strong>make</strong></span>, the distribution files are
1.1       dsieger  4090:     unpacked into the directory denoted by
                   4091:     <code class="varname">WRKDIR</code>. It can be removed by running
1.10      hubertf  4092:     <span class="command"><strong>make clean</strong></span>. Besides the sources, this
1.1       dsieger  4093:     directory is also used to keep various timestamp files.
                   4094:     The directory gets <span class="emphasis"><em>removed completely</em></span> on clean.
                   4095:     The default is <code class="filename">${.CURDIR}/work</code>
                   4096:     or <code class="filename">${.CURDIR}/work.${MACHINE_ARCH}</code>
                   4097:     if <code class="varname">OBJMACHINE</code> is set.</p>
                   4098: </div>
1.41      asau     4099: <div class="sect1">
1.1       dsieger  4100: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   4101: <a name="files-dir"></a>13.7. <code class="filename">files/*</code>
1.1       dsieger  4102: </h2></div></div></div>
                   4103: <p>If you have any files that you wish to be placed in the package prior
                   4104:     to configuration or building, you could place these files here and use
1.10      hubertf  4105:     a <span class="command"><strong>${CP}</strong></span> command in the
1.23      wiz      4106:     <span class="quote">&#8220;<span class="quote">pre-configure</span>&#8221;</span> target to achieve
1.1       dsieger  4107:     this. Alternatively, you could simply diff the file against
                   4108:     <code class="filename">/dev/null</code> and use the patch mechanism to manage
                   4109:     the creation of this file.</p>
                   4110: <p>If you want to share files in this way with other
                   4111:     packages, set the <code class="varname">FILESDIR</code> variable to point
                   4112:     to the other package's <code class="filename">files</code> directory,
                   4113:     e.g.:</p>
                   4114: <pre class="programlisting">
1.159     rillig   4115: FILESDIR=       ../../editors/xemacs/files
1.1       dsieger  4116: </pre>
                   4117: </div>
                   4118: </div>
1.41      asau     4119: <div class="chapter">
1.1       dsieger  4120: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   4121: <a name="makefile"></a>Chapter 14. Programming in <code class="filename">Makefile</code>s</h2></div></div></div>
1.1       dsieger  4122: <div class="toc">
                   4123: <p><b>Table of Contents</b></p>
1.100     leot     4124: <dl class="toc">
1.154     rillig   4125: <dt><span class="sect1"><a href="#makefile.style">14.1. Caveats</a></span></dt>
                   4126: <dt><span class="sect1"><a href="#makefile.variables">14.2. <code class="filename">Makefile</code> variables</a></span></dt>
                   4127: <dd><dl><dt><span class="sect2"><a href="#makefile.variables.names">14.2.1. Naming conventions</a></span></dt></dl></dd>
                   4128: <dt><span class="sect1"><a href="#makefile.code">14.3. Code snippets</a></span></dt>
                   4129: <dd><dl>
                   4130: <dt><span class="sect2"><a href="#adding-to-list">14.3.1. Adding things to a list</a></span></dt>
                   4131: <dt><span class="sect2"><a href="#echo-literal">14.3.2. Echoing a string exactly as-is</a></span></dt>
                   4132: <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>
                   4133: <dt><span class="sect2"><a href="#empty-variables">14.3.4. Handling possibly empty variables</a></span></dt>
1.1       dsieger  4134: </dl></dd>
                   4135: </dl>
                   4136: </div>
                   4137: <p>Pkgsrc consists of many <code class="filename">Makefile</code> fragments,
                   4138:   each of which forms a well-defined part of the pkgsrc system. Using
1.157     leot     4139:   the <a class="citerefentry" href="http://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  4140:   like pkgsrc requires some discipline to keep the code correct and
                   4141:   understandable.</p>
                   4142: <p>The basic ingredients for <code class="filename">Makefile</code>
1.154     rillig   4143:   programming are variables and shell
1.1       dsieger  4144:   commands. Among these shell commands may even be more complex ones
1.157     leot     4145:   like <a class="citerefentry" href="http://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  4146:   as intended it is necessary to quote all variables correctly when they
                   4147:   are used.</p>
1.154     rillig   4148: <p>This chapter describes some patterns that appear quite often in
1.1       dsieger  4149:   <code class="filename">Makefile</code>s, including the pitfalls that come along
                   4150:   with them.</p>
1.41      asau     4151: <div class="sect1">
1.1       dsieger  4152: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   4153: <a name="makefile.style"></a>14.1. Caveats</h2></div></div></div>
1.41      asau     4154: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; "><li class="listitem">
1.1       dsieger  4155: <p>When you are creating a file as a
                   4156:     target of a rule, always write the data to a temporary file first
                   4157:     and finally rename that file. Otherwise there might occur an error
                   4158:     in the middle of generating the file, and when the user runs
1.157     leot     4159:     <a class="citerefentry" href="http://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  4160:     regenerated properly. Example:</p>
                   4161: <pre class="programlisting">
                   4162: wrong:
                   4163:         @echo "line 1" &gt; ${.TARGET}
                   4164:         @echo "line 2" &gt;&gt; ${.TARGET}
                   4165:         @false
                   4166: 
                   4167: correct:
                   4168:         @echo "line 1" &gt; ${.TARGET}.tmp
                   4169:         @echo "line 2" &gt;&gt; ${.TARGET}.tmp
                   4170:         @false
                   4171:         @mv ${.TARGET}.tmp ${.TARGET}
                   4172: </pre>
1.10      hubertf  4173: <p>When you run <span class="command"><strong>make wrong</strong></span> twice, the file
1.1       dsieger  4174:     <code class="filename">wrong</code> will exist, although there was an error
1.10      hubertf  4175:     message in the first run. On the other hand, running <span class="command"><strong>make
1.1       dsieger  4176:     correct</strong></span> gives an error message twice, as expected.</p>
1.157     leot     4177: <p>You might remember that <a class="citerefentry" href="http://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  4178:     <code class="literal">${.TARGET}</code> in case of error, but this only
                   4179:     happens when it is interrupted, for example by pressing
1.154     rillig   4180:     <code class="literal">Ctrl+C</code>. This does <span class="emphasis"><em>not</em></span> happen
1.157     leot     4181:     when one of the commands fails (like <a class="citerefentry" href="http://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  4182: </li></ul></div>
                   4183: </div>
1.41      asau     4184: <div class="sect1">
1.1       dsieger  4185: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   4186: <a name="makefile.variables"></a>14.2. <code class="filename">Makefile</code> variables</h2></div></div></div>
1.1       dsieger  4187: <p><code class="filename">Makefile</code> variables contain strings that
1.154     rillig   4188:     can be processed using the five operators <code class="code">=</code>,
                   4189:     <code class="code">+=</code>, <code class="code">?=</code>, <code class="code">:=</code> and
1.157     leot     4190:     <code class="code">!=</code>, which are described in the <a class="citerefentry" href="http://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  4191:     page.</p>
                   4192: <p>When a variable's value is parsed from a
1.154     rillig   4193:     <code class="filename">Makefile</code>, the hash character <code class="code">#</code> and
                   4194:     the backslash character <code class="code">\</code> are handled specially. If a
                   4195:     backslash is the last character in a line, that backslash is removed
                   4196:     from the line and the line continues with the next line of the file.</p>
                   4197: <p>The <code class="code">#</code> character starts a comment that reaches
                   4198:     until the end of the line. To get an actual <code class="code">#</code> character,
                   4199:     such as in a URL, write <code class="code">\#</code> instead.</p>
1.108     rillig   4200: <p>The evaluation of variables either happens immediately or lazy.
1.154     rillig   4201:     It happens immediately when the variable occurs on the right-hand
                   4202:     side of the <code class="code">:=</code> or the <code class="code">!=</code> operator, in a
1.108     rillig   4203:     <code class="varname">.if</code> condition or a <code class="varname">.for</code> loop.
                   4204:     In the other cases, it is evaluated lazily.</p>
1.1       dsieger  4205: <p>Some of the modifiers split the string into words and then
1.154     rillig   4206:     operate on the words, others operate on the string as a whole. When a
                   4207:     string is split into words, double quotes and single quotes are
1.157     leot     4208:     interpreted as delimiters, just like in <a class="citerefentry" href="http://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     4209: <div class="sect2">
1.1       dsieger  4210: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   4211: <a name="makefile.variables.names"></a>14.2.1. Naming conventions</h3></div></div></div>
1.41      asau     4212: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      4213: <li class="listitem"><p>All variable names starting with an underscore
1.1       dsieger  4214:        are reserved for use by the pkgsrc infrastructure. They shall
1.154     rillig   4215:        not be used by packages.</p></li>
1.23      wiz      4216: <li class="listitem"><p>In <span class="command"><strong>.for</strong></span> loops you should use
1.1       dsieger  4217:        lowercase variable names for the iteration
                   4218:        variables.</p></li>
1.154     rillig   4219: <li class="listitem"><p>All list variables should have a plural name,
                   4220:        such as <code class="varname">PKG_OPTIONS</code> or
1.1       dsieger  4221:        <code class="varname">DISTFILES</code>.</p></li>
                   4222: </ul></div>
                   4223: </div>
                   4224: </div>
1.41      asau     4225: <div class="sect1">
1.1       dsieger  4226: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   4227: <a name="makefile.code"></a>14.3. Code snippets</h2></div></div></div>
1.41      asau     4228: <div class="sect2">
1.1       dsieger  4229: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   4230: <a name="adding-to-list"></a>14.3.1. Adding things to a list</h3></div></div></div>
1.108     rillig   4231: <p>When adding a string that possibly contains whitespace or quotes to
                   4232: a list (example 1), it must be quoted using the <code class="code">:Q</code>
                   4233: modifier.</p>
                   4234: <p>When adding another list to a list (example 2), it must not be
                   4235: quoted, since its elements are already quoted.</p>
1.1       dsieger  4236: <pre class="programlisting">
1.108     rillig   4237: STRING=         foo * bar `date`
                   4238: LIST=           # empty
                   4239: ANOTHER_LIST=   a=b c=d
                   4240: 
                   4241: LIST+=          ${STRING:Q}       # 1
                   4242: LIST+=          ${ANOTHER_LIST}   # 2
1.1       dsieger  4243: </pre>
                   4244: </div>
1.41      asau     4245: <div class="sect2">
1.1       dsieger  4246: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   4247: <a name="echo-literal"></a>14.3.2. Echoing a string exactly as-is</h3></div></div></div>
1.108     rillig   4248: <p>Echoing a string containing special characters needs special
                   4249: work.</p>
1.1       dsieger  4250: <pre class="programlisting">
                   4251: STRING=         foo bar &lt;    &gt; * `date` $$HOME ' "
1.108     rillig   4252: EXAMPLE_ENV=    string=${STRING:Q} x=multiple\ quoted\ words
1.1       dsieger  4253: 
                   4254: all:
                   4255:         echo ${STRING}                  # 1
1.108     rillig   4256:         echo ${STRING:Q}                # 2
                   4257:         printf '%s\n' ${STRING:Q}''     # 3
                   4258:         env ${EXAMPLE_ENV} sh -c 'echo "$$string"; echo "$$x"'   # 4
                   4259: </pre>
                   4260: <p>Example 1 leads to a syntax error in the shell, as the characters
                   4261: are just copied.</p>
                   4262: <p>Example 2 quotes the string so that the shell interprets it
                   4263: correctly. But the echo command may additionally interpret strings with a
                   4264: leading dash or those containing backslashes.</p>
1.157     leot     4265: <p>Example 3 can handle arbitrary strings, since <a class="citerefentry" href="http://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     4266: interprets the format string, but not the next argument. The trailing
                   4267: single quotes handle the case when the string is empty. In that case, the
                   4268: :Q modifier would result in an empty string too, which would then be
1.157     leot     4269: skipped by the shell. For <a class="citerefentry" href="http://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     4270: but other programs may care.</p>
1.108     rillig   4271: <p>In example 4, the <code class="varname">EXAMPLE_ENV</code> does not
                   4272: need to be quoted because the quoting has already been done
                   4273: when adding elements to the list.</p>
1.1       dsieger  4274: </div>
1.41      asau     4275: <div class="sect2">
1.1       dsieger  4276: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   4277: <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   4278: <p>When passing <code class="varname">CFLAGS</code> or similar variables to a
                   4279: GNU-style configure script (especially those that call other configure
                   4280: scripts), it must not have leading or trailing whitespace, since
                   4281: otherwise the configure script gets confused. To trim leading and
                   4282: trailing whitespace, use the <code class="code">:M</code> modifier, as in the
                   4283: following example:</p>
1.1       dsieger  4284: <pre class="programlisting">
                   4285: CPPFLAGS=               # empty
1.108     rillig   4286: CPPFLAGS+=              -Wundef -DPREFIX=\"${PREFIX}\"
1.1       dsieger  4287: CPPFLAGS+=              ${MY_CPPFLAGS}
                   4288: 
                   4289: CONFIGURE_ARGS+=        CPPFLAGS=${CPPFLAGS:M*:Q}
                   4290: 
                   4291: all:
                   4292:         echo x${CPPFLAGS:Q}x            # leading and trailing whitespace
1.108     rillig   4293:         echo x${CONFIGURE_ARGS:Q}x      # properly trimmed
1.1       dsieger  4294: </pre>
1.108     rillig   4295: <p>In this example, <code class="varname">CPPFLAGS</code> has both leading and
                   4296: trailing whitespace because the <code class="code">+=</code> operator always adds a
                   4297: space.</p>
                   4298: </div>
                   4299: <div class="sect2">
                   4300: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   4301: <a name="empty-variables"></a>14.3.4. Handling possibly empty variables</h3></div></div></div>
1.108     rillig   4302: <p>When a possibly empty variable is used in a shell program, it may
                   4303: lead to a syntax error.</p>
                   4304: <pre class="programlisting">
                   4305: EGFILES=        # empty
                   4306: 
                   4307: install-examples:   # produces a syntax error in the shell
                   4308:         for egfile in ${EGFILES}; do            \
                   4309:                 echo "Installing $$egfile";     \
                   4310:         done
                   4311: </pre>
                   4312: <p>The shell only sees the text <code class="code">for egfile in ; do</code>, since
1.157     leot     4313: <code class="code">${EGFILES}</code> is replaced with an empty string by <a class="citerefentry" href="http://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   4314: To fix this syntax error, use one of the snippets below.</p>
                   4315: <pre class="programlisting">
                   4316: EMPTY=          # empty
                   4317: 
                   4318: install-examples:
                   4319:         for egfile in ${EGFILES} ""; do         \
                   4320:                 [ -n "$$egfile" ] || continue;  \
                   4321:                 echo "Installing $$egfile";     \
1.1       dsieger  4322:         done
1.108     rillig   4323: </pre>
                   4324: <p>In this case, an empty string is appended to the iteration list (to
                   4325: prevent the syntax error) and filtered out later.</p>
                   4326: <pre class="programlisting">
                   4327: EGFILES=        # empty
1.1       dsieger  4328: 
1.108     rillig   4329: install-examples:
                   4330: .for egfile in ${EGFILES}
                   4331:         echo "Installing ${egfile}"
1.1       dsieger  4332: .endfor
                   4333: </pre>
1.154     rillig   4334: <p>If one of the filenames contains special characters, it should be
                   4335: enclosed in single or double quotes.</p>
1.108     rillig   4336: <p>To have a shell command test whether a make variable is empty, use
                   4337: the following code: <code class="code">${TEST} -z ${POSSIBLY_EMPTY:Q}""</code>.</p>
1.1       dsieger  4338: </div>
                   4339: </div>
                   4340: </div>
1.41      asau     4341: <div class="chapter">
1.1       dsieger  4342: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   4343: <a name="plist"></a>Chapter 15. PLIST issues</h2></div></div></div>
1.1       dsieger  4344: <div class="toc">
                   4345: <p><b>Table of Contents</b></p>
1.100     leot     4346: <dl class="toc">
1.154     rillig   4347: <dt><span class="sect1"><a href="#rcs-id">15.1. RCS ID</a></span></dt>
                   4348: <dt><span class="sect1"><a href="#automatic-plist-generation">15.2. Semi-automatic <code class="filename">PLIST</code> generation</a></span></dt>
                   4349: <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>
                   4350: <dt><span class="sect1"><a href="#plist.misc">15.4. Variable substitution in PLIST</a></span></dt>
                   4351: <dt><span class="sect1"><a href="#manpage-compression">15.5. Man page compression</a></span></dt>
                   4352: <dt><span class="sect1"><a href="#using-PLIST_SRC">15.6. Changing PLIST source with <code class="varname">PLIST_SRC</code></a></span></dt>
                   4353: <dt><span class="sect1"><a href="#platform-specific-plist">15.7. Platform-specific and differing PLISTs</a></span></dt>
                   4354: <dt><span class="sect1"><a href="#build-plist">15.8. Build-specific PLISTs</a></span></dt>
                   4355: <dt><span class="sect1"><a href="#faq.common-dirs">15.9. Sharing directories between packages</a></span></dt>
1.1       dsieger  4356: </dl>
                   4357: </div>
                   4358: <p>The <code class="filename">PLIST</code> file contains a package's
1.23      wiz      4359:   <span class="quote">&#8220;<span class="quote">packing list</span>&#8221;</span>, i.e. a list of files that belong to
1.1       dsieger  4360:   the package (relative to the <code class="filename">${PREFIX}</code>
                   4361:   directory it's been installed in) plus some additional statements
1.157     leot     4362:   - see the <a class="citerefentry" href="http://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  4363:   This chapter addresses some issues that need attention when
                   4364:   dealing with the <code class="filename">PLIST</code> file (or files, see
                   4365:   below!).</p>
1.41      asau     4366: <div class="sect1">
1.1       dsieger  4367: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   4368: <a name="rcs-id"></a>15.1. RCS ID</h2></div></div></div>
1.1       dsieger  4369: <p>Be sure to add a RCS ID line as the first thing in any
                   4370:     <code class="filename">PLIST</code> file you write:</p>
                   4371: <pre class="programlisting">
1.121     sevan    4372: @comment $NetBSD $
1.111     sevan    4373: </pre>
1.123     wiz      4374: <p>An artificial space has been added between NetBSD and $, this is a
1.121     sevan    4375: workaround here to prevent CVS expanding to the filename of the guide. When
1.125     leot     4376: adding the RCS ID the space should be omitted.</p>
1.1       dsieger  4377: </div>
1.41      asau     4378: <div class="sect1">
1.1       dsieger  4379: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   4380: <a name="automatic-plist-generation"></a>15.2. Semi-automatic <code class="filename">PLIST</code> generation</h2></div></div></div>
1.10      hubertf  4381: <p>You can use the <span class="command"><strong>make print-PLIST</strong></span> command
1.1       dsieger  4382:     to output a PLIST that matches any new files since the package
1.154     rillig   4383:     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  4384:     more information on this target.</p>
                   4385: </div>
1.41      asau     4386: <div class="sect1">
1.1       dsieger  4387: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   4388: <a name="print-PLIST"></a>15.3. Tweaking output of <span class="command"><strong>make print-PLIST</strong></span>
1.1       dsieger  4389: </h2></div></div></div>
                   4390: <p>The <code class="varname">PRINT_PLIST_AWK</code> variable takes a set
                   4391:     of AWK patterns and actions that are used to filter the output of
                   4392:     print-PLIST.  You can <span class="emphasis"><em>append</em></span> any chunk of AWK
                   4393:     scripting you like to it, but be careful with quoting.</p>
                   4394: <p>For example, to get all files inside the
                   4395:     <code class="filename">libdata/foo</code> directory removed from the
                   4396:     resulting PLIST:</p>
                   4397: <pre class="programlisting">
                   4398: PRINT_PLIST_AWK+=       /^libdata\/foo/ { next; }
1.111     sevan    4399: </pre>
1.1       dsieger  4400: </div>
1.41      asau     4401: <div class="sect1">
1.1       dsieger  4402: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   4403: <a name="plist.misc"></a>15.4. Variable substitution in PLIST</h2></div></div></div>
1.1       dsieger  4404: <p>A number of variables are substituted automatically in
                   4405:     PLISTs when a package is installed on a system. This includes the
                   4406:     following variables:</p>
1.41      asau     4407: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  4408: <dt><span class="term"><code class="varname">${MACHINE_ARCH}</code>, <code class="varname">${MACHINE_GNU_ARCH}</code></span></dt>
                   4409: <dd>
                   4410: <p>Some packages like emacs and perl embed information
                   4411:          about which architecture they were built on into the
                   4412:          pathnames where they install their files. To handle this
                   4413:          case, PLIST will be preprocessed before actually used, and
                   4414:          the symbol
1.23      wiz      4415:          <span class="quote">&#8220;<span class="quote"><code class="varname">${MACHINE_ARCH}</code></span>&#8221;</span> will be
1.10      hubertf  4416:          replaced by what <span class="command"><strong>uname -p</strong></span> gives. The
1.1       dsieger  4417:          same is done if the string
                   4418:          <code class="varname">${MACHINE_GNU_ARCH}</code> is embedded in
                   4419:          PLIST somewhere - use this on packages that have GNU
                   4420:          autoconf-created configure scripts.</p>
1.41      asau     4421: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  4422: <h3 class="title">Legacy note</h3>
                   4423: <p>There used to be a symbol
1.23      wiz      4424:            <span class="quote">&#8220;<span class="quote"><code class="varname">$ARCH</code></span>&#8221;</span> that
1.10      hubertf  4425:            was replaced by the output of <span class="command"><strong>uname
1.1       dsieger  4426:            -m</strong></span>, but that's no longer supported and has
                   4427:            been removed.</p>
                   4428: </div>
                   4429: </dd>
                   4430: <dt><span class="term"><code class="varname">${OPSYS}</code>, <code class="varname">${LOWER_OPSYS}</code>, <code class="varname">${OS_VERSION}</code></span></dt>
                   4431: <dd>
                   4432: <p>Some packages want to embed the OS name and version
                   4433:          into some paths.  To do this, use these variables in the
                   4434:          <code class="filename">PLIST</code>:
                   4435:          </p>
1.41      asau     4436: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      4437: <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>
                   4438: <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>
                   4439: <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  4440: </ul></div>
                   4441: </dd>
                   4442: </dl></div>
1.88      tnn      4443: <p>For a list of values which are replaced by
                   4444:     default, the output of <span class="command"><strong>make help topic=PLIST_SUBST</strong></span> as
                   4445: well as searching the <code class="filename">pkgsrc/mk</code> directory with <span class="command"><strong>grep</strong></span> for
                   4446: <code class="varname">PLIST_SUBST</code> should help.</p>
1.1       dsieger  4447: <p>If you want to change other variables not listed above, you
                   4448:     can add variables and their expansions to this variable in the
1.154     rillig   4449:     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  4450: <pre class="programlisting">
                   4451: PLIST_SUBST+=   SOMEVAR="somevalue"
1.111     sevan    4452: </pre>
1.23      wiz      4453: <p>This replaces all occurrences of <span class="quote">&#8220;<span class="quote">${SOMEVAR}</span>&#8221;</span>
1.1       dsieger  4454:     in the <code class="filename">PLIST</code> with
1.23      wiz      4455:     <span class="quote">&#8220;<span class="quote">somevalue</span>&#8221;</span>.</p>
1.18      snj      4456: <p>The <code class="varname">PLIST_VARS</code> variable can be used to simplify
                   4457:     the common case of conditionally including some
                   4458:     <code class="filename">PLIST</code> entries. It can be done by adding
                   4459:     <code class="literal"><code class="varname">PLIST_VARS</code>+=foo</code> and
                   4460:     setting the corresponding <code class="varname">PLIST.foo</code> variable
                   4461:     to <code class="literal">yes</code> if the entry should be included.
1.23      wiz      4462:     This will substitute <span class="quote">&#8220;<span class="quote"><code class="varname">${PLIST.foo}</code></span>&#8221;</span>
1.18      snj      4463:     in the <code class="filename">PLIST</code> with either
1.23      wiz      4464:     <span class="quote">&#8220;<span class="quote"><code class="literal">""</code></span>&#8221;</span> or
                   4465:     <span class="quote">&#8220;<span class="quote"><code class="literal">"@comment "</code></span>&#8221;</span>.
1.18      snj      4466:     For example, in <code class="filename">Makefile</code>:</p>
                   4467: <pre class="programlisting">
1.112     rillig   4468: PLIST_VARS+=    foo
1.18      snj      4469: .if <em class="replaceable"><code>condition</code></em>
1.112     rillig   4470: PLIST.foo=      yes
1.18      snj      4471: .else
1.111     sevan    4472: </pre>
1.18      snj      4473: <p>And then in <code class="filename">PLIST</code>:</p>
                   4474: <pre class="programlisting">
1.121     sevan    4475: @comment $NetBSD $
1.18      snj      4476: bin/bar
                   4477: man/man1/bar.1
                   4478: ${PLIST.foo}bin/foo
                   4479: ${PLIST.foo}man/man1/foo.1
                   4480: ${PLIST.foo}share/bar/foo.data
1.111     sevan    4481: </pre>
1.123     wiz      4482: <p>An artificial space has been added between NetBSD and $, this is a
1.121     sevan    4483: workaround here to prevent CVS expanding to the filename of the guide. When
                   4484: adding the RCS ID the space should be ommited.</p>
1.1       dsieger  4485: </div>
1.41      asau     4486: <div class="sect1">
1.1       dsieger  4487: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   4488: <a name="manpage-compression"></a>15.5. Man page compression</h2></div></div></div>
1.1       dsieger  4489: <p>Man pages should be installed in compressed form if
                   4490:     <code class="varname">MANZ</code> is set (in <code class="filename">bsd.own.mk</code>),
                   4491:     and uncompressed otherwise. To handle this in the
1.23      wiz      4492:     <code class="filename">PLIST</code> file, the suffix <span class="quote">&#8220;<span class="quote">.gz</span>&#8221;</span> is
1.1       dsieger  4493:     appended/removed automatically for man pages according to
                   4494:     <code class="varname">MANZ</code> and <code class="varname">MANCOMPRESSED</code> being set
                   4495:     or not, see above for details. This modification of the
                   4496:     <code class="filename">PLIST</code> file is done on a copy of it, not
                   4497:     <code class="filename">PLIST</code> itself.</p>
                   4498: </div>
1.41      asau     4499: <div class="sect1">
1.1       dsieger  4500: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   4501: <a name="using-PLIST_SRC"></a>15.6. Changing PLIST source with <code class="varname">PLIST_SRC</code>
1.1       dsieger  4502: </h2></div></div></div>
                   4503: <p>To use one or more files as source for the <code class="filename">PLIST</code> used
                   4504:     in generating the binary package, set the variable
                   4505:     <code class="varname">PLIST_SRC</code> to the names of that file(s).
1.157     leot     4506:     The files are later concatenated using <a class="citerefentry" href="http://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  4507:     important. The default for <code class="varname">PLIST_SRC</code> is
                   4508:     <code class="filename">${PKGDIR}/PLIST</code>.</p>
                   4509: </div>
1.41      asau     4510: <div class="sect1">
1.1       dsieger  4511: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   4512: <a name="platform-specific-plist"></a>15.7. Platform-specific and differing PLISTs</h2></div></div></div>
1.1       dsieger  4513: <p>Some packages decide to install a different set of files based on
                   4514:     the operating system being used. These differences can be
                   4515:     automatically handled by using the following files:</p>
1.41      asau     4516: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      4517: <li class="listitem"><p><code class="filename">PLIST.common</code></p></li>
                   4518: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}</code></p></li>
                   4519: <li class="listitem"><p><code class="filename">PLIST.${MACHINE_ARCH}</code></p></li>
                   4520: <li class="listitem"><p><code class="filename">PLIST.${OPSYS}-${MACHINE_ARCH}</code></p></li>
                   4521: <li class="listitem"><p><code class="filename">PLIST.common_end</code></p></li>
1.1       dsieger  4522: </ul></div>
                   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="build-plist"></a>15.8. Build-specific PLISTs</h2></div></div></div>
1.86      wiz      4527: <p>Some packages decide to generate hard-to-guess file names
                   4528:     during installation that are hard to wire down.</p>
                   4529: <p>In such cases, you can set the
                   4530:     <code class="varname">GENERATE_PLIST</code> variable to shell code
                   4531:     terminated (with a semicolon) that will output PLIST entries which
                   4532:     will be appended to the PLIST</p>
                   4533: <p>You can find one example in editors/xemacs:</p>
                   4534: <pre class="programlisting">
1.111     sevan    4535: GENERATE_PLIST+=        ${ECHO} bin/${DISTNAME}-`${WRKSRC}/src/xemacs -sd`.dmp ;
                   4536: </pre>
1.86      wiz      4537: <p>which will append something like
                   4538:     <code class="filename">bin/xemacs-21.4.23-54e8ea71.dmp</code> to the
                   4539:     <code class="filename">PLIST</code>.
                   4540:     </p>
                   4541: </div>
                   4542: <div class="sect1">
                   4543: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   4544: <a name="faq.common-dirs"></a>15.9. Sharing directories between packages</h2></div></div></div>
1.23      wiz      4545: <p>A <span class="quote">&#8220;<span class="quote">shared directory</span>&#8221;</span> is a directory where
1.1       dsieger  4546:     multiple (and unrelated) packages install files.  These
1.22      jakllsch 4547:     directories were problematic because you had to add special
                   4548:     tricks in the PLIST to conditionally remove them, or have some
1.1       dsieger  4549:     centralized package handle them.</p>
1.22      jakllsch 4550: <p>In pkgsrc, it is now easy: Each package should create
                   4551:     directories and install files as needed; <span class="command"><strong>pkg_delete</strong></span>
                   4552:     will remove any directories left empty after uninstalling a
                   4553:     package.</p>
                   4554: <p>If a package needs an empty directory to work, create
                   4555:     the directory during installation as usual, and also add an
                   4556:     entry to the PLIST:
1.111     sevan    4557: 
                   4558: </p>
1.1       dsieger  4559: <pre class="programlisting">
1.22      jakllsch 4560: @pkgdir path/to/empty/directory
1.111     sevan    4561: </pre>
1.22      jakllsch 4562: <p>
1.111     sevan    4563: 
1.86      wiz      4564:     or take a look at <code class="varname">MAKE_DIRS</code> and
                   4565:     <code class="varname">OWN_DIRS</code>.
1.22      jakllsch 4566:     </p>
1.1       dsieger  4567: </div>
                   4568: </div>
1.41      asau     4569: <div class="chapter">
1.1       dsieger  4570: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   4571: <a name="buildlink"></a>Chapter 16. Buildlink methodology</h2></div></div></div>
1.1       dsieger  4572: <div class="toc">
                   4573: <p><b>Table of Contents</b></p>
1.100     leot     4574: <dl class="toc">
1.154     rillig   4575: <dt><span class="sect1"><a href="#converting-to-buildlink3">16.1. Converting packages to use buildlink3</a></span></dt>
                   4576: <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  4577: <dd><dl>
1.154     rillig   4578: <dt><span class="sect2"><a href="#anatomy-of-bl3">16.2.1. Anatomy of a buildlink3.mk file</a></span></dt>
                   4579: <dt><span class="sect2"><a href="#updating-buildlink-depends">16.2.2. Updating
1.26      wiz      4580:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   4581:       and
                   4582:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   4583:       in <code class="filename">buildlink3.mk</code> files</a></span></dt>
1.1       dsieger  4584: </dl></dd>
1.154     rillig   4585: <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  4586: <dd><dl>
1.154     rillig   4587: <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>
                   4588: <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  4589: </dl></dd>
                   4590: </dl>
                   4591: </div>
                   4592: <p>Buildlink is a framework in pkgsrc that controls what headers and libraries
                   4593:   are seen by a package's configure and build processes.  This is implemented
                   4594:   in a two step process:</p>
1.23      wiz      4595: <div class="orderedlist"><ol class="orderedlist" type="1">
                   4596: <li class="listitem"><p>Symlink headers and libraries for dependencies into
1.1       dsieger  4597:       <code class="varname">BUILDLINK_DIR</code>, which by default is a subdirectory
                   4598:       of <code class="varname">WRKDIR</code>.</p></li>
1.23      wiz      4599: <li class="listitem"><p>Create wrapper scripts that are used in place of the normal compiler
1.1       dsieger  4600:       tools that translate <code class="option">-I${LOCALBASE}/include</code> and
                   4601:       <code class="option">-L${LOCALBASE}/lib</code> into references to
                   4602:       <code class="varname">BUILDLINK_DIR</code>. The wrapper scripts also make
                   4603:       native compiler on some operating systems look like GCC, so that
                   4604:       packages that expect GCC won't require modifications to build with
                   4605:       those native compilers.</p></li>
                   4606: </ol></div>
                   4607: <p>This normalizes the environment in which a package is built so that the
                   4608:   package may be built consistently despite what other software may be
                   4609:   installed. Please note that the normal system header and library paths,
                   4610:   e.g. <code class="filename">/usr/include</code>,
                   4611:   <code class="filename">/usr/lib</code>, etc., are always searched -- buildlink3 is
                   4612:   designed to insulate the package build from non-system-supplied
                   4613:   software.</p>
1.41      asau     4614: <div class="sect1">
1.1       dsieger  4615: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   4616: <a name="converting-to-buildlink3"></a>16.1. Converting packages to use buildlink3</h2></div></div></div>
1.1       dsieger  4617: <p>The process of converting packages to use the buildlink3
1.23      wiz      4618:     framework (<span class="quote">&#8220;<span class="quote">bl3ifying</span>&#8221;</span>) is fairly straightforward.
1.1       dsieger  4619:     The things to keep in mind are:</p>
1.23      wiz      4620: <div class="orderedlist"><ol class="orderedlist" type="1">
                   4621: <li class="listitem"><p>Ensure that the build always calls the wrapper scripts
1.1       dsieger  4622:        instead of the actual toolchain.  Some packages are tricky,
                   4623:        and the only way to know for sure is the check
                   4624:        <code class="filename">${WRKDIR}/.work.log</code> to see if the
                   4625:        wrappers are being invoked.</p></li>
1.23      wiz      4626: <li class="listitem"><p>Don't override <code class="varname">PREFIX</code> from within
1.1       dsieger  4627:        the package Makefile, e.g. Java VMs, standalone shells,
                   4628:        etc., because the code to symlink files into
                   4629:        <code class="filename">${BUILDLINK_DIR}</code> looks for files
1.23      wiz      4630:        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  4631:        </p></li>
1.23      wiz      4632: <li class="listitem"><p>Remember that <span class="emphasis"><em>only</em></span> the
1.1       dsieger  4633:        <code class="filename">buildlink3.mk</code> files that you list in a
                   4634:        package's Makefile are added as dependencies for that package.
                   4635:        </p></li>
                   4636: </ol></div>
                   4637: <p>If a dependency on a particular package is required for its libraries and
                   4638:     headers, then we replace:</p>
                   4639: <pre class="programlisting">
                   4640: DEPENDS+=       foo&gt;=1.1.0:../../category/foo
                   4641: </pre>
                   4642: <p>with</p>
                   4643: <pre class="programlisting">
                   4644: .include "../../category/foo/buildlink3.mk"
                   4645: </pre>
                   4646: <p>The buildlink3.mk files usually define the required dependencies.
                   4647:     If you need a newer version of the dependency when using buildlink3.mk
                   4648:     files, then you can define it in your Makefile; for example:</p>
                   4649: <pre class="programlisting">
                   4650: BUILDLINK_API_DEPENDS.foo+=   foo&gt;=1.1.0
                   4651: .include "../../category/foo/buildlink3.mk"
                   4652: </pre>
                   4653: <p>There are several <code class="filename">buildlink3.mk</code>
                   4654:     files in <code class="filename">pkgsrc/mk</code>
                   4655:     that handle special package issues:</p>
1.41      asau     4656: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      4657: <li class="listitem"><p><code class="filename">bdb.buildlink3.mk</code> chooses either
1.1       dsieger  4658:        the native or a pkgsrc Berkeley DB implementation based on
                   4659:        the values of <code class="varname">BDB_ACCEPTED</code> and
                   4660:        <code class="varname">BDB_DEFAULT</code>.</p></li>
1.23      wiz      4661: <li class="listitem"><p><code class="filename">curses.buildlink3.mk</code>: If the system
1.1       dsieger  4662:        comes with neither Curses nor NCurses, this will take care
1.137     leot     4663:        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      4664: <li class="listitem"><p><code class="filename">krb5.buildlink3.mk</code> uses the value
1.1       dsieger  4665:        of <code class="varname">KRB5_ACCEPTED</code> to choose between
                   4666:        adding a dependency on Heimdal or MIT-krb5 for packages that
                   4667:        require a Kerberos 5 implementation.</p></li>
1.23      wiz      4668: <li class="listitem"><p><code class="filename">motif.buildlink3.mk</code> checks for a
1.1       dsieger  4669:        system-provided Motif installation or adds a dependency on
1.137     leot     4670:        <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      4671:        <code class="varname">MOTIF_TYPE</code> to <span class="quote">&#8220;<span class="quote">dt</span>&#8221;</span>,
1.126     leot     4672:        <span class="quote">&#8220;<span class="quote">lesstif</span>&#8221;</span> or <span class="quote">&#8220;<span class="quote">motif</span>&#8221;</span>
                   4673:        to choose which Motif version will be used.</p></li>
1.55      ryoon    4674: <li class="listitem"><p><code class="filename">readline.buildlink3.mk</code> checks for a
1.56      wiz      4675:        system-provided GNU readline or editline (libedit) installation,
1.137     leot     4676:        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>,
                   4677:        <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    4678:        <code class="varname">READLINE_DEFAULT</code> to choose readline implementation.
                   4679:        If your package really needs GNU readline library, its Makefile
                   4680:        should include <code class="filename">devel/readline/buildlink3.mk</code>
                   4681:        instead of <code class="filename">readline.buildlink3.mk</code>.</p></li>
1.23      wiz      4682: <li class="listitem"><p><code class="filename">oss.buildlink3.mk</code> defines several
1.1       dsieger  4683:        variables that may be used by packages that use the
                   4684:        Open Sound System (OSS) API.</p></li>
1.23      wiz      4685: <li class="listitem"><p><code class="filename">pgsql.buildlink3.mk</code> will accept
1.35      wiz      4686:        any of the Postgres versions in the variable
                   4687:        <code class="varname">PGSQL_VERSIONS_ACCEPTED</code> and default to
                   4688:        the version <code class="varname">PGSQL_VERSION_DEFAULT</code>. See
1.1       dsieger  4689:        the file for more information.</p></li>
1.23      wiz      4690: <li class="listitem"><p><code class="filename">pthread.buildlink3.mk</code> uses the value of
1.1       dsieger  4691:        <code class="varname">PTHREAD_OPTS</code> and checks for native pthreads or adds
1.137     leot     4692:        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      4693: <li class="listitem"><p><code class="filename">xaw.buildlink3.mk</code> uses the value of
1.1       dsieger  4694:        <code class="varname">XAW_TYPE</code> to choose a particular Athena widgets
                   4695:        library.</p></li>
                   4696: </ul></div>
                   4697: <p>The comments in those <code class="filename">buildlink3.mk</code>
                   4698:     files provide a more complete
                   4699:     description of how to use them properly.</p>
                   4700: </div>
1.41      asau     4701: <div class="sect1">
1.1       dsieger  4702: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   4703: <a name="creating-buildlink3.mk"></a>16.2. Writing <code class="filename">buildlink3.mk</code> files</h2></div></div></div>
1.7       rillig   4704: <a name="buildlink3.mk"></a><p>A package's <code class="filename">buildlink3.mk</code> file is
1.1       dsieger  4705:     included by Makefiles to indicate the need to compile and link
                   4706:     against header files and libraries provided by the package.  A
                   4707:     <code class="filename">buildlink3.mk</code> file should always provide
                   4708:     enough information to add the correct type of dependency
                   4709:     relationship and include any other
                   4710:     <code class="filename">buildlink3.mk</code> files that it needs to find
                   4711:     headers and libraries that it needs in turn.</p>
                   4712: <p>To generate an initial <code class="filename">buildlink3.mk</code>
1.137     leot     4713:     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  4714:     package is highly recommended.  For most packages, the following
                   4715:     command will generate a good starting point for
                   4716:     <code class="filename">buildlink3.mk</code> files:</p>
                   4717: <pre class="screen">
                   4718: <code class="prompt">%</code> <strong class="userinput"><code>cd pkgsrc/<em class="replaceable"><code>category</code></em>/<em class="replaceable"><code>pkgdir</code></em>
                   4719: <code class="prompt">%</code> createbuildlink &gt;buildlink3.mk</code></strong>
                   4720:     </pre>
1.41      asau     4721: <div class="sect2">
1.1       dsieger  4722: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   4723: <a name="anatomy-of-bl3"></a>16.2.1. Anatomy of a buildlink3.mk file</h3></div></div></div>
1.1       dsieger  4724: <p>The following real-life example
                   4725:       <code class="filename">buildlink3.mk</code> is taken
                   4726:       from <code class="filename">pkgsrc/graphics/tiff</code>:</p>
                   4727: <pre class="programlisting">
1.18      snj      4728: # $NetBSD: buildlink3.mk,v 1.16 2009/03/20 19:24:45 joerg Exp $
1.1       dsieger  4729: 
1.112     rillig   4730: BUILDLINK_TREE+=        tiff
1.1       dsieger  4731: 
1.18      snj      4732: .if !defined(TIFF_BUILDLINK3_MK)
                   4733: TIFF_BUILDLINK3_MK:=
1.1       dsieger  4734: 
1.112     rillig   4735: BUILDLINK_API_DEPENDS.tiff+=    tiff&gt;=3.6.1
                   4736: BUILDLINK_ABI_DEPENDS.tiff+=    tiff&gt;=3.7.2nb1
                   4737: BUILDLINK_PKGSRCDIR.tiff?=      ../../graphics/tiff
1.1       dsieger  4738: 
                   4739: .include "../../devel/zlib/buildlink3.mk"
                   4740: .include "../../graphics/jpeg/buildlink3.mk"
1.18      snj      4741: .endif # TIFF_BUILDLINK3_MK
1.1       dsieger  4742: 
1.112     rillig   4743: BUILDLINK_TREE+=        -tiff
1.1       dsieger  4744: </pre>
                   4745: <p>The header and footer manipulate
1.18      snj      4746:       <code class="varname">BUILDLINK_TREE</code>, which is common across all
1.1       dsieger  4747:       <code class="filename">buildlink3.mk</code> files and is used to track
1.18      snj      4748:       the dependency tree.</p>
                   4749: <p>The main section is protected from multiple inclusion
1.1       dsieger  4750:       and controls how the dependency on <em class="replaceable"><code>pkg</code></em> is
                   4751:       added.  Several important variables are set in the section:</p>
1.41      asau     4752: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      4753: <li class="listitem"><p><code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.1       dsieger  4754:          is the actual dependency recorded in the installed
                   4755:          package; this should always be set using
1.10      hubertf  4756:          <span class="command"><strong>+=</strong></span> to ensure that
1.1       dsieger  4757:          we're appending to any pre-existing list of values.  This
                   4758:          variable should be set to the first version of the
1.26      wiz      4759:          package that had an backwards-incompatible API change.
1.1       dsieger  4760:          </p></li>
1.23      wiz      4761: <li class="listitem"><p><code class="varname">BUILDLINK_PKGSRCDIR.<em class="replaceable"><code>pkg</code></em></code>
1.1       dsieger  4762:          is the location of the <em class="replaceable"><code>pkg</code></em>
                   4763:          pkgsrc directory.</p></li>
1.23      wiz      4764: <li class="listitem"><p><code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.1       dsieger  4765:          (not shown above) controls whether we use
                   4766:          <code class="varname">BUILD_DEPENDS</code> or
                   4767:          <code class="varname">DEPENDS</code> to add the dependency on
                   4768:          <em class="replaceable"><code>pkg</code></em>.  The build dependency is
                   4769:          selected by setting
                   4770:          <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>pkg</code></em></code>
1.23      wiz      4771:          to <span class="quote">&#8220;<span class="quote">build</span>&#8221;</span>.  By default, the full dependency is
1.1       dsieger  4772:          used.</p></li>
1.23      wiz      4773: <li class="listitem"><p><code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code>
1.1       dsieger  4774:            and
                   4775:            <code class="varname">BUILDLINK_LIBDIRS.<em class="replaceable"><code>pkg</code></em></code>
                   4776:            (not shown above) are lists of subdirectories of
                   4777:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
                   4778:            to add to the header and library search paths.  These
1.23      wiz      4779:            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  4780:          respectively.</p></li>
1.23      wiz      4781: <li class="listitem"><p><code class="varname">BUILDLINK_CPPFLAGS.<em class="replaceable"><code>pkg</code></em></code>
1.1       dsieger  4782:            (not shown above) is the list of preprocessor flags to add
                   4783:            to <code class="varname">CPPFLAGS</code>, which are passed on to the
1.23      wiz      4784:            configure and build phases.  The <span class="quote">&#8220;<span class="quote">-I</span>&#8221;</span> option
1.1       dsieger  4785:            should be avoided and instead be handled using
                   4786:            <code class="varname">BUILDLINK_INCDIRS.<em class="replaceable"><code>pkg</code></em></code> as
                   4787:          above.</p></li>
                   4788: </ul></div>
                   4789: <p>The following variables are all optionally defined within
                   4790:       this second section (protected against multiple inclusion) and
                   4791:       control which package files are symlinked into
                   4792:       <code class="filename">${BUILDLINK_DIR}</code> and how their names are
                   4793:       transformed during the symlinking:</p>
1.41      asau     4794: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      4795: <li class="listitem"><p><code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>
1.1       dsieger  4796:            (not shown above) is a shell glob pattern relative to
                   4797:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
                   4798:            to be symlinked into
                   4799:            <code class="filename">${BUILDLINK_DIR}</code>,
                   4800:          e.g. <code class="filename">include/*.h</code>.</p></li>
1.23      wiz      4801: <li class="listitem"><p><code class="varname">BUILDLINK_FILES_CMD.<em class="replaceable"><code>pkg</code></em></code>
1.1       dsieger  4802:            (not shown above) is a shell pipeline that
                   4803:            outputs to stdout a list of files relative to
                   4804:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>.
                   4805:            The resulting files are to be symlinked
                   4806:            into <code class="filename">${BUILDLINK_DIR}</code>.  By default,
                   4807:            this takes the <code class="filename">+CONTENTS</code> of a
                   4808:            <em class="replaceable"><code>pkg</code></em> and filters it through
                   4809:            <code class="varname">${BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em>}</code>.</p></li>
1.23      wiz      4810: <li class="listitem"><p><code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
1.1       dsieger  4811:            (not shown above) is a filter command that filters
                   4812:            <code class="filename">+CONTENTS</code> input into a list of files
                   4813:            relative to
                   4814:            <code class="filename">${BUILDLINK_PREFIX.<em class="replaceable"><code>pkg</code></em>}</code>
1.84      wiz      4815:            on stdout.  By default,
1.1       dsieger  4816:            <code class="varname">BUILDLINK_CONTENTS_FILTER.<em class="replaceable"><code>pkg</code></em></code>
                   4817:            outputs the contents of the <code class="filename">include</code>
                   4818:            and <code class="filename">lib</code> directories in the package
1.84      wiz      4819:            <code class="filename">+CONTENTS</code>.</p></li>
1.23      wiz      4820: <li class="listitem"><p><code class="varname">BUILDLINK_FNAME_TRANSFORM.<em class="replaceable"><code>pkg</code></em></code>
1.1       dsieger  4821:            (not shown above) is a list of sed arguments used to
                   4822:            transform the name of the source filename into a
1.10      hubertf  4823:            destination filename, e.g. <span class="command"><strong>-e
1.1       dsieger  4824:            "s|/curses.h|/ncurses.h|g"</strong></span>.</p></li>
                   4825: </ul></div>
1.18      snj      4826: <p>This section can additionally include any
1.1       dsieger  4827:       <code class="filename">buildlink3.mk</code> needed for
                   4828:       <em class="replaceable"><code>pkg</code></em>'s library dependencies.
                   4829:       Including these <code class="filename">buildlink3.mk</code> files
                   4830:       means that the headers and libraries for these
                   4831:       dependencies are also symlinked into
                   4832:       <code class="filename">${BUILDLINK_DIR}</code>
                   4833:       whenever the <em class="replaceable"><code>pkg</code></em>
                   4834:       <code class="filename">buildlink3.mk</code>
1.18      snj      4835:       file is included. Dependencies are only added for directly
                   4836:       include <code class="filename">buildlink3.mk</code> files.</p>
1.47      wiz      4837: <p>When providing a <code class="filename">buildlink3.mk</code> and
                   4838:       including other <code class="filename">buildlink3.mk</code> files in it,
1.50      wiz      4839:       please only add necessary ones, i.e., those whose libraries or
1.47      wiz      4840:       header files are automatically exposed when the package is
                   4841:       use.</p>
                   4842: <p>In particular, if only an executable
                   4843:       (<code class="filename">bin/foo</code>) is linked against a library, that
                   4844:       library does not need to be propagated in the
                   4845:       <code class="filename">buildlink3.mk</code> file.</p>
                   4846: <p>The following steps should help you decide if a
                   4847:       <code class="filename">buildlink3.mk</code> file needs to be included:
                   4848:       </p>
                   4849: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   4850: <li class="listitem"><p>Look at the installed header files: What
                   4851:        headers do they include? The packages providing these files
                   4852:        must be buildlinked.</p></li>
1.49      wiz      4853: <li class="listitem"><p>Run <code class="filename">ldd</code> on all installed
                   4854:        libraries and look against what other libraries they link.
                   4855:        Some of the packages providing these probably need to be
                   4856:        buildlinked; however, it's not automatic, since e.g. GTK on
                   4857:        some systems pulls in the X libraries, so they will show up in
                   4858:        the <code class="filename">ldd</code> output, while on others (like OS
1.50      wiz      4859:        X) it won't. <code class="filename">ldd</code> output can thus only be
1.49      wiz      4860:        used as a hint.</p></li>
1.47      wiz      4861: </ul></div>
                   4862: <p>
                   4863:       </p>
1.1       dsieger  4864: </div>
1.41      asau     4865: <div class="sect2">
1.1       dsieger  4866: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   4867: <a name="updating-buildlink-depends"></a>16.2.2. Updating
1.1       dsieger  4868:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.26      wiz      4869:       and
                   4870:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   4871:       in <code class="filename">buildlink3.mk</code> files</h3></div></div></div>
                   4872: <p>These two variables differ in that one describes source
                   4873:       compatibility (API) and the other binary compatibility (ABI).
                   4874:       The difference is that a change in the API breaks compilation of
                   4875:       programs while changes in the ABI stop compiled programs from
                   4876:       running.</p>
                   4877: <p>Changes to the
1.27      wiz      4878:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
1.26      wiz      4879:       variable in a <code class="filename">buildlink3.mk</code> file happen
                   4880:       very rarely. One possible reason is that all packages depending
                   4881:       on this already need a newer version. In case it is bumped see
                   4882:       the description below.</p>
                   4883: <p>The most common example of an ABI change is that the major
                   4884:       version of a shared library is increased. In this case,
                   4885:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   4886:       should be adjusted to require at least the new package version.
                   4887:       Then the packages that depend on this package need their
                   4888:       <code class="varname">PKGREVISION</code>s increased and, if they have
                   4889:       <code class="filename">buildlink3.mk</code> files, their
                   4890:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   4891:       adjusted, too. This is needed so pkgsrc will require the correct
                   4892:       package dependency and not settle for an older one when building
                   4893:       the source.</p>
1.154     rillig   4894: <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      4895:       more information about dependencies on other packages,
                   4896:       including the <code class="varname">BUILDLINK_ABI_DEPENDS</code> and
1.1       dsieger  4897:       <code class="varname">ABI_DEPENDS</code> definitions.</p>
                   4898: <p>Please take careful consideration before adjusting
                   4899:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   4900:       or
                   4901:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   4902:       as we don't want to cause unneeded package deletions and
                   4903:       rebuilds.  In many cases, new versions of packages work just
                   4904:       fine with older dependencies.</p>
                   4905: <p>Also it is not needed to set
1.26      wiz      4906:       <code class="varname">BUILDLINK_ABI_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>
                   4907:       when it is identical to
1.1       dsieger  4908:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.        </p>
                   4909: </div>
                   4910: </div>
1.41      asau     4911: <div class="sect1">
1.1       dsieger  4912: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   4913: <a name="writing-builtin.mk"></a>16.3. Writing <code class="filename">builtin.mk</code> files</h2></div></div></div>
1.1       dsieger  4914: <p>Some packages in pkgsrc install headers and libraries that
                   4915:       coincide with headers and libraries present in the base system.
                   4916:       Aside from a <code class="filename">buildlink3.mk</code> file, these
                   4917:       packages should also include a <code class="filename">builtin.mk</code>
                   4918:       file that includes the necessary checks to decide whether using
                   4919:       the built-in software or the pkgsrc software is
                   4920:     appropriate.</p>
                   4921: <p>The only requirements of a builtin.mk file for
                   4922:     <em class="replaceable"><code>pkg</code></em> are:</p>
1.23      wiz      4923: <div class="orderedlist"><ol class="orderedlist" type="1">
                   4924: <li class="listitem"><p>It should set
1.1       dsieger  4925:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23      wiz      4926:        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  4927:        after it is included.</p></li>
1.23      wiz      4928: <li class="listitem"><p>It should <span class="emphasis"><em>not</em></span> override any
1.1       dsieger  4929:        <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   4930:        which is already set before the
                   4931:        <code class="filename">builtin.mk</code> file is included.</p></li>
1.23      wiz      4932: <li class="listitem"><p>It should be written to allow multiple inclusion.  This
1.1       dsieger  4933:        is <span class="emphasis"><em>very</em></span> important and takes careful
                   4934:        attention to <code class="filename">Makefile</code> coding.</p></li>
                   4935: </ol></div>
1.41      asau     4936: <div class="sect2">
1.1       dsieger  4937: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   4938: <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  4939: <p>The following is the recommended template for builtin.mk
                   4940:       files:</p>
                   4941: <pre class="programlisting">
                   4942: .if !defined(IS_BUILTIN.foo)
                   4943: #
                   4944: # IS_BUILTIN.foo is set to "yes" or "no" depending on whether "foo"
                   4945: # genuinely exists in the system or not.
                   4946: #
                   4947: IS_BUILTIN.foo?=        no
                   4948: 
                   4949: # BUILTIN_PKG.foo should be set here if "foo" is built-in and its package
                   4950: # version can be determined.
                   4951: #
                   4952: .  if !empty(IS_BUILTIN.foo:M[yY][eE][sS])
                   4953: BUILTIN_PKG.foo?=       foo-1.0
                   4954: .  endif
                   4955: .endif  # IS_BUILTIN.foo
                   4956: 
                   4957: .if !defined(USE_BUILTIN.foo)
                   4958: USE_BUILTIN.foo?=       ${IS_BUILTIN.foo}
                   4959: .  if defined(BUILTIN_PKG.foo)
                   4960: .    for _depend_ in ${BUILDLINK_API_DEPENDS.foo}
                   4961: .      if !empty(USE_BUILTIN.foo:M[yY][eE][sS])
                   4962: USE_BUILTIN.foo!=                                                       \
                   4963:         ${PKG_ADMIN} pmatch '${_depend_}' ${BUILTIN_PKG.foo}            \
                   4964:         &amp;&amp; ${ECHO} "yes" || ${ECHO} "no"
                   4965: .      endif
                   4966: .    endfor
                   4967: .  endif
                   4968: .endif  # USE_BUILTIN.foo
                   4969: 
                   4970: CHECK_BUILTIN.foo?=     no
                   4971: .if !empty(CHECK_BUILTIN.foo:M[nN][oO])
                   4972: #
                   4973: # Here we place code that depends on whether USE_BUILTIN.foo is set to
                   4974: # "yes" or "no".
                   4975: #
                   4976: .endif  # CHECK_BUILTIN.foo
                   4977: </pre>
                   4978: <p>The first section sets
                   4979:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   4980:       depending on if <em class="replaceable"><code>pkg</code></em> really exists
                   4981:       in the base system.  This should not be a base system software
                   4982:       with similar functionality to <em class="replaceable"><code>pkg</code></em>;
1.23      wiz      4983:       it should only be <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> if the actual package is
1.1       dsieger  4984:       included as part of the base system.  This variable is only
                   4985:       used internally within the <code class="filename">builtin.mk</code>
                   4986:       file.</p>
                   4987: <p>The second section sets
                   4988:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   4989:       to the version of <em class="replaceable"><code>pkg</code></em> in the base
                   4990:       system if it exists (if
                   4991:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23      wiz      4992:       is <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>).  This variable is only used internally
1.1       dsieger  4993:       within the <code class="filename">builtin.mk</code> file.</p>
                   4994: <p>The third section sets
                   4995:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   4996:       and is <span class="emphasis"><em>required</em></span> in all
                   4997:       <code class="filename">builtin.mk</code> files.  The code in this
                   4998:       section must make the determination whether the built-in
                   4999:       software is adequate to satisfy the dependencies listed in
                   5000:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   5001:       This is typically done by comparing
                   5002:       <code class="varname">BUILTIN_PKG.<em class="replaceable"><code>pkg</code></em></code>
                   5003:       against each of the dependencies in
                   5004:       <code class="varname">BUILDLINK_API_DEPENDS.<em class="replaceable"><code>pkg</code></em></code>.
                   5005:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5006:       <span class="emphasis"><em>must</em></span> be set to the correct value by the
                   5007:       end of the <code class="filename">builtin.mk</code> file.  Note that
                   5008:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23      wiz      5009:       may be <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> even if
1.1       dsieger  5010:       <code class="varname">IS_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
1.23      wiz      5011:       is <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span> because we may make the determination
1.1       dsieger  5012:       that the built-in version of the software is similar enough to
                   5013:       be used as a replacement.</p>
                   5014: <p>The last section is guarded by
                   5015:       <code class="varname">CHECK_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>,
                   5016:       and includes code that uses the value of
                   5017:       <code class="varname">USE_BUILTIN.<em class="replaceable"><code>pkg</code></em></code>
                   5018:       set in the previous section.  This typically includes, e.g.,
                   5019:       adding additional dependency restrictions and listing additional
                   5020:       files to symlink into <code class="filename">${BUILDLINK_DIR}</code> (via
                   5021:       <code class="varname">BUILDLINK_FILES.<em class="replaceable"><code>pkg</code></em></code>).</p>
                   5022: </div>
1.41      asau     5023: <div class="sect2">
1.1       dsieger  5024: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   5025: <a name="native-or-pkgsrc-preference"></a>16.3.2. Global preferences for native or pkgsrc software</h3></div></div></div>
1.1       dsieger  5026: <p>When building packages, it's possible to choose whether to set
                   5027:        a global preference for using either the built-in (native)
                   5028:        version or the pkgsrc version of software to satisfy a
                   5029:        dependency.  This is controlled by setting
                   5030:        <code class="varname">PREFER_PKGSRC</code> and
                   5031:        <code class="varname">PREFER_NATIVE</code>.  These variables take values
1.23      wiz      5032:        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  5033:        packages.  <code class="varname">PREFER_PKGSRC</code> tells pkgsrc to
                   5034:        use the pkgsrc versions of software, while
                   5035:        <code class="varname">PREFER_NATIVE</code> tells pkgsrc to use the
                   5036:        built-in versions.  Preferences are determined by the most
                   5037:        specific instance of the package in either
                   5038:        <code class="varname">PREFER_PKGSRC</code> or
                   5039:        <code class="varname">PREFER_NATIVE</code>.  If a package is specified
                   5040:        in neither or in both variables, then
                   5041:        <code class="varname">PREFER_PKGSRC</code> has precedence over
                   5042:        <code class="varname">PREFER_NATIVE</code>.  For example, to require
                   5043:        using pkgsrc versions of software for all but the most basic
                   5044:       bits on a NetBSD system, you can set:</p>
                   5045: <pre class="programlisting">
                   5046: PREFER_PKGSRC=  yes
                   5047: PREFER_NATIVE=  getopt skey tcp_wrappers
                   5048: </pre>
                   5049: <p>A package <span class="emphasis"><em>must</em></span> have a
                   5050:       <code class="filename">builtin.mk</code>
                   5051:       file to be listed in <code class="varname">PREFER_NATIVE</code>,
                   5052:       otherwise it is simply ignored in that list.</p>
1.117     sevan    5053: <p>Setting <code class="varname">PREFER_NATIVE</code> should be performed
                   5054:       straight after bootstrap and <code class="varname">PREFER_PKGSRC</code> during
                   5055:       bootstrap.
                   5056:       Switching between settings globally at a later date can introduce
                   5057:       complications with dependency resolution. This is caused by packages
                   5058:       built with the opposite preference being installed alongside each other.</p>
                   5059: <pre class="screen">
                   5060: <code class="prompt">#</code> <strong class="userinput"><code>./bootstrap --prefer-pkgsrc yes</code></strong>
                   5061: </pre>
1.1       dsieger  5062: </div>
                   5063: </div>
                   5064: </div>
1.41      asau     5065: <div class="chapter">
1.1       dsieger  5066: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   5067: <a name="pkginstall"></a>Chapter 17. The pkginstall framework</h2></div></div></div>
1.1       dsieger  5068: <div class="toc">
                   5069: <p><b>Table of Contents</b></p>
1.100     leot     5070: <dl class="toc">
1.154     rillig   5071: <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  5072: <dd><dl>
1.154     rillig   5073: <dt><span class="sect2"><a href="#dirs-outside-prefix">17.1.1. Directory manipulation</a></span></dt>
                   5074: <dt><span class="sect2"><a href="#files-outside-prefix">17.1.2. File manipulation</a></span></dt>
1.1       dsieger  5075: </dl></dd>
1.154     rillig   5076: <dt><span class="sect1"><a href="#conf-files">17.2. Configuration files</a></span></dt>
1.1       dsieger  5077: <dd><dl>
1.154     rillig   5078: <dt><span class="sect2"><a href="#conf-files-sysconfdir">17.2.1. How <code class="varname">PKG_SYSCONFDIR</code> is set</a></span></dt>
                   5079: <dt><span class="sect2"><a href="#conf-files-configure">17.2.2. Telling the software where configuration files are</a></span></dt>
                   5080: <dt><span class="sect2"><a href="#conf-files-patching">17.2.3. Patching installations</a></span></dt>
                   5081: <dt><span class="sect2"><a href="#conf-files-disable">17.2.4. Disabling handling of configuration files</a></span></dt>
                   5082: </dl></dd>
                   5083: <dt><span class="sect1"><a href="#rcd-scripts">17.3. System startup scripts</a></span></dt>
                   5084: <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>
                   5085: <dt><span class="sect1"><a href="#users-and-groups">17.4. System users and groups</a></span></dt>
                   5086: <dt><span class="sect1"><a href="#shells">17.5. System shells</a></span></dt>
                   5087: <dd><dl><dt><span class="sect2"><a href="#shells-disable">17.5.1. Disabling shell registration</a></span></dt></dl></dd>
                   5088: <dt><span class="sect1"><a href="#fonts">17.6. Fonts</a></span></dt>
                   5089: <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  5090: </dl>
                   5091: </div>
                   5092: <p>This chapter describes the framework known as
                   5093: <code class="literal">pkginstall</code>, whose key features are:</p>
1.41      asau     5094: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      5095: <li class="listitem"><p>Generic installation and manipulation of directories and files
1.1       dsieger  5096:     outside the pkgsrc-handled tree, <code class="varname">LOCALBASE</code>.</p></li>
1.23      wiz      5097: <li class="listitem"><p>Automatic handling of configuration files during installation,
1.1       dsieger  5098:     provided that packages are correctly designed.</p></li>
1.23      wiz      5099: <li class="listitem"><p>Generation and installation of system startup scripts.</p></li>
                   5100: <li class="listitem"><p>Registration of system users and groups.</p></li>
                   5101: <li class="listitem"><p>Registration of system shells.</p></li>
                   5102: <li class="listitem"><p>Automatic updating of fonts databases.</p></li>
1.1       dsieger  5103: </ul></div>
                   5104: <p>The following sections inspect each of the above points in detail.</p>
                   5105: <p>You may be thinking that many of the things described here could be
                   5106: easily done with simple code in the package's post-installation target
                   5107: (<code class="literal">post-install</code>).  <span class="emphasis"><em>This is incorrect</em></span>,
                   5108: as the code in them is only executed when building from source.  Machines
                   5109: using binary packages could not benefit from it at all (as the code itself
                   5110: could be unavailable).  Therefore, the only way to achieve any of the items
                   5111: described above is by means of the installation scripts, which are
                   5112: automatically generated by pkginstall.</p>
1.41      asau     5113: <div class="sect1">
1.1       dsieger  5114: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   5115: <a name="files-and-dirs-outside-prefix"></a>17.1. Files and directories outside the installation prefix</h2></div></div></div>
1.1       dsieger  5116: <p>As you already know, the <code class="filename">PLIST</code> file holds a list
                   5117: of files and directories that belong to a package.  The names used in it
                   5118: are relative to the installation prefix (<code class="filename">${PREFIX}</code>),
                   5119: which means that it cannot register files outside this directory (absolute
                   5120: path names are not allowed).  Despite this restriction, some packages need
                   5121: to install files outside this location; e.g., under
                   5122: <code class="filename">${VARBASE}</code> or
                   5123: <code class="filename">${PKG_SYSCONFDIR}</code>.  The only way to achieve this
                   5124: is to create such files during installation time by using
                   5125: installation scripts.</p>
                   5126: <p>The generic installation scripts are shell scripts that can
                   5127: contain arbitrary code.  The list of scripts to execute is taken from
                   5128: the <code class="varname">INSTALL_FILE</code> variable, which defaults to
                   5129: <code class="filename">INSTALL</code>.  A similar variable exists for package
                   5130: removal (<code class="varname">DEINSTALL_FILE</code>, whose default is
                   5131: <code class="filename">DEINSTALL</code>).  These scripts can run arbitrary
                   5132: commands, so they have the potential to create and manage files
                   5133: anywhere in the file system.</p>
                   5134: <p>Using these general installation files is not recommended, but
                   5135: may be needed in some special cases.  One reason for avoiding them is
                   5136: that the user has to trust the packager that there is no unwanted or
                   5137: simply erroneous code included in the installation script. Also,
                   5138: previously there were many similar scripts for the same functionality,
                   5139: and fixing a common error involved finding and changing all of
                   5140: them.</p>
                   5141: <p>The pkginstall framework offers another, standardized way.  It
                   5142: provides generic scripts to abstract the manipulation of such files
                   5143: and directories based on variables set in the package's
                   5144: <code class="filename">Makefile</code>.  The rest of this section describes
                   5145: these variables.</p>
1.41      asau     5146: <div class="sect2">
1.1       dsieger  5147: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   5148: <a name="dirs-outside-prefix"></a>17.1.1. Directory manipulation</h3></div></div></div>
1.1       dsieger  5149: <p>The following variables can be set to request the creation of
                   5150: directories anywhere in the file system:</p>
1.41      asau     5151: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.108     rillig   5152: <li class="listitem">
                   5153: <p><code class="varname">MAKE_DIRS</code> and <code class="varname">OWN_DIRS</code>
1.1       dsieger  5154:     contain a list of directories that should be created and should attempt
                   5155:     to be destroyed by the installation scripts.  The difference between
                   5156:     the two is that the latter prompts the administrator to remove any
                   5157:     directories that may be left after deinstallation (because they were
1.108     rillig   5158:     not empty), while the former does not.  Example:</p>
                   5159: <pre class="programlisting">
                   5160: MAKE_DIRS+=             ${VARBASE}/foo/private
                   5161: </pre>
                   5162: </li>
1.23      wiz      5163: <li class="listitem">
1.1       dsieger  5164: <p><code class="varname">MAKE_DIRS_PERMS</code> and
                   5165:     <code class="varname">OWN_DIRS_PERMS</code> contain a list of tuples describing
                   5166:     which directories should be created and should attempt to be destroyed
                   5167:     by the installation scripts.  Each tuple holds the following values,
                   5168:     separated by spaces: the directory name, its owner, its group and its
                   5169:     numerical mode.  For example:</p>
                   5170: <pre class="programlisting">
1.108     rillig   5171: MAKE_DIRS_PERMS+=       ${VARBASE}/foo/private \
                   5172:                         ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1       dsieger  5173: </pre>
                   5174: <p>The difference between the two is exactly the same as their
                   5175:     non-<code class="varname">PERMS</code> counterparts.</p>
                   5176: </li>
                   5177: </ul></div>
                   5178: </div>
1.41      asau     5179: <div class="sect2">
1.1       dsieger  5180: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   5181: <a name="files-outside-prefix"></a>17.1.2. File manipulation</h3></div></div></div>
1.1       dsieger  5182: <p>Creating non-empty files outside the installation prefix is tricky
                   5183: because the <code class="filename">PLIST</code> forces all files to be inside it.
                   5184: To overcome this problem, the only solution is to extract the file in the
                   5185: known place (i.e., inside the installation prefix) and copy it to the
                   5186: appropriate location during installation (done by the installation scripts
                   5187: generated by pkginstall).  We will call the former the <span class="emphasis"><em>master
                   5188: file</em></span> in the following paragraphs, which describe the variables
                   5189: that can be used to automatically and consistently handle files outside the
                   5190: installation prefix:</p>
1.41      asau     5191: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      5192: <li class="listitem">
1.1       dsieger  5193: <p><code class="varname">CONF_FILES</code> and
1.30      wiz      5194:     <code class="varname">REQD_FILES</code> are pairs of master and target files.
1.1       dsieger  5195:     During installation time, the master file is copied to the target one
                   5196:     if and only if the latter does not exist.  Upon deinstallation, the
                   5197:     target file is removed provided that it was not modified by the
                   5198:     installation.</p>
                   5199: <p>The difference between the two is that the latter prompts the
                   5200:     administrator to remove any files that may be left after
                   5201:     deinstallation (because they were not empty), while the former does
                   5202:     not.</p>
                   5203: </li>
1.23      wiz      5204: <li class="listitem">
1.1       dsieger  5205: <p><code class="varname">CONF_FILES_PERMS</code> and
1.30      wiz      5206:     <code class="varname">REQD_FILES_PERMS</code> contain tuples describing master
1.1       dsieger  5207:     files as well as their target locations.  For each of them, it also
                   5208:     specifies their owner, their group and their numeric permissions, in
                   5209:     this order.  For example:</p>
                   5210: <pre class="programlisting">
1.108     rillig   5211: REQD_FILES_PERMS+=      ${PREFIX}/share/somefile ${VARBASE}/somefile \
                   5212:                         ${REAL_ROOT_USER} ${REAL_ROOT_GROUP} 0700
1.1       dsieger  5213: </pre>
                   5214: <p>The difference between the two is exactly the same as their
                   5215:     non-<code class="varname">PERMS</code> counterparts.</p>
                   5216: </li>
                   5217: </ul></div>
                   5218: </div>
                   5219: </div>
1.41      asau     5220: <div class="sect1">
1.1       dsieger  5221: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   5222: <a name="conf-files"></a>17.2. Configuration files</h2></div></div></div>
1.1       dsieger  5223: <p>Configuration files are special in the sense that they are installed
                   5224: in their own specific directory, <code class="varname">PKG_SYSCONFDIR</code>, and
                   5225: need special treatment during installation (most of which is automated by
                   5226: pkginstall).  The main concept you must bear in mind is that files marked
                   5227: as configuration files are automatically copied to the right place (somewhere
                   5228: inside <code class="varname">PKG_SYSCONFDIR</code>) during installation <span class="emphasis"><em>if
                   5229: and only if</em></span> they didn't exist before.  Similarly, they will not
                   5230: be removed if they have local modifications.  This ensures that
                   5231: administrators never lose any custom changes they may have made.</p>
1.41      asau     5232: <div class="sect2">
1.1       dsieger  5233: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   5234: <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  5235: <p>As said before, the <code class="varname">PKG_SYSCONFDIR</code> variable
                   5236: specifies where configuration files shall be installed.  Its contents are
                   5237: set based upon the following variables:</p>
1.41      asau     5238: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      5239: <li class="listitem"><p><code class="varname">PKG_SYSCONFBASE</code>: The configuration's root
1.1       dsieger  5240:     directory.  Defaults to <code class="filename">${PREFIX}/etc</code> although it may
                   5241:     be overridden by the user to point to his preferred location (e.g.,
                   5242:     <code class="filename">/etc</code>, <code class="filename">/etc/pkg</code>, etc.).
                   5243:     Packages must not use it directly.</p></li>
1.23      wiz      5244: <li class="listitem">
1.1       dsieger  5245: <p><code class="varname">PKG_SYSCONFSUBDIR</code>: A subdirectory of
                   5246:     <code class="varname">PKG_SYSCONFBASE</code> under which the configuration files
                   5247:     for the package being built shall be installed.  The definition of this
                   5248:     variable only makes sense in the package's
                   5249:     <code class="filename">Makefile</code> (i.e., it is not user-customizable).</p>
                   5250: <p>As an example, consider the Apache package,
1.137     leot     5251:     <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  5252:     configuration files under the
                   5253:     <code class="filename">httpd/</code> subdirectory of
                   5254:     <code class="varname">PKG_SYSCONFBASE</code>.  This should be set in the package
                   5255:     Makefile.</p>
                   5256: </li>
1.23      wiz      5257: <li class="listitem"><p><code class="varname">PKG_SYSCONFVAR</code>: Specifies the name of the
1.1       dsieger  5258:     variable that holds this package's configuration directory (if
                   5259:     different from <code class="varname">PKG_SYSCONFBASE</code>).  It defaults to
                   5260:     <code class="varname">PKGBASE</code>'s value, and is always prefixed with
                   5261:     <code class="literal">PKG_SYSCONFDIR</code>.</p></li>
1.23      wiz      5262: <li class="listitem"><p><code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code>: Holds the
1.1       dsieger  5263:     directory where the configuration files for the package identified by
                   5264:     <code class="varname">PKG_SYSCONFVAR</code>'s shall be placed.</p></li>
                   5265: </ul></div>
                   5266: <p>Based on the above variables, pkginstall determines the value of
                   5267: <code class="varname">PKG_SYSCONFDIR</code>, which is the <span class="emphasis"><em>only</em></span>
                   5268: variable that can be used within a package to refer to its configuration
                   5269: directory.  The algorithm used to set its value is basically the
                   5270: following:</p>
1.23      wiz      5271: <div class="orderedlist"><ol class="orderedlist" type="1">
                   5272: <li class="listitem"><p>If <code class="varname">PKG_SYSCONFDIR.${PKG_SYSCONFVAR}</code> is set,
1.1       dsieger  5273:     its value is used.</p></li>
1.23      wiz      5274: <li class="listitem"><p>If the previous variable is not defined but
1.1       dsieger  5275:     <code class="varname">PKG_SYSCONFSUBDIR</code> is set in the package's
                   5276:     <code class="filename">Makefile</code>, the resulting value is
                   5277:     <code class="filename">${PKG_SYSCONFBASE}/${PKG_SYSCONFSUBDIR}</code>.</p></li>
1.23      wiz      5278: <li class="listitem"><p>Otherwise, it is set to
1.1       dsieger  5279:     <code class="filename">${PKG_SYSCONFBASE}</code>.</p></li>
                   5280: </ol></div>
                   5281: <p>It is worth mentioning that <code class="filename">${PKG_SYSCONFDIR}</code> is
1.154     rillig   5282: 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  5283: subdirectories of <code class="filename">${PKG_SYSCONFDIR}</code>, they still have to
                   5284: be created with OWN_DIRS or MAKE_DIRS.</p>
1.1       dsieger  5285: </div>
1.41      asau     5286: <div class="sect2">
1.1       dsieger  5287: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   5288: <a name="conf-files-configure"></a>17.2.2. Telling the software where configuration files are</h3></div></div></div>
1.1       dsieger  5289: <p>Given that pkgsrc (and users!) expect configuration files to be in a
                   5290: known place, you need to teach each package where it shall install its
                   5291: files.  In some cases you will have to patch the package Makefiles to
                   5292: achieve it.  If you are lucky, though, it may be as easy as passing an
                   5293: extra flag to the configuration script; this is the case of GNU Autoconf-
                   5294: generated files:</p>
                   5295: <pre class="programlisting">
                   5296: CONFIGURE_ARGS+= --sysconfdir=${PKG_SYSCONFDIR}
                   5297: </pre>
                   5298: <p>Note that this specifies where the package has to <span class="emphasis"><em>look
                   5299: for</em></span> its configuration files, not where they will be originally
                   5300: installed (although the difference is never explicit,
                   5301: unfortunately).</p>
                   5302: </div>
1.41      asau     5303: <div class="sect2">
1.1       dsieger  5304: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   5305: <a name="conf-files-patching"></a>17.2.3. Patching installations</h3></div></div></div>
1.1       dsieger  5306: <p>As said before, pkginstall automatically handles configuration files.
                   5307: This means that <span class="strong"><strong>the packages themselves must not
                   5308: touch the contents of <code class="filename">${PKG_SYSCONFDIR}</code>
                   5309: directly</strong></span>.  Bad news is that many software installation scripts
                   5310: will, out of the box, mess with the contents of that directory.  So what is
                   5311: the correct procedure to fix this issue?</p>
                   5312: <p>You must teach the package (usually by manually patching it) to
                   5313: install any configuration files under the examples hierarchy,
                   5314: <code class="filename">share/examples/${PKGBASE}/</code>.  This way, the
                   5315: <code class="filename">PLIST</code> registers them and the administrator always
                   5316: has the original copies available.</p>
                   5317: <p>Once the required configuration files are in place (i.e., under the
                   5318: examples hierarchy), the pkginstall framework can use them as master copies
                   5319: during the package installation to update what is in
                   5320: <code class="filename">${PKG_SYSCONFDIR}</code>.  To achieve this, the variables
                   5321: <code class="varname">CONF_FILES</code> and <code class="varname">CONF_FILES_PERMS</code> are
1.154     rillig   5322: 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  5323: about their syntax and their purpose.  Here is an example, taken from the
1.137     leot     5324: <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  5325: <pre class="programlisting">
                   5326: EGDIR=        ${PREFIX}/share/doc/mutt/samples
                   5327: CONF_FILES=   ${EGDIR}/Muttrc ${PKG_SYSCONFDIR}/Muttrc
                   5328: </pre>
                   5329: <p>Note that the <code class="varname">EGDIR</code> variable is specific to that
                   5330: package and has no meaning outside it.</p>
                   5331: </div>
1.41      asau     5332: <div class="sect2">
1.1       dsieger  5333: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   5334: <a name="conf-files-disable"></a>17.2.4. Disabling handling of configuration files</h3></div></div></div>
1.1       dsieger  5335: <p>The automatic copying of config files can be toggled by setting the
                   5336: environment variable <code class="varname">PKG_CONFIG</code> prior to package
                   5337: installation.</p>
                   5338: </div>
                   5339: </div>
1.41      asau     5340: <div class="sect1">
1.1       dsieger  5341: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   5342: <a name="rcd-scripts"></a>17.3. System startup scripts</h2></div></div></div>
1.1       dsieger  5343: <p>System startup scripts are special files because they must be
                   5344: installed in a place known by the underlying OS, usually outside the
1.154     rillig   5345: 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  5346: can be used.  However, pkginstall provides a special mechanism to handle
                   5347: these files.</p>
                   5348: <p>In order to provide system startup scripts, the package has
                   5349: to:</p>
1.23      wiz      5350: <div class="orderedlist"><ol class="orderedlist" type="1">
                   5351: <li class="listitem"><p>Store the script inside <code class="filename">${FILESDIR}</code>, with
1.1       dsieger  5352:     the <code class="literal">.sh</code> suffix appended.  Considering the
1.137     leot     5353:     <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  5354:     <code class="filename">cupsd.sh</code> in its files directory.</p></li>
1.23      wiz      5355: <li class="listitem">
1.1       dsieger  5356: <p>Tell pkginstall to handle it, appending the name of the script,
                   5357:     without its extension, to the <code class="varname">RCD_SCRIPTS</code> variable.
                   5358:     Continuing the previous example:</p>
                   5359: <pre class="programlisting">
                   5360: RCD_SCRIPTS+=   cupsd
                   5361: </pre>
                   5362: </li>
                   5363: </ol></div>
                   5364: <p>Once this is done, pkginstall will do the following steps for each
                   5365: script in an automated fashion:</p>
1.23      wiz      5366: <div class="orderedlist"><ol class="orderedlist" type="1">
                   5367: <li class="listitem"><p>Process the file found in the files directory applying all the
1.1       dsieger  5368:     substitutions described in the <code class="filename">FILES_SUBST</code>
                   5369:     variable.</p></li>
1.23      wiz      5370: <li class="listitem"><p>Copy the script from the files directory to the examples
1.1       dsieger  5371:     hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>.  Note
                   5372:     that this master file must be explicitly registered in the
                   5373:     <code class="filename">PLIST</code>.</p></li>
1.23      wiz      5374: <li class="listitem"><p>Add code to the installation scripts to copy the startup script
1.1       dsieger  5375:     from the examples hierarchy into the system-wide startup scripts
                   5376:     directory.</p></li>
                   5377: </ol></div>
1.41      asau     5378: <div class="sect2">
1.1       dsieger  5379: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   5380: <a name="rcd-scripts-disable"></a>17.3.1. Disabling handling of system startup scripts</h3></div></div></div>
1.1       dsieger  5381: <p>The automatic copying of config files can be toggled by setting the
                   5382: environment variable <code class="varname">PKG_RCD_SCRIPTS</code> prior to package
                   5383: installation.  Note that the scripts will be always copied inside the
                   5384: examples hierarchy, <code class="filename">${PREFIX}/share/examples/rc.d/</code>, no
                   5385: matter what the value of this variable is.</p>
                   5386: </div>
                   5387: </div>
1.41      asau     5388: <div class="sect1">
1.1       dsieger  5389: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   5390: <a name="users-and-groups"></a>17.4. System users and groups</h2></div></div></div>
1.1       dsieger  5391: <p>If a package needs to create special users and/or groups during
                   5392: installation, it can do so by using the pkginstall framework.</p>
                   5393: <p>Users can be created by adding entries to the
                   5394: <code class="varname">PKG_USERS</code> variable.  Each entry has the following
                   5395: syntax:</p>
                   5396: <pre class="programlisting">
                   5397: user:group
                   5398: </pre>
                   5399: <p>Further specification of user details may be done by setting
                   5400: per-user variables.
                   5401: <code class="varname">PKG_UID.<em class="replaceable"><code>user</code></em></code> is the
                   5402: numeric UID for the user.
                   5403: <code class="varname">PKG_GECOS.<em class="replaceable"><code>user</code></em></code> is the
                   5404: user's description or comment.
                   5405: <code class="varname">PKG_HOME.<em class="replaceable"><code>user</code></em></code> is the
                   5406: user's home directory, and defaults to
                   5407: <code class="filename">/nonexistent</code> if not specified.
                   5408: <code class="varname">PKG_SHELL.<em class="replaceable"><code>user</code></em></code> is the
                   5409: user's shell, and defaults to <code class="filename">/sbin/nologin</code> if
                   5410: not specified.</p>
                   5411: <p>Similarly, groups can be created by adding entries to the
                   5412: <code class="varname">PKG_GROUPS</code> variable, whose syntax is:</p>
                   5413: <pre class="programlisting">
                   5414: group
                   5415: </pre>
                   5416: <p>The numeric GID of the group may be set by defining
                   5417: <code class="varname">PKG_GID.<em class="replaceable"><code>group</code></em></code>.</p>
                   5418: <p>If a package needs to create the users and groups at an earlier
1.116     wiz      5419: stage, then it can set <code class="varname">USERGROUP_PHASE</code> to either
                   5420: <code class="literal">configure</code>,<code class="literal">build</code>, or
                   5421: <code class="literal">pre-install</code> to indicate the phase before which the
                   5422: users and groups are created. In this case, the numeric UIDs and GIDs
                   5423: of the created users and groups are automatically hardcoded into the
                   5424: final installation scripts.</p>
1.1       dsieger  5425: </div>
1.41      asau     5426: <div class="sect1">
1.1       dsieger  5427: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   5428: <a name="shells"></a>17.5. System shells</h2></div></div></div>
1.1       dsieger  5429: <p>Packages that install system shells should register them in the shell
                   5430: database, <code class="filename">/etc/shells</code>, to make things easier to the
                   5431: administrator.  This must be done from the installation scripts to keep
                   5432: binary packages working on any system.  pkginstall provides an easy way to
                   5433: accomplish this task.</p>
                   5434: <p>When a package provides a shell interpreter, it has to set the
                   5435: <code class="varname">PKG_SHELL</code> variable to its absolute file name.  This will
                   5436: add some hooks to the installation scripts to handle it.  Consider the
1.137     leot     5437: 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  5438: <pre class="programlisting">
                   5439: PKG_SHELL=      ${PREFIX}/bin/zsh
                   5440: </pre>
1.41      asau     5441: <div class="sect2">
1.1       dsieger  5442: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   5443: <a name="shells-disable"></a>17.5.1. Disabling shell registration</h3></div></div></div>
1.1       dsieger  5444: <p>The automatic registration of shell interpreters can be disabled by
                   5445: the administrator by setting the <code class="filename">PKG_REGISTER_SHELLS</code>
                   5446: environment variable to <code class="literal">NO</code>.</p>
                   5447: </div>
                   5448: </div>
1.41      asau     5449: <div class="sect1">
1.1       dsieger  5450: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   5451: <a name="fonts"></a>17.6. Fonts</h2></div></div></div>
1.1       dsieger  5452: <p>Packages that install X11 fonts should update the database files
                   5453: that index the fonts within each fonts directory.  This can easily be
                   5454: accomplished within the pkginstall framework.</p>
                   5455: <p>When a package installs X11 fonts, it must list the directories in
                   5456: which fonts are installed in the
                   5457: <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code> variables,
1.23      wiz      5458: where <em class="replaceable"><code>type</code></em> can be one of <span class="quote">&#8220;<span class="quote">ttf</span>&#8221;</span>,
                   5459: <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  5460: installation scripts to run the appropriate commands to update the fonts
                   5461: database files within each of those directories.  For convenience, if the
                   5462: directory path is relative, it is taken to be relative to the package's
1.137     leot     5463: 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  5464: <pre class="programlisting">
1.67      wiz      5465: FONTS_DIRS.ttf= ${PREFIX}/share/fonts/X11/TTF
1.1       dsieger  5466: </pre>
1.41      asau     5467: <div class="sect2">
1.1       dsieger  5468: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   5469: <a name="fonts-disable"></a>17.6.1. Disabling automatic update of the fonts databases</h3></div></div></div>
1.1       dsieger  5470: <p>The automatic update of fonts databases can be disabled by
                   5471: the administrator by setting the <code class="filename">PKG_UPDATE_FONTS_DB</code>
                   5472: environment variable to <code class="literal">NO</code>.</p>
                   5473: </div>
                   5474: </div>
                   5475: </div>
1.41      asau     5476: <div class="chapter">
1.1       dsieger  5477: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   5478: <a name="options"></a>Chapter 18. Options handling</h2></div></div></div>
1.1       dsieger  5479: <div class="toc">
                   5480: <p><b>Table of Contents</b></p>
1.100     leot     5481: <dl class="toc">
1.154     rillig   5482: <dt><span class="sect1"><a href="#global-default-options">18.1. Global default options</a></span></dt>
                   5483: <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>
                   5484: <dt><span class="sect1"><a href="#option-names">18.3. Option Names</a></span></dt>
                   5485: <dt><span class="sect1"><a href="#option-build">18.4. Determining the options of dependencies</a></span></dt>
1.1       dsieger  5486: </dl>
                   5487: </div>
                   5488: <p>Many packages have the ability to be built to support different
                   5489: sets of features.  <code class="filename">bsd.options.mk</code> is a framework
                   5490: in pkgsrc that provides generic handling of those options that
                   5491: determine different ways in which the packages can be built.  It's
                   5492: possible for the user to specify exactly which sets of options will be
                   5493: built into a package or to allow a set of global default options
                   5494: apply.</p>
1.7       rillig   5495: <p>There are two broad classes of behaviors that one might want to
                   5496: control via options.  One is whether some particular feature is
                   5497: enabled in a program that will be built anyway, often by including or
                   5498: not including a dependency on some other package.  The other is
                   5499: whether or not an additional program will be built as part of the
                   5500: package.  Generally, it is better to make a split package for such
                   5501: additional programs instead of using options, because it enables
                   5502: binary packages to be built which can then be added separately.  For
                   5503: example, the foo package might have minimal dependencies (those
                   5504: packages without which foo doesn't make sense), and then the foo-gfoo
                   5505: package might include the GTK frontend program gfoo.  This is better
                   5506: than including a gtk option to foo that adds gfoo, because either that
                   5507: option is default, in which case binary users can't get foo without
                   5508: gfoo, or not default, in which case they can't get gfoo.  With split
                   5509: packages, they can install foo without having GTK, and later decide to
                   5510: install gfoo (pulling in GTK at that time).  This is an advantage to
                   5511: source users too, avoiding the need for rebuilds.</p>
                   5512: <p>Plugins with widely varying dependencies should usually be split
                   5513: instead of options.</p>
                   5514: <p>It is often more work to maintain split packages, especially if
                   5515: the upstream package does not support this.  The decision of split
                   5516: vs. option should be made based on the likelihood that users will want
                   5517: or object to the various pieces, the size of the dependencies that are
                   5518: included, and the amount of work.</p>
                   5519: <p>A further consideration is licensing.  Non-free parts, or parts
                   5520: that depend on non-free dependencies (especially plugins) should
                   5521: almost always be split if feasible.</p>
1.41      asau     5522: <div class="sect1">
1.1       dsieger  5523: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   5524: <a name="global-default-options"></a>18.1. Global default options</h2></div></div></div>
1.1       dsieger  5525: <p>Global default options are listed in
                   5526: <code class="varname">PKG_DEFAULT_OPTIONS</code>, which is a list of the options
                   5527: that should be built into every package if that option is supported.
1.10      hubertf  5528: This variable should be set in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.</p>
1.1       dsieger  5529: </div>
1.41      asau     5530: <div class="sect1">
1.1       dsieger  5531: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   5532: <a name="converting-to-options"></a>18.2. Converting packages to use <code class="filename">bsd.options.mk</code>
1.1       dsieger  5533: </h2></div></div></div>
                   5534: <p>The following example shows how
                   5535: <code class="filename">bsd.options.mk</code> should be used
                   5536: by the hypothetical ``wibble'' package, either in the package
                   5537: <code class="filename">Makefile</code>, or in a file,
                   5538: e.g. <code class="filename">options.mk</code>, that is included by the
                   5539: main package <code class="filename">Makefile</code>.</p>
                   5540: <pre class="programlisting">
                   5541: PKG_OPTIONS_VAR=                PKG_OPTIONS.wibble
                   5542: PKG_SUPPORTED_OPTIONS=          wibble-foo ldap
                   5543: PKG_OPTIONS_OPTIONAL_GROUPS=    database
                   5544: PKG_OPTIONS_GROUP.database=     mysql pgsql
                   5545: PKG_SUGGESTED_OPTIONS=          wibble-foo
                   5546: PKG_OPTIONS_LEGACY_VARS+=       WIBBLE_USE_OPENLDAP:ldap
                   5547: PKG_OPTIONS_LEGACY_OPTS+=       foo:wibble-foo
                   5548: 
                   5549: .include "../../mk/bsd.prefs.mk"
                   5550: 
                   5551: # this package was previously named wibble2
                   5552: .if defined(PKG_OPTIONS.wibble2)
                   5553: PKG_LEGACY_OPTIONS+=            ${PKG_OPTIONS.wibble2}
                   5554: PKG_OPTIONS_DEPRECATED_WARNINGS+= \
                   5555:         "Deprecated variable PKG_OPTIONS.wibble2 used, use ${PKG_OPTIONS_VAR} instead."
                   5556: .endif
                   5557: 
                   5558: .include "../../mk/bsd.options.mk"
                   5559: 
                   5560: # Package-specific option-handling
                   5561: 
                   5562: ###
                   5563: ### FOO support
                   5564: ###
                   5565: .if !empty(PKG_OPTIONS:Mwibble-foo)
                   5566: CONFIGURE_ARGS+=    --enable-foo
                   5567: .endif
                   5568: 
                   5569: ###
                   5570: ### LDAP support
                   5571: ###
                   5572: .if !empty(PKG_OPTIONS:Mldap)
                   5573: .  include "../../databases/openldap-client/buildlink3.mk"
                   5574: CONFIGURE_ARGS+=    --enable-ldap=${BUILDLINK_PREFIX.openldap-client}
                   5575: .endif
                   5576: 
                   5577: ###
                   5578: ### database support
                   5579: ###
                   5580: .if !empty(PKG_OPTIONS:Mmysql)
                   5581: .  include "../../mk/mysql.buildlink3.mk"
                   5582: .endif
                   5583: .if !empty(PKG_OPTIONS:Mpgsql)
                   5584: .  include "../../mk/pgsql.buildlink3.mk"
                   5585: .endif
                   5586: </pre>
                   5587: <p>The first section contains the information about which build
                   5588: options are supported by the package, and any default options settings
                   5589: if needed.</p>
1.23      wiz      5590: <div class="orderedlist"><ol class="orderedlist" type="1">
                   5591: <li class="listitem"><p><code class="varname">PKG_OPTIONS_VAR</code> is the name of the
1.157     leot     5592: <a class="citerefentry" href="http://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  5593: options.  It should be set to
                   5594: PKG_OPTIONS.<em class="replaceable"><code>pkgbase</code></em>. Do not set it to
                   5595: PKG_OPTIONS.${PKGBASE}, since <code class="varname">PKGBASE</code> is not defined
                   5596: at the point where the options are processed.</p></li>
1.23      wiz      5597: <li class="listitem"><p><code class="varname">PKG_SUPPORTED_OPTIONS</code> is a list of
1.1       dsieger  5598: build options supported by the package.</p></li>
1.23      wiz      5599: <li class="listitem"><p><code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code> is a
1.1       dsieger  5600: list of names of groups of mutually exclusive options.  The options in
                   5601: each group are listed in
                   5602: <code class="varname">PKG_OPTIONS_GROUP.<em class="replaceable"><code>groupname</code></em></code>.
                   5603: The most specific setting of any option from the group takes
                   5604: precedence over all other options in the group.  Options from the
                   5605: groups will be automatically added to
                   5606: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.</p></li>
1.23      wiz      5607: <li class="listitem"><p><code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> is like
1.1       dsieger  5608: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, but building the
                   5609: packages will fail if no option from the group is
                   5610: selected.</p></li>
1.23      wiz      5611: <li class="listitem"><p><code class="varname">PKG_OPTIONS_NONEMPTY_SETS</code> is a list
1.1       dsieger  5612: of names of sets of options.  At least one option from each set must
                   5613: be selected.  The options in each set are listed in
                   5614: <code class="varname">PKG_OPTIONS_SET.<em class="replaceable"><code>setname</code></em></code>.
                   5615: Options from the sets will be automatically added to
                   5616: <code class="varname">PKG_SUPPORTED_OPTIONS</code>.  Building the package will
                   5617: fail if no option from the set is selected.</p></li>
1.23      wiz      5618: <li class="listitem"><p><code class="varname">PKG_SUGGESTED_OPTIONS</code> is a list of
1.1       dsieger  5619: build options which are enabled by default.</p></li>
1.23      wiz      5620: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_VARS</code> is a list
1.1       dsieger  5621: of
1.23      wiz      5622: <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  5623: pairs that map legacy <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> variables to
1.1       dsieger  5624: their option counterparts.  Pairs should be added with
1.23      wiz      5625: <span class="quote">&#8220;<span class="quote">+=</span>&#8221;</span> to keep the listing of global legacy variables.  A
1.1       dsieger  5626: warning will be issued if the user uses a legacy
                   5627: variable.</p></li>
1.23      wiz      5628: <li class="listitem"><p><code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> is a list
1.1       dsieger  5629: of
1.23      wiz      5630: <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  5631: pairs that map options that have been renamed to their new
1.23      wiz      5632: counterparts.  Pairs should be added with <span class="quote">&#8220;<span class="quote">+=</span>&#8221;</span> to keep
1.1       dsieger  5633: the listing of global legacy options.  A warning will be issued if
                   5634: the user uses a legacy option.</p></li>
1.23      wiz      5635: <li class="listitem"><p><code class="varname">PKG_LEGACY_OPTIONS</code> is a list of
1.1       dsieger  5636: options implied by deprecated variables used.  This can be used for
                   5637: cases that neither <code class="varname">PKG_OPTIONS_LEGACY_VARS</code> nor
                   5638: <code class="varname">PKG_OPTIONS_LEGACY_OPTS</code> can handle, e. g. when
                   5639: <code class="varname">PKG_OPTIONS_VAR</code> is renamed.</p></li>
1.23      wiz      5640: <li class="listitem"><p><code class="varname">PKG_OPTIONS_DEPRECATED_WARNINGS</code> is
1.1       dsieger  5641: a list of warnings about deprecated variables or options used, and
                   5642: what to use instead.</p></li>
                   5643: </ol></div>
                   5644: <p>A package should never modify
                   5645: <code class="varname">PKG_DEFAULT_OPTIONS</code> or the variable named in
                   5646: <code class="varname">PKG_OPTIONS_VAR</code>.  These are strictly user-settable.
                   5647: To suggest a default set of options, use
                   5648: <code class="varname">PKG_SUGGESTED_OPTIONS</code>.</p>
                   5649: <p><code class="varname">PKG_OPTIONS_VAR</code> must be defined before
                   5650: including <code class="filename">bsd.options.mk</code>.  If none of
                   5651: <code class="varname">PKG_SUPPORTED_OPTIONS</code>,
                   5652: <code class="varname">PKG_OPTIONS_OPTIONAL_GROUPS</code>, and
                   5653: <code class="varname">PKG_OPTIONS_REQUIRED_GROUPS</code> are defined (as can
                   5654: happen with platform-specific options if none of them is supported on
                   5655: the current platform), <code class="varname">PKG_OPTIONS</code> is set to the
                   5656: empty list and the package is otherwise treated as not using the
                   5657: options framework.</p>
                   5658: <p>After the inclusion of <code class="filename">bsd.options.mk</code>, the
                   5659: variable <code class="varname">PKG_OPTIONS</code> contains the list of selected
                   5660: build options, properly filtered to remove unsupported and duplicate
                   5661: options.</p>
                   5662: <p>The remaining sections contain the logic that is specific to
                   5663: each option.  The correct way to check for an option is to check
                   5664: whether it is listed in <code class="varname">PKG_OPTIONS</code>:</p>
                   5665: <pre class="programlisting">
                   5666: .if !empty(PKG_OPTIONS:M<em class="replaceable"><code>option</code></em>)
                   5667: </pre>
                   5668: </div>
1.41      asau     5669: <div class="sect1">
1.1       dsieger  5670: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   5671: <a name="option-names"></a>18.3. Option Names</h2></div></div></div>
1.1       dsieger  5672: <p>Options that enable similar features in different packages (like
                   5673: optional support for a library) should use a common name in all
                   5674: packages that support it (like the name of the library).  If another
                   5675: package already has an option with the same meaning, use the same
                   5676: name.</p>
                   5677: <p>Options that enable features specific to one package, where it's
                   5678: unlikely that another (unrelated) package has the same (or a similar)
                   5679: optional feature, should use a name prefixed with
                   5680: <code class="varname"><em class="replaceable"><code>pkgname</code></em>-</code>.</p>
                   5681: <p>If a group of related packages share an optional feature
                   5682: specific to that group, prefix it with the name of the
1.23      wiz      5683: <span class="quote">&#8220;<span class="quote">main</span>&#8221;</span> package
1.1       dsieger  5684: (e. g. <code class="varname">djbware-errno-hack</code>).</p>
                   5685: <p>For new options, add a line to
                   5686: <code class="filename">mk/defaults/options.description</code>.  Lines have two
                   5687: fields, separated by tab.  The first field is the option name, the
                   5688: second its description.  The description should be a whole sentence
                   5689: (starting with an uppercase letter and ending with a period) that
1.23      wiz      5690: describes what enabling the option does.  E. g. <span class="quote">&#8220;<span class="quote">Enable ispell
                   5691: support.</span>&#8221;</span> The file is sorted by option names.</p>
1.1       dsieger  5692: </div>
1.41      asau     5693: <div class="sect1">
1.7       rillig   5694: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   5695: <a name="option-build"></a>18.4. Determining the options of dependencies</h2></div></div></div>
1.10      hubertf  5696: <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   5697: different dependencies based on the options with which the package was
                   5698: built. For querying these options, the file
                   5699: <code class="filename">pkgsrc/mk/pkg-build-options.mk</code> should be used. A
                   5700: typical example looks like this:</p>
                   5701: <pre class="programlisting">
                   5702: pkgbase := libpurple
                   5703: .include "../../mk/pkg-build-options.mk"
                   5704: 
                   5705: .if !empty(PKG_BUILD_OPTIONS.libpurple:Mdbus)
                   5706: ...
                   5707: .endif
                   5708: </pre>
                   5709: <p>Including <code class="filename">pkg-build-options.mk</code> here will set
                   5710: the variable <code class="varname">PKG_BUILD_OPTIONS.libpurple</code> to the build
                   5711: options of the libpurple package, which can then be queried like
                   5712: <code class="varname">PKG_OPTIONS</code> in the <code class="filename">options.mk</code>
                   5713: file. See the file <code class="filename">pkg-build-options.mk</code> for more
                   5714: details.</p>
                   5715: </div>
1.1       dsieger  5716: </div>
1.41      asau     5717: <div class="chapter">
1.1       dsieger  5718: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   5719: <a name="build"></a>Chapter 19. The build process</h2></div></div></div>
1.1       dsieger  5720: <div class="toc">
                   5721: <p><b>Table of Contents</b></p>
1.100     leot     5722: <dl class="toc">
1.154     rillig   5723: <dt><span class="sect1"><a href="#build.intro">19.1. Introduction</a></span></dt>
                   5724: <dt><span class="sect1"><a href="#build.prefix">19.2. Program location</a></span></dt>
                   5725: <dt><span class="sect1"><a href="#build.builddirs">19.3. Directories used during the build process</a></span></dt>
                   5726: <dt><span class="sect1"><a href="#build.running">19.4. Running a phase</a></span></dt>
                   5727: <dt><span class="sect1"><a href="#build.fetch">19.5. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                   5728: <dd><dl>
                   5729: <dt><span class="sect2"><a href="#build.fetch.what">19.5.1. What to fetch and where to get it from</a></span></dt>
                   5730: <dt><span class="sect2"><a href="#build.fetch.how">19.5.2. How are the files fetched?</a></span></dt>
                   5731: </dl></dd>
                   5732: <dt><span class="sect1"><a href="#build.checksum">19.6. The <span class="emphasis"><em>checksum</em></span> phase</a></span></dt>
                   5733: <dt><span class="sect1"><a href="#build.extract">19.7. The <span class="emphasis"><em>extract</em></span> phase</a></span></dt>
                   5734: <dt><span class="sect1"><a href="#build.patch">19.8. The <span class="emphasis"><em>patch</em></span> phase</a></span></dt>
                   5735: <dt><span class="sect1"><a href="#build.tools">19.9. The <span class="emphasis"><em>tools</em></span> phase</a></span></dt>
                   5736: <dt><span class="sect1"><a href="#build.wrapper">19.10. The <span class="emphasis"><em>wrapper</em></span> phase</a></span></dt>
                   5737: <dt><span class="sect1"><a href="#build.configure">19.11. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   5738: <dt><span class="sect1"><a href="#build.build">19.12. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   5739: <dt><span class="sect1"><a href="#build.test">19.13. The <span class="emphasis"><em>test</em></span> phase</a></span></dt>
                   5740: <dt><span class="sect1"><a href="#build.install">19.14. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   5741: <dt><span class="sect1"><a href="#build.package">19.15. The <span class="emphasis"><em>package</em></span> phase</a></span></dt>
                   5742: <dt><span class="sect1"><a href="#build.clean">19.16. Cleaning up</a></span></dt>
                   5743: <dt><span class="sect1"><a href="#build.helpful-targets">19.17. Other helpful targets</a></span></dt>
1.1       dsieger  5744: </dl>
                   5745: </div>
1.41      asau     5746: <div class="sect1">
1.1       dsieger  5747: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   5748: <a name="build.intro"></a>19.1. Introduction</h2></div></div></div>
1.1       dsieger  5749: <p>This chapter gives a detailed description on how a package is
                   5750:     built. Building a package is separated into different
                   5751:     <span class="emphasis"><em>phases</em></span> (for example <code class="varname">fetch</code>,
                   5752:     <code class="varname">build</code>, <code class="varname">install</code>), all of which are
1.18      snj      5753:     described in the following sections. Each phase is split into
1.1       dsieger  5754:     so-called <span class="emphasis"><em>stages</em></span>, which take the name of the
                   5755:     containing phase, prefixed by one of <code class="varname">pre-</code>,
                   5756:     <code class="varname">do-</code> or <code class="varname">post-</code>. (Examples are
                   5757:     <code class="varname">pre-configure</code>, <code class="varname">post-build</code>.) Most
                   5758:     of the actual work is done in the <code class="varname">do-*</code> stages.</p>
                   5759: <p>Never override the regular targets (like
                   5760:     <code class="varname">fetch</code>), if you have to, override the
                   5761:     <code class="varname">do-*</code> ones instead.</p>
                   5762: <p>The basic steps for building a program are always the same.  First
                   5763:     the program's source (<span class="emphasis"><em>distfile</em></span>) must be brought to
                   5764:     the local system and then extracted. After any pkgsrc-specific patches
                   5765:     to compile properly are applied, the software can be configured, then
                   5766:     built (usually by compiling), and finally the generated binaries, etc.
                   5767:     can be put into place on the system.</p>
                   5768: <p>To get more details about what is happening at each step,
                   5769:     you can set the <code class="varname">PKG_VERBOSE</code> variable, or the
                   5770:     <code class="varname">PATCH_DEBUG</code> variable if you are just interested
                   5771:     in more details about the <span class="emphasis"><em>patch</em></span> step.</p>
                   5772: </div>
1.41      asau     5773: <div class="sect1">
1.1       dsieger  5774: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   5775: <a name="build.prefix"></a>19.2. Program location</h2></div></div></div>
1.1       dsieger  5776: <p>Before outlining the process performed by the NetBSD package system in
                   5777:     the next section, here's a brief discussion on where programs are
                   5778:     installed, and which variables influence this.</p>
                   5779: <p>The automatic variable <code class="varname">PREFIX</code> indicates
                   5780:     where all files of the final program shall be installed. It is
                   5781:     usually set to <code class="varname">LOCALBASE</code>
                   5782:     (<code class="filename">/usr/pkg</code>), or <code class="varname">CROSSBASE</code>
                   5783:     for pkgs in the <code class="filename">cross</code> category.  The value of
                   5784:     <code class="varname">PREFIX</code> needs to be put
                   5785:     into the various places in the program's source where paths to
1.154     rillig   5786:     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  5787: <p>When choosing which of these variables to use,
                   5788:     follow the following rules:</p>
1.41      asau     5789: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      5790: <li class="listitem"><p><code class="varname">PREFIX</code> always points to the location
1.1       dsieger  5791:        where the current pkg will be installed.  When referring to a
                   5792:        pkg's own installation path, use
1.23      wiz      5793:        <span class="quote">&#8220;<span class="quote">${PREFIX}</span>&#8221;</span>.</p></li>
                   5794: <li class="listitem"><p><code class="varname">LOCALBASE</code> is where all non-X11 pkgs
1.1       dsieger  5795:        are installed.  If you need to construct a -I or -L argument
                   5796:        to the compiler to find includes and libraries installed by
1.23      wiz      5797:        another non-X11 pkg, use <span class="quote">&#8220;<span class="quote">${LOCALBASE}</span>&#8221;</span>. The name
1.1       dsieger  5798:        <code class="varname">LOCALBASE</code> stems from FreeBSD, which
                   5799:        installed all packages in <code class="filename">/usr/local</code>. As
                   5800:        pkgsrc leaves <code class="filename">/usr/local</code> for the system
                   5801:        administrator, this variable is a misnomer.</p></li>
1.23      wiz      5802: <li class="listitem"><p><code class="varname">X11BASE</code> is where the actual X11
1.1       dsieger  5803:        distribution (from xsrc, etc.) is installed. When looking for
                   5804:        <span class="emphasis"><em>standard</em></span> X11 includes (not those
1.23      wiz      5805:        installed by a package), use <span class="quote">&#8220;<span class="quote">${X11BASE}</span>&#8221;</span>.</p></li>
1.99      sevan    5806: <li class="listitem"><p>X11-based packages using imake must set
                   5807:        <code class="varname">USE_IMAKE</code> to be installed correctly under
                   5808:        <code class="varname">LOCALBASE</code>.</p></li>
1.23      wiz      5809: <li class="listitem"><p>Within <code class="filename">${PREFIX}</code>, packages should
1.157     leot     5810:        install files according to <a class="citerefentry" href="http://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  5811:        manual pages go into <code class="filename">${PREFIX}/man</code>, not
                   5812:        <code class="filename">${PREFIX}/share/man</code>.</p></li>
                   5813: </ul></div>
                   5814: </div>
1.41      asau     5815: <div class="sect1">
1.1       dsieger  5816: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   5817: <a name="build.builddirs"></a>19.3. Directories used during the build process</h2></div></div></div>
1.14      jmcneill 5818: <p>When building a package, various directories are used to store
1.1       dsieger  5819:     source files, temporary files, pkgsrc-internal files, and so on. These
                   5820:     directories are explained here.</p>
                   5821: <p>Some of the directory variables contain relative pathnames. There
                   5822:     are two common base directories for these relative directories:
                   5823:     <code class="varname">PKGSRCDIR/PKGPATH</code> is used for directories that are
                   5824:     pkgsrc-specific. <code class="varname">WRKSRC</code> is used for directories
                   5825:     inside the package itself.</p>
1.41      asau     5826: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  5827: <dt><span class="term"><code class="varname">PKGSRCDIR</code></span></dt>
                   5828: <dd><p>This is an absolute pathname that points to the pkgsrc
                   5829:       root directory. Generally, you don't need
                   5830:       it.</p></dd>
                   5831: <dt><span class="term"><code class="varname">PKGDIR</code></span></dt>
                   5832: <dd><p>This is an absolute pathname that points to the
                   5833:       current package.</p></dd>
                   5834: <dt><span class="term"><code class="varname">PKGPATH</code></span></dt>
                   5835: <dd><p>This is a pathname relative to
                   5836:       <code class="varname">PKGSRCDIR</code> that points to the current
                   5837:       package.</p></dd>
                   5838: <dt><span class="term"><code class="varname">WRKDIR</code></span></dt>
                   5839: <dd><p>This is an absolute pathname pointing to the directory
                   5840:       where all work takes place. The distfiles are extracted to this
                   5841:       directory. It also contains temporary directories and log files used by
                   5842:       the various pkgsrc frameworks, like <span class="emphasis"><em>buildlink</em></span> or
                   5843:       the <span class="emphasis"><em>wrappers</em></span>.</p></dd>
                   5844: <dt><span class="term"><code class="varname">WRKSRC</code></span></dt>
                   5845: <dd><p>This is an absolute pathname pointing to the directory
                   5846:       where the distfiles are extracted. It is usually a direct subdirectory
                   5847:       of <code class="varname">WRKDIR</code>, and often it's the only directory entry
                   5848:       that isn't hidden. This variable may be changed by a package
                   5849:       <code class="filename">Makefile</code>.</p></dd>
                   5850: </dl></div>
1.14      jmcneill 5851: <p>The <code class="varname">CREATE_WRKDIR_SYMLINK</code> definition takes either
                   5852:     the value <span class="emphasis"><em>yes</em></span> or <span class="emphasis"><em>no</em></span> and defaults
1.15      rillig   5853:     to <span class="emphasis"><em>no</em></span>. It indicates whether a symbolic link to the
1.14      jmcneill 5854:     <code class="varname">WRKDIR</code> is to be created in the pkgsrc entry's directory.
                   5855:     If users would like to have their pkgsrc trees behave in a
                   5856:     read-only manner, then the value of
                   5857:     <code class="varname">CREATE_WRKDIR_SYMLINK</code> should be set to
                   5858:     <span class="emphasis"><em>no</em></span>.</p>
1.1       dsieger  5859: </div>
1.41      asau     5860: <div class="sect1">
1.1       dsieger  5861: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   5862: <a name="build.running"></a>19.4. Running a phase</h2></div></div></div>
1.10      hubertf  5863: <p>You can run a particular phase by typing <span class="command"><strong>make
1.1       dsieger  5864:     phase</strong></span>, where <span class="emphasis"><em>phase</em></span> is the name of the
                   5865:     phase. This will automatically run all phases that are required for this
                   5866:     phase. The default phase is <code class="varname">build</code>, that is, when you
1.10      hubertf  5867:     run <span class="command"><strong>make</strong></span> without parameters in a package directory,
1.1       dsieger  5868:     the package will be built, but not installed.</p>
                   5869: </div>
1.41      asau     5870: <div class="sect1">
1.1       dsieger  5871: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   5872: <a name="build.fetch"></a>19.5. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.1       dsieger  5873: <p>The first step in building a package is to fetch the
                   5874:     distribution files (distfiles) from the sites that are providing
                   5875:     them. This is the task of the <span class="emphasis"><em>fetch</em></span>
                   5876:     phase.</p>
1.41      asau     5877: <div class="sect2">
1.1       dsieger  5878: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   5879: <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  5880: <p>In simple cases, <code class="varname">MASTER_SITES</code>
                   5881:       defines all URLs from where the distfile, whose name is
                   5882:       derived from the <code class="varname">DISTNAME</code> variable, is
                   5883:       fetched. The more complicated cases are described
                   5884:       below.</p>
                   5885: <p>The variable <code class="varname">DISTFILES</code> specifies
                   5886:       the list of distfiles that have to be fetched. Its value
1.66      asau     5887:       defaults to <code class="literal">${DEFAULT_DISTFILES}</code> and
                   5888:       its value is <code class="literal">${DISTNAME}${EXTRACT_SUFX}</code>,
1.1       dsieger  5889:       so that most packages don't need to define it at all.
                   5890:       <code class="varname">EXTRACT_SUFX</code> is
                   5891:       <code class="literal">.tar.gz</code> by default, but can be changed
                   5892:       freely. Note that if your package requires additional
                   5893:       distfiles to the default one, you cannot just append the
                   5894:       additional filenames using the <code class="literal">+=</code>
                   5895:       operator, but you have write for example:</p>
                   5896: <pre class="programlisting">
1.66      asau     5897: DISTFILES=      ${DEFAULT_DISTFILES} additional-files.tar.gz
1.1       dsieger  5898: </pre>
                   5899: <p>Each distfile is fetched from a list of sites, usually
                   5900:       <code class="varname">MASTER_SITES</code>. If the package has multiple
                   5901:       <code class="varname">DISTFILES</code> or multiple
                   5902:       <code class="varname">PATCHFILES</code> from different sites, you can
                   5903:       set
                   5904:       <code class="varname">SITES.<em class="replaceable"><code>distfile</code></em></code>
                   5905:       to the list of URLs where the file
                   5906:       <code class="filename"><em class="replaceable"><code>distfile</code></em></code>
                   5907:       (including the suffix) can be found.</p>
                   5908: <pre class="programlisting">
                   5909: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX}
                   5910: DISTFILES+=     foo-file.tar.gz
                   5911: SITES.foo-file.tar.gz= \
                   5912: http://www.somewhere.com/somehow/ \
                   5913: http://www.somewhereelse.com/mirror/somehow/
                   5914: </pre>
                   5915: <p>When actually fetching the distfiles, each item from
                   5916:       <code class="varname">MASTER_SITES</code> or
                   5917:       <code class="varname">SITES.*</code> gets the name of each distfile
                   5918:       appended to it, without an intermediate slash. Therefore,
                   5919:       all site values have to end with a slash or other separator
                   5920:       character. This allows for example to set
                   5921:       <code class="varname">MASTER_SITES</code> to a URL of a CGI script
                   5922:       that gets the name of the distfile as a parameter. In this
                   5923:       case, the definition would look like:</p>
                   5924: <pre class="programlisting">
                   5925: MASTER_SITES=   http://www.example.com/download.cgi?file=
                   5926: </pre>
1.22      jakllsch 5927: <p> The exception to this rule are URLs starting with a dash.
1.66      asau     5928:       In that case the URL is taken as is, fetched and the result
                   5929:       stored under the name of the distfile. You can use this style
                   5930:       for the case when the download URL style does not match the
                   5931:       above common case. For example, if permanent download URL is a
                   5932:       redirector to the real download URL, or the download file name
                   5933:       is offered by an HTTP Content-Disposition header. In the
                   5934:       following example, <code class="filename">foo-1.0.0.tar.gz</code> will be
                   5935:       created instead of the default
                   5936:       <code class="filename">v1.0.0.tar.gz</code>.</p>
                   5937: <pre class="programlisting">
                   5938: DISTNAME=       foo-1.0.0
                   5939: MASTER_SITES=   -http://www.example.com/archive/v1.0.0.tar.gz
                   5940: </pre>
1.1       dsieger  5941: <p>There are some predefined values for
                   5942:       <code class="varname">MASTER_SITES</code>, which can be used in
                   5943:       packages.  The names of the variables should speak for
                   5944:       themselves.</p>
1.156     leot     5945: <table border="0" summary="Simple list" class="simplelist">
                   5946: <tr>
                   5947: <td>MASTER_SITE_APACHE</td>
                   5948: <td>MASTER_SITE_BACKUP</td>
                   5949: </tr>
                   5950: <tr>
                   5951: <td>MASTER_SITE_CRATESIO</td>
                   5952: <td>MASTER_SITE_CYGWIN</td>
                   5953: </tr>
                   5954: <tr>
                   5955: <td>MASTER_SITE_DEBIAN</td>
                   5956: <td>MASTER_SITE_FREEBSD</td>
                   5957: </tr>
                   5958: <tr>
                   5959: <td>MASTER_SITE_FREEBSD_LOCAL</td>
                   5960: <td>MASTER_SITE_GENTOO</td>
                   5961: </tr>
                   5962: <tr>
                   5963: <td>MASTER_SITE_GITHUB</td>
                   5964: <td>MASTER_SITE_GNOME</td>
                   5965: </tr>
                   5966: <tr>
                   5967: <td>MASTER_SITE_GNU</td>
                   5968: <td>MASTER_SITE_GNUSTEP</td>
                   5969: </tr>
                   5970: <tr>
                   5971: <td>MASTER_SITE_HASKELL_HACKAGE</td>
                   5972: <td>MASTER_SITE_IFARCHIVE</td>
                   5973: </tr>
                   5974: <tr>
                   5975: <td>MASTER_SITE_KDE</td>
                   5976: <td>MASTER_SITE_MOZILLA</td>
                   5977: </tr>
                   5978: <tr>
                   5979: <td>MASTER_SITE_MOZILLA_ALL</td>
                   5980: <td>MASTER_SITE_MYSQL</td>
                   5981: </tr>
                   5982: <tr>
                   5983: <td>MASTER_SITE_NETLIB</td>
                   5984: <td>MASTER_SITE_OPENBSD</td>
                   5985: </tr>
                   5986: <tr>
                   5987: <td>MASTER_SITE_OPENOFFICE</td>
                   5988: <td>MASTER_SITE_OSDN</td>
                   5989: </tr>
                   5990: <tr>
                   5991: <td>MASTER_SITE_PERL_CPAN</td>
                   5992: <td>MASTER_SITE_PGSQL</td>
                   5993: </tr>
                   5994: <tr>
                   5995: <td>MASTER_SITE_PYPI</td>
                   5996: <td>MASTER_SITE_RUBYGEMS</td>
                   5997: </tr>
                   5998: <tr>
                   5999: <td>MASTER_SITE_R_CRAN</td>
                   6000: <td>MASTER_SITE_SOURCEFORGE</td>
                   6001: </tr>
                   6002: <tr>
                   6003: <td>MASTER_SITE_SUNSITE</td>
                   6004: <td>MASTER_SITE_SUSE</td>
                   6005: </tr>
                   6006: <tr>
                   6007: <td>MASTER_SITE_TEX_CTAN</td>
                   6008: <td>MASTER_SITE_XCONTRIB</td>
                   6009: </tr>
                   6010: <tr>
                   6011: <td>MASTER_SITE_XEMACS</td>
                   6012: <td>MASTER_SITE_XORG</td>
                   6013: </tr>
                   6014: </table>
1.1       dsieger  6015: <p>Some explanations for the less self-explaining ones:
                   6016:       <code class="varname">MASTER_SITE_BACKUP</code> contains backup sites
1.26      wiz      6017:       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      6018:       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  6019: <p>If you choose one of these predefined sites, you may
                   6020:       want to specify a subdirectory of that site. Since these
                   6021:       macros may expand to more than one actual site, you
                   6022:       <span class="emphasis"><em>must</em></span> use the following construct to
                   6023:       specify a subdirectory:</p>
                   6024: <pre class="programlisting">
                   6025: MASTER_SITES=   ${MASTER_SITE_GNU:=subdirectory/name/}
                   6026: MASTER_SITES=   ${MASTER_SITE_SOURCEFORGE:=project_name/}
                   6027: </pre>
                   6028: <p>Note the trailing slash after the subdirectory
                   6029:       name.</p>
                   6030: </div>
1.41      asau     6031: <div class="sect2">
1.1       dsieger  6032: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   6033: <a name="build.fetch.how"></a>19.5.2. How are the files fetched?</h3></div></div></div>
1.1       dsieger  6034: <p>The <span class="emphasis"><em>fetch</em></span> phase makes sure that
                   6035:       all the distfiles exist in a local directory
                   6036:       (<code class="varname">DISTDIR</code>, which can be set by the pkgsrc
                   6037:       user). If the files do not exist, they are fetched using
                   6038:       commands of the form</p>
                   6039: <pre class="programlisting">
                   6040: ${FETCH_CMD} ${FETCH_BEFORE_ARGS} ${site}${file} ${FETCH_AFTER_ARGS}
                   6041: </pre>
                   6042: <p>where <code class="literal">${site}</code> varies through
                   6043:       several possibilities in turn: first,
                   6044:       <code class="varname">MASTER_SITE_OVERRIDE</code> is tried, then the
                   6045:       sites specified in either <code class="varname">SITES.file</code> if
                   6046:       defined, else <code class="varname">MASTER_SITES</code> or
                   6047:       <code class="varname">PATCH_SITES</code>, as applies, then finally the
                   6048:       value of <code class="varname">MASTER_SITE_BACKUP</code>. The order of
                   6049:       all except the first and the last can be optionally sorted
                   6050:       by the user, via setting either
                   6051:       <code class="varname">MASTER_SORT_RANDOM</code>, and
                   6052:       <code class="varname">MASTER_SORT_AWK</code> or
                   6053:       <code class="varname">MASTER_SORT_REGEX</code>.</p>
1.16      jnemeth  6054: <p> The specific command and arguments used depend on the
                   6055:       <code class="varname">FETCH_USING</code> parameter. The example above is
                   6056:       for <code class="literal">FETCH_USING=custom</code>.</p>
1.1       dsieger  6057: <p>The distfiles mirror run by the NetBSD Foundation uses the
                   6058:       <span class="emphasis"><em>mirror-distfiles</em></span> target to mirror the
                   6059:       distfiles, if they are freely distributable.  Packages setting
                   6060:       <code class="varname">NO_SRC_ON_FTP</code> (usually to
1.23      wiz      6061:       <span class="quote">&#8220;<span class="quote">${RESTRICTED}</span>&#8221;</span>) will not have their distfiles
1.1       dsieger  6062:       mirrored.</p>
                   6063: </div>
                   6064: </div>
1.41      asau     6065: <div class="sect1">
1.1       dsieger  6066: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   6067: <a name="build.checksum"></a>19.6. The <span class="emphasis"><em>checksum</em></span> phase</h2></div></div></div>
1.1       dsieger  6068: <p>After the distfile(s) are fetched, their checksum is
                   6069:     generated and compared with the checksums stored in the
                   6070:     distinfo file. If the checksums don't match, the build is
                   6071:     aborted. This is to ensure the same distfile is used for
                   6072:     building, and that the distfile wasn't changed, e.g. by some
                   6073:     malign force, deliberately changed distfiles on the master
                   6074:     distribution site or network lossage.</p>
                   6075: </div>
1.41      asau     6076: <div class="sect1">
1.1       dsieger  6077: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   6078: <a name="build.extract"></a>19.7. The <span class="emphasis"><em>extract</em></span> phase</h2></div></div></div>
1.1       dsieger  6079: <p>When the distfiles are present on the local system, they
                   6080:     need to be extracted, as they usually come in the form of some
                   6081:     compressed archive format.</p>
                   6082: <p>By default, all <code class="varname">DISTFILES</code> are
                   6083:     extracted. If you only need some of them, you can set the
                   6084:     <code class="varname">EXTRACT_ONLY</code> variable to the list of those
                   6085:     files.</p>
                   6086: <p>Extracting the files is usually done by a little
                   6087:     program, <code class="filename">mk/extract/extract</code>, which
                   6088:     already knows how to extract various archive formats, so most
                   6089:     likely you will not need to change anything here. But if you
                   6090:     need, the following variables may help you:</p>
1.41      asau     6091: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  6092: <dt><span class="term"><code class="varname">EXTRACT_OPTS_{BIN,LHA,PAX,RAR,TAR,ZIP,ZOO}</code></span></dt>
                   6093: <dd><p>Use these variables to override the default
                   6094:       options for an extract command, which are defined in
                   6095:       <code class="filename">mk/extract/extract</code>.</p></dd>
                   6096: <dt><span class="term"><code class="varname">EXTRACT_USING</code></span></dt>
                   6097: <dd><p>This variable can be set to
1.14      jmcneill 6098:       <code class="literal">bsdtar</code>, <code class="literal">gtar</code>, <code class="literal">nbtar</code>
                   6099:       (which is the default value), <code class="literal">pax</code>, or an
1.1       dsieger  6100:       absolute pathname pointing to the command with which tar
1.14      jmcneill 6101:       archives should be extracted.  It is preferred to choose bsdtar over gtar
                   6102:       if NetBSD's pax-as-tar is not good enough.</p></dd>
1.1       dsieger  6103: </dl></div>
                   6104: <p>If the <code class="filename">extract</code> program doesn't
                   6105:     serve your needs, you can also override the
                   6106:     <code class="varname">EXTRACT_CMD</code> variable, which holds the
                   6107:     command used for extracting the files. This command is
                   6108:     executed in the <code class="filename">${WRKSRC}</code>
                   6109:     directory. During execution of this command, the shell
                   6110:     variable <code class="varname">extract_file</code> holds the absolute
                   6111:     pathname of the file that is going to be extracted.</p>
                   6112: <p>And if that still does not suffice, you can override the
                   6113:     <code class="varname">do-extract</code> target in the package
                   6114:     Makefile.</p>
                   6115: </div>
1.41      asau     6116: <div class="sect1">
1.1       dsieger  6117: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   6118: <a name="build.patch"></a>19.8. The <span class="emphasis"><em>patch</em></span> phase</h2></div></div></div>
1.1       dsieger  6119: <p>After extraction, all the patches named by the
                   6120:     <code class="varname">PATCHFILES</code>, those present in the patches
                   6121:     subdirectory of the package as well as in
                   6122:     $LOCALPATCHES/$PKGPATH (e.g.
                   6123:     <code class="filename">/usr/local/patches/graphics/png</code>) are
                   6124:     applied.  Patchfiles ending in <code class="filename">.Z</code> or
                   6125:     <code class="filename">.gz</code> are uncompressed before they are
                   6126:     applied, files ending in <code class="filename">.orig</code> or
                   6127:     <code class="filename">.rej</code> are ignored. Any special options to
1.157     leot     6128:     <a class="citerefentry" href="http://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   6129:     <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.157     leot     6130: <p>By default <a class="citerefentry" href="http://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  6131:     it fail if the patches apply with some lines of fuzz. Please
                   6132:     fix (regen) the patches so that they apply cleanly. The
                   6133:     rationale behind this is that patches that don't apply cleanly
                   6134:     may end up being applied in the wrong place, and cause severe
                   6135:     harm there.</p>
                   6136: </div>
1.41      asau     6137: <div class="sect1">
1.1       dsieger  6138: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   6139: <a name="build.tools"></a>19.9. The <span class="emphasis"><em>tools</em></span> phase</h2></div></div></div>
                   6140: <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  6141:     </p>
                   6142: </div>
1.41      asau     6143: <div class="sect1">
1.1       dsieger  6144: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   6145: <a name="build.wrapper"></a>19.10. The <span class="emphasis"><em>wrapper</em></span> phase</h2></div></div></div>
1.1       dsieger  6146: <p>This phase creates wrapper programs for the compilers and
                   6147:     linkers. The following variables can be used to tweak the
                   6148:     wrappers.</p>
1.41      asau     6149: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  6150: <dt><span class="term"><code class="varname">ECHO_WRAPPER_MSG</code></span></dt>
                   6151: <dd><p>The command used to print progress
                   6152:       messages. Does nothing by default. Set to
                   6153:       <code class="literal">${ECHO}</code> to see the progress
                   6154:       messages.</p></dd>
                   6155: <dt><span class="term"><code class="varname">WRAPPER_DEBUG</code></span></dt>
                   6156: <dd><p>This variable can be set to
                   6157:       <code class="literal">yes</code> (default) or <code class="literal">no</code>,
                   6158:       depending on whether you want additional information in the
                   6159:       wrapper log file.</p></dd>
                   6160: <dt><span class="term"><code class="varname">WRAPPER_UPDATE_CACHE</code></span></dt>
                   6161: <dd><p>This variable can be set to
                   6162:       <code class="literal">yes</code> or <code class="literal">no</code>, depending
                   6163:       on whether the wrapper should use its cache, which will
                   6164:       improve the speed. The default value is
                   6165:       <code class="literal">yes</code>, but is forced to
                   6166:       <code class="literal">no</code> if the platform does not support
                   6167:       it.</p></dd>
                   6168: <dt><span class="term"><code class="varname">WRAPPER_REORDER_CMDS</code></span></dt>
                   6169: <dd><p>A list of reordering commands. A reordering
                   6170:       command has the form
                   6171:       <code class="literal">reorder:l:<em class="replaceable"><code>lib1</code></em>:<em class="replaceable"><code>lib2</code></em></code>.
                   6172:       It ensures that that
                   6173:       <code class="literal">-l<em class="replaceable"><code>lib1</code></em></code> occurs
                   6174:       before <code class="literal">-l<em class="replaceable"><code>lib2</code></em></code>.
                   6175:       </p></dd>
                   6176: <dt><span class="term"><code class="varname">WRAPPER_TRANSFORM_CMDS</code></span></dt>
                   6177: <dd><p>A list of transformation commands. [TODO:
                   6178:       investigate further]</p></dd>
                   6179: </dl></div>
                   6180: </div>
1.41      asau     6181: <div class="sect1">
1.1       dsieger  6182: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   6183: <a name="build.configure"></a>19.11. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.1       dsieger  6184: <p>Most pieces of software need information on the header
                   6185:     files, system calls, and library routines which are available
                   6186:     on the platform they run on. The process of determining this
                   6187:     information is known as configuration, and is usually
                   6188:     automated. In most cases, a script is supplied with the
                   6189:     distfiles, and its invocation results in generation of header
                   6190:     files, Makefiles, etc.</p>
                   6191: <p>If the package contains a configure script, this can be
                   6192:     invoked by setting <code class="varname">HAS_CONFIGURE</code> to
1.23      wiz      6193:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. If the configure script is a GNU autoconf
1.1       dsieger  6194:     script, you should set <code class="varname">GNU_CONFIGURE</code> to
1.23      wiz      6195:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span> instead. What happens in the
1.1       dsieger  6196:     <span class="emphasis"><em>configure</em></span> phase is roughly:</p>
                   6197: <pre class="programlisting">
                   6198: .for d in ${CONFIGURE_DIRS}
                   6199:         cd ${WRKSRC} \
                   6200:         &amp;&amp; cd ${d} \
                   6201:         &amp;&amp; env ${CONFIGURE_ENV} ${CONFIGURE_SCRIPT} ${CONFIGURE_ARGS}
                   6202: .endfor
                   6203: </pre>
                   6204: <p><code class="varname">CONFIGURE_DIRS</code> (default:
1.23      wiz      6205:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span>) is a list of pathnames relative to
1.1       dsieger  6206:     <code class="varname">WRKSRC</code>. In each of these directories, the
                   6207:     configure script is run with the environment
                   6208:     <code class="varname">CONFIGURE_ENV</code> and arguments
                   6209:     <code class="varname">CONFIGURE_ARGS</code>. The variables
                   6210:     <code class="varname">CONFIGURE_ENV</code>,
                   6211:     <code class="varname">CONFIGURE_SCRIPT</code> (default:
1.23      wiz      6212:     <span class="quote">&#8220;<span class="quote">./configure</span>&#8221;</span>) and
1.1       dsieger  6213:     <code class="varname">CONFIGURE_ARGS</code> may all be changed by the
                   6214:     package.</p>
1.37      wiz      6215: <p>If the program uses the Perl way of configuration (mainly Perl
                   6216:     modules, but not only), i.e. a file called
                   6217:     <code class="filename">Makefile.PL</code>, it should include
                   6218:     <code class="filename">../../lang/perl5/module.mk</code>. To set any parameter for
                   6219:     <code class="filename">Makefile.PL</code> use the <code class="varname">MAKE_PARAMS</code>
                   6220:     variable (e.g., <code class="literal">MAKE_PARAMS+=foo=bar</code></p>
1.1       dsieger  6221: <p>If the program uses an <code class="filename">Imakefile</code>
                   6222:     for configuration, the appropriate steps can be invoked by
                   6223:     setting <code class="varname">USE_IMAKE</code> to
1.99      sevan    6224:     <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>.
                   6225:     You can add variables to xmkmf's environment by adding them to the
1.1       dsieger  6226:     <code class="varname">SCRIPTS_ENV</code> variable.</p>
1.11      rillig   6227: <p>If the program uses <code class="filename">cmake</code>
                   6228:     for configuration, the appropriate steps can be invoked by
1.23      wiz      6229:     setting <code class="varname">USE_CMAKE</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.
1.11      rillig   6230:     You can add variables to cmake's environment by adding them to the
                   6231:     <code class="varname">CONFIGURE_ENV</code> variable and arguments to cmake
                   6232:     by adding them to the <code class="varname">CMAKE_ARGS</code> variable.
                   6233:     The top directory argument is given by the
                   6234:     <code class="varname">CMAKE_ARG_PATH</code> variable, that defaults to
1.23      wiz      6235:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span> (relative to <code class="varname">CONFIGURE_DIRS</code>)</p>
1.1       dsieger  6236: <p>If there is no configure step at all, set
1.23      wiz      6237:     <code class="varname">NO_CONFIGURE</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.</p>
1.1       dsieger  6238: </div>
1.41      asau     6239: <div class="sect1">
1.1       dsieger  6240: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   6241: <a name="build.build"></a>19.12. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.1       dsieger  6242: <p>For building a package, a rough equivalent of the
                   6243:     following code is executed.</p>
                   6244: <pre class="programlisting">
                   6245: .for d in ${BUILD_DIRS}
                   6246:         cd ${WRKSRC} \
                   6247:         &amp;&amp; cd ${d} \
                   6248:         &amp;&amp; env ${MAKE_ENV} \
                   6249:             ${MAKE_PROGRAM} ${BUILD_MAKE_FLAGS} \
                   6250:                 -f ${MAKE_FILE} \
                   6251:                 ${BUILD_TARGET}
                   6252: .endfor
                   6253: </pre>
                   6254: <p><code class="varname">BUILD_DIRS</code> (default:
1.23      wiz      6255:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span>) is a list of pathnames relative to
1.1       dsieger  6256:     <code class="varname">WRKSRC</code>. In each of these directories,
                   6257:     <code class="varname">MAKE_PROGRAM</code> is run with the environment
                   6258:     <code class="varname">MAKE_ENV</code> and arguments
                   6259:     <code class="varname">BUILD_MAKE_FLAGS</code>. The variables
                   6260:     <code class="varname">MAKE_ENV</code>,
                   6261:     <code class="varname">BUILD_MAKE_FLAGS</code>,
                   6262:     <code class="varname">MAKE_FILE</code> and
                   6263:     <code class="varname">BUILD_TARGET</code> may all be changed by the
                   6264:     package.</p>
                   6265: <p>The default value of <code class="varname">MAKE_PROGRAM</code> is
1.23      wiz      6266:     <span class="quote">&#8220;<span class="quote">gmake</span>&#8221;</span> if <code class="varname">USE_TOOLS</code> contains
                   6267:     <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  6268:     default value of <code class="varname">MAKE_FILE</code> is
1.23      wiz      6269:     <span class="quote">&#8220;<span class="quote">Makefile</span>&#8221;</span>, and <code class="varname">BUILD_TARGET</code>
                   6270:     defaults to <span class="quote">&#8220;<span class="quote">all</span>&#8221;</span>.</p>
1.1       dsieger  6271: <p>If there is no build step at all, set
1.23      wiz      6272:     <code class="varname">NO_BUILD</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.</p>
1.1       dsieger  6273: </div>
1.41      asau     6274: <div class="sect1">
1.1       dsieger  6275: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   6276: <a name="build.test"></a>19.13. The <span class="emphasis"><em>test</em></span> phase</h2></div></div></div>
1.1       dsieger  6277: <p>[TODO]</p>
                   6278: </div>
1.41      asau     6279: <div class="sect1">
1.1       dsieger  6280: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   6281: <a name="build.install"></a>19.14. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.1       dsieger  6282: <p>Once the build stage has completed, the final step is to
                   6283:     install the software in public directories, so users can
                   6284:     access the programs and files.</p>
                   6285: <p>In the <span class="emphasis"><em>install</em></span> phase, a rough
                   6286:     equivalent of the following code is executed. Additionally,
                   6287:     before and after this code, much magic is performed to do
                   6288:     consistency checks, registering the package, and so on.</p>
                   6289: <pre class="programlisting">
                   6290: .for d in ${INSTALL_DIRS}
                   6291:         cd ${WRKSRC} \
                   6292:         &amp;&amp; cd ${d} \
                   6293:         &amp;&amp; env ${MAKE_ENV} \
                   6294:             ${MAKE_PROGRAM} ${INSTALL_MAKE_FLAGS} \
                   6295:                 -f ${MAKE_FILE} \
                   6296:                 ${INSTALL_TARGET}
                   6297: .endfor
                   6298: </pre>
                   6299: <p>The variable's meanings are analogous to the ones in the
                   6300:     <span class="emphasis"><em>build</em></span> phase.
                   6301:     <code class="varname">INSTALL_DIRS</code> defaults to
                   6302:     <code class="varname">BUILD_DIRS</code>. <code class="varname">INSTALL_TARGET</code>
1.23      wiz      6303:     is <span class="quote">&#8220;<span class="quote">install</span>&#8221;</span> by default, plus
                   6304:     <span class="quote">&#8220;<span class="quote">install.man</span>&#8221;</span> if <code class="varname">USE_IMAKE</code> is
1.1       dsieger  6305:     defined and <code class="varname">NO_INSTALL_MANPAGES</code> is not
                   6306:     defined.</p>
                   6307: <p>In the <span class="emphasis"><em>install</em></span> phase, the following
                   6308:     variables are useful. They are all variations of the
1.157     leot     6309:     <a class="citerefentry" href="http://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  6310:     permissions preset. <code class="varname">INSTALL</code> is the plain
                   6311:     install command. The specialized variants, together with their
                   6312:     intended use, are:</p>
1.41      asau     6313: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  6314: <dt><span class="term"><code class="varname">INSTALL_PROGRAM_DIR</code></span></dt>
                   6315: <dd><p>directories that contain
                   6316:       binaries</p></dd>
                   6317: <dt><span class="term"><code class="varname">INSTALL_SCRIPT_DIR</code></span></dt>
                   6318: <dd><p>directories that contain
                   6319:       scripts</p></dd>
                   6320: <dt><span class="term"><code class="varname">INSTALL_LIB_DIR</code></span></dt>
                   6321: <dd><p>directories that contain shared and static
                   6322:       libraries</p></dd>
                   6323: <dt><span class="term"><code class="varname">INSTALL_DATA_DIR</code></span></dt>
                   6324: <dd><p>directories that contain data
                   6325:       files</p></dd>
                   6326: <dt><span class="term"><code class="varname">INSTALL_MAN_DIR</code></span></dt>
                   6327: <dd><p>directories that contain man
                   6328:       pages</p></dd>
1.100     leot     6329: <dt><span class="term"><code class="varname">INSTALL_GAME_DIR</code></span></dt>
                   6330: <dd><p>directories that contain data files for games
                   6331:       </p></dd>
1.1       dsieger  6332: <dt><span class="term"><code class="varname">INSTALL_PROGRAM</code></span></dt>
                   6333: <dd><p>binaries that can be stripped from debugging
                   6334:       symbols</p></dd>
                   6335: <dt><span class="term"><code class="varname">INSTALL_SCRIPT</code></span></dt>
                   6336: <dd><p>binaries that cannot be
                   6337:       stripped</p></dd>
                   6338: <dt><span class="term"><code class="varname">INSTALL_GAME</code></span></dt>
                   6339: <dd><p>game
                   6340:       binaries</p></dd>
                   6341: <dt><span class="term"><code class="varname">INSTALL_LIB</code></span></dt>
                   6342: <dd><p>shared and static
                   6343:       libraries</p></dd>
                   6344: <dt><span class="term"><code class="varname">INSTALL_DATA</code></span></dt>
                   6345: <dd><p>data files</p></dd>
                   6346: <dt><span class="term"><code class="varname">INSTALL_GAME_DATA</code></span></dt>
                   6347: <dd><p>data files for
                   6348:       games</p></dd>
                   6349: <dt><span class="term"><code class="varname">INSTALL_MAN</code></span></dt>
                   6350: <dd><p>man pages</p></dd>
                   6351: </dl></div>
                   6352: <p>Some other variables are:</p>
1.41      asau     6353: <div class="variablelist"><dl class="variablelist">
1.106     tnn      6354: <dt><span class="term"><code class="varname">INSTALL_UNSTRIPPED</code></span></dt>
1.157     leot     6355: <dd><p>If set to <code class="literal">yes</code>, do not run <a class="citerefentry" href="http://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      6356:       when installing binaries. Any debugging sections and symbols present in
                   6357:       binaries will be preserved.
                   6358:       </p></dd>
1.1       dsieger  6359: <dt><span class="term"><code class="varname">INSTALLATION_DIRS</code></span></dt>
                   6360: <dd><p>A list of directories relative to
                   6361:       <code class="varname">PREFIX</code> that are created by pkgsrc at the
                   6362:       beginning of the <span class="emphasis"><em>install</em></span> phase.
                   6363:       The package is supposed to create all needed directories itself
                   6364:       before installing files to it and list all other directories here.
                   6365:       </p></dd>
                   6366: </dl></div>
                   6367: <p>In the rare cases that a package shouldn't install anything,
1.23      wiz      6368:     set <code class="varname">NO_INSTALL</code> to <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. This is
1.1       dsieger  6369:     mostly relevant for packages in the <code class="filename">regress</code>
                   6370:     category.</p>
                   6371: </div>
1.41      asau     6372: <div class="sect1">
1.1       dsieger  6373: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   6374: <a name="build.package"></a>19.15. The <span class="emphasis"><em>package</em></span> phase</h2></div></div></div>
1.1       dsieger  6375: <p>Once the install stage has completed, a binary package of
                   6376:     the installed files can be built.  These binary packages can be
                   6377:     used for quick installation without previous compilation, e.g. by
1.10      hubertf  6378:     the <span class="command"><strong>make bin-install</strong></span> or by using
                   6379:     <span class="command"><strong>pkg_add</strong></span>.</p>
1.1       dsieger  6380: <p>By default, the binary packages are created in
                   6381:     <code class="filename">${PACKAGES}/All</code> and symlinks are created in
                   6382:     <code class="filename">${PACKAGES}/<em class="replaceable"><code>category</code></em></code>,
                   6383:     one for each category in the <code class="varname">CATEGORIES</code>
                   6384:     variable.  <code class="varname">PACKAGES</code> defaults to
                   6385:     <code class="filename">pkgsrc/packages</code>.</p>
                   6386: </div>
1.41      asau     6387: <div class="sect1">
1.1       dsieger  6388: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   6389: <a name="build.clean"></a>19.16. Cleaning up</h2></div></div></div>
1.1       dsieger  6390: <p>Once you're finished with a package, you can clean the work
1.10      hubertf  6391:     directory by running <span class="command"><strong>make clean</strong></span>.  If you want
1.1       dsieger  6392:     to clean the work directories of all dependencies too, use
1.10      hubertf  6393:     <span class="command"><strong>make clean-depends</strong></span>.</p>
1.1       dsieger  6394: </div>
1.41      asau     6395: <div class="sect1">
1.1       dsieger  6396: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   6397: <a name="build.helpful-targets"></a>19.17. Other helpful targets</h2></div></div></div>
1.41      asau     6398: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  6399: <dt><span class="term">pre/post-*</span></dt>
                   6400: <dd><p>For any of the main targets described in the
                   6401:          previous section, two auxiliary targets exist with
1.23      wiz      6402:          <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  6403:          prefix for the main target's name.  These targets are
                   6404:          invoked before and after the main target is called,
                   6405:          allowing extra configuration or installation steps be
                   6406:          performed from a package's Makefile, for example, which
                   6407:          a program's configure script or install target
                   6408:          omitted.</p></dd>
                   6409: <dt><span class="term">do-*</span></dt>
                   6410: <dd><p>Should one of the main targets do the wrong thing,
                   6411:          and should there be no variable to fix this, you can
                   6412:          redefine it with the do-* target.  (Note that redefining
                   6413:          the target itself instead of the do-* target is a bad
                   6414:          idea, as the pre-* and post-* targets won't be called
                   6415:          anymore, etc.) You will not usually need to do
                   6416:          this.</p></dd>
                   6417: <dt><span class="term">reinstall</span></dt>
                   6418: <dd>
1.10      hubertf  6419: <p>If you did a <span class="command"><strong>make install</strong></span> and
1.1       dsieger  6420:          you noticed some file was not installed properly, you
                   6421:          can repeat the installation with this target, which will
1.23      wiz      6422:          ignore the <span class="quote">&#8220;<span class="quote">already installed</span>&#8221;</span> flag.</p>
1.1       dsieger  6423: <p>This is the default value of
                   6424:          <code class="varname">DEPENDS_TARGET</code> except in the case of
1.10      hubertf  6425:          <span class="command"><strong>make update</strong></span> and <span class="command"><strong>make
1.1       dsieger  6426:          package</strong></span>, where the defaults are
1.23      wiz      6427:          <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  6428:          respectively.</p>
                   6429: </dd>
                   6430: <dt><span class="term">deinstall</span></dt>
                   6431: <dd>
1.157     leot     6432: <p>This target does a <a class="citerefentry" href="http://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  6433:          current directory, effectively de-installing the
                   6434:          package. The following variables can be used to tune the
                   6435:          behaviour:</p>
1.41      asau     6436: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  6437: <dt><span class="term"><code class="varname">PKG_VERBOSE</code></span></dt>
1.157     leot     6438: <dd><p>Add a "-v" to the <a class="citerefentry" href="http://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  6439: <dt><span class="term"><code class="varname">DEINSTALLDEPENDS</code></span></dt>
                   6440: <dd><p>Remove all packages that require (depend on)
                   6441:                the given package.  This can be used to remove any
                   6442:                packages that may have been pulled in by a given
1.10      hubertf  6443:                package, e.g. if <span class="command"><strong>make deinstall
1.1       dsieger  6444:                DEINSTALLDEPENDS=1</strong></span> is done in
                   6445:                <code class="filename">pkgsrc/x11/kde</code>, this is
                   6446:                likely to remove whole KDE. Works by adding
1.157     leot     6447:                <span class="quote">&#8220;<span class="quote">-R</span>&#8221;</span> to the <a class="citerefentry" href="http://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  6448:                command line.</p></dd>
                   6449: </dl></div>
                   6450: </dd>
                   6451: <dt><span class="term">bin-install</span></dt>
                   6452: <dd><p>Install a binary package from local disk and via FTP
                   6453:          from a list of sites (see the
                   6454:          <code class="varname">BINPKG_SITES</code> variable), and do a
1.10      hubertf  6455:          <span class="command"><strong>make package</strong></span> if no binary package is
1.1       dsieger  6456:          available anywhere.  The arguments given to
1.10      hubertf  6457:          <span class="command"><strong>pkg_add</strong></span> can be set via
1.1       dsieger  6458:          <code class="varname">BIN_INSTALL_FLAGS</code> e.g., to do verbose
                   6459:          operation, etc.</p></dd>
1.95      wiz      6460: <dt><span class="term">install-clean</span></dt>
                   6461: <dd><p>This target removes the state files for the "install" and later
                   6462:          phases so that the "install" target may be re-invoked. This can be
                   6463:          used after editing the PLIST to install the package without
                   6464:          rebuilding it.</p></dd>
                   6465: <dt><span class="term">build-clean</span></dt>
                   6466: <dd><p>This target removes the state files for the "build" and later
                   6467:          phases so that the "build" target may be re-invoked.</p></dd>
1.1       dsieger  6468: <dt><span class="term">update</span></dt>
                   6469: <dd>
                   6470: <p>This target causes the current package to be
                   6471:          updated to the latest version.  The package and all
                   6472:          depending packages first get de-installed, then current
                   6473:          versions of the corresponding packages get compiled and
                   6474:          installed.  This is similar to manually noting which
                   6475:          packages are currently installed, then performing a
1.10      hubertf  6476:          series of <span class="command"><strong>make deinstall</strong></span> and
                   6477:          <span class="command"><strong>make install</strong></span> (or whatever
1.1       dsieger  6478:          <code class="varname">UPDATE_TARGET</code> is set to) for these
                   6479:          packages.</p>
1.23      wiz      6480: <p>You can use the <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> target to
1.10      hubertf  6481:          resume package updating in case a previous <span class="command"><strong>make
1.1       dsieger  6482:          update</strong></span> was interrupted for some reason.
                   6483:          However, in this case, make sure you don't call
1.10      hubertf  6484:          <span class="command"><strong>make clean</strong></span> or otherwise remove the
1.1       dsieger  6485:          list of dependent packages in <code class="varname">WRKDIR</code>.
                   6486:          Otherwise, you lose the ability to automatically update
                   6487:          the current package along with the dependent packages
                   6488:          you have installed.</p>
1.10      hubertf  6489: <p>Resuming an interrupted <span class="command"><strong>make
1.1       dsieger  6490:          update</strong></span> will only work as long as the package
                   6491:          tree remains unchanged.  If the source code for one of
                   6492:          the packages to be updated has been changed, resuming
1.10      hubertf  6493:          <span class="command"><strong>make update</strong></span> will most certainly
1.1       dsieger  6494:          fail!</p>
                   6495: <p>The following variables can be used either on the
1.10      hubertf  6496:          command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
                   6497:          alter the behaviour of <span class="command"><strong>make
1.1       dsieger  6498:          update</strong></span>:</p>
1.41      asau     6499: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  6500: <dt><span class="term"><code class="varname">UPDATE_TARGET</code></span></dt>
                   6501: <dd><p>Install target to recursively use for the
                   6502:                updated package and the dependent packages.
                   6503:                Defaults to <code class="varname">DEPENDS_TARGET</code> if
1.23      wiz      6504:                set, <span class="quote">&#8220;<span class="quote">install</span>&#8221;</span> otherwise for
1.10      hubertf  6505:                <span class="command"><strong>make update</strong></span>.  Other good
1.23      wiz      6506:                targets are <span class="quote">&#8220;<span class="quote">package</span>&#8221;</span> or
                   6507:                <span class="quote">&#8220;<span class="quote">bin-install</span>&#8221;</span>.  Do not set this to
                   6508:                <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> or you will get stuck in an
1.1       dsieger  6509:                endless loop!</p></dd>
                   6510: <dt><span class="term"><code class="varname">NOCLEAN</code></span></dt>
                   6511: <dd><p>Don't clean up after updating.  Useful if
                   6512:                you want to leave the work sources of the updated
                   6513:                packages around for inspection or other purposes.
                   6514:                Be sure you eventually clean up the source tree
1.23      wiz      6515:                (see the <span class="quote">&#8220;<span class="quote">clean-update</span>&#8221;</span> target below)
1.1       dsieger  6516:                or you may run into troubles with old source code
                   6517:                still lying around on your next
1.10      hubertf  6518:                <span class="command"><strong>make</strong></span> or <span class="command"><strong>make
1.1       dsieger  6519:                update</strong></span>.</p></dd>
                   6520: <dt><span class="term"><code class="varname">REINSTALL</code></span></dt>
                   6521: <dd><p>Deinstall each package before installing
                   6522:                (making <code class="varname">DEPENDS_TARGET</code>). This
                   6523:                may be necessary if the
1.23      wiz      6524:                <span class="quote">&#8220;<span class="quote">clean-update</span>&#8221;</span> target (see below) was
1.10      hubertf  6525:                called after interrupting a running <span class="command"><strong>make
1.1       dsieger  6526:                update</strong></span>.</p></dd>
                   6527: <dt><span class="term"><code class="varname">DEPENDS_TARGET</code></span></dt>
                   6528: <dd><p>Allows you to disable recursion and hardcode
                   6529:                the target for packages.  The default is
1.23      wiz      6530:                <span class="quote">&#8220;<span class="quote">update</span>&#8221;</span> for the update target,
1.1       dsieger  6531:                facilitating a recursive update of prerequisite
                   6532:                packages.  Only set
                   6533:                <code class="varname">DEPENDS_TARGET</code> if you want to
                   6534:                disable recursive updates. Use
                   6535:                <code class="varname">UPDATE_TARGET</code> instead to just
                   6536:                set a specific target for each package to be
1.10      hubertf  6537:                installed during <span class="command"><strong>make update</strong></span>
1.1       dsieger  6538:                (see above).</p></dd>
                   6539: </dl></div>
                   6540: </dd>
                   6541: <dt><span class="term">clean-update</span></dt>
                   6542: <dd>
                   6543: <p>Clean the source tree for all packages that would
1.10      hubertf  6544:          get updated if <span class="command"><strong>make update</strong></span> was called
1.1       dsieger  6545:          from the current directory.  This target should not be
                   6546:          used if the current package (or any of its depending
                   6547:          packages) have already been de-installed (e.g., after
1.10      hubertf  6548:          calling <span class="command"><strong>make update</strong></span>) or you may lose
1.1       dsieger  6549:          some packages you intended to update. As a rule of
                   6550:          thumb: only use this target <span class="emphasis"><em>before</em></span>
1.10      hubertf  6551:          the first time you run <span class="command"><strong>make update</strong></span>
1.1       dsieger  6552:          and only if you have a dirty package tree (e.g., if you
                   6553:          used <code class="varname">NOCLEAN</code>).</p>
                   6554: <p>If you are unsure about whether your tree is
1.10      hubertf  6555:          clean, you can either perform a <span class="command"><strong>make
1.1       dsieger  6556:          clean</strong></span> at the top of the tree, or use the
                   6557:          following sequence of commands from the directory of the
                   6558:          package you want to update (<span class="emphasis"><em>before</em></span>
1.10      hubertf  6559:          running <span class="command"><strong>make update</strong></span> for the first
1.1       dsieger  6560:          time, otherwise you lose all the packages you wanted to
                   6561:          update!):</p>
                   6562: <pre class="screen">
                   6563: <code class="prompt">#</code> <strong class="userinput"><code>make clean-update</code></strong>
                   6564: <code class="prompt">#</code> <strong class="userinput"><code>make clean CLEANDEPENDS=YES</code></strong>
                   6565: <code class="prompt">#</code> <strong class="userinput"><code>make update</code></strong>
                   6566:          </pre>
                   6567: <p>The following variables can be used either on the
1.10      hubertf  6568:          command line or in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to alter the behaviour of
                   6569:          <span class="command"><strong>make clean-update</strong></span>:</p>
1.41      asau     6570: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  6571: <dt><span class="term"><code class="varname">CLEAR_DIRLIST</code></span></dt>
1.10      hubertf  6572: <dd><p>After <span class="command"><strong>make clean</strong></span>, do not
1.1       dsieger  6573:                reconstruct the list of directories to update for
1.10      hubertf  6574:                this package.  Only use this if <span class="command"><strong>make
1.1       dsieger  6575:                update</strong></span> successfully installed all
                   6576:                packages you wanted to update.  Normally, this is
1.10      hubertf  6577:                done automatically on <span class="command"><strong>make
1.1       dsieger  6578:                update</strong></span>, but may have been suppressed by
                   6579:                the <code class="varname">NOCLEAN</code> variable (see
                   6580:                above).</p></dd>
                   6581: </dl></div>
                   6582: </dd>
                   6583: <dt><span class="term">replace</span></dt>
                   6584: <dd>
                   6585: <p>Update the installation of the current package.  This
                   6586:          differs from update in that it does not replace dependent
1.137     leot     6587:          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  6588:          target to work.</p>
                   6589: <p><span class="emphasis"><em>Be careful when using this
                   6590:          target!</em></span> There are no guarantees that dependent
                   6591:          packages will still work, in particular they will most
1.10      hubertf  6592:          certainly break if you <span class="command"><strong>make replace</strong></span> a
1.1       dsieger  6593:          library package whose shared library major version changed
                   6594:          between your installed version and the new one.  For this
                   6595:          reason, this target is not officially supported and only
                   6596:          recommended for advanced users.</p>
                   6597: </dd>
                   6598: <dt><span class="term">info</span></dt>
1.157     leot     6599: <dd><p>This target invokes <a class="citerefentry" href="http://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  6600:          package. You can use this to check which version of a
                   6601:          package is installed.</p></dd>
                   6602: <dt><span class="term">index</span></dt>
                   6603: <dd>
                   6604: <p>This is a top-level command, i.e. it should be used in
                   6605:          the <code class="filename">pkgsrc</code> directory.  It creates a
                   6606:          database of all packages in the local pkgsrc tree, including
                   6607:          dependencies, comment, maintainer, and some other useful
                   6608:          information.  Individual entries are created by running
1.10      hubertf  6609:          <span class="command"><strong>make describe</strong></span> in the packages'
1.1       dsieger  6610:          directories.  This index file is saved as
                   6611:          <code class="filename">pkgsrc/INDEX</code>.  It can be displayed in
1.10      hubertf  6612:          verbose format by running <span class="command"><strong>make
1.1       dsieger  6613:          print-index</strong></span>.  You can search in it with
1.10      hubertf  6614:          <span class="command"><strong>make search
1.1       dsieger  6615:          key=<em class="replaceable"><code>something</code></em></strong></span>.  You can
                   6616:          extract a list of all packages that depend on a particular
1.10      hubertf  6617:          one by running <span class="command"><strong>make show-deps
1.1       dsieger  6618:          PKG=<em class="replaceable"><code>somepackage</code></em></strong></span>.</p>
                   6619: <p>Running this command takes a very long time, some
                   6620:          hours even on fast machines!</p>
                   6621: </dd>
                   6622: <dt><span class="term">readme</span></dt>
                   6623: <dd>
                   6624: <p>This target generates a
                   6625:          <code class="filename">README.html</code> file, which can be
1.137     leot     6626:          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  6627:          contain references to any packages which are in the
                   6628:          <code class="varname">PACKAGES</code> directory on the local
                   6629:          host. The generated files can be made to refer to URLs
                   6630:          based on <code class="varname">FTP_PKG_URL_HOST</code> and
                   6631:          <code class="varname">FTP_PKG_URL_DIR</code>. For example, if I
                   6632:          wanted to generate <code class="filename">README.html</code>
                   6633:          files which pointed to binary packages on the local
                   6634:          machine, in the directory
                   6635:          <code class="filename">/usr/packages</code>, set
                   6636:          <code class="varname">FTP_PKG_URL_HOST=file://localhost</code> and
                   6637:          <code class="varname">FTP_PKG_URL_DIR=/usr/packages</code>. The
                   6638:          <code class="varname">${PACKAGES}</code> directory and its
                   6639:          subdirectories will be searched for all the binary
                   6640:          packages.</p>
                   6641: <p>The target can be run at the toplevel or in category
                   6642:          directories, in which case it descends recursively.</p>
                   6643: </dd>
                   6644: <dt><span class="term">readme-all</span></dt>
                   6645: <dd><p>This is a top-level command, run it in
                   6646:          <code class="filename">pkgsrc</code>.  Use this target to create a
                   6647:          file <code class="filename">README-all.html</code> which contains a
                   6648:          list of all packages currently available in the NetBSD
                   6649:          Packages Collection, together with the category they belong
                   6650:          to and a short description. This file is compiled from the
                   6651:          <code class="filename">pkgsrc/*/README.html</code> files, so be sure
1.10      hubertf  6652:          to run this <span class="emphasis"><em>after</em></span> a <span class="command"><strong>make
1.1       dsieger  6653:          readme</strong></span>.</p></dd>
                   6654: <dt><span class="term">cdrom-readme</span></dt>
                   6655: <dd><p>This is very much the same as the
1.23      wiz      6656:          <span class="quote">&#8220;<span class="quote">readme</span>&#8221;</span> target (see above), but is to be
1.1       dsieger  6657:          used when generating a pkgsrc tree to be written to a
                   6658:          CD-ROM.  This target also produces
                   6659:          <code class="filename">README.html</code> files, and can be made
                   6660:          to refer to URLs based on
                   6661:          <code class="varname">CDROM_PKG_URL_HOST</code> and
                   6662:          <code class="varname">CDROM_PKG_URL_DIR</code>.</p></dd>
                   6663: <dt><span class="term">show-distfiles</span></dt>
                   6664: <dd><p>This target shows which distfiles and patchfiles
                   6665:          are needed to build the package
                   6666:          (<code class="varname">ALLFILES</code>, which contains all
                   6667:          <code class="varname">DISTFILES</code> and
                   6668:          <code class="varname">PATCHFILES</code>, but not
                   6669:          <code class="filename">patches/*</code>).</p></dd>
                   6670: <dt><span class="term">show-downlevel</span></dt>
                   6671: <dd><p>This target shows nothing if the package is not
                   6672:          installed. If a version of this package is installed,
                   6673:          but is not the version provided in this version of
                   6674:          pkgsrc, then a warning message is displayed. This target
                   6675:          can be used to show which of your installed packages are
                   6676:          downlevel, and so the old versions can be deleted, and
                   6677:          the current ones added.</p></dd>
                   6678: <dt><span class="term">show-pkgsrc-dir</span></dt>
                   6679: <dd><p>This target shows the directory in the pkgsrc
                   6680:          hierarchy from which the package can be built and
                   6681:          installed. This may not be the same directory as the one
                   6682:          from which the package was installed. This target is
                   6683:          intended to be used by people who may wish to upgrade
                   6684:          many packages on a single host, and can be invoked from
                   6685:          the top-level pkgsrc Makefile by using the
1.23      wiz      6686:          <span class="quote">&#8220;<span class="quote">show-host-specific-pkgs</span>&#8221;</span> target.</p></dd>
1.1       dsieger  6687: <dt><span class="term">show-installed-depends</span></dt>
                   6688: <dd><p>This target shows which installed packages match
                   6689:          the current package's <code class="varname">DEPENDS</code>. Useful
                   6690:          if out of date dependencies are causing build
                   6691:          problems.</p></dd>
1.95      wiz      6692: <dt><span class="term">print-build-depends-list</span></dt>
                   6693: <dd><p>This target shows the list of packages that the current package
                   6694:            depends on for building.</p></dd>
                   6695: <dt><span class="term">print-run-depends-list</span></dt>
                   6696: <dd><p>This target shows the list of packages that the current package
                   6697:            depends on for running.</p></dd>
1.1       dsieger  6698: <dt><span class="term">check-shlibs</span></dt>
                   6699: <dd><p>After a package is installed, check all its
                   6700:          binaries and (on ELF platforms) shared libraries to see
                   6701:          if they find the shared libs they need.  Run by default
1.10      hubertf  6702:          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  6703: <dt><span class="term">print-PLIST</span></dt>
                   6704: <dd>
1.23      wiz      6705: <p>After a <span class="quote">&#8220;<span class="quote">make install</span>&#8221;</span> from a new or
1.1       dsieger  6706:          upgraded pkg, this prints out an attempt to generate a
1.10      hubertf  6707:          new <code class="filename">PLIST</code> from a <span class="command"><strong>find
1.1       dsieger  6708:          -newer work/.extract_done</strong></span>.  An attempt is made
                   6709:          to care for shared libs etc., but it is
                   6710:          <span class="emphasis"><em>strongly</em></span> recommended to review the
                   6711:          result before putting it into
                   6712:          <code class="filename">PLIST</code>. On upgrades, it's useful to
                   6713:          diff the output of this command against an already
                   6714:          existing <code class="filename">PLIST</code> file.</p>
1.157     leot     6715: <p>If the package installs files via <a class="citerefentry" href="http://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  6716:          other methods that don't update file access times, be
                   6717:          sure to add these files manually to your
1.23      wiz      6718:          <code class="filename">PLIST</code>, as the <span class="quote">&#8220;<span class="quote">find
                   6719:          -newer</span>&#8221;</span> command used by this target won't catch
1.1       dsieger  6720:          them!</p>
1.154     rillig   6721: <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  6722:          information on this target.</p>
                   6723: </dd>
                   6724: <dt><span class="term">bulk-package</span></dt>
                   6725: <dd>
                   6726: <p>Used to do bulk builds. If an appropriate binary
                   6727:          package already exists, no action is taken. If not, this
                   6728:          target will compile, install and package it (and its
                   6729:          depends, if <code class="varname">PKG_DEPENDS</code> is set
1.154     rillig   6730:          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     6731: builds)</i></a>).
1.1       dsieger  6732:          After creating the binary package, the sources, the
                   6733:          just-installed package and its required packages are
                   6734:          removed, preserving free disk space.</p>
                   6735: <p><span class="emphasis"><em>Beware that this target may deinstall
                   6736:          all packages installed on a system!</em></span></p>
                   6737: </dd>
                   6738: <dt><span class="term">bulk-install</span></dt>
                   6739: <dd>
                   6740: <p>Used during bulk-installs to install required
                   6741:          packages. If an up-to-date binary package is available,
1.157     leot     6742:          it will be installed via <a class="citerefentry" href="http://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  6743:          <span class="command"><strong>make bulk-package</strong></span> will be executed,
1.1       dsieger  6744:          but the installed binary won't be removed.</p>
                   6745: <p>A binary package is considered
1.23      wiz      6746:          <span class="quote">&#8220;<span class="quote">up-to-date</span>&#8221;</span> to be installed via
1.157     leot     6747:          <a class="citerefentry" href="http://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     6748: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      6749: <li class="listitem"><p>None of the package's files
1.1       dsieger  6750:              (<code class="filename">Makefile</code>, ...) were modified
                   6751:              since it was built.</p></li>
1.23      wiz      6752: <li class="listitem"><p>None of the package's required (binary)
1.1       dsieger  6753:              packages were modified since it was built.</p></li>
                   6754: </ul></div>
                   6755: <p><span class="emphasis"><em>Beware that this target may deinstall
                   6756:          all packages installed on a system!</em></span></p>
                   6757: </dd>
                   6758: </dl></div>
                   6759: </div>
                   6760: </div>
1.41      asau     6761: <div class="chapter">
1.1       dsieger  6762: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   6763: <a name="tools"></a>Chapter 20. Tools needed for building or running</h2></div></div></div>
1.1       dsieger  6764: <div class="toc">
                   6765: <p><b>Table of Contents</b></p>
1.100     leot     6766: <dl class="toc">
1.154     rillig   6767: <dt><span class="sect1"><a href="#pkgsrc-tools">20.1. Tools for pkgsrc builds</a></span></dt>
                   6768: <dt><span class="sect1"><a href="#package-tools">20.2. Tools needed by packages</a></span></dt>
                   6769: <dt><span class="sect1"><a href="#platform-tools">20.3. Tools provided by platforms</a></span></dt>
1.1       dsieger  6770: </dl>
                   6771: </div>
                   6772: <p>The <code class="varname">USE_TOOLS</code> definition is used both internally
                   6773: by pkgsrc and also for individual packages to define what commands
1.156     leot     6774: are needed for building a package (like <code class="varname">TOOL_DEPENDS</code>)
1.1       dsieger  6775: or for later run-time of an installed packaged (such as
                   6776: <code class="varname">DEPENDS</code>).
                   6777: If the native system provides an adequate tool, then in many cases, a pkgsrc
                   6778: package will not be used.</p>
                   6779: <p>When building a package, the replacement tools are
                   6780: made available in a directory (as symlinks or wrapper scripts)
                   6781: that is early in the executable search path. Just like the buildlink
                   6782: system, this helps with consistent builds.</p>
                   6783: <p>A tool may be needed to help build a specific package. For example,
                   6784: perl, GNU make (gmake) or yacc may be needed.</p>
                   6785: <p>Also a tool may be needed, for example, because the native system's supplied
                   6786: tool may be inefficient for building a package with pkgsrc.
                   6787: For example, a package may need GNU awk, bison (instead of
                   6788: yacc) or a better sed.</p>
                   6789: <p>The tools used by a package can be listed by running
1.10      hubertf  6790: <span class="command"><strong>make show-tools</strong></span>.</p>
1.41      asau     6791: <div class="sect1">
1.1       dsieger  6792: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   6793: <a name="pkgsrc-tools"></a>20.1. Tools for pkgsrc builds</h2></div></div></div>
1.1       dsieger  6794: <p>The default set of tools used by pkgsrc is defined in
                   6795: <code class="filename">bsd.pkg.mk</code>. This includes standard Unix tools,
1.10      hubertf  6796: such as: <span class="command"><strong>cat</strong></span>, <span class="command"><strong>awk</strong></span>,
                   6797: <span class="command"><strong>chmod</strong></span>, <span class="command"><strong>test</strong></span>, and so on.
1.1       dsieger  6798: These can be seen by running:
1.10      hubertf  6799: <span class="command"><strong>make show-var VARNAME=USE_TOOLS</strong></span>.</p>
1.1       dsieger  6800: <p>If a package needs a specific program to build
                   6801: then the <code class="varname">USE_TOOLS</code> variable can be used
                   6802: to define the tools needed.</p>
                   6803: </div>
1.41      asau     6804: <div class="sect1">
1.1       dsieger  6805: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   6806: <a name="package-tools"></a>20.2. Tools needed by packages</h2></div></div></div>
1.28      wiz      6807: <p>In the following examples, the :run means that it is needed at
                   6808: run-time (and becomes a DEPENDS).
1.1       dsieger  6809: The default is a build dependency which can be set with
                   6810: :build. (So in this example, it is the same as gmake:build
                   6811: and pkg-config:build.)</p>
                   6812: <pre class="programlisting">
                   6813: USE_TOOLS+=     gmake perl:run pkg-config
                   6814: </pre>
                   6815: <p>When using the tools framework, a
                   6816: <code class="varname">TOOLS_PATH.foo</code> variable is defined
                   6817: which contains the full path to the appropriate tool. For example,
1.23      wiz      6818: <code class="varname">TOOLS_PATH.bash</code> could be <span class="quote">&#8220;<span class="quote">/bin/bash</span>&#8221;</span>
1.1       dsieger  6819: on Linux systems.</p>
                   6820: <p>If you always need a pkgsrc version of the
                   6821: tool at run-time, then just use <code class="varname">DEPENDS</code> instead.
                   6822: </p>
                   6823: </div>
1.41      asau     6824: <div class="sect1">
1.1       dsieger  6825: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   6826: <a name="platform-tools"></a>20.3. Tools provided by platforms</h2></div></div></div>
1.1       dsieger  6827: <p>When improving or porting pkgsrc to a new platform, have a look
                   6828: at (or create) the corresponding platform specific make file fragment under
                   6829: <code class="filename">pkgsrc/mk/tools/tools.${OPSYS}.mk</code> which defines
                   6830: the name of the common tools. For example:</p>
                   6831: <pre class="programlisting">
                   6832: .if exists(/usr/bin/bzcat)
                   6833: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzcat
                   6834: .elif exists(/usr/bin/bzip2)
                   6835: TOOLS_PLATFORM.bzcat?=          /usr/bin/bzip2 -cd
                   6836: .endif
                   6837: 
                   6838: TOOLS_PLATFORM.true?=           true                    # shell builtin
                   6839: </pre>
                   6840: </div>
                   6841: </div>
1.41      asau     6842: <div class="chapter">
1.1       dsieger  6843: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   6844: <a name="fixes"></a>Chapter 21. Making your package work</h2></div></div></div>
1.1       dsieger  6845: <div class="toc">
                   6846: <p><b>Table of Contents</b></p>
1.100     leot     6847: <dl class="toc">
1.154     rillig   6848: <dt><span class="sect1"><a href="#general-operation">21.1. General operation</a></span></dt>
1.1       dsieger  6849: <dd><dl>
1.154     rillig   6850: <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>
                   6851: <dt><span class="sect2"><a href="#user-interaction">21.1.2. User interaction</a></span></dt>
                   6852: <dt><span class="sect2"><a href="#handling-licenses">21.1.3. Handling licenses</a></span></dt>
                   6853: <dt><span class="sect2"><a href="#restricted-packages">21.1.4. Restricted packages</a></span></dt>
                   6854: <dt><span class="sect2"><a href="#dependencies">21.1.5. Handling dependencies</a></span></dt>
                   6855: <dt><span class="sect2"><a href="#conflicts">21.1.6. Handling conflicts with other packages</a></span></dt>
                   6856: <dt><span class="sect2"><a href="#not-building-packages">21.1.7. Packages that cannot or should not be built</a></span></dt>
                   6857: <dt><span class="sect2"><a href="#undeletable-packages">21.1.8. Packages which should not be deleted, once installed</a></span></dt>
                   6858: <dt><span class="sect2"><a href="#security-handling">21.1.9. Handling packages with security problems</a></span></dt>
                   6859: <dt><span class="sect2"><a href="#bumping-pkgrevision">21.1.10. How to handle incrementing versions when fixing an existing package</a></span></dt>
                   6860: <dt><span class="sect2"><a href="#fixes.subst">21.1.11. Substituting variable text in the package files (the SUBST framework)</a></span></dt>
                   6861: </dl></dd>
                   6862: <dt><span class="sect1"><a href="#fixes.fetch">21.2. The <span class="emphasis"><em>fetch</em></span> phase</a></span></dt>
                   6863: <dd><dl>
                   6864: <dt><span class="sect2"><a href="#no-plain-download">21.2.1. Packages whose distfiles aren't available for plain downloading</a></span></dt>
                   6865: <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>
                   6866: <dt><span class="sect2"><a href="#build.fetch.github">21.2.3. Packages hosted on github.com</a></span></dt>
                   6867: </dl></dd>
                   6868: <dt><span class="sect1"><a href="#fixes.configure">21.3. The <span class="emphasis"><em>configure</em></span> phase</a></span></dt>
                   6869: <dd><dl>
                   6870: <dt><span class="sect2"><a href="#fixes.libtool">21.3.1. Shared libraries - libtool</a></span></dt>
                   6871: <dt><span class="sect2"><a href="#using-libtool">21.3.2. Using libtool on GNU packages that already support libtool</a></span></dt>
                   6872: <dt><span class="sect2"><a href="#autoconf-automake">21.3.3. GNU Autoconf/Automake</a></span></dt>
                   6873: </dl></dd>
                   6874: <dt><span class="sect1"><a href="#programming-languages">21.4. Programming languages</a></span></dt>
                   6875: <dd><dl>
                   6876: <dt><span class="sect2"><a href="#basic-programming-languages">21.4.1. C, C++, and Fortran</a></span></dt>
                   6877: <dt><span class="sect2"><a href="#java-programming-language">21.4.2. Java</a></span></dt>
                   6878: <dt><span class="sect2"><a href="#perl-scripts">21.4.3. Packages containing perl scripts</a></span></dt>
                   6879: <dt><span class="sect2"><a href="#shell-scripts">21.4.4. Packages containing shell scripts</a></span></dt>
                   6880: <dt><span class="sect2"><a href="#other-programming-languages">21.4.5. Other programming languages</a></span></dt>
                   6881: </dl></dd>
                   6882: <dt><span class="sect1"><a href="#fixes.build">21.5. The <span class="emphasis"><em>build</em></span> phase</a></span></dt>
                   6883: <dd><dl>
                   6884: <dt><span class="sect2"><a href="#fixes.build.cpp">21.5.1. Compiling C and C++ code conditionally</a></span></dt>
                   6885: <dt><span class="sect2"><a href="#compiler-bugs">21.5.2. How to handle compiler bugs</a></span></dt>
                   6886: <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>
                   6887: <dt><span class="sect2"><a href="#out-of-memory">21.5.4. Running out of memory</a></span></dt>
                   6888: </dl></dd>
                   6889: <dt><span class="sect1"><a href="#fixes.install">21.6. The <span class="emphasis"><em>install</em></span> phase</a></span></dt>
                   6890: <dd><dl>
                   6891: <dt><span class="sect2"><a href="#install-scripts">21.6.1. Creating needed directories</a></span></dt>
                   6892: <dt><span class="sect2"><a href="#where-to-install-documentation">21.6.2. Where to install documentation</a></span></dt>
                   6893: <dt><span class="sect2"><a href="#installing-score-files">21.6.3. Installing highscore files</a></span></dt>
                   6894: <dt><span class="sect2"><a href="#destdir-support">21.6.4. Adding DESTDIR support to packages</a></span></dt>
                   6895: <dt><span class="sect2"><a href="#hardcoded-paths">21.6.5. Packages with hardcoded paths to other interpreters</a></span></dt>
                   6896: <dt><span class="sect2"><a href="#perl-modules">21.6.6. Packages installing perl modules</a></span></dt>
                   6897: <dt><span class="sect2"><a href="#faq.info-files">21.6.7. Packages installing info files</a></span></dt>
                   6898: <dt><span class="sect2"><a href="#manpages">21.6.8. Packages installing man pages</a></span></dt>
                   6899: <dt><span class="sect2"><a href="#gconf-data-files">21.6.9. Packages installing GConf data files</a></span></dt>
                   6900: <dt><span class="sect2"><a href="#scrollkeeper-data-files">21.6.10. Packages installing scrollkeeper/rarian data files</a></span></dt>
                   6901: <dt><span class="sect2"><a href="#x11-fonts">21.6.11. Packages installing X11 fonts</a></span></dt>
                   6902: <dt><span class="sect2"><a href="#gtk2-modules">21.6.12. Packages installing GTK2 modules</a></span></dt>
                   6903: <dt><span class="sect2"><a href="#sgml-xml-data">21.6.13. Packages installing SGML or XML data</a></span></dt>
                   6904: <dt><span class="sect2"><a href="#mime-database">21.6.14. Packages installing extensions to the MIME database</a></span></dt>
                   6905: <dt><span class="sect2"><a href="#intltool">21.6.15. Packages using intltool</a></span></dt>
                   6906: <dt><span class="sect2"><a href="#startup-scripts">21.6.16. Packages installing startup scripts</a></span></dt>
                   6907: <dt><span class="sect2"><a href="#tex-packages">21.6.17. Packages installing TeX modules</a></span></dt>
                   6908: <dt><span class="sect2"><a href="#emulation-packages">21.6.18. Packages supporting running binaries in
1.1       dsieger  6909:     emulation</a></span></dt>
1.154     rillig   6910: <dt><span class="sect2"><a href="#hicolor-theme">21.6.19. Packages installing hicolor theme icons</a></span></dt>
                   6911: <dt><span class="sect2"><a href="#desktop-files">21.6.20. Packages installing desktop files</a></span></dt>
1.1       dsieger  6912: </dl></dd>
1.154     rillig   6913: <dt><span class="sect1"><a href="#punting">21.7. Marking packages as having problems</a></span></dt>
1.1       dsieger  6914: </dl>
                   6915: </div>
1.41      asau     6916: <div class="sect1">
1.1       dsieger  6917: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   6918: <a name="general-operation"></a>21.1. General operation</h2></div></div></div>
1.1       dsieger  6919: <p>One appealing feature of pkgsrc is that it runs on many
1.108     rillig   6920:   different platforms. As a result, it is important to ensure,
                   6921:   where possible, that packages in pkgsrc are portable. This
                   6922:   chapter mentions some particular details you should pay
                   6923:   attention to while working on pkgsrc.</p>
1.41      asau     6924: <div class="sect2">
1.1       dsieger  6925: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   6926: <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  6927: </h3></div></div></div>
                   6928: <p>The pkgsrc user can configure pkgsrc by overriding several
                   6929:     variables in the file pointed to by <code class="varname">MAKECONF</code>,
1.10      hubertf  6930:     which is <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> by default. When you
1.1       dsieger  6931:     want to use those variables in the preprocessor directives of
1.157     leot     6932:     <a class="citerefentry" href="http://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  6933:     <code class="literal">.for</code>), you need to include the file
                   6934:     <code class="filename">../../mk/bsd.prefs.mk</code> before, which in turn
                   6935:     loads the user preferences.</p>
                   6936: <p>But note that some variables may not be completely defined
                   6937:     after <code class="filename">../../mk/bsd.prefs.mk</code> has been
                   6938:     included, as they may contain references to variables that are
1.108     rillig   6939:     not yet defined. In shell commands (the lines in
                   6940:     <code class="filename">Makefile</code> that are indented with a tab) this
                   6941:     is no problem, since variables are only expanded when they are
                   6942:     used. But in the preprocessor directives mentioned above and in
                   6943:     dependency lines (of the form <code class="literal">target:
1.1       dsieger  6944:     dependencies</code>) the variables are expanded at load
                   6945:     time.</p>
1.41      asau     6946: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  6947: <h3 class="title">Note</h3>
1.108     rillig   6948: <p>To check whether a variable can be used at load time,
                   6949:     run <span class="command"><strong>pkglint -Wall</strong></span> on your package.</p>
1.1       dsieger  6950: </div>
                   6951: </div>
1.41      asau     6952: <div class="sect2">
1.1       dsieger  6953: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   6954: <a name="user-interaction"></a>21.1.2. User interaction</h3></div></div></div>
1.1       dsieger  6955: <p>Occasionally, packages require interaction from the user,
                   6956:     and this can be in a number of ways:</p>
1.41      asau     6957: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      6958: <li class="listitem"><p>When fetching the distfiles, some packages require user
1.1       dsieger  6959:        interaction such as entering username/password or accepting a
                   6960:        license on a web page.</p></li>
1.23      wiz      6961: <li class="listitem"><p>When extracting the distfiles, some packages may ask for
1.1       dsieger  6962:        passwords.</p></li>
1.23      wiz      6963: <li class="listitem"><p>help to configure the package before it is built</p></li>
                   6964: <li class="listitem"><p>help during the build process</p></li>
                   6965: <li class="listitem"><p>help during the installation of a package</p></li>
1.1       dsieger  6966: </ul></div>
1.108     rillig   6967: <p>A package can set the <code class="varname">INTERACTIVE_STAGE</code>
                   6968:     variable to define which stages need interaction. This should be
                   6969:     done in the package's <code class="filename">Makefile</code>, e.g.:</p>
1.1       dsieger  6970: <pre class="programlisting">
                   6971: INTERACTIVE_STAGE=      configure install
1.111     sevan    6972: </pre>
1.1       dsieger  6973: <p>The user can then decide to skip this package by setting the
1.108     rillig   6974:     <code class="varname">BATCH</code> variable. Packages that require interaction
                   6975:     are also excluded from bulk builds.</p>
1.1       dsieger  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="handling-licenses"></a>21.1.3. Handling licenses</h3></div></div></div>
1.111     sevan    6980: <p>Authors of software can choose the licence under which software
                   6981:     can be copied.  The Free Software Foundation has declared some
                   6982:     licenses "Free", and the Open Source Initiative has a definition of
                   6983:     "Open Source".</p>
                   6984: <p>By default, pkgsrc allows packages with Free or Open Source
                   6985:     licenses to be built.  To allow packages with other licenses to be
                   6986:     built as well, the pkgsrc user needs to add these licenses to the
                   6987:     <code class="varname">ACCEPTABLE_LICENSES</code> variable in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>.  Note
                   6988:     that this variable only affects which packages may be
                   6989:     <span class="emphasis"><em>built</em></span>, while the license terms often also
                   6990:     restrict the actual use of the package and its redistribution.</p>
1.1       dsieger  6991: <p>One might want to only install packages with a BSD license,
1.108     rillig   6992:     or the GPL, and not the other.  The free licenses are added to the
1.111     sevan    6993:     default <code class="varname">ACCEPTABLE_LICENSES</code> variable.  The pkgsrc
1.19      jnemeth  6994:     user can override the default by setting the
                   6995:     <code class="varname">ACCEPTABLE_LICENSES</code> variable with "=" instead
1.111     sevan    6996:     of "+=".  The licenses accepted by default are defined in the
                   6997:     <code class="varname">DEFAULT_ACCEPTABLE_LICENSES</code> variable in the file
                   6998:     <code class="filename">pkgsrc/mk/license.mk</code>.</p>
1.1       dsieger  6999: <p>The license tag mechanism is intended to address
                   7000:     copyright-related issues surrounding building, installing and
                   7001:     using a package, and not to address redistribution issues (see
                   7002:     <code class="varname">RESTRICTED</code> and
1.111     sevan    7003:     <code class="varname">NO_SRC_ON_FTP</code>, etc.).
1.19      jnemeth  7004:     Packages with redistribution restrictions should set these
                   7005:     tags.</p>
1.1       dsieger  7006: <p>Denoting that a package may be copied according to a
                   7007:     particular license is done by placing the license in
                   7008:     <code class="filename">pkgsrc/licenses</code> and setting the
                   7009:     <code class="varname">LICENSE</code> variable to a string identifying the
1.137     leot     7010:     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  7011: <pre class="programlisting">
                   7012: LICENSE=        xv-license
1.111     sevan    7013: </pre>
1.1       dsieger  7014: <p>When trying to build, the user will get a notice that the
                   7015:     package is covered by a license which has not been placed in the
                   7016:     <code class="varname">ACCEPTABLE_LICENSES</code> variable:</p>
                   7017: <pre class="programlisting">
                   7018: <code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   7019: ===&gt; xv-3.10anb9 has an unacceptable license: xv-license.
                   7020: ===&gt;     To view the license, enter "/usr/bin/make show-license".
                   7021: ===&gt;     To indicate acceptance, add this line to your /etc/mk.conf:
                   7022: ===&gt;     ACCEPTABLE_LICENSES+=xv-license
                   7023: *** Error code 1
1.111     sevan    7024: </pre>
1.10      hubertf  7025: <p>The license can be viewed with <span class="command"><strong>make
1.1       dsieger  7026:     show-license</strong></span>, and if the user so chooses, the line
1.10      hubertf  7027:     printed above can be added to <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> to
1.1       dsieger  7028:     convey to pkgsrc that it should not in the future fail because of
                   7029:     that license:</p>
                   7030: <pre class="programlisting">
                   7031: ACCEPTABLE_LICENSES+=xv-license
1.111     sevan    7032: </pre>
                   7033: <p>The use of <code class="varname">LICENSE=shareware</code>,
                   7034:     <code class="varname">LICENSE=no-commercial-use</code>, and similar language
                   7035:     is deprecated because it does not crisply refer to a particular
                   7036:     license text.  Another problem with such usage is that it does not
                   7037:     enable a user to tell pkgsrc to proceed for a single package
                   7038:     without also telling pkgsrc to proceed for all packages with that
                   7039:     tag.</p>
                   7040: <div class="sect3">
                   7041: <div class="titlepage"><div><div><h4 class="title">
1.154     rillig   7042: <a name="new-license"></a>21.1.3.1. Adding a package with a new license</h4></div></div></div>
1.48      rodent   7043: <p>When adding a package with a new license, the following steps
                   7044:     are required:</p>
                   7045: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7046: <li class="listitem">
1.111     sevan    7047: <p>Check whether the license qualifies as Free or Open
                   7048:     Source by referencing <a class="ulink" href="http://www.gnu.org/licenses/license-list.en.html" target="_top">Various Licenses
                   7049:     and Comments about Them</a> and <a class="ulink" href="http://opensource.org/licenses/alphabetical" target="_top">Licenses by Name |
                   7050:     Open Source Initiative</a>.  If this is the case, the filename in
                   7051:     <code class="filename">pkgsrc/licenses/</code> does not need the
                   7052:     <code class="filename">-license</code> suffix, and the license name should be
                   7053:     added to:</p>
1.48      rodent   7054: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   7055: <li class="listitem"><p>DEFAULT_ACCEPTABLE_LICENSES in <code class="filename">pkgsrc/mk/license.mk</code></p></li>
                   7056: <li class="listitem"><p>default_acceptable_licenses in <code class="filename">pkgsrc/pkgtools/pkg_install/files/lib/license.c</code></p></li>
                   7057: </ul></div>
                   7058: </li>
                   7059: <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>
                   7060: </ol></div>
1.111     sevan    7061: </div>
                   7062: <div class="sect3">
                   7063: <div class="titlepage"><div><div><h4 class="title">
1.154     rillig   7064: <a name="change-license"></a>21.1.3.2. Change to the license</h4></div></div></div>
1.1       dsieger  7065: <p>When the license changes (in a way other than formatting),
1.111     sevan    7066:     make sure that the new license has a different name (e.g.,
1.1       dsieger  7067:     append the version number if it exists, or the date).  Just
                   7068:     because a user told pkgsrc to build programs under a previous
                   7069:     version of a license does not mean that pkgsrc should build
                   7070:     programs under the new licenses.  The higher-level point is that
                   7071:     pkgsrc does not evaluate licenses for reasonableness; the only
                   7072:     test is a mechanistic test of whether a particular text has been
1.111     sevan    7073:     approved by either of two bodies (FSF or OSI).</p>
                   7074: </div>
1.1       dsieger  7075: </div>
1.41      asau     7076: <div class="sect2">
1.1       dsieger  7077: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   7078: <a name="restricted-packages"></a>21.1.4. Restricted packages</h3></div></div></div>
1.1       dsieger  7079: <p>Some licenses restrict how software may be re-distributed.
1.111     sevan    7080:     By declaring the restrictions, package tools can
1.1       dsieger  7081:     automatically refrain from e.g. placing binary packages on FTP
                   7082:     sites.</p>
1.111     sevan    7083: <p>There are four possible restrictions, which are
1.1       dsieger  7084:     the cross product of sources (distfiles) and binaries not being
                   7085:     placed on FTP sites and CD-ROMs.  Because this is rarely the exact
                   7086:     language in any license, and because non-Free licenses tend to be
                   7087:     different from each other, pkgsrc adopts a definition of FTP and
1.111     sevan    7088:     CD-ROM.
                   7089: 
                   7090:     "FTP" means making the source or binary file available over the
                   7091:     Internet at no charge.
                   7092: 
                   7093:     "CD-ROM" means making the source or binary available on some kind of
                   7094:     media, together with other source and binary packages, which is sold
                   7095:     for a distribution charge.
1.1       dsieger  7096:     </p>
                   7097: <p>In order to encode these restrictions, the package system
                   7098:     defines five make variables that can be set to note these
                   7099:     restrictions:</p>
1.41      asau     7100: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      7101: <li class="listitem">
1.1       dsieger  7102: <p><code class="varname">RESTRICTED</code></p>
                   7103: <p>This variable should be set whenever a restriction
                   7104:        exists (regardless of its kind).  Set this variable to a
                   7105:        string containing the reason for the restriction.  It should
                   7106:        be understood that those wanting to understand the restriction
                   7107:        will have to read the license, and perhaps seek advice of
                   7108:        counsel.</p>
                   7109: </li>
1.23      wiz      7110: <li class="listitem">
1.1       dsieger  7111: <p><code class="varname">NO_BIN_ON_CDROM</code></p>
                   7112: <p>Binaries may not be placed on CD-ROM containing other
                   7113:        binary packages, for which a distribution charge may be made.
                   7114:        In this case, set this variable to
                   7115:        <code class="varname">${RESTRICTED}</code>.</p>
                   7116: </li>
1.23      wiz      7117: <li class="listitem">
1.1       dsieger  7118: <p><code class="varname">NO_BIN_ON_FTP</code></p>
                   7119: <p>Binaries may not made available on the Internet without
                   7120:        charge.  In this case, set this variable to
                   7121:        <code class="varname">${RESTRICTED}</code>.  If this variable is set,
                   7122:        binary packages will not be included on ftp.NetBSD.org.</p>
                   7123: </li>
1.23      wiz      7124: <li class="listitem">
1.1       dsieger  7125: <p><code class="varname">NO_SRC_ON_CDROM</code></p>
                   7126: <p>Distfiles may not be placed on CD-ROM, together with
                   7127:        other distfiles, for which a fee may be charged.  In this
                   7128:        case, set this variable to <code class="varname">${RESTRICTED}</code>.
                   7129:        </p>
                   7130: </li>
1.23      wiz      7131: <li class="listitem">
1.1       dsieger  7132: <p><code class="varname">NO_SRC_ON_FTP</code></p>
                   7133: <p>Distfiles may not made available via FTP at no charge.
                   7134:        In this case, set this variable to
                   7135:        <code class="varname">${RESTRICTED}</code>.  If this variable is set,
                   7136:        the distfile(s) will not be mirrored on ftp.NetBSD.org.</p>
                   7137: </li>
                   7138: </ul></div>
1.111     sevan    7139: <p>Please note that packages will be removed from pkgsrc when the
                   7140:     distfiles are not distributable and cannot be obtained for a period
                   7141:     of one full quarter branch. Packages with manual/interactive fetch
                   7142:     must have a maintainer and it is his/her responsibility to ensure
                   7143:     this.</p>
1.1       dsieger  7144: </div>
1.41      asau     7145: <div class="sect2">
1.1       dsieger  7146: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   7147: <a name="dependencies"></a>21.1.5. Handling dependencies</h3></div></div></div>
1.1       dsieger  7148: <p>Your package may depend on some other package being present
                   7149:     - and there are various ways of expressing this dependency.
                   7150:     pkgsrc supports the <code class="varname">BUILD_DEPENDS</code> and
1.156     leot     7151:     <code class="varname">DEPENDS</code> and
                   7152:     <code class="varname">TOOL_DEPENDS</code> definitions, the
1.1       dsieger  7153:     <code class="varname">USE_TOOLS</code> definition, as well as dependencies
                   7154:     via <code class="filename">buildlink3.mk</code>, which is the preferred way
                   7155:     to handle dependencies, and which uses the variables named above.
1.154     rillig   7156:     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  7157: <p>The basic difference between the two variables is as
                   7158:     follows: The <code class="varname">DEPENDS</code> definition registers
                   7159:     that pre-requisite in the binary package so it will be pulled in
                   7160:     when the binary package is later installed, whilst the
1.156     leot     7161:     <code class="varname">BUILD_DEPENDS</code> and <code class="varname">TOOL_DEPENDS</code>
                   7162:     definitions does not, marking a dependency that is only needed for
                   7163:     building the package.</p>
1.1       dsieger  7164: <p>This means that if you only need a package present whilst
                   7165:     you are building, it should be noted as a
1.156     leot     7166:     <code class="varname">TOOL_DEPENDS</code> or
                   7167:     <code class="varname">BUILD_DEPENDS</code>.  When cross-compiling,
                   7168:     <code class="varname">TOOL_DEPENDS</code> are <span class="emphasis"><em>native</em></span>
                   7169:     packages, i.e. packages for the architecture where the package
                   7170:     is built;
                   7171:     <code class="varname">BUILD_DEPENDS</code> are <span class="emphasis"><em>target</em></span>
                   7172:     packages, i.e. packages for the architecture for which the package
                   7173:     is built.</p>
                   7174: <p>The format for <code class="varname">BUILD_DEPENDS</code>,
                   7175:     <code class="varname">DEPENDS</code> and <code class="varname">TOOL_DEPENDS</code>
                   7176:     definition is:</p>
1.1       dsieger  7177: <pre class="programlisting">
                   7178: &lt;pre-req-package-name&gt;:../../&lt;category&gt;/&lt;pre-req-package&gt;
1.111     sevan    7179: </pre>
1.23      wiz      7180: <p>Please note that the <span class="quote">&#8220;<span class="quote">pre-req-package-name</span>&#8221;</span>
1.1       dsieger  7181:     may include any of the wildcard version numbers recognized by
1.157     leot     7182:     <a class="citerefentry" href="http://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      7183: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7184: <li class="listitem">
1.1       dsieger  7185: <p>If your package needs another package's binaries or
1.54      wiz      7186:        libraries to build and run, and if that package has a
1.1       dsieger  7187:        <code class="filename">buildlink3.mk</code> file available, use it:</p>
                   7188: <pre class="programlisting">
                   7189: .include "../../graphics/jpeg/buildlink3.mk"
1.111     sevan    7190: </pre>
1.1       dsieger  7191: </li>
1.23      wiz      7192: <li class="listitem">
1.54      wiz      7193: <p>If your package needs another package's binaries or
                   7194:        libraries only for building, and if that package has a
                   7195:        <code class="filename">buildlink3.mk</code> file available, use it:</p>
                   7196: <pre class="programlisting">
                   7197: .include "../../graphics/jpeg/buildlink3.mk"
1.111     sevan    7198: </pre>
1.54      wiz      7199: <p>but set
                   7200:        <code class="varname">BUILDLINK_DEPMETHOD.<em class="replaceable"><code>jpeg</code></em>?=build</code>
                   7201:        to make it a build dependency only. This case is rather
                   7202:        rare.</p>
                   7203: </li>
                   7204: <li class="listitem">
1.25      spz      7205: <p>If your package needs binaries from another package to build,
1.156     leot     7206:        use the <code class="varname">TOOL_DEPENDS</code> definition:</p>
1.1       dsieger  7207: <pre class="programlisting">
1.156     leot     7208: TOOL_DEPENDS+= itstool-[0-9]*:../../textproc/itstool
1.111     sevan    7209: </pre>
1.1       dsieger  7210: </li>
1.156     leot     7211: <li class="listitem"><p>If your package needs static libraries to link against, header
                   7212:        files to include, etc. from another package to build,
                   7213:        use the <code class="varname">BUILD_DEPENDS</code> definition.</p></li>
1.25      spz      7214: <li class="listitem"><p>If your package needs a library with which to link and
                   7215:        there is no <code class="filename">buildlink3.mk</code> file
                   7216:        available, create one. Using
                   7217:        <code class="varname">DEPENDS</code> won't be sufficient because the
                   7218:        include files and libraries will be hidden from the compiler.</p></li>
1.23      wiz      7219: <li class="listitem">
1.25      spz      7220: <p>If your package needs some executable to be able to run
                   7221:        correctly and if there's no
                   7222:        <code class="filename">buildlink3.mk</code> file, this is specified
                   7223:        using the <code class="varname">DEPENDS</code> variable. The
1.137     leot     7224:        <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      7225:        be able to execute the latex binary from the tex-latex-bin package
1.25      spz      7226:        when it runs, and that is specified:</p>
1.1       dsieger  7227: <pre class="programlisting">
1.129     wiz      7228: DEPENDS+=        tex-latex-bin-[0-9]*:../../print/tex-latex-bin
1.111     sevan    7229: </pre>
1.25      spz      7230: </li>
                   7231: <li class="listitem">
                   7232: <p>You can use wildcards in package dependencies. Note that
                   7233:        such wildcard dependencies are retained when creating binary
                   7234:        packages. The dependency is checked when installing the binary
                   7235:        package and any package which matches the pattern will be
                   7236:        used. Wildcard dependencies should be used with care.</p>
1.23      wiz      7237: <p>The <span class="quote">&#8220;<span class="quote">-[0-9]*</span>&#8221;</span> should be used instead of
                   7238:        <span class="quote">&#8220;<span class="quote">-*</span>&#8221;</span> to avoid potentially ambiguous matches
                   7239:        such as <span class="quote">&#8220;<span class="quote">tk-postgresql</span>&#8221;</span> matching a
                   7240:        <span class="quote">&#8220;<span class="quote">tk-*</span>&#8221;</span> <code class="varname">DEPENDS</code>.</p>
1.1       dsieger  7241: <p>Wildcards can also be used to specify that a package
                   7242:        will only build against a certain minimum version of a
                   7243:        pre-requisite:</p>
                   7244: <pre class="programlisting">
1.25      spz      7245: DEPENDS+=       ImageMagick&gt;=6.0:../../graphics/ImageMagick
1.111     sevan    7246: </pre>
1.25      spz      7247: <p>This means that the package will build using version 6.0
                   7248:        of ImageMagick or newer. Such a dependency may be warranted
                   7249:        if, for example, the command line options of an executable
                   7250:        have changed.</p>
                   7251: <p>If you need to depend on minimum versions of libraries,
                   7252:        see the buildlink section of the pkgsrc guide.</p>
1.1       dsieger  7253: <p>For security fixes, please update the package
1.154     rillig   7254:        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  7255:        information.</p>
                   7256: </li>
                   7257: </ol></div>
                   7258: <p>If your package needs files from another package to build,
                   7259:     add the relevant distribution files to
                   7260:     <code class="varname">DISTFILES</code>, so they will be extracted
1.137     leot     7261:     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  7262:     (It relies on the jpeg sources being present in source form
                   7263:     during the build.)</p>
                   7264: </div>
1.41      asau     7265: <div class="sect2">
1.1       dsieger  7266: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   7267: <a name="conflicts"></a>21.1.6. Handling conflicts with other packages</h3></div></div></div>
1.1       dsieger  7268: <p>Your package may conflict with other packages a user might
                   7269:     already have installed on his system, e.g. if your package
                   7270:     installs the same set of files as another package in the pkgsrc
1.80      wiz      7271:     tree or has the same <code class="varname">PKGNAME</code>.</p>
1.142     leot     7272: <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>
                   7273:     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>
                   7274:     install the same shared library, thus you set in
                   7275:     <code class="filename">pkgsrc/x11/libXaw3d/Makefile</code>:</p>
                   7276: <pre class="programlisting">
                   7277: CONFLICTS=      Xaw-Xpm-[0-9]*
                   7278:     </pre>
                   7279: <p>and in <code class="filename">pkgsrc/x11/Xaw-Xpm/Makefile</code>:</p>
                   7280: <pre class="programlisting">
                   7281: CONFLICTS=      libXaw3d-[0-9]*
                   7282:     </pre>
1.157     leot     7283: <p><a class="citerefentry" href="http://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     7284:     that conflict with existing packages and abort. However, in many
                   7285:     situations this is too late in the process. Binary package managers
                   7286:     will not know about the conflict until they attempt to install the
                   7287:     package after already downloading it and all its dependencies.
                   7288:     Users may also waste time building a package and its dependencies
                   7289:     only to find out at the end that it conflicts with another package
                   7290:     they have installed.</p>
                   7291: <p>To avoid these issues <code class="varname">CONFLICTS</code> entries
                   7292:     should be added in all cases where it is known that packages conflict
                   7293:     with each other.  These <code class="varname">CONFLICTS</code> entries are
1.157     leot     7294:     exported in <a class="citerefentry" href="http://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     7295:     managers to inform users that packages cannot be installed onto
                   7296:     the target system.</p>
1.1       dsieger  7297: </div>
1.41      asau     7298: <div class="sect2">
1.1       dsieger  7299: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   7300: <a name="not-building-packages"></a>21.1.7. Packages that cannot or should not be built</h3></div></div></div>
1.1       dsieger  7301: <p>There are several reasons why a package might be
                   7302:     instructed to not build under certain circumstances.  If the
                   7303:     package builds and runs on most platforms, the exceptions
1.83      dholland 7304:     should be noted with <code class="varname">BROKEN_ON_PLATFORM</code>.  If
                   7305:     the package builds and runs on a small handful of platforms,
                   7306:     set <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> instead.
                   7307:     Both <code class="varname">BROKEN_ON_PLATFORM</code> and
                   7308:     <code class="varname">BROKEN_EXCEPT_ON_PLATFORM</code> are OS triples
                   7309:     (OS-version-platform) that can use glob-style
                   7310:     wildcards.</p>
                   7311: <p>If a package is not appropriate for some platforms (as
1.114     maya     7312:     opposed to merely broken), a different set of variables should be
1.83      dholland 7313:     used as this affects failure reporting and statistics.
                   7314:     If the package is appropriate for most platforms, the exceptions
1.1       dsieger  7315:     should be noted with <code class="varname">NOT_FOR_PLATFORM</code>.  If
1.83      dholland 7316:     the package is appropriate for only a small handful of platforms
                   7317:     (often exactly one), set <code class="varname">ONLY_FOR_PLATFORM</code> instead.
1.1       dsieger  7318:     Both <code class="varname">ONLY_FOR_PLATFORM</code> and
                   7319:     <code class="varname">NOT_FOR_PLATFORM</code> are OS triples
                   7320:     (OS-version-platform) that can use glob-style
                   7321:     wildcards.</p>
                   7322: <p>Some packages are tightly bound to a specific version of an
1.137     leot     7323:     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  7324:     backwards compatible with other versions of the OS, and should be
                   7325:     uploaded to a version specific directory on the FTP server.  Mark
                   7326:     these packages by setting <code class="varname">OSVERSION_SPECIFIC</code> to
1.23      wiz      7327:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>.  This variable is not currently used by any of
1.1       dsieger  7328:     the package system internals, but may be used in the
                   7329:     future.</p>
                   7330: <p>If the package should be skipped (for example, because it
                   7331:     provides functionality already provided by the system), set
                   7332:     <code class="varname">PKG_SKIP_REASON</code> to a descriptive message.  If
                   7333:     the package should fail because some preconditions are not met,
                   7334:     set <code class="varname">PKG_FAIL_REASON</code> to a descriptive
                   7335:     message.</p>
                   7336: </div>
1.41      asau     7337: <div class="sect2">
1.1       dsieger  7338: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   7339: <a name="undeletable-packages"></a>21.1.8. Packages which should not be deleted, once installed</h3></div></div></div>
1.1       dsieger  7340: <p>To ensure that a package may not be deleted, once it has been
                   7341:     installed, the <code class="varname">PKG_PRESERVE</code> definition should
                   7342:     be set in the package Makefile. This will be carried into any
                   7343:     binary package that is made from this pkgsrc entry. A
1.23      wiz      7344:     <span class="quote">&#8220;<span class="quote">preserved</span>&#8221;</span> package will
1.157     leot     7345:     not be deleted using <a class="citerefentry" href="http://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      7346:     <span class="quote">&#8220;<span class="quote">-f</span>&#8221;</span> option is used.</p>
1.1       dsieger  7347: </div>
1.41      asau     7348: <div class="sect2">
1.1       dsieger  7349: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   7350: <a name="security-handling"></a>21.1.9. Handling packages with security problems</h3></div></div></div>
1.1       dsieger  7351: <p>When a vulnerability is found, this should be noted in
                   7352:     <code class="filename">localsrc/security/advisories/pkg-vulnerabilities</code>,
1.31      wiz      7353:     and after committing that file, ask pkgsrc-security@NetBSD.org to
                   7354:     update the file on ftp.NetBSD.org.</p>
1.1       dsieger  7355: <p>After fixing the vulnerability by a patch, its
1.31      wiz      7356:     <code class="varname">PKGREVISION</code> should be increased (this is of
                   7357:     course not necessary if the problem is fixed by using a newer
                   7358:     release of the software), and the pattern in the
                   7359:     pkg-vulnerabilities file must be updated.</p>
1.1       dsieger  7360: <p>Also, if the fix should be applied to the stable pkgsrc
                   7361:     branch, be sure to submit a pullup request!</p>
                   7362: <p>Binary packages already on ftp.NetBSD.org will be handled
                   7363:     semi-automatically by a weekly cron job.</p>
                   7364: </div>
1.41      asau     7365: <div class="sect2">
1.1       dsieger  7366: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   7367: <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  7368: <p>When making fixes to an existing package it can be useful
                   7369:     to change the version number in <code class="varname">PKGNAME</code>. To
                   7370:     avoid conflicting with future versions by the original author, a
1.23      wiz      7371:     <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  7372:     on package versions by setting <code class="varname">PKGREVISION=1</code>
1.23      wiz      7373:     (2, ...). The <span class="quote">&#8220;<span class="quote">nb</span>&#8221;</span> is treated like a
                   7374:     <span class="quote">&#8220;<span class="quote">.</span>&#8221;</span> by the package tools. e.g.</p>
1.1       dsieger  7375: <pre class="programlisting">
                   7376: DISTNAME=       foo-17.42
                   7377: PKGREVISION=    9
1.111     sevan    7378: </pre>
1.1       dsieger  7379: <p>will result in a <code class="varname">PKGNAME</code> of
1.23      wiz      7380:     <span class="quote">&#8220;<span class="quote">foo-17.42nb9</span>&#8221;</span>. If you want to use the original
                   7381:     value of <code class="varname">PKGNAME</code> without the <span class="quote">&#8220;<span class="quote">nbX</span>&#8221;</span>
1.1       dsieger  7382:     suffix, e.g. for setting <code class="varname">DIST_SUBDIR</code>, use
                   7383:     <code class="varname">PKGNAME_NOREV</code>.</p>
                   7384: <p>When a new release of the package is released, the
                   7385:     <code class="varname">PKGREVISION</code> should be removed, e.g. on a new
                   7386:     minor release of the above package, things should be like:</p>
                   7387: <pre class="programlisting">
                   7388: DISTNAME=       foo-17.43
1.111     sevan    7389: </pre>
1.1       dsieger  7390: <p><code class="varname">PKGREVISION</code> should be incremented for any
                   7391:     non-trivial change in the resulting binary package.  Without a
                   7392:     <code class="varname">PKGREVISION</code> bump, someone with the previous
                   7393:     version installed has no way of knowing that their package is out
                   7394:     of date.  Thus, changes without increasing
                   7395:     <code class="varname">PKGREVISION</code> are essentially labeled "this is so
                   7396:     trivial that no reasonable person would want to upgrade", and this
                   7397:     is the rough test for when increasing
                   7398:     <code class="varname">PKGREVISION</code> is appropriate.  Examples of
                   7399:     changes that do not merit increasing
                   7400:     <code class="varname">PKGREVISION</code> are:</p>
1.41      asau     7401: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      7402: <li class="listitem"><p>Changing <code class="varname">HOMEPAGE</code>,
1.14      jmcneill 7403:       <code class="varname">MAINTAINER</code>, <code class="varname">OWNER</code>,
1.1       dsieger  7404:       or comments in Makefile.</p></li>
1.23      wiz      7405: <li class="listitem"><p>
1.1       dsieger  7406:       Changing build variables if the resulting binary package is the same.</p></li>
1.23      wiz      7407: <li class="listitem"><p>
1.1       dsieger  7408:       Changing <code class="filename">DESCR</code>.</p></li>
1.23      wiz      7409: <li class="listitem"><p>
1.1       dsieger  7410:       Adding <code class="varname">PKG_OPTIONS</code> if the default options don't change.</p></li>
                   7411: </ul></div>
                   7412: <p>Examples of changes that do merit an increase to
                   7413:     <code class="varname">PKGREVISION</code> include:</p>
1.41      asau     7414: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      7415: <li class="listitem"><p>
1.1       dsieger  7416:       Security fixes</p></li>
1.23      wiz      7417: <li class="listitem"><p>
1.1       dsieger  7418:       Changes or additions to a patch file</p></li>
1.23      wiz      7419: <li class="listitem"><p>
1.1       dsieger  7420:       Changes to the <code class="filename">PLIST</code></p></li>
1.23      wiz      7421: <li class="listitem"><p>A dependency is changed or renamed.</p></li>
1.1       dsieger  7422: </ul></div>
                   7423: <p>PKGREVISION must also be incremented when dependencies have ABI
                   7424:     changes.</p>
                   7425: </div>
1.41      asau     7426: <div class="sect2">
1.1       dsieger  7427: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   7428: <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  7429: <p>When you want to replace the same text in multiple files
                   7430:     or when the replacement text varies, patches alone cannot help.
                   7431:     This is where the SUBST framework comes in. It provides an
                   7432:     easy-to-use interface for replacing text in files.
                   7433:     Example:</p>
                   7434: <pre class="programlisting">
                   7435: SUBST_CLASSES+=                 fix-paths
                   7436: SUBST_STAGE.fix-paths=          pre-configure
                   7437: SUBST_MESSAGE.fix-paths=        Fixing absolute paths.
                   7438: SUBST_FILES.fix-paths=          src/*.c
                   7439: SUBST_FILES.fix-paths+=         scripts/*.sh
                   7440: SUBST_SED.fix-paths=            -e 's,"/usr/local,"${PREFIX},g'
                   7441: SUBST_SED.fix-paths+=           -e 's,"/var/log,"${VARBASE}/log,g'
1.111     sevan    7442: </pre>
1.1       dsieger  7443: <p><code class="varname">SUBST_CLASSES</code> is a list of identifiers
                   7444:     that are used to identify the different SUBST blocks that are
                   7445:     defined. The SUBST framework is heavily used by pkgsrc, so it is
                   7446:     important to always use the <code class="literal">+=</code> operator with
                   7447:     this variable. Otherwise some substitutions may be
                   7448:     skipped.</p>
                   7449: <p>The remaining variables of each SUBST block are
                   7450:     parameterized with the identifier from the first line
                   7451:     (<code class="literal">fix-paths</code> in this case.) They can be seen as
                   7452:     parameters to a function call.</p>
                   7453: <p><code class="varname">SUBST_STAGE.*</code> specifies the stage at
                   7454:     which the replacement will take place. All combinations of
                   7455:     <code class="literal">pre-</code>, <code class="literal">do-</code> and
                   7456:     <code class="literal">post-</code> together with a phase name are
                   7457:     possible, though only few are actually used. Most commonly used
                   7458:     are <code class="literal">post-patch</code> and
                   7459:     <code class="literal">pre-configure</code>. Of these two,
                   7460:     <code class="literal">pre-configure</code> should be preferred because
1.10      hubertf  7461:     then it is possible to run <span class="command"><strong>bmake patch</strong></span> and
1.1       dsieger  7462:     have the state after applying the patches but before making any
                   7463:     other changes. This is especially useful when you are debugging
                   7464:     a package in order to create new patches for it. Similarly,
                   7465:     <code class="literal">post-build</code> is preferred over
                   7466:     <code class="literal">pre-install</code>, because the install phase should
                   7467:     generally be kept as simple as possible. When you use
                   7468:     <code class="literal">post-build</code>, you have the same files in the
                   7469:     working directory that will be installed later, so you can check
                   7470:     if the substitution has succeeded.</p>
                   7471: <p><code class="varname">SUBST_MESSAGE.*</code> is an optional text
                   7472:     that is printed just before the substitution is done.</p>
                   7473: <p><code class="varname">SUBST_FILES.*</code> is the list of shell
                   7474:     globbing patterns that specifies the files in which the
                   7475:     substitution will take place. The patterns are interpreted
                   7476:     relatively to the <code class="varname">WRKSRC</code> directory.</p>
                   7477: <p><code class="varname">SUBST_SED.*</code> is a list of arguments to
1.157     leot     7478:     <a class="citerefentry" href="http://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  7479:     command should be prefixed with <code class="literal">-e</code>, so that
                   7480:     all SUBST blocks look uniform.</p>
                   7481: <p>There are some more variables, but they are so seldomly
                   7482:     used that they are only documented in the
                   7483:     <code class="filename">mk/subst.mk</code> file.</p>
                   7484: </div>
                   7485: </div>
1.41      asau     7486: <div class="sect1">
1.1       dsieger  7487: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   7488: <a name="fixes.fetch"></a>21.2. The <span class="emphasis"><em>fetch</em></span> phase</h2></div></div></div>
1.41      asau     7489: <div class="sect2">
1.1       dsieger  7490: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   7491: <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  7492: <p>If you need to download from a dynamic URL you can set
1.10      hubertf  7493:     <code class="varname">DYNAMIC_MASTER_SITES</code> and a <span class="command"><strong>make
1.1       dsieger  7494:     fetch</strong></span> will call <code class="filename">files/getsite.sh</code>
                   7495:     with the name of each file to download as an argument, expecting
                   7496:     it to output the URL of the directory from which to download
1.137     leot     7497:     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  7498:     example of this usage.</p>
                   7499: <p>If the download can't be automated, because the user must
                   7500:     submit personal information to apply for a password, or must pay
                   7501:     for the source, or whatever, you can set
                   7502:     <code class="varname">FETCH_MESSAGE</code> to a list of lines that are
                   7503:     displayed to the user before aborting the build. Example:</p>
                   7504: <pre class="programlisting">
                   7505: FETCH_MESSAGE=  "Please download the files"
                   7506: FETCH_MESSAGE+= "    "${DISTFILES:Q}
                   7507: FETCH_MESSAGE+= "manually from "${MASTER_SITES:Q}"."
1.111     sevan    7508: </pre>
1.1       dsieger  7509: </div>
1.41      asau     7510: <div class="sect2">
1.1       dsieger  7511: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   7512: <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  7513: <p>Sometimes authors of a software package make some
                   7514:     modifications after the software was released, and they put up a
                   7515:     new distfile without changing the package's version number. If a
                   7516:     package is already in pkgsrc at that time, the checksum will
                   7517:     no longer match. The contents of the new distfile should be
                   7518:     compared against the old one before changing anything, to make
                   7519:     sure the distfile was really updated on purpose, and that
                   7520:     no trojan horse or so crept in.
                   7521:     Please mention that the distfiles were compared and what was found
1.53      rodent   7522:     in your commit message.</p>
1.109     wiz      7523: <p>Then, the correct way to work around this is to set
                   7524:     <code class="varname">DIST_SUBDIR</code> to a unique directory name, usually
                   7525:     based on <code class="varname">PKGNAME_NOREV</code> (but take care with
                   7526:     python or ruby packages, where <code class="varname">PKGNAME</code> includes
                   7527:     a variable prefix). All <code class="varname">DISTFILES</code> and
1.1       dsieger  7528:     <code class="varname">PATCHFILES</code> for this package will be put in that
1.154     rillig   7529:     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  7530:     happens more often, <code class="varname">PKGNAME</code> can be used (thus
1.109     wiz      7531:     including the <code class="filename">nbX</code> suffix) or a date stamp can
                   7532:     be appended, like
                   7533:     <code class="varname">${PKGNAME_NOREV}-YYYYMMDD</code>.</p>
1.53      rodent   7534: <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>
                   7535: <p>Do not forget regenerating the <code class="filename">distinfo</code> file
1.1       dsieger  7536:     after that, since it contains the <code class="varname">DIST_SUBDIR</code>
                   7537:     path in the filenames.
1.53      rodent   7538:     Also, increase the PKGREVISION if the installed package is different.
1.1       dsieger  7539:     Furthermore, a mail to the package's authors seems appropriate
                   7540:     telling them that changing distfiles after releases without
                   7541:     changing the file names is not good practice.</p>
                   7542: </div>
1.88      tnn      7543: <div class="sect2">
                   7544: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   7545: <a name="build.fetch.github"></a>21.2.3. Packages hosted on github.com</h3></div></div></div>
1.90      tnn      7546: <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:
                   7547:     </p>
1.88      tnn      7548: <div class="sect3">
                   7549: <div class="titlepage"><div><div><h4 class="title">
1.154     rillig   7550: <a name="build.fetch.github.tag"></a>21.2.3.1. Fetch based on a tagged release</h4></div></div></div>
1.88      tnn      7551: <p>
                   7552:         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.
                   7553:       </p>
                   7554: <pre class="programlisting">
                   7555: DISTNAME=       exampleproject-1.0
1.90      tnn      7556: MASTER_SITES=   ${MASTER_SITE_GITHUB:=username/}
                   7557: #GITHUB_PROJECT=        # can be omitted if same as DISTNAME
                   7558: GITHUB_TAG=     v${PKGVERSION_NOREV}
1.88      tnn      7559: EXTRACT_SUFX=   .zip
                   7560: </pre>
                   7561: </div>
                   7562: <div class="sect3">
                   7563: <div class="titlepage"><div><div><h4 class="title">
1.154     rillig   7564: <a name="build.fetch.github.commit"></a>21.2.3.2. Fetch based on a specific commit</h4></div></div></div>
1.88      tnn      7565: <p>
                   7566:         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.
                   7567:       </p>
                   7568: <pre class="programlisting">
                   7569: DISTNAME=       example-1.0
1.107     jnemeth  7570: MASTER_SITES=   ${MASTER_SITE_GITHUB:=example/}
1.90      tnn      7571: #GITHUB_PROJECT=        # can be omitted if same as DISTNAME
                   7572: GITHUB_TAG=     988881adc9fc3655077dc2d4d757d480b5ea0e11
1.111     sevan    7573: </pre>
1.88      tnn      7574: </div>
                   7575: <div class="sect3">
                   7576: <div class="titlepage"><div><div><h4 class="title">
1.154     rillig   7577: <a name="build.fetch.github.release"></a>21.2.3.3. Fetch based on release</h4></div></div></div>
1.88      tnn      7578: <p>
                   7579:         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.
                   7580:       </p>
                   7581: <pre class="programlisting">
                   7582: DISTNAME=       offensive-1.6
1.90      tnn      7583: PKGNAME=        ${DISTNAME:S/offensive/proper/}
                   7584: MASTER_SITES=   ${MASTER_SITE_GITHUB:=username/}
                   7585: GITHUB_PROJECT= exampleproject
                   7586: GITHUB_RELEASE= rel-${PKGVERSION_NOREV} # usually just set this to ${DISTNAME}
                   7587: EXTRACT_SUFX=   .zip
1.111     sevan    7588: </pre>
1.88      tnn      7589: </div>
                   7590: </div>
1.1       dsieger  7591: </div>
1.41      asau     7592: <div class="sect1">
1.1       dsieger  7593: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   7594: <a name="fixes.configure"></a>21.3. The <span class="emphasis"><em>configure</em></span> phase</h2></div></div></div>
1.41      asau     7595: <div class="sect2">
1.1       dsieger  7596: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   7597: <a name="fixes.libtool"></a>21.3.1. Shared libraries - libtool</h3></div></div></div>
1.1       dsieger  7598: <p>pkgsrc supports many different machines, with different
                   7599:     object formats like a.out and ELF, and varying abilities to do
                   7600:     shared library and dynamic loading at all. To accompany this,
                   7601:     varying commands and options have to be passed to the
                   7602:     compiler, linker, etc. to get the Right Thing, which can be
                   7603:     pretty annoying especially if you don't have all the machines
                   7604:     at your hand to test things.  The
1.137     leot     7605:     <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      7606:     can help here, as it just <span class="quote">&#8220;<span class="quote">knows</span>&#8221;</span> how to build
1.1       dsieger  7607:     both static and dynamic libraries from a set of source files,
                   7608:     thus being platform-independent.</p>
                   7609: <p>Here's how to use libtool in a package in seven simple
                   7610:     steps:</p>
1.23      wiz      7611: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7612: <li class="listitem"><p>Add <code class="varname">USE_LIBTOOL=yes</code> to the package
1.1       dsieger  7613:        Makefile.</p></li>
1.23      wiz      7614: <li class="listitem"><p>For library objects, use <span class="quote">&#8220;<span class="quote">${LIBTOOL} --mode=compile
                   7615:        ${CC}</span>&#8221;</span> in place of <span class="quote">&#8220;<span class="quote">${CC}</span>&#8221;</span>. You could even
1.1       dsieger  7616:        add it to the definition of <code class="varname">CC</code>, if only
                   7617:        libraries are being built in a given Makefile. This one command
                   7618:        will build both PIC and non-PIC library objects, so you need not
                   7619:        have separate shared and non-shared library rules.</p></li>
1.23      wiz      7620: <li class="listitem">
1.1       dsieger  7621: <p>For the linking of the library, remove any
1.23      wiz      7622:        <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
                   7623:        -Bshareable</span>&#8221;</span> commands, and instead use:</p>
1.1       dsieger  7624: <pre class="programlisting">
                   7625: ${LIBTOOL} --mode=link \
                   7626:     ${CC} -o ${.TARGET:.a=.la} \
                   7627:         ${OBJS:.o=.lo} \
                   7628:         -rpath ${PREFIX}/lib \
                   7629:         -version-info major:minor
1.111     sevan    7630: </pre>
1.1       dsieger  7631: <p>Note that the library is changed to have a
                   7632:        <code class="filename">.la</code> extension, and the objects are
                   7633:        changed to have a <code class="filename">.lo</code>
                   7634:        extension. Change <code class="varname">OBJS</code> as
                   7635:        necessary. This automatically creates all of the
                   7636:        <code class="filename">.a</code>,
                   7637:        <code class="filename">.so.major.minor</code>, and ELF symlinks (if
                   7638:        necessary) in the build directory. Be sure to include
1.23      wiz      7639:        <span class="quote">&#8220;<span class="quote">-version-info</span>&#8221;</span>, especially when major and
1.1       dsieger  7640:        minor are zero, as libtool will otherwise strip off the
                   7641:        shared library version.</p>
                   7642: <p>From the libtool manual:</p>
                   7643: <pre class="programlisting">
                   7644: So, libtool library versions are described by three integers:
                   7645: 
                   7646: CURRENT
                   7647: The most recent interface number that this library implements.
                   7648: 
                   7649: REVISION
                   7650: The implementation number of the CURRENT interface.
                   7651: 
                   7652: AGE
                   7653: The difference between the newest and oldest interfaces that
                   7654: this library implements.  In other words, the library implements
                   7655: all the interface numbers in the range from number `CURRENT -
                   7656: AGE' to `CURRENT'.
                   7657: 
                   7658: If two libraries have identical CURRENT and AGE numbers, then the
                   7659: dynamic linker chooses the library with the greater REVISION number.
1.111     sevan    7660: </pre>
1.23      wiz      7661: <p>The <span class="quote">&#8220;<span class="quote">-release</span>&#8221;</span> option will produce
1.1       dsieger  7662:        different results for a.out and ELF (excluding symlinks)
                   7663:        in only one case. An ELF library of the form
1.23      wiz      7664:        <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  7665:        will have a symlink of
1.23      wiz      7666:        <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  7667:        on an a.out platform. This is handled
                   7668:        automatically.</p>
1.23      wiz      7669: <p>The <span class="quote">&#8220;<span class="quote">-rpath argument</span>&#8221;</span> is the install
1.1       dsieger  7670:        directory of the library being built.</p>
                   7671: <p>In the <code class="filename">PLIST</code>, include only the
                   7672:        <code class="filename">.la</code> file, the other files will be
                   7673:        added automatically.</p>
                   7674: </li>
1.23      wiz      7675: <li class="listitem">
1.1       dsieger  7676: <p>When linking shared object (<code class="filename">.so</code>)
1.157     leot     7677:        files, i.e. files that are loaded via <a class="citerefentry" href="http://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      7678:        shared libraries, use <span class="quote">&#8220;<span class="quote">-module
                   7679:        -avoid-version</span>&#8221;</span> to prevent them getting version
1.1       dsieger  7680:        tacked on.</p>
                   7681: <p>The <code class="filename">PLIST</code> file gets the
                   7682:        <code class="filename">foo.so</code> entry.</p>
                   7683: </li>
1.23      wiz      7684: <li class="listitem">
1.1       dsieger  7685: <p>When linking programs that depend on these libraries
                   7686:        <span class="emphasis"><em>before</em></span> they are installed, preface
1.157     leot     7687:        the <a class="citerefentry" href="http://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="http://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      7688:        --mode=link</span>&#8221;</span>, and it will find the correct
1.1       dsieger  7689:        libraries (static or shared), but please be aware that
                   7690:        libtool will not allow you to specify a relative path in
1.23      wiz      7691:        -L (such as <span class="quote">&#8220;<span class="quote">-L../somelib</span>&#8221;</span>), because it
1.1       dsieger  7692:        expects you to change that argument to be the
                   7693:        <code class="filename">.la</code> file. e.g.</p>
                   7694: <pre class="programlisting">
                   7695: ${LIBTOOL} --mode=link ${CC} -o someprog -L../somelib -lsomelib
1.111     sevan    7696: </pre>
1.1       dsieger  7697: <p>should be changed to:</p>
                   7698: <pre class="programlisting">
                   7699: ${LIBTOOL} --mode=link ${CC} -o <em class="replaceable"><code>someprog</code></em> <em class="replaceable"><code>../somelib/somelib.la</code></em>
1.111     sevan    7700: </pre>
1.1       dsieger  7701: <p>and it will do the right thing with the libraries.</p>
                   7702: </li>
1.23      wiz      7703: <li class="listitem">
1.157     leot     7704: <p>When installing libraries, preface the <a class="citerefentry" href="http://netbsd.gw.com/cgi-bin/man-cgi?install+1.i386+NetBSD-8.1"><span class="citerefentry"><span class="refentrytitle">install</span>(1)</span></a>
                   7705:        or <a class="citerefentry" href="http://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      7706:        --mode=install</span>&#8221;</span>, and change the library name to
1.1       dsieger  7707:        <code class="filename">.la</code>. e.g.</p>
                   7708: <pre class="programlisting">
1.22      jakllsch 7709: ${LIBTOOL} --mode=install ${BSD_INSTALL_LIB} ${SOMELIB:.a=.la} ${PREFIX}/lib
1.111     sevan    7710: </pre>
1.1       dsieger  7711: <p>This will install the static <code class="filename">.a</code>,
                   7712:        shared library, any needed symlinks, and run
1.157     leot     7713:        <a class="citerefentry" href="http://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  7714: </li>
1.23      wiz      7715: <li class="listitem"><p>In your <code class="filename">PLIST</code>, include only
1.1       dsieger  7716:        the <code class="filename">.la</code>
                   7717:        file (this is a change from previous behaviour).</p></li>
                   7718: </ol></div>
                   7719: </div>
1.41      asau     7720: <div class="sect2">
1.1       dsieger  7721: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   7722: <a name="using-libtool"></a>21.3.2. Using libtool on GNU packages that already support libtool</h3></div></div></div>
1.1       dsieger  7723: <p>Add <code class="varname">USE_LIBTOOL=yes</code> to the
                   7724:     package Makefile. This will override the package's own libtool
                   7725:     in most cases.  For older libtool using packages,  libtool is
                   7726:     made by ltconfig script during the do-configure step; you can
1.10      hubertf  7727:     check the libtool script location by doing <span class="command"><strong>make
1.1       dsieger  7728:     configure; find work*/ -name libtool</strong></span>.</p>
                   7729: <p><code class="varname">LIBTOOL_OVERRIDE</code> specifies which libtool
                   7730:     scripts, relative to <code class="varname">WRKSRC</code>, to override.  By
1.23      wiz      7731:     default, it is set to <span class="quote">&#8220;<span class="quote">libtool */libtool
                   7732:     */*/libtool</span>&#8221;</span>.  If this does not match the location of the
1.1       dsieger  7733:     package's libtool script(s), set it as appropriate.</p>
                   7734: <p>If you do not need <code class="filename">*.a</code> static
                   7735:     libraries built and installed, then use
                   7736:     <code class="varname">SHLIBTOOL_OVERRIDE</code> instead.</p>
                   7737: <p>If your package makes use of the platform-independent library
                   7738:     for loading dynamic shared objects, that comes with libtool
                   7739:     (libltdl), you should include devel/libltdl/buildlink3.mk.</p>
                   7740: <p>Some packages use libtool incorrectly so that the package
                   7741:     may not work or build in some circumstances. Some of the more
                   7742:     common errors are:</p>
1.41      asau     7743: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      7744: <li class="listitem">
1.1       dsieger  7745: <p>The inclusion of a shared object (-module) as a dependent library in an
                   7746:        executable or library. This in itself isn't a problem if one of two things
                   7747:        has been done:</p>
1.23      wiz      7748: <div class="orderedlist"><ol class="orderedlist" type="1">
                   7749: <li class="listitem"><p>The shared object is named correctly, i.e.
1.1       dsieger  7750:            <code class="filename">libfoo.la</code>, not
                   7751:            <code class="filename">foo.la</code></p></li>
1.23      wiz      7752: <li class="listitem"><p>The -dlopen option is used when linking an executable.</p></li>
1.1       dsieger  7753: </ol></div>
                   7754: </li>
1.23      wiz      7755: <li class="listitem"><p>The use of libltdl without the correct calls to initialisation routines.
1.1       dsieger  7756:        The function lt_dlinit() should be called and the macro
                   7757:        <code class="varname">LTDL_SET_PRELOADED_SYMBOLS</code> included in
                   7758:        executables.</p></li>
                   7759: </ul></div>
                   7760: </div>
1.41      asau     7761: <div class="sect2">
1.1       dsieger  7762: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   7763: <a name="autoconf-automake"></a>21.3.3. GNU Autoconf/Automake</h3></div></div></div>
1.1       dsieger  7764: <p>If a package needs GNU autoconf or automake to be executed
                   7765:     to regenerate the configure script and Makefile.in makefile
                   7766:     templates, then they should be executed in a pre-configure
                   7767:     target.</p>
                   7768: <p>For packages that need only autoconf:</p>
                   7769: <pre class="programlisting">
                   7770: AUTOCONF_REQD=  2.50            # if default version is not good enough
                   7771: USE_TOOLS+=     autoconf        # use "autoconf213" for autoconf-2.13
                   7772: ...
                   7773: 
                   7774: pre-configure:
                   7775:         cd ${WRKSRC} &amp;&amp; autoconf
                   7776: 
                   7777: ...
1.111     sevan    7778: </pre>
1.1       dsieger  7779: <p>and for packages that need automake and autoconf:</p>
                   7780: <pre class="programlisting">
                   7781: AUTOMAKE_REQD=  1.7.1           # if default version is not good enough
                   7782: USE_TOOLS+=     automake        # use "automake14" for automake-1.4
                   7783: ...
                   7784: 
                   7785: pre-configure:
                   7786:         set -e; cd ${WRKSRC}; \
                   7787:         aclocal; autoheader; automake -a --foreign -i; autoconf
                   7788: 
                   7789: ...
1.111     sevan    7790: </pre>
1.1       dsieger  7791: <p>Packages which use GNU Automake will almost certainly
                   7792:     require GNU Make.</p>
                   7793: <p>There are times when the configure process makes
                   7794:     additional changes to the generated files, which then causes
                   7795:     the build process to try to re-execute the automake sequence.
                   7796:     This is prevented by touching various files in the configure
                   7797:     stage. If this causes problems with your package you can set
                   7798:     <code class="varname">AUTOMAKE_OVERRIDE=NO</code> in the package
                   7799:     Makefile.</p>
                   7800: </div>
                   7801: </div>
1.41      asau     7802: <div class="sect1">
1.1       dsieger  7803: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   7804: <a name="programming-languages"></a>21.4. Programming languages</h2></div></div></div>
1.41      asau     7805: <div class="sect2">
1.1       dsieger  7806: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   7807: <a name="basic-programming-languages"></a>21.4.1. C, C++, and Fortran</h3></div></div></div>
1.1       dsieger  7808: <p>Compilers for the C, C++, and Fortran languages comes with
                   7809:     the NetBSD base system.  By default, pkgsrc assumes that a package
                   7810:     is written in C and will hide all other compilers (via the wrapper
1.154     rillig   7811:     framework, see <a class="xref" href="#buildlink" title="Chapter 16. Buildlink methodology">Chapter 16, <i>Buildlink methodology</i></a>).</p>
1.1       dsieger  7812: <p>To declare which language's compiler a package needs, set
                   7813:     the <code class="varname">USE_LANGUAGES</code> variable. Allowed values
1.23      wiz      7814:     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
                   7815:     <span class="quote">&#8220;<span class="quote">fortran</span>&#8221;</span> (and any combination).  The default is
                   7816:     <span class="quote">&#8220;<span class="quote">c</span>&#8221;</span>.  Packages using GNU configure scripts, even if
1.1       dsieger  7817:     written in C++, usually need a C compiler for the configure
                   7818:     phase.</p>
                   7819: </div>
1.41      asau     7820: <div class="sect2">
1.1       dsieger  7821: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   7822: <a name="java-programming-language"></a>21.4.2. Java</h3></div></div></div>
1.1       dsieger  7823: <p>If a program is written in Java, use the Java framework in
                   7824:     pkgsrc.  The package must include
                   7825:     <code class="filename">../../mk/java-vm.mk</code>.  This Makefile fragment
                   7826:     provides the following variables:</p>
1.41      asau     7827: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      7828: <li class="listitem"><p><code class="varname">USE_JAVA</code> defines if a build
1.1       dsieger  7829:       dependency on the JDK is added.  If
1.23      wiz      7830:       <code class="varname">USE_JAVA</code> is set to <span class="quote">&#8220;<span class="quote">run</span>&#8221;</span>, then
1.1       dsieger  7831:       there is only a runtime dependency on the JDK.  The default is
1.23      wiz      7832:       <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>, which also adds a build dependency on the
1.1       dsieger  7833:       JDK.</p></li>
1.23      wiz      7834: <li class="listitem"><p>Set <code class="varname">USE_JAVA2</code> to declare that
1.1       dsieger  7835:       a package needs a Java2 implementation.  The supported values
1.23      wiz      7836:       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
                   7837:       <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
                   7838:       implementation, <span class="quote">&#8220;<span class="quote">1.4</span>&#8221;</span> insists on versions 1.4 or
                   7839:       above, and <span class="quote">&#8220;<span class="quote">1.5</span>&#8221;</span> only accepts versions 1.5 or
1.1       dsieger  7840:       above. This variable is not set by default.</p></li>
1.24      wiz      7841: <li class="listitem"><p><code class="varname">PKG_JAVA_HOME</code> is
                   7842:       automatically set to the runtime location of the used Java
                   7843:       implementation dependency. It may be used to set
                   7844:       <code class="varname">JAVA_HOME</code> to a good value if the program
                   7845:       needs this variable to be defined.
                   7846:       </p></li>
1.1       dsieger  7847: </ul></div>
                   7848: </div>
1.41      asau     7849: <div class="sect2">
1.1       dsieger  7850: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   7851: <a name="perl-scripts"></a>21.4.3. Packages containing perl scripts</h3></div></div></div>
1.1       dsieger  7852: <p>If your package contains interpreted perl scripts, add
1.23      wiz      7853:     <span class="quote">&#8220;<span class="quote">perl</span>&#8221;</span> to the <code class="varname">USE_TOOLS</code> variable
1.1       dsieger  7854:     and set <code class="varname">REPLACE_PERL</code> to ensure that the proper
                   7855:     interpreter path is set. <code class="varname">REPLACE_PERL</code> should
                   7856:     contain a list of scripts, relative to <code class="varname">WRKSRC</code>,
1.74      wiz      7857:     that you want adjusted. Every occurrence of
                   7858:     <code class="filename">*/bin/perl</code> in a she-bang line will be
                   7859:     replaced with the full path to the perl executable.</p>
1.1       dsieger  7860: <p>If a particular version of perl is needed, set the
                   7861:     <code class="varname">PERL5_REQD</code> variable to the version number.  The
1.23      wiz      7862:     default is <span class="quote">&#8220;<span class="quote">5.0</span>&#8221;</span>.</p>
1.154     rillig   7863: <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  7864:     about handling perl modules.</p>
                   7865: </div>
1.41      asau     7866: <div class="sect2">
1.1       dsieger  7867: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   7868: <a name="shell-scripts"></a>21.4.4. Packages containing shell scripts</h3></div></div></div>
1.40      wiz      7869: <p><code class="varname">REPLACE_SH</code>,
                   7870:     <code class="varname">REPLACE_BASH</code>, <code class="varname">REPLACE_CSH</code>,
                   7871:     and <code class="varname">REPLACE_KSH</code> can be used to replace shell
                   7872:     hash bangs in files. Please use the appropriate one, prefering
                   7873:     <code class="varname">REPLACE_SH</code> in case this shell is sufficient.
1.74      wiz      7874:     Each should contain a list of scripts, relative to
                   7875:     <code class="varname">WRKSRC</code>, that you want adjusted. Every
                   7876:     occurrence of the matching shell in a she-bang line will be
                   7877:     replaced with the full path to the shell executable.
1.40      wiz      7878:     When using <code class="varname">REPLACE_BASH</code>, don't forget to add
                   7879:     <code class="filename">bash</code> to <code class="varname">USE_TOOLS</code>.</p>
                   7880: </div>
1.41      asau     7881: <div class="sect2">
1.40      wiz      7882: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   7883: <a name="other-programming-languages"></a>21.4.5. Other programming languages</h3></div></div></div>
1.1       dsieger  7884: <p>Currently, there is no special handling for other languages
                   7885:     in pkgsrc.  If a compiler package provides a
                   7886:     <code class="filename">buildlink3.mk</code> file, include that, otherwise
                   7887:     just add a (build) dependency on the appropriate compiler
                   7888:     package.</p>
                   7889: </div>
                   7890: </div>
1.41      asau     7891: <div class="sect1">
1.1       dsieger  7892: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   7893: <a name="fixes.build"></a>21.5. The <span class="emphasis"><em>build</em></span> phase</h2></div></div></div>
1.1       dsieger  7894: <p>The most common failures when building a package are that
                   7895:        some platforms do not provide certain header files, functions or
                   7896:        libraries, or they provide the functions in a library that the
                   7897:        original package author didn't know. To work around this, you
                   7898:        can rewrite the source code in most cases so that it does not
                   7899:        use the missing functions or provides a replacement function.</p>
1.41      asau     7900: <div class="sect2">
1.1       dsieger  7901: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   7902: <a name="fixes.build.cpp"></a>21.5.1. Compiling C and C++ code conditionally</h3></div></div></div>
1.1       dsieger  7903: <p>If a package already comes with a GNU configure script, the
                   7904:        preferred way to fix the build failure is to change the
                   7905:        configure script, not the code. In the other cases, you can
                   7906:        utilize the C preprocessor, which defines certain macros
                   7907:        depending on the operating system and hardware architecture it
                   7908:        compiles for. These macros can be queried using for example
                   7909:        <code class="varname">#if defined(__i386)</code>. Almost every operating
                   7910:        system, hardware architecture and compiler has its own macro.
                   7911:        For example, if the macros <code class="varname">__GNUC__</code>,
                   7912:        <code class="varname">__i386__</code> and <code class="varname">__NetBSD__</code>
                   7913:        are all defined, you know that you are using NetBSD on an i386
                   7914:        compatible CPU, and your compiler is GCC.</p>
                   7915: <p>The list of the following macros for hardware and
                   7916:        operating system depends on the compiler that is used. For
                   7917:        example, if you want to conditionally compile code on Solaris,
                   7918:        don't use <code class="varname">__sun__</code>, as the SunPro compiler
                   7919:        does not define it. Use <code class="varname">__sun</code> instead.</p>
1.41      asau     7920: <div class="sect3">
1.1       dsieger  7921: <div class="titlepage"><div><div><h4 class="title">
1.154     rillig   7922: <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  7923: <p>To distinguish between 4.4 BSD-derived systems and the
                   7924:         rest of the world, you should use the following code.</p>
                   7925: <pre class="programlisting">
                   7926: #include &lt;sys/param.h&gt;
                   7927: #if (defined(BSD) &amp;&amp; BSD &gt;= 199306)
                   7928: /* BSD-specific code goes here */
                   7929: #else
                   7930: /* non-BSD-specific code goes here */
                   7931: #endif
                   7932: </pre>
                   7933: <p>If this distinction is not fine enough, you can also test
                   7934:        for the following macros.</p>
                   7935: <pre class="programlisting">
1.45      obache   7936: Cygwin      __CYGWIN__
                   7937: DragonFly   __DragonFly__
1.1       dsieger  7938: FreeBSD     __FreeBSD__
1.45      obache   7939: Haiku       __HAIKU__
1.1       dsieger  7940: Interix     __INTERIX
                   7941: IRIX        __sgi (TODO: get a definite source for this)
                   7942: Linux       linux, __linux, __linux__
1.83      dholland 7943: Mac OS X    __APPLE__
1.45      obache   7944: MirBSD      __MirBSD__ (__OpenBSD__ is also defined)
                   7945: Minix3      __minix
1.1       dsieger  7946: NetBSD      __NetBSD__
                   7947: OpenBSD     __OpenBSD__
                   7948: Solaris     sun, __sun
                   7949: </pre>
                   7950: </div>
1.41      asau     7951: <div class="sect3">
1.1       dsieger  7952: <div class="titlepage"><div><div><h4 class="title">
1.154     rillig   7953: <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  7954: <pre class="programlisting">
                   7955: i386        i386, __i386, __i386__
                   7956: MIPS        __mips
                   7957: SPARC       sparc, __sparc
                   7958: </pre>
                   7959: </div>
1.41      asau     7960: <div class="sect3">
1.1       dsieger  7961: <div class="titlepage"><div><div><h4 class="title">
1.154     rillig   7962: <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  7963: <pre class="programlisting">
                   7964: GCC         __GNUC__ (major version), __GNUC_MINOR__
                   7965: MIPSpro     _COMPILER_VERSION (0x741 for MIPSpro 7.41)
                   7966: SunPro      __SUNPRO_C (0x570 for Sun C 5.7)
                   7967: SunPro C++  __SUNPRO_CC (0x580 for Sun C++ 5.8)
                   7968: </pre>
                   7969: </div>
                   7970: </div>
1.41      asau     7971: <div class="sect2">
1.1       dsieger  7972: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   7973: <a name="compiler-bugs"></a>21.5.2. How to handle compiler bugs</h3></div></div></div>
1.1       dsieger  7974: <p>Some source files trigger bugs in the compiler, based on
                   7975:         combinations of compiler version and architecture and almost
                   7976:         always relation to optimisation being enabled.  Common symptoms
                   7977:         are gcc internal errors or never finishing compiling a
                   7978:        file.</p>
                   7979: <p>Typically, a workaround involves testing the
                   7980:         <code class="varname">MACHINE_ARCH</code> and compiler version, disabling
                   7981:         optimisation for that combination of file,
1.87      tnn      7982:        <code class="varname">MACHINE_ARCH</code> and compiler.</p>
                   7983: <p>This used to be a big problem in the past, but is rarely
                   7984:        needed now as compiler technology has matured. If you still need
                   7985:        to add a compiler specific workaround, please do so in the file
                   7986:        <code class="filename">hacks.mk</code> and describe the symptom and
                   7987:        compiler version as detailed as possible.</p>
1.1       dsieger  7988: </div>
1.41      asau     7989: <div class="sect2">
1.1       dsieger  7990: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   7991: <a name="undefined-reference"></a>21.5.3. Undefined reference to <span class="quote">&#8220;<span class="quote">...</span>&#8221;</span>
1.23      wiz      7992: </h3></div></div></div>
1.1       dsieger  7993: <p>This error message often means that a package did not
                   7994:        link to a shared library it needs. The following functions are
                   7995:        known to cause this error message over and over.</p>
                   7996: <div class="informaltable">
1.106     tnn      7997: <a name="undefined-reference-functions"></a><table class="informaltable" border="1">
1.1       dsieger  7998: <colgroup>
                   7999: <col>
                   8000: <col>
                   8001: <col>
                   8002: </colgroup>
                   8003: <thead><tr>
                   8004: <th>Function</th>
                   8005: <th>Library</th>
                   8006: <th>Affected platforms</th>
                   8007: </tr></thead>
                   8008: <tbody>
                   8009: <tr>
                   8010: <td>accept, bind, connect</td>
                   8011: <td>-lsocket</td>
                   8012: <td>Solaris</td>
                   8013: </tr>
                   8014: <tr>
                   8015: <td>crypt</td>
                   8016: <td>-lcrypt</td>
                   8017: <td>DragonFly, NetBSD</td>
                   8018: </tr>
                   8019: <tr>
                   8020: <td>dlopen, dlsym</td>
                   8021: <td>-ldl</td>
                   8022: <td>Linux</td>
                   8023: </tr>
                   8024: <tr>
                   8025: <td>gethost*</td>
                   8026: <td>-lnsl</td>
                   8027: <td>Solaris</td>
                   8028: </tr>
                   8029: <tr>
                   8030: <td>inet_aton</td>
                   8031: <td>-lresolv</td>
                   8032: <td>Solaris</td>
                   8033: </tr>
                   8034: <tr>
                   8035: <td>nanosleep, sem_*, timer_*</td>
                   8036: <td>-lrt</td>
                   8037: <td>Solaris</td>
                   8038: </tr>
                   8039: <tr>
                   8040: <td>openpty</td>
                   8041: <td>-lutil</td>
                   8042: <td>Linux</td>
                   8043: </tr>
                   8044: </tbody>
                   8045: </table>
                   8046: </div>
                   8047: <p>To fix these linker errors, it is often sufficient to say
                   8048:     <code class="literal">LIBS.<em class="replaceable"><code>OperatingSystem</code></em>+=
                   8049:     -l<em class="replaceable"><code>foo</code></em></code> to the package
1.10      hubertf  8050:     <code class="filename">Makefile</code> and then say <span class="command"><strong>bmake clean;
1.1       dsieger  8051:     bmake</strong></span>.</p>
1.41      asau     8052: <div class="sect3">
1.1       dsieger  8053: <div class="titlepage"><div><div><h4 class="title">
1.154     rillig   8054: <a name="undefined-reference-sunpro"></a>21.5.3.1. Special issue: The SunPro compiler</h4></div></div></div>
1.1       dsieger  8055: <p>When you are using the SunPro compiler, there is another
                   8056: possibility. That compiler cannot handle the following code:</p>
                   8057: <pre class="programlisting">
                   8058: extern int extern_func(int);
                   8059: 
                   8060: static inline int
                   8061: inline_func(int x)
                   8062: {
                   8063:         return extern_func(x);
                   8064: }
                   8065: 
                   8066: int main(void)
                   8067: {
                   8068:         return 0;
                   8069: }
                   8070: </pre>
                   8071: <p>It generates the code for <code class="function">inline_func</code> even if
                   8072: that function is never used. This code then refers to
                   8073: <code class="function">extern_func</code>, which can usually not be resolved. To
                   8074: solve this problem you can try to tell the package to disable inlining
                   8075: of functions.</p>
                   8076: </div>
                   8077: </div>
1.41      asau     8078: <div class="sect2">
1.1       dsieger  8079: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8080: <a name="out-of-memory"></a>21.5.4. Running out of memory</h3></div></div></div>
1.1       dsieger  8081: <p>Sometimes packages fail to build because the compiler runs
                   8082:     into an operating system specific soft limit.  With the
                   8083:     <code class="varname">UNLIMIT_RESOURCES</code> variable pkgsrc can be told
1.94      wiz      8084:     to unlimit the resources.  Currently, the allowed values are any combination of
                   8085:     <span class="quote">&#8220;<span class="quote">cputime</span>&#8221;</span>, <span class="quote">&#8220;<span class="quote">datasize</span>&#8221;</span>,
                   8086:     <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  8087:     Setting this variable is similar to running the shell builtin
1.10      hubertf  8088:     <span class="command"><strong>ulimit</strong></span> command to raise the maximum data
1.1       dsieger  8089:     segment size or maximum stack size of a process, respectively, to
                   8090:     their hard limits.</p>
                   8091: </div>
                   8092: </div>
1.41      asau     8093: <div class="sect1">
1.1       dsieger  8094: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   8095: <a name="fixes.install"></a>21.6. The <span class="emphasis"><em>install</em></span> phase</h2></div></div></div>
1.41      asau     8096: <div class="sect2">
1.1       dsieger  8097: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8098: <a name="install-scripts"></a>21.6.1. Creating needed directories</h3></div></div></div>
1.10      hubertf  8099: <p>The BSD-compatible <span class="command"><strong>install</strong></span> supplied
1.1       dsieger  8100:     with some operating systems cannot create more than one
                   8101:     directory at a time. As such, you should call
                   8102:     <code class="literal">${INSTALL_*_DIR}</code> like this:</p>
                   8103: <pre class="programlisting">
                   8104: ${INSTALL_DATA_DIR} ${PREFIX}/dir1
                   8105: ${INSTALL_DATA_DIR} ${PREFIX}/dir2
1.111     sevan    8106: </pre>
1.23      wiz      8107: <p>You can also just append <span class="quote">&#8220;<span class="quote"><code class="literal">dir1
                   8108:     dir2</code></span>&#8221;</span> to the
1.1       dsieger  8109:     <code class="varname">INSTALLATION_DIRS</code> variable, which will
                   8110:     automatically do the right thing.</p>
                   8111: </div>
1.41      asau     8112: <div class="sect2">
1.1       dsieger  8113: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8114: <a name="where-to-install-documentation"></a>21.6.2. Where to install documentation</h3></div></div></div>
1.1       dsieger  8115: <p>In general, documentation should be installed into
                   8116:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
                   8117:     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code> (the latter
                   8118:     includes the version number of the package).</p>
                   8119: <p>Many modern packages using GNU autoconf allow to set the
                   8120:     directory where HTML documentation is installed with the
1.23      wiz      8121:     <span class="quote">&#8220;<span class="quote">--with-html-dir</span>&#8221;</span> option. Sometimes using this flag
1.1       dsieger  8122:     is needed because otherwise the documentation ends up in
                   8123:     <code class="filename">${PREFIX}/share/doc/html</code> or other
                   8124:     places.</p>
                   8125: <p>An exception to the above is that library API documentation
1.137     leot     8126:     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  8127:     browsers (devhelp) should be left at their default location, which
                   8128:     is <code class="filename">${PREFIX}/share/gtk-doc</code>.  Such
                   8129:     documentation can be recognized from files ending in
                   8130:     <code class="filename">.devhelp</code> or <code class="filename">.devhelp2</code>.
                   8131:     (It is also acceptable to install such files in
                   8132:     <code class="filename">${PREFIX}/share/doc/${PKGBASE}</code> or
                   8133:     <code class="filename">${PREFIX}/share/doc/${PKGNAME}</code>; the
                   8134:     <code class="filename">.devhelp*</code> file must be directly in that
                   8135:     directory then, no additional subdirectory level is allowed in
                   8136:     this case. This is usually achieved by using
1.23      wiz      8137:     <span class="quote">&#8220;<span class="quote">--with-html-dir=${PREFIX}/share/doc</span>&#8221;</span>.
1.1       dsieger  8138:     <code class="filename">${PREFIX}/share/gtk-doc</code> is preferred
                   8139:     though.)</p>
                   8140: </div>
1.41      asau     8141: <div class="sect2">
1.1       dsieger  8142: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8143: <a name="installing-score-files"></a>21.6.3. Installing highscore files</h3></div></div></div>
1.1       dsieger  8144: <p>Certain packages, most of them in the games category, install
                   8145:     a score file that allows all users on the system to record their
                   8146:     highscores.  In order for this to work, the binaries need to be
                   8147:     installed setgid and the score files owned by the appropriate
1.35      wiz      8148:     group and/or owner (traditionally the "games" user/group).  Set
                   8149:     <code class="varname">USE_GAMESGROUP</code> to yes to support this. The
1.1       dsieger  8150:     following variables, documented in more detail in
                   8151:     <code class="filename">mk/defaults/mk.conf</code>, control this
1.35      wiz      8152:     behaviour: <code class="varname">GAMEDATAMODE</code>,
                   8153:     <code class="varname">GAMEDIRMODE</code>, <code class="varname">GAMES_GROUP</code>,
1.100     leot     8154:     <code class="varname">GAMEMODE</code>, <code class="varname">GAME_USER</code>.
                   8155:     Other useful variables are: <code class="varname">GAMEDIR_PERMS</code>,
                   8156:     <code class="varname">GAMEDATA_PERMS</code> and
                   8157:     <code class="varname">SETGID_GAMES_PERMS</code>.</p>
                   8158: <p>An example that illustrates some of the variables described above is
                   8159:     <code class="filename">games/moon-buggy</code>. <code class="varname">OWN_DIRS_PERMS</code> is
                   8160:     used to properly set directory permissions of the directory where the
                   8161:     scorefile is saved, <code class="varname">REQD_FILES_PERMS</code> is used to create a
                   8162:     dummy scorefile (<code class="filename">mbscore</code>) with the proper permissions
                   8163:     and <code class="varname">SPECIAL_PERMS</code> is used to install setgid the game
                   8164:     binary:</p>
                   8165: <pre class="programlisting">
1.112     rillig   8166: USE_GAMESGROUP=         yes
1.100     leot     8167: 
1.112     rillig   8168: BUILD_DEFS+=            VARBASE
1.100     leot     8169: 
1.112     rillig   8170: OWN_DIRS_PERMS+=        ${VARBASE}/games/moon-buggy ${GAMEDIR_PERMS}
                   8171: REQD_FILES_PERMS+=      /dev/null ${VARBASE}/games/moon-buggy/mbscore ${GAMEDATA_PERMS}
                   8172: SPECIAL_PERMS+=         ${PREFIX}/bin/moon-buggy ${SETGID_GAMES_PERMS}
1.111     sevan    8173: </pre>
1.100     leot     8174: <p>Various <code class="varname">INSTALL_*</code> variables are also available:
                   8175:     <code class="varname">INSTALL_GAME</code> to install setgid game binaries,
                   8176:     <code class="varname">INSTALL_GAME_DIR</code> to install game directories that are
                   8177:     needed to be accessed by setgid games and
                   8178:     <code class="varname">INSTALL_GAME_DATA</code> to install scorefiles.</p>
1.14      jmcneill 8179: <p>A package should therefore never hard code file ownership or
1.100     leot     8180:     access permissions but rely on <code class="varname">*_PERMS</code> as described above
                   8181:     or alternatively on <code class="varname">INSTALL_GAME</code>,
                   8182:     <code class="varname">INSTALL_GAME_DATA</code> and
                   8183:     <code class="varname">INSTALL_GAME_DIR</code> to set these correctly.</p>
1.1       dsieger  8184: </div>
1.41      asau     8185: <div class="sect2">
1.1       dsieger  8186: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8187: <a name="destdir-support"></a>21.6.4. Adding DESTDIR support to packages</h3></div></div></div>
1.14      jmcneill 8188: <p><code class="varname">DESTDIR</code> support means that a package
                   8189:     installs into a staging directory, not the final location of the
                   8190:     files. Then a binary package is created which can be used for
                   8191:     installation as usual. There are two ways: Either the package must
1.23      wiz      8192:     install as root (<span class="quote">&#8220;<span class="quote">destdir</span>&#8221;</span>) or the package can
                   8193:     install as non-root user (<span class="quote">&#8220;<span class="quote">user-destdir</span>&#8221;</span>).</p>
1.41      asau     8194: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      8195: <li class="listitem"><p><code class="varname">PKG_DESTDIR_SUPPORT</code> has to be
1.113     leot     8196:       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>.
                   8197:       By default <code class="varname">PKG_DESTDIR_SUPPORT</code>
1.38      wiz      8198:       is set to <span class="quote">&#8220;<span class="quote">user-destdir</span>&#8221;</span> to help catching more
                   8199:       potential packaging problems. If bsd.prefs.mk is included in the Makefile,
1.14      jmcneill 8200:       <code class="varname">PKG_DESTDIR_SUPPORT</code> needs to be set before
                   8201:       the inclusion.</p></li>
1.23      wiz      8202: <li class="listitem"><p>All installation operations have to be prefixed with
1.4       rillig   8203:       <code class="filename">${DESTDIR}</code>.</p></li>
1.23      wiz      8204: <li class="listitem"><p>automake gets this DESTDIR mostly right
1.4       rillig   8205:       automatically. Many manual rules and pre/post-install often are
                   8206:       incorrect; fix them.</p></li>
1.23      wiz      8207: <li class="listitem"><p>If files are installed with special owner/group
1.17      imil     8208:       use <code class="varname">SPECIAL_PERMS</code>.</p></li>
1.23      wiz      8209: <li class="listitem"><p>In general, packages should support
1.4       rillig   8210:       <code class="varname">UNPRIVILEGED</code> to be able to use
                   8211:       DESTDIR.</p></li>
                   8212: </ul></div>
                   8213: </div>
1.41      asau     8214: <div class="sect2">
1.4       rillig   8215: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8216: <a name="hardcoded-paths"></a>21.6.5. Packages with hardcoded paths to other interpreters</h3></div></div></div>
1.1       dsieger  8217: <p>Your package may also contain scripts with hardcoded paths to
                   8218:       other interpreters besides (or as well as) perl.  To correct the
                   8219:       full pathname to the script interpreter, you need to set the
                   8220:       following definitions in your <code class="filename">Makefile</code> (we
1.10      hubertf  8221:     shall use <span class="command"><strong>tclsh</strong></span> in this example):</p>
1.1       dsieger  8222: <pre class="programlisting">
                   8223: REPLACE_INTERPRETER+=   tcl
                   8224: REPLACE.tcl.old=        .*/bin/tclsh
                   8225: REPLACE.tcl.new=        ${PREFIX}/bin/tclsh
                   8226: REPLACE_FILES.tcl=      # list of tcl scripts which need to be fixed,
                   8227: # relative to ${WRKSRC}, just as in REPLACE_PERL
1.111     sevan    8228: </pre>
1.41      asau     8229: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  8230: <h3 class="title">Note</h3>
                   8231: <p>Before March 2006, these variables were called
                   8232:     <code class="varname">_REPLACE.*</code> and
                   8233:     <code class="varname">_REPLACE_FILES.*</code>.</p>
                   8234: </div>
                   8235: </div>
1.41      asau     8236: <div class="sect2">
1.1       dsieger  8237: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8238: <a name="perl-modules"></a>21.6.6. Packages installing perl modules</h3></div></div></div>
1.1       dsieger  8239: <p>Makefiles of packages providing perl5 modules should include
                   8240:     the Makefile fragment
                   8241:     <code class="filename">../../lang/perl5/module.mk</code>.  It provides a
1.10      hubertf  8242:     <span class="command"><strong>do-configure</strong></span> target for the standard perl
1.1       dsieger  8243:     configuration for such modules as well as various hooks to tune
                   8244:     this configuration.  See comments in this file for
                   8245:     details.</p>
                   8246: <p>Perl5 modules will install into different places depending
                   8247:     on the version of perl used during the build process.  To
                   8248:     address this, pkgsrc will append lines to the
                   8249:     <code class="filename">PLIST</code> corresponding to the files listed in
                   8250:     the installed <code class="filename">.packlist</code> file generated by
                   8251:     most perl5 modules.  This is invoked by defining
                   8252:     <code class="varname">PERL5_PACKLIST</code> to a space-separated list of
1.47      wiz      8253:     packlist files relative to <code class="varname">PERL5_PACKLIST_DIR</code>
                   8254:     (<code class="varname">PERL5_INSTALLVENDORARCH</code> by default),
                   8255:     e.g.:</p>
1.1       dsieger  8256: <pre class="programlisting">
1.47      wiz      8257: PERL5_PACKLIST= auto/Pg/.packlist
1.111     sevan    8258: </pre>
1.47      wiz      8259: <p>The perl5 config variables
                   8260:     <code class="varname">installarchlib</code>,
                   8261:     <code class="varname">installscript</code>,
                   8262:     <code class="varname">installvendorbin</code>,
                   8263:     <code class="varname">installvendorscript</code>,
                   8264:     <code class="varname">installvendorarch</code>,
                   8265:     <code class="varname">installvendorlib</code>,
                   8266:     <code class="varname">installvendorman1dir</code>, and
                   8267:     <code class="varname">installvendorman3dir</code> represent those
                   8268:     locations in which components of perl5 modules may be installed,
                   8269:     provided as variable with uppercase and prefixed with
                   8270:     <code class="varname">PERL5_</code>, e.g. <code class="varname">PERL5_INSTALLARCHLIB</code>
                   8271:     and may be used by perl5 packages that don't have a packlist.
                   8272:     These variables are also substituted for in the
                   8273:     <code class="filename">PLIST</code> as uppercase prefixed with
                   8274:     <code class="varname">PERL5_SUB_</code>.</p>
1.1       dsieger  8275: </div>
1.41      asau     8276: <div class="sect2">
1.1       dsieger  8277: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8278: <a name="faq.info-files"></a>21.6.7. Packages installing info files</h3></div></div></div>
1.1       dsieger  8279: <p>Some packages install info files or use the
1.23      wiz      8280:     <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  8281:     commands.  <code class="varname">INFO_FILES</code> should be defined in
                   8282:     the package Makefile so that <code class="filename">INSTALL</code> and
                   8283:     <code class="filename">DEINSTALL</code> scripts will be generated to
                   8284:     handle registration of the info files in the Info directory
1.23      wiz      8285:     file. The <span class="quote">&#8220;<span class="quote">install-info</span>&#8221;</span> command used for the info
1.1       dsieger  8286:     files registration is either provided by the system, or by a
                   8287:     special purpose package automatically added as dependency if
                   8288:     needed.</p>
                   8289: <p><code class="varname">PKGINFODIR</code> is the directory under
                   8290:     <code class="filename">${PREFIX}</code> where info files are primarily
                   8291:     located. <code class="varname">PKGINFODIR</code> defaults to
1.23      wiz      8292:     <span class="quote">&#8220;<span class="quote">info</span>&#8221;</span> and can be overridden by the user.</p>
1.1       dsieger  8293: <p>The info files for the package should be listed in the
                   8294:     package <code class="filename">PLIST</code>; however any split info files
                   8295:     need not be listed.</p>
1.23      wiz      8296: <p>A package which needs the <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> command
                   8297:     at build time must add <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> to
1.1       dsieger  8298:     <code class="varname">USE_TOOLS</code> in its Makefile. If a minimum
1.23      wiz      8299:     version of the <span class="quote">&#8220;<span class="quote">makeinfo</span>&#8221;</span> command is needed it
1.1       dsieger  8300:     should be noted with the <code class="varname">TEXINFO_REQD</code>
                   8301:     variable in the package <code class="filename">Makefile</code>. By
                   8302:     default, a minimum version of 3.12 is required. If the system
1.10      hubertf  8303:     does not provide a <span class="command"><strong>makeinfo</strong></span> command or if it
1.1       dsieger  8304:     does not match the required minimum, a build dependency on the
1.137     leot     8305:     <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  8306:     be added automatically.</p>
                   8307: <p>The build and installation process of the software provided
                   8308:     by the package should not use the
1.10      hubertf  8309:     <span class="command"><strong>install-info</strong></span> command as the registration of
1.1       dsieger  8310:     info files is the task of the package
                   8311:     <code class="filename">INSTALL</code> script, and it must use the
1.10      hubertf  8312:     appropriate <span class="command"><strong>makeinfo</strong></span> command.</p>
1.1       dsieger  8313: <p>To achieve this goal, the pkgsrc infrastructure creates
1.10      hubertf  8314:     overriding scripts for the <span class="command"><strong>install-info</strong></span> and
                   8315:     <span class="command"><strong>makeinfo</strong></span> commands in a directory listed early
1.1       dsieger  8316:     in <code class="varname">PATH</code>.</p>
1.10      hubertf  8317: <p>The script overriding <span class="command"><strong>install-info</strong></span> has
1.1       dsieger  8318:     no effect except the logging of a message. The script overriding
1.10      hubertf  8319:     <span class="command"><strong>makeinfo</strong></span> logs a message and according to the
1.1       dsieger  8320:     value of <code class="varname">TEXINFO_REQD</code> either runs the appropriate
1.10      hubertf  8321:     <span class="command"><strong>makeinfo</strong></span> command or exit on error.</p>
1.1       dsieger  8322: </div>
1.41      asau     8323: <div class="sect2">
1.1       dsieger  8324: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8325: <a name="manpages"></a>21.6.8. Packages installing man pages</h3></div></div></div>
1.1       dsieger  8326: <p>All packages that install manual pages should install them
                   8327:     into the same directory, so that there is one common place to look
                   8328:     for them. In pkgsrc, this place is
                   8329:     <code class="literal">${PREFIX}/${PKGMANDIR}</code>, and this expression
                   8330:     should be used in packages. The default for
                   8331:     <code class="varname">PKGMANDIR</code> is
1.23      wiz      8332:     <span class="quote">&#8220;<span class="quote"><code class="filename">man</code></span>&#8221;</span>. Another often-used value
                   8333:     is <span class="quote">&#8220;<span class="quote"><code class="filename">share/man</code></span>&#8221;</span>.</p>
1.41      asau     8334: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  8335: <h3 class="title">Note</h3>
                   8336: <p>The support for a custom <code class="varname">PKGMANDIR</code>
                   8337:     is far from complete.</p>
                   8338: </div>
                   8339: <p>The <code class="filename">PLIST</code> files can just use
                   8340:     <code class="filename">man/</code> as the top level directory for the man
                   8341:     page file entries, and the pkgsrc framework will convert as
                   8342:     needed. In all other places, the correct
                   8343:     <code class="varname">PKGMANDIR</code> must be used.</p>
                   8344: <p>Packages that are
                   8345:     configured with <code class="varname">GNU_CONFIGURE</code> set as
1.23      wiz      8346:     <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>, by default will use the
1.1       dsieger  8347:     <code class="filename">./configure</code>
                   8348:     --mandir switch to set where the man pages should be installed.
                   8349:     The path is <code class="varname">GNU_CONFIGURE_MANDIR</code> which defaults
                   8350:     to <code class="varname">${PREFIX}/${PKGMANDIR}</code>.</p>
                   8351: <p>Packages that use <code class="varname">GNU_CONFIGURE</code> but do not
                   8352:     use --mandir, can set <code class="varname">CONFIGURE_HAS_MANDIR</code>
1.23      wiz      8353:     to <span class="quote">&#8220;<span class="quote">no</span>&#8221;</span>.
1.1       dsieger  8354:     Or if the <code class="filename">./configure</code> script uses
                   8355:     a non-standard use of --mandir, you can set
                   8356:     <code class="varname">GNU_CONFIGURE_MANDIR</code> as needed.</p>
1.154     rillig   8357: <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  8358:     information on installation of compressed manual pages.</p>
                   8359: </div>
1.41      asau     8360: <div class="sect2">
1.1       dsieger  8361: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8362: <a name="gconf-data-files"></a>21.6.9. Packages installing GConf data files</h3></div></div></div>
1.1       dsieger  8363: <p>If a package installs <code class="filename">.schemas</code> or
1.7       rillig   8364:     <code class="filename">.entries</code> files, used by GConf,
1.1       dsieger  8365:     you need to take some extra steps to make sure they get registered
                   8366:     in the database:</p>
1.23      wiz      8367: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8368: <li class="listitem"><p>Include <code class="filename">../../devel/GConf/schemas.mk</code>
1.1       dsieger  8369:        instead of its <code class="filename">buildlink3.mk</code> file.  This
1.7       rillig   8370:        takes care of rebuilding the GConf database at installation and
1.1       dsieger  8371:        deinstallation time, and tells the package where to install
1.7       rillig   8372:        GConf data files using some standard configure arguments.  It
1.1       dsieger  8373:        also disallows any access to the database directly from the
                   8374:        package.</p></li>
1.23      wiz      8375: <li class="listitem"><p>Ensure that the package installs its
1.1       dsieger  8376:        <code class="filename">.schemas</code> files under
                   8377:        <code class="filename">${PREFIX}/share/gconf/schemas</code>.  If they get
                   8378:        installed under <code class="filename">${PREFIX}/etc</code>, you will
                   8379:        need to manually patch the package.</p></li>
1.23      wiz      8380: <li class="listitem"><p>Check the PLIST and remove any entries under the etc/gconf
1.1       dsieger  8381:        directory, as they will be handled automatically.  See
1.154     rillig   8382:        <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      8383: <li class="listitem"><p>Define the <code class="varname">GCONF_SCHEMAS</code> variable in
1.1       dsieger  8384:        your <code class="filename">Makefile</code> with a list of all
                   8385:        <code class="filename">.schemas</code> files installed by the package, if
                   8386:        any.  Names must not contain any directories in them.</p></li>
1.23      wiz      8387: <li class="listitem"><p>Define the <code class="varname">GCONF_ENTRIES</code> variable in
1.1       dsieger  8388:        your <code class="filename">Makefile</code> with a
                   8389:        list of all <code class="filename">.entries</code> files installed by the
                   8390:        package, if any. Names must not contain any directories in
                   8391:        them.</p></li>
                   8392: </ol></div>
                   8393: </div>
1.41      asau     8394: <div class="sect2">
1.1       dsieger  8395: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8396: <a name="scrollkeeper-data-files"></a>21.6.10. Packages installing scrollkeeper/rarian data files</h3></div></div></div>
1.1       dsieger  8397: <p>If a package installs <code class="filename">.omf</code> files, used by
1.18      snj      8398:     scrollkeeper/rarian, you need to take some extra steps to make sure they
1.1       dsieger  8399:     get registered in the database:</p>
1.23      wiz      8400: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8401: <li class="listitem"><p>Include
1.18      snj      8402:        <code class="filename">../../mk/omf-scrollkeeper.mk</code>
                   8403:        instead of rarian's <code class="filename">buildlink3.mk</code> file.  This
1.1       dsieger  8404:        takes care of rebuilding the scrollkeeper database at
                   8405:        installation and deinstallation time, and disallows any access
                   8406:        to it directly from the package.</p></li>
1.23      wiz      8407: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.1       dsieger  8408:        <code class="filename">libdata/scrollkeeper</code> directory, as they
                   8409:        will be handled automatically.</p></li>
1.23      wiz      8410: <li class="listitem"><p>Remove the <code class="filename">share/omf</code> directory from
1.18      snj      8411:        the PLIST.  It will be handled by rarian. (<span class="command"><strong>make
                   8412:        print-PLIST</strong></span> does this automatically.)</p></li>
1.1       dsieger  8413: </ol></div>
                   8414: </div>
1.41      asau     8415: <div class="sect2">
1.1       dsieger  8416: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8417: <a name="x11-fonts"></a>21.6.11. Packages installing X11 fonts</h3></div></div></div>
1.1       dsieger  8418: <p>If a package installs font files, you will need to rebuild
                   8419:     the fonts database in the directory where they get installed at
                   8420:     installation and deinstallation time.  This can be automatically
                   8421:     done by using the pkginstall framework.</p>
                   8422: <p>You can list the directories where fonts are installed in the
                   8423:     <code class="varname">FONTS_DIRS.<em class="replaceable"><code>type</code></em></code>
                   8424:     variables, where <em class="replaceable"><code>type</code></em> can be one of
1.23      wiz      8425:     <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  8426:     Also make sure that the database file
                   8427:     <code class="filename">fonts.dir</code> is not listed in the PLIST.</p>
                   8428: <p>Note that you should not create new directories for fonts;
                   8429:     instead use the standard ones to avoid that the user needs to
                   8430:     manually configure his X server to find them.</p>
                   8431: </div>
1.41      asau     8432: <div class="sect2">
1.1       dsieger  8433: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8434: <a name="gtk2-modules"></a>21.6.12. Packages installing GTK2 modules</h3></div></div></div>
1.1       dsieger  8435: <p>If a package installs GTK2 immodules or loaders, you need to
                   8436:     take some extra steps to get them registered in the GTK2 database
                   8437:     properly:</p>
1.23      wiz      8438: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8439: <li class="listitem"><p>Include
1.1       dsieger  8440:       <code class="filename">../../x11/gtk2/modules.mk</code> instead of its
                   8441:       <code class="filename">buildlink3.mk</code> file.  This takes care of
                   8442:       rebuilding the database at installation and deinstallation time.</p></li>
1.23      wiz      8443: <li class="listitem"><p>Set <code class="varname">GTK2_IMMODULES=YES</code> if
1.1       dsieger  8444:       your package installs GTK2 immodules.</p></li>
1.23      wiz      8445: <li class="listitem"><p>Set <code class="varname">GTK2_LOADERS=YES</code> if your package installs
1.1       dsieger  8446:       GTK2 loaders.</p></li>
1.23      wiz      8447: <li class="listitem">
1.1       dsieger  8448: <p>Patch the package to not touch any of the GTK2
                   8449:       databases directly.  These are:</p>
1.41      asau     8450: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      8451: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gdk-pixbuf.loaders</code></p></li>
                   8452: <li class="listitem"><p><code class="filename">libdata/gtk-2.0/gtk.immodules</code></p></li>
1.1       dsieger  8453: </ul></div>
                   8454: </li>
1.23      wiz      8455: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove
1.1       dsieger  8456:       any entries under the <code class="filename">libdata/gtk-2.0</code>
                   8457:       directory, as they will be handled automatically.</p></li>
                   8458: </ol></div>
                   8459: </div>
1.41      asau     8460: <div class="sect2">
1.1       dsieger  8461: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8462: <a name="sgml-xml-data"></a>21.6.13. Packages installing SGML or XML data</h3></div></div></div>
1.1       dsieger  8463: <p>If a package installs SGML or XML data files that need to be
                   8464:     registered in system-wide catalogs (like DTDs, sub-catalogs,
                   8465:     etc.), you need to take some extra steps:</p>
1.23      wiz      8466: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8467: <li class="listitem"><p>Include
1.1       dsieger  8468:        <code class="filename">../../textproc/xmlcatmgr/catalogs.mk</code> in
                   8469:        your <code class="filename">Makefile</code>, which takes care of
                   8470:        registering those files in system-wide catalogs at
                   8471:        installation and deinstallation time.</p></li>
1.23      wiz      8472: <li class="listitem"><p>Set <code class="varname">SGML_CATALOGS</code> to the full path of
1.1       dsieger  8473:        any SGML catalogs installed by the package.</p></li>
1.23      wiz      8474: <li class="listitem"><p>Set <code class="varname">XML_CATALOGS</code> to the full path of
1.1       dsieger  8475:        any XML catalogs installed by the package.</p></li>
1.23      wiz      8476: <li class="listitem"><p>Set <code class="varname">SGML_ENTRIES</code> to individual entries
1.1       dsieger  8477:        to be added to the SGML catalog.  These come in groups of
                   8478:        three strings; see xmlcatmgr(1) for more information
                   8479:        (specifically, arguments recognized by the 'add' action).
                   8480:        Note that you will normally not use this variable.</p></li>
1.23      wiz      8481: <li class="listitem"><p>Set <code class="varname">XML_ENTRIES</code> to individual entries
1.1       dsieger  8482:        to be added to the XML catalog.  These come in groups of three
                   8483:        strings; see xmlcatmgr(1) for more information (specifically,
                   8484:        arguments recognized by the 'add' action).  Note that you will
                   8485:        normally not use this variable.</p></li>
                   8486: </ol></div>
                   8487: </div>
1.41      asau     8488: <div class="sect2">
1.1       dsieger  8489: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8490: <a name="mime-database"></a>21.6.14. Packages installing extensions to the MIME database</h3></div></div></div>
1.1       dsieger  8491: <p>If a package provides extensions to the MIME database by
                   8492:     installing <code class="filename">.xml</code> files inside
                   8493:     <code class="filename">${PREFIX}/share/mime/packages</code>, you
                   8494:     need to take some extra steps to ensure that the database is kept
                   8495:     consistent with respect to these new files:</p>
1.23      wiz      8496: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8497: <li class="listitem"><p>Include
1.1       dsieger  8498:        <code class="filename">../../databases/shared-mime-info/mimedb.mk</code>
                   8499:        (avoid using the <code class="filename">buildlink3.mk</code> file from
                   8500:        this same directory, which is reserved for inclusion from
                   8501:        other <code class="filename">buildlink3.mk</code> files).  It takes
                   8502:        care of rebuilding the MIME database at installation and
                   8503:        deinstallation time, and disallows any access to it directly
                   8504:        from the package.</p></li>
1.23      wiz      8505: <li class="listitem"><p>Check the PLIST and remove any entries under the
1.1       dsieger  8506:        <code class="filename">share/mime</code> directory,
                   8507:        <span class="emphasis"><em>except</em></span> for files saved under
                   8508:        <code class="filename">share/mime/packages</code>.  The former are
                   8509:        handled automatically by
                   8510:        the update-mime-database program, but the latter are
                   8511:        package-dependent and must be removed by the package that
                   8512:        installed them in the first place.</p></li>
1.23      wiz      8513: <li class="listitem"><p>Remove any <code class="filename">share/mime/*</code> directories
1.1       dsieger  8514:        from the PLIST.  They will be handled by the shared-mime-info
                   8515:        package.</p></li>
                   8516: </ol></div>
                   8517: </div>
1.41      asau     8518: <div class="sect2">
1.1       dsieger  8519: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8520: <a name="intltool"></a>21.6.15. Packages using intltool</h3></div></div></div>
1.1       dsieger  8521: <p>If a package uses intltool during its build, add
                   8522:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>,
                   8523:     which forces it to use the intltool package provided by pkgsrc,
                   8524:     instead of the one bundled with the distribution file.</p>
                   8525: <p>This tracks intltool's build-time dependencies and uses the
                   8526:     latest available version; this way, the package benefits of any
                   8527:     bug fixes that may have appeared since it was released.</p>
                   8528: </div>
1.41      asau     8529: <div class="sect2">
1.1       dsieger  8530: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8531: <a name="startup-scripts"></a>21.6.16. Packages installing startup scripts</h3></div></div></div>
1.1       dsieger  8532: <p>If a package contains a rc.d script, it won't be copied into
                   8533:     the startup directory by default, but you can enable it, by adding
                   8534:     the option <code class="varname">PKG_RCD_SCRIPTS=YES</code> in
1.10      hubertf  8535:     <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a>. This option will copy the scripts
1.1       dsieger  8536:     into <code class="filename">/etc/rc.d</code> when a package is installed, and
                   8537:     it will automatically remove the scripts when the package is
                   8538:     deinstalled.</p>
                   8539: </div>
1.41      asau     8540: <div class="sect2">
1.1       dsieger  8541: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8542: <a name="tex-packages"></a>21.6.17. Packages installing TeX modules</h3></div></div></div>
1.1       dsieger  8543: <p>If a package installs TeX packages into the texmf tree,
                   8544:     the <code class="filename">ls-R</code> database of the tree needs to be
                   8545:     updated.</p>
1.41      asau     8546: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  8547: <h3 class="title">Note</h3>
1.22      jakllsch 8548: <p>Except the main TeX packages such as kpathsea,
1.1       dsieger  8549:     packages should install files
1.22      jakllsch 8550:     into <code class="filename">${PREFIX}/share/texmf-dist</code>,
                   8551:     not <code class="filename">${PREFIX}/share/texmf</code>.</p>
1.1       dsieger  8552: </div>
1.23      wiz      8553: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8554: <li class="listitem"><p>Include
1.22      jakllsch 8555:       <code class="filename">../../print/kpathsea/texmf.mk</code>.  This
1.1       dsieger  8556:       takes care of rebuilding the <code class="filename">ls-R</code>
                   8557:       database at installation and deinstallation time.</p></li>
1.23      wiz      8558: <li class="listitem">
1.1       dsieger  8559: <p>If your package installs files into a texmf
                   8560:       tree other than the one
1.22      jakllsch 8561:       at <code class="filename">${PREFIX}/share/texmf-dist</code>,
                   8562:       set <code class="varname">TEX_TEXMF_DIRS</code> to the list of all texmf
1.1       dsieger  8563:       trees that need database update.</p>
                   8564: <p>If your package also installs font map files that need
1.10      hubertf  8565:       to be registered using <span class="command"><strong>updmap</strong></span>,
1.29      dholland 8566:       include <code class="filename">../../print/tex-tetex/map.mk</code> and
1.22      jakllsch 8567:       set <code class="varname">TEX_MAP_FILES</code> and/or
                   8568:       <code class="varname">TEX_MIXEDMAP_FILES</code> to the list of all
1.10      hubertf  8569:       such font map files.  Then <span class="command"><strong>updmap</strong></span> will
1.1       dsieger  8570:       be run automatically at installation/deinstallation to
                   8571:       enable/disable font map files for TeX output
                   8572:       drivers.</p>
                   8573: </li>
1.23      wiz      8574: <li class="listitem"><p>Make sure that none of <code class="filename">ls-R</code>
1.1       dsieger  8575:       databases are included in <code class="filename">PLIST</code>, as
1.29      dholland 8576:       they will be removed only by the kpathsea package.</p></li>
1.1       dsieger  8577: </ol></div>
                   8578: </div>
1.41      asau     8579: <div class="sect2">
1.1       dsieger  8580: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8581: <a name="emulation-packages"></a>21.6.18. Packages supporting running binaries in
1.1       dsieger  8582:     emulation</h3></div></div></div>
                   8583: <p>There are some packages that provide libraries and
                   8584:     executables for running binaries from a one operating system
                   8585:     on a different one (if the latter supports it).  One example
                   8586:     is running Linux binaries on NetBSD.</p>
1.137     leot     8587: <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  8588:     helps in extracting and packaging Linux rpm packages.</p>
                   8589: <p>The <code class="varname">CHECK_SHLIBS</code> can be set to no to
1.10      hubertf  8590:     avoid the <span class="command"><strong>check-shlibs</strong></span> target, which tests
1.1       dsieger  8591:     if all libraries for each installed executable can be found by
                   8592:     the dynamic linker.  Since the standard dynamic linker is run,
                   8593:     this fails for emulation packages, because the libraries used
                   8594:     by the emulation are not in the standard directories.</p>
                   8595: </div>
1.41      asau     8596: <div class="sect2">
1.1       dsieger  8597: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8598: <a name="hicolor-theme"></a>21.6.19. Packages installing hicolor theme icons</h3></div></div></div>
1.1       dsieger  8599: <p>If a package installs images under the
                   8600:     <code class="filename">share/icons/hicolor</code> and/or updates the
                   8601:     <code class="filename">share/icons/hicolor/icon-theme.cache</code>
                   8602:     database, you need to take some extra steps to make sure that the
                   8603:     shared theme directory is handled appropriately and that the cache
                   8604:     database is rebuilt:</p>
1.23      wiz      8605: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8606: <li class="listitem"><p>Include
1.1       dsieger  8607:        <code class="filename">../../graphics/hicolor-icon-theme/buildlink3.mk</code>.</p></li>
1.23      wiz      8608: <li class="listitem"><p>Check the <code class="filename">PLIST</code> and remove the
1.1       dsieger  8609:        entry that refers to the theme cache.</p></li>
1.23      wiz      8610: <li class="listitem"><p>Ensure that the PLIST does not remove the shared icon
1.1       dsieger  8611:          directories from the <code class="filename">share/icons/hicolor</code>
                   8612:          hierarchy because they will be handled automatically.</p></li>
                   8613: </ol></div>
                   8614: <p>The best way to verify that the PLIST is correct with
                   8615:       respect to the last two points is to regenerate it using
1.10      hubertf  8616:       <span class="command"><strong>make print-PLIST</strong></span>.</p>
1.1       dsieger  8617: </div>
1.41      asau     8618: <div class="sect2">
1.1       dsieger  8619: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   8620: <a name="desktop-files"></a>21.6.20. Packages installing desktop files</h3></div></div></div>
1.1       dsieger  8621: <p>If a package installs <code class="filename">.desktop</code> files
                   8622:       under <code class="filename">share/applications</code> and these include
1.53      rodent   8623:       MIME information (MimeType key), you need to take extra steps to
                   8624:       ensure that they are registered into the MIME database:</p>
1.23      wiz      8625: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8626: <li class="listitem"><p>Include
1.1       dsieger  8627:          <code class="filename">../../sysutils/desktop-file-utils/desktopdb.mk</code>.</p></li>
1.23      wiz      8628: <li class="listitem"><p>Check the PLIST and remove the entry that refers to the
1.1       dsieger  8629:          <code class="filename">share/applications/mimeinfo.cache</code> file.
                   8630:          It will be handled automatically.</p></li>
                   8631: </ol></div>
                   8632: <p>The best way to verify that the PLIST is correct with
1.10      hubertf  8633:       respect to the last point is to regenerate it using <span class="command"><strong>make
1.1       dsieger  8634:       print-PLIST</strong></span>.</p>
                   8635: </div>
                   8636: </div>
1.41      asau     8637: <div class="sect1">
1.1       dsieger  8638: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   8639: <a name="punting"></a>21.7. Marking packages as having problems</h2></div></div></div>
1.1       dsieger  8640: <p>In some cases one does not have the time to solve a problem
1.22      jakllsch 8641:   immediately. In this case, one can plainly mark a package as broken.  For
                   8642:   this, one just sets the variable <code class="varname">BROKEN</code> to the
                   8643:   reason why the package is broken (similar to the
                   8644:   <code class="varname">RESTRICTED</code> variable).  A user trying to build
                   8645:   the package will immediately be shown this message, and the build
                   8646:   will not be even tried.</p>
                   8647: <p><code class="varname">BROKEN</code> packages are removed from pkgsrc in irregular
1.1       dsieger  8648:   intervals.</p>
                   8649: </div>
                   8650: </div>
1.41      asau     8651: <div class="chapter">
1.1       dsieger  8652: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   8653: <a name="debug"></a>Chapter 22. Debugging</h2></div></div></div>
1.1       dsieger  8654: <p>To check out all the gotchas when building a package, here are
                   8655:   the steps that I do in order to get a package working.  Please note
                   8656:   this is basically the same as what was explained in the previous
                   8657:   sections, only with some debugging aids.</p>
1.41      asau     8658: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      8659: <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>
                   8660: <li class="listitem">
1.137     leot     8661: <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  8662:       create a directory for a new package, change into it, then run
1.10      hubertf  8663:       <span class="command"><strong>url2pkg</strong></span>:</p>
1.1       dsieger  8664: <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>
                   8665: <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>
                   8666: <code class="prompt">%</code> <strong class="userinput"><code>url2pkg http://www.example.com/path/to/distfile.tar.gz</code></strong></pre>
                   8667: </li>
1.23      wiz      8668: <li class="listitem"><p>Edit the <code class="filename">Makefile</code> as requested.</p></li>
                   8669: <li class="listitem"><p>Fill in the <code class="filename">DESCR</code> file</p></li>
                   8670: <li class="listitem"><p>Run <span class="command"><strong>make configure</strong></span></p></li>
                   8671: <li class="listitem"><p>Add any dependencies glimpsed from documentation and the
1.1       dsieger  8672:       configure step to the package's
                   8673:       <code class="filename">Makefile</code>.</p></li>
1.23      wiz      8674: <li class="listitem">
1.1       dsieger  8675: <p>Make the package compile, doing multiple rounds of</p>
                   8676: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>make</code></strong>
                   8677: <code class="prompt">%</code> <strong class="userinput"><code>pkgvi ${WRKSRC}/some/file/that/does/not/compile</code></strong>
                   8678: <code class="prompt">%</code> <strong class="userinput"><code>mkpatches</code></strong>
                   8679: <code class="prompt">%</code> <strong class="userinput"><code>patchdiff</code></strong>
                   8680: <code class="prompt">%</code> <strong class="userinput"><code>mv ${WRKDIR}/.newpatches/* patches</code></strong>
                   8681: <code class="prompt">%</code> <strong class="userinput"><code>make mps</code></strong>
                   8682: <code class="prompt">%</code> <strong class="userinput"><code>make clean</code></strong></pre>
                   8683: <p>Doing this step as non-root user will ensure that no files
                   8684:       are modified that shouldn't be, especially during the build
1.10      hubertf  8685:       phase.  <span class="command"><strong>mkpatches</strong></span>,
                   8686:       <span class="command"><strong>patchdiff</strong></span> and <span class="command"><strong>pkgvi</strong></span> are
1.137     leot     8687:       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  8688:       package.</p>
                   8689: </li>
1.23      wiz      8690: <li class="listitem"><p>Look at the <code class="filename">Makefile</code>, fix if
1.154     rillig   8691:       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      8692: <li class="listitem">
1.1       dsieger  8693: <p>Generate a <code class="filename">PLIST</code>:</p>
                   8694: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   8695: <code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST &gt;PLIST</code></strong>
                   8696: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong>
                   8697: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   8698: <code class="prompt">#</code> <strong class="userinput"><code>make deinstall</code></strong></pre>
                   8699: <p>You usually need to be <code class="username">root</code> to do
                   8700:       this.  Look if there are any files left:</p>
                   8701: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
                   8702: <p>If this reveals any files that are missing in
                   8703:       <code class="filename">PLIST</code>, add them.</p>
                   8704: </li>
1.23      wiz      8705: <li class="listitem">
1.1       dsieger  8706: <p>Now that the <code class="filename">PLIST</code> is OK, install the
                   8707:       package again and make a binary package:</p>
                   8708: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make reinstall</code></strong>
                   8709: <code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong></pre>
                   8710: </li>
1.23      wiz      8711: <li class="listitem">
1.1       dsieger  8712: <p>Delete the installed package:</p>
                   8713: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_delete <em class="replaceable"><code>examplepkg</code></em></code></strong></pre>
                   8714: </li>
1.23      wiz      8715: <li class="listitem">
1.10      hubertf  8716: <p>Repeat the above <span class="command"><strong>make print-PLIST</strong></span>
1.1       dsieger  8717:       command, which shouldn't find anything now:</p>
                   8718: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make print-PLIST</code></strong></pre>
                   8719: </li>
1.23      wiz      8720: <li class="listitem">
1.1       dsieger  8721: <p>Reinstall the binary package:</p>
                   8722: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkg_add .../<em class="replaceable"><code>examplepkg</code></em>.tgz</code></strong></pre>
                   8723: </li>
1.23      wiz      8724: <li class="listitem"><p>Play with it.  Make sure everything works.</p></li>
                   8725: <li class="listitem">
1.137     leot     8726: <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  8727:       reports:</p>
                   8728: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>pkglint</code></strong></pre>
                   8729: </li>
1.154     rillig   8730: <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  8731: </ul></div>
                   8732: </div>
1.41      asau     8733: <div class="chapter">
1.1       dsieger  8734: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   8735: <a name="submit"></a>Chapter 23. Submitting and Committing</h2></div></div></div>
1.1       dsieger  8736: <div class="toc">
                   8737: <p><b>Table of Contents</b></p>
1.100     leot     8738: <dl class="toc">
1.154     rillig   8739: <dt><span class="sect1"><a href="#submitting-binary-packages">23.1. Submitting binary packages</a></span></dt>
                   8740: <dt><span class="sect1"><a href="#submitting-your-package">23.2. Submitting source packages (for non-NetBSD-developers)</a></span></dt>
                   8741: <dt><span class="sect1"><a href="#general-notes-for-changes">23.3. General notes when adding, updating, or removing packages</a></span></dt>
                   8742: <dt><span class="sect1"><a href="#commit-messages">23.4. Commit Messages</a></span></dt>
                   8743: <dt><span class="sect1"><a href="#committing-importing">23.5. Committing: Adding a package to CVS</a></span></dt>
                   8744: <dt><span class="sect1"><a href="#updating-package">23.6. Updating a package to a newer version</a></span></dt>
                   8745: <dt><span class="sect1"><a href="#renaming-package">23.7. Renaming a package in pkgsrc</a></span></dt>
                   8746: <dt><span class="sect1"><a href="#moving-package">23.8. Moving a package in pkgsrc</a></span></dt>
1.1       dsieger  8747: </dl>
                   8748: </div>
1.41      asau     8749: <div class="sect1">
1.1       dsieger  8750: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   8751: <a name="submitting-binary-packages"></a>23.1. Submitting binary packages</h2></div></div></div>
1.1       dsieger  8752: <p>Our policy is that we accept binaries only from pkgsrc
                   8753:        developers to guarantee that the packages don't contain any
                   8754:        trojan horses etc. This is not to annoy anyone but rather to
                   8755:        protect our users! You're still free to put up your home-made
                   8756:        binary packages and tell the world where to get them. NetBSD
                   8757:        developers doing bulk builds and wanting to upload them please
1.154     rillig   8758:        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     8759: builds)</i></a>.</p>
1.1       dsieger  8760: </div>
1.41      asau     8761: <div class="sect1">
1.1       dsieger  8762: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   8763: <a name="submitting-your-package"></a>23.2. Submitting source packages (for non-NetBSD-developers)</h2></div></div></div>
1.1       dsieger  8764: <p>First, check that your package is complete, compiles and
1.154     rillig   8765:        runs well; see <a class="xref" href="#debug" title="Chapter 22. Debugging">Chapter 22, <i>Debugging</i></a> and the rest of this
1.157     leot     8766:        document. Next, generate an uuencoded gzipped <a class="citerefentry" href="http://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  8767:        archive that contains all files that make up the package.
                   8768:        Finally, send this package to the pkgsrc bug tracking system,
1.157     leot     8769:        either with the <a class="citerefentry" href="http://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  8770:        that, go to the web page
1.10      hubertf  8771:        <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      8772:        which contains some instructions and a link to a form where you
                   8773:        can submit packages.  The
1.137     leot     8774:        <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      8775:        also available as a substitute for either of the above two tools.
                   8776:        </p>
1.1       dsieger  8777: <p>In the form of the problem report, the category should be
1.23      wiz      8778:        <span class="quote">&#8220;<span class="quote">pkg</span>&#8221;</span>, the synopsis should include the package name
1.1       dsieger  8779:        and version number, and the description field should contain a
                   8780:        short description of your package (contents of the COMMENT
                   8781:        variable or DESCR file are OK). The uuencoded package data should
1.23      wiz      8782:        go into the <span class="quote">&#8220;<span class="quote">fix</span>&#8221;</span> field.</p>
1.1       dsieger  8783: <p>If you want to submit several packages, please send a
                   8784:        separate PR for each one, it's easier for us to track things
                   8785:        that way.</p>
                   8786: <p>Alternatively, you can also import new packages into
1.23      wiz      8787:        pkgsrc-wip (<span class="quote">&#8220;<span class="quote">pkgsrc work-in-progress</span>&#8221;</span>); see the
1.105     wiz      8788:        homepage at <a class="ulink" href="http://pkgsrc.org/wip/" target="_top">http://pkgsrc.org/wip/</a>
1.1       dsieger  8789:        for details.</p>
                   8790: </div>
1.41      asau     8791: <div class="sect1">
1.1       dsieger  8792: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   8793: <a name="general-notes-for-changes"></a>23.3. General notes when adding, updating, or removing packages</h2></div></div></div>
1.1       dsieger  8794: <p>Please note all package additions, updates, moves, and
                   8795:        removals in <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code>. It's very
                   8796:        important to keep this file up to date and conforming to the
                   8797:        existing format, because it will be used by scripts to
1.10      hubertf  8798:        automatically update pages on <a class="ulink" href="http://www.NetBSD.org/" target="_top">www.NetBSD.org</a> and other
1.1       dsieger  8799:        sites. Additionally, check the
                   8800:        <code class="filename">pkgsrc/doc/TODO</code> file and remove the entry
                   8801:        for the package you updated or removed, in case it was mentioned
                   8802:        there.</p>
                   8803: <p>When the <code class="varname">PKGREVISION</code> of a package is
                   8804:        bumped, the change should appear in
                   8805:        <code class="filename">pkgsrc/doc/CHANGES-<em class="replaceable"><code>YYYY</code></em></code> if it is security
                   8806:        related or otherwise relevant. Mass bumps that result from a
                   8807:        dependency being updated should not be mentioned. In all other
                   8808:        cases it's the developer's decision.</p>
                   8809: <p>There is a make target that helps in creating proper
1.10      hubertf  8810:   <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code> entries:  <span class="command"><strong>make
1.1       dsieger  8811:   changes-entry</strong></span>. It uses the optional <code class="varname">CTYPE</code>
                   8812:   and <code class="varname">NETBSD_LOGIN_NAME</code> variables. The general
                   8813:   usage is to first make sure that your <code class="filename">CHANGES-<em class="replaceable"><code>YYYY</code></em></code>
                   8814:   file is up-to-date (to avoid having to resolve conflicts later-on)
1.10      hubertf  8815:   and then to <span class="command"><strong>cd</strong></span> to the package directory.  For
                   8816:   package updates, <span class="command"><strong>make changes-entry</strong></span> is enough.
1.1       dsieger  8817:   For new packages, or package moves or removals, set the
                   8818:   <code class="varname">CTYPE</code> variable on the command line to "Added",
                   8819:   "Moved", or "Removed".  You can set <code class="varname">NETBSD_LOGIN_NAME</code>
1.10      hubertf  8820:   in <a class="link" href="#mk.conf"><code class="filename">mk.conf</code></a> if your local login name is
1.22      jakllsch 8821:   not the same as your NetBSD login name. The target also automatically
                   8822:   removes possibly existing entries for the package in the
                   8823:   <code class="filename">TODO</code> file. Don't forget to commit
1.66      asau     8824:   the changes, e.g. by using <span class="command"><strong>make commit-changes-entry</strong></span>!
1.22      jakllsch 8825:   If you are not using a checkout directly from cvs.NetBSD.org, but e.g.
                   8826:   a local copy of the repository, you can set USE_NETBSD_REPO=yes. This
                   8827:   makes the cvs commands use the main repository.
                   8828:   </p>
1.1       dsieger  8829: </div>
1.41      asau     8830: <div class="sect1">
1.1       dsieger  8831: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   8832: <a name="commit-messages"></a>23.4. Commit Messages</h2></div></div></div>
1.130     wiz      8833: <p>For several years, there have been mirrors of pkgsrc in
                   8834:   fossil, git, and hg. Standard practise when using these tools is to
                   8835:   make the first line of a commit message function as a summary that
                   8836:   can be read without the rest, such as is commonly done with "git log
                   8837:   --oneline". For this reason, we have the following guidelines for
                   8838:   pkgsrc commit messages:</p>
                   8839: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
                   8840: <li class="listitem"><p>Start the commit message with a line that explains the
1.131     wiz      8841:     big picture in 65 characters or less. When a commit is for one
1.130     wiz      8842:     package, include the name of the package. For updates, include the
                   8843:     version to which it is updated.</p></li>
                   8844: <li class="listitem"><p>Leave the next line empty.</p></li>
                   8845: <li class="listitem"><p>Then come the details for the commit (changes in that
                   8846:     package, reason for a change) and any relevant PRs. Wrap this
                   8847:     section.</p></li>
                   8848: </ul></div>
                   8849: <p>Here is an example:
                   8850:   </p>
                   8851: <pre class="programlisting">
                   8852:   libxslt: update to 1.0.30
                   8853: 
                   8854:   Changes since 1.0.29:
                   8855:   ...
                   8856:   </pre>
                   8857: <p>
                   8858:   </p>
                   8859: <p>Here is another example:
                   8860:   </p>
                   8861: <pre class="programlisting">
                   8862:   mk/bsd.pkg.mk: enable SSP by default on NetBSD
                   8863: 
                   8864:   (rationale)
                   8865:   </pre>
                   8866: <p>
                   8867:   </p>
                   8868: <p>Commit messages are final: no <span class="quote">&#8220;<span class="quote">cvs admin</span>&#8221;</span> is
                   8869:   allowed on the pkgsrc repository to change commit messages.</p>
                   8870: </div>
                   8871: <div class="sect1">
                   8872: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   8873: <a name="committing-importing"></a>23.5. Committing: Adding a package to CVS</h2></div></div></div>
1.1       dsieger  8874: <p>This section is only of interest for pkgsrc developers with write
1.33      wiz      8875:   access to the pkgsrc repository.</p>
                   8876: <p>When the package is finished, <span class="quote">&#8220;<span class="quote">cvs add</span>&#8221;</span> the files.
                   8877: Start by adding the directory and then files in the directory. Don't
                   8878: forget to add the new package to the category's
                   8879: <code class="filename">Makefile</code>. Make sure you don't forget any files;
                   8880: you can check by running <span class="quote">&#8220;<span class="quote">cvs status</span>&#8221;</span>. An example:</p>
                   8881: <pre class="programlisting">
                   8882: <code class="prompt">$</code> cd .../pkgsrc/category
                   8883: <code class="prompt">$</code> cvs add pkgname
                   8884: <code class="prompt">$</code> cd pkgname
                   8885: <code class="prompt">$</code> cvs add DESCR Makefile PLIST distinfo buildlink3.mk patches
                   8886: <code class="prompt">$</code> cvs add patches/p*
                   8887: <code class="prompt">$</code> cvs status | less
1.34      wiz      8888: <code class="prompt">$</code> cvs commit
1.33      wiz      8889: <code class="prompt">$</code> cd ..
                   8890: <code class="prompt">$</code> vi Makefile # add SUBDIRS+=pkgname line
1.34      wiz      8891: <code class="prompt">$</code> cvs commit Makefile
1.66      asau     8892: <code class="prompt">$</code> cd pkgname
1.73      jnemeth  8893: <code class="prompt">$</code> make CTYPE=Added commit-changes-entry
1.33      wiz      8894: </pre>
1.1       dsieger  8895: <p>The commit message of the initial import should include part of the
                   8896:   <code class="filename">DESCR</code> file, so people reading the mailing lists know
                   8897:   what the package is/does.</p>
1.33      wiz      8898: <p>Also mention the new package in
                   8899: <code class="filename">pkgsrc/doc/CHANGES-20xx</code>.</p>
                   8900: <p>Previously, <span class="quote">&#8220;<span class="quote">cvs import</span>&#8221;</span> was suggested, but it was
                   8901: much easier to get wrong than <span class="quote">&#8220;<span class="quote">cvs add</span>&#8221;</span>.</p>
1.1       dsieger  8902: </div>
1.41      asau     8903: <div class="sect1">
1.1       dsieger  8904: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   8905: <a name="updating-package"></a>23.6. Updating a package to a newer version</h2></div></div></div>
1.1       dsieger  8906: <p>Please always put a concise, appropriate and relevant summary of the
                   8907:   changes between old and new versions into the commit log when updating
                   8908:   a package. There are various reasons for this:</p>
1.41      asau     8909: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      8910: <li class="listitem"><p>A URL is volatile, and can change over time. It may go away completely
1.1       dsieger  8911:   or its information may be overwritten by newer information.</p></li>
1.23      wiz      8912: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1       dsieger  8913:   repository is very useful for people who use either cvs or anoncvs.</p></li>
1.23      wiz      8914: <li class="listitem"><p>Having the change information between old and new versions in our CVS
1.1       dsieger  8915:   repository is very useful for people who read the pkgsrc-changes mailing
                   8916:   list, so that they can make tactical decisions about when to upgrade
                   8917:   the package.</p></li>
                   8918: </ul></div>
                   8919: <p>Please also recognize that, just because a new version of a package
                   8920:   has been released, it should not automatically be upgraded in the CVS
                   8921:   repository.  We prefer to be conservative in the packages that are
                   8922:   included in pkgsrc - development or beta packages are not really the
                   8923:   best thing for most places in which pkgsrc is used. Please use your
                   8924:   judgement about what should go into pkgsrc, and bear in mind that
                   8925:   stability is to be preferred above new and possibly untested features.</p>
                   8926: </div>
1.41      asau     8927: <div class="sect1">
1.1       dsieger  8928: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   8929: <a name="renaming-package"></a>23.7. Renaming a package in pkgsrc</h2></div></div></div>
1.20      snj      8930: <p>Renaming packages is not recommended.</p>
                   8931: <p>When renaming packages, be sure to fix any references to old name
                   8932:   in other Makefiles, options, buildlink files, etc.</p>
                   8933: <p>Also When renaming a package, please define
                   8934:   <code class="varname">SUPERSEDES</code> to the package name and dewey version
                   8935:   pattern(s) of the previous package name.
                   8936:   This may be repeated for multiple renames.
                   8937:   The new package would be an exact replacement.
                   8938: </p>
1.23      wiz      8939: <p>Note that <span class="quote">&#8220;<span class="quote">successor</span>&#8221;</span> in the
1.20      snj      8940:   CHANGES-<em class="replaceable"><code>YYYY</code></em> file doesn't necessarily
                   8941:   mean that it <span class="emphasis"><em>supersedes</em></span>, as that successor may
                   8942:   not be an exact replacement but is a suggestion for the replaced
                   8943:   functionality.</p>
                   8944: </div>
1.41      asau     8945: <div class="sect1">
1.20      snj      8946: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   8947: <a name="moving-package"></a>23.8. Moving a package in pkgsrc</h2></div></div></div>
1.20      snj      8948: <p>It is preferred that packages are not renamed or moved, but if needed
                   8949:   please follow these steps.
                   8950: </p>
1.23      wiz      8951: <div class="orderedlist"><ol class="orderedlist" type="1">
                   8952: <li class="listitem"><p>Make a copy of the directory somewhere else.</p></li>
                   8953: <li class="listitem">
1.1       dsieger  8954: <p>Remove all CVS dirs.</p>
                   8955: <p>Alternatively to the first two steps you can also do:</p>
                   8956: <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>
                   8957: <p>and use that for further work.</p>
                   8958: </li>
1.23      wiz      8959: <li class="listitem"><p>Fix <code class="varname">CATEGORIES</code> and any
                   8960: <code class="varname">DEPENDS</code> paths that just did <span class="quote">&#8220;<span class="quote">../package</span>&#8221;</span>
                   8961: instead of <span class="quote">&#8220;<span class="quote">../../category/package</span>&#8221;</span>.</p></li>
                   8962: <li class="listitem"><p>In the modified package's Makefile, consider setting
1.20      snj      8963: <code class="varname">PREV_PKGPATH</code> to the previous category/package
                   8964: pathname.  The <code class="varname">PREV_PKGPATH</code> can be used by tools
                   8965: for doing an update using pkgsrc building; for example, it can
1.157     leot     8966: search the <a class="citerefentry" href="http://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      8967: (if no <code class="varname">SUPERSEDES</code>) and then use the corresponding
                   8968: new <code class="varname">PKGPATH</code> for that moved package.  Note that
                   8969: it may have multiple matches, so the tool should also check on the
                   8970: <code class="varname">PKGBASE</code> too.  The <code class="varname">PREV_PKGPATH</code>
                   8971: probably has no value unless <code class="varname">SUPERSEDES</code> is not
                   8972: set, i.e.  <code class="varname">PKGBASE</code> stays the same.  </p></li>
1.23      wiz      8973: <li class="listitem"><p><span class="command"><strong>cvs import</strong></span> the modified package in the new
1.1       dsieger  8974: place.</p></li>
1.23      wiz      8975: <li class="listitem">
1.1       dsieger  8976: <p>Check if any package depends on it:
                   8977: </p>
                   8978: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cd /usr/pkgsrc</code></strong>
                   8979: <code class="prompt">%</code> <strong class="userinput"><code>grep /package */*/Makefile* */*/buildlink*</code></strong></pre>
                   8980: </li>
1.23      wiz      8981: <li class="listitem"><p>Fix paths in packages from step 5 to point to new location.</p></li>
                   8982: <li class="listitem"><p><span class="command"><strong>cvs rm (-f)</strong></span> the package at the old location.</p></li>
                   8983: <li class="listitem"><p>Remove from <code class="filename">oldcategory/Makefile</code>.</p></li>
                   8984: <li class="listitem"><p>Add to <code class="filename">newcategory/Makefile</code>.</p></li>
                   8985: <li class="listitem">
1.1       dsieger  8986: <p>Commit the changed and removed files:</p>
                   8987: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>cvs commit oldcategory/package oldcategory/Makefile newcategory/Makefile</code></strong></pre>
                   8988: <p>(and any packages from step 5, of course).</p>
                   8989: </li>
                   8990: </ol></div>
                   8991: </div>
                   8992: </div>
1.41      asau     8993: <div class="chapter">
1.1       dsieger  8994: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   8995: <a name="devfaq"></a>Chapter 24. Frequently Asked Questions</h2></div></div></div>
1.1       dsieger  8996: <p>This section contains the answers to questions that may
                   8997:        arise when you are writing a package. If you don't find your
                   8998:        question answered here, first have a look in the other chapters,
                   8999:        and if you still don't have the answer, ask on the
                   9000:        <code class="literal">pkgsrc-users</code> mailing list.</p>
1.41      asau     9001: <div class="qandaset">
1.160   ! brook    9002: <a name="idp140445875777112"></a><dl>
1.154     rillig   9003: <dt>24.1. <a href="#devfaq.makeflags">What is the difference between
1.1       dsieger  9004:        MAKEFLAGS, .MAKEFLAGS and
                   9005:        MAKE_FLAGS?</a>
                   9006: </dt>
1.154     rillig   9007: <dt>24.2. <a href="#devfaq.make">What is the difference between
1.1       dsieger  9008:        MAKE, GMAKE and
                   9009:        MAKE_PROGRAM?</a>
                   9010: </dt>
1.154     rillig   9011: <dt>24.3. <a href="#devfaq.cc">What is the difference between
1.1       dsieger  9012:        CC, PKG_CC and
                   9013:        PKGSRC_COMPILER?</a>
                   9014: </dt>
1.154     rillig   9015: <dt>24.4. <a href="#devfaq.bl3flags">What is the difference between
1.1       dsieger  9016:        BUILDLINK_LDFLAGS,
                   9017:        BUILDLINK_LDADD and
                   9018:        BUILDLINK_LIBS?</a>
                   9019: </dt>
1.154     rillig   9020: <dt>24.5. <a href="#devfaq.bl3prefix">Why does make show-var
1.1       dsieger  9021:        VARNAME=BUILDLINK_PREFIX.foo
                   9022:        say it's empty?</a>
                   9023: </dt>
1.154     rillig   9024: <dt>24.6. <a href="#devfaq.master_sites">What does
1.1       dsieger  9025:        ${MASTER_SITE_SOURCEFORGE:=package/} mean? I
                   9026:        don't understand the := inside
                   9027:        it.</a>
                   9028: </dt>
1.154     rillig   9029: <dt>24.7. <a href="#devfaq.mailinglists">Which mailing lists are there for package
1.1       dsieger  9030:        developers?</a>
                   9031: </dt>
1.154     rillig   9032: <dt>24.8. <a href="#devfaq.documentation">Where is the pkgsrc
1.1       dsieger  9033:        documentation?</a>
                   9034: </dt>
1.154     rillig   9035: <dt>24.9. <a href="#devfaq.too-much-time">I have a little time to kill.  What shall I
1.1       dsieger  9036: do?</a>
                   9037: </dt>
                   9038: </dl>
1.41      asau     9039: <table border="0" style="width: 100%;">
                   9040: <colgroup>
1.1       dsieger  9041: <col align="left" width="1%">
1.23      wiz      9042: <col>
1.41      asau     9043: </colgroup>
1.1       dsieger  9044: <tbody>
1.41      asau     9045: <tr class="question">
1.1       dsieger  9046: <td align="left" valign="top">
1.160   ! brook    9047: <a name="devfaq.makeflags"></a><a name="idp140445875777816"></a><p><b>24.1.</b></p>
1.1       dsieger  9048: </td>
                   9049: <td align="left" valign="top"><p>What is the difference between
                   9050:        <code class="varname">MAKEFLAGS</code>, <code class="varname">.MAKEFLAGS</code> and
                   9051:        <code class="varname">MAKE_FLAGS</code>?</p></td>
                   9052: </tr>
                   9053: <tr class="answer">
                   9054: <td align="left" valign="top"></td>
                   9055: <td align="left" valign="top"><p><code class="varname">MAKEFLAGS</code> are the flags passed
1.157     leot     9056:        to the pkgsrc-internal invocations of <a class="citerefentry" href="http://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  9057:        <code class="varname">MAKE_FLAGS</code> are the flags that are passed to
                   9058:        the <code class="varname">MAKE_PROGRAM</code> when building the
                   9059:        package. [FIXME: What is .MAKEFLAGS for?]</p></td>
                   9060: </tr>
1.41      asau     9061: <tr class="question">
1.1       dsieger  9062: <td align="left" valign="top">
1.160   ! brook    9063: <a name="devfaq.make"></a><a name="idp140445875782280"></a><p><b>24.2.</b></p>
1.1       dsieger  9064: </td>
                   9065: <td align="left" valign="top"><p>What is the difference between
                   9066:        <code class="varname">MAKE</code>, <code class="varname">GMAKE</code> and
                   9067:        <code class="varname">MAKE_PROGRAM</code>?</p></td>
                   9068: </tr>
                   9069: <tr class="answer">
                   9070: <td align="left" valign="top"></td>
                   9071: <td align="left" valign="top"><p><code class="varname">MAKE</code> is the path to the
1.157     leot     9072:        <a class="citerefentry" href="http://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  9073:        infrastructure. <code class="varname">GMAKE</code> is the path to GNU
                   9074:        Make, but you need to say <code class="varname">USE_TOOLS+=gmake</code> to
                   9075:        use that. <code class="varname">MAKE_PROGRAM</code> is the path to the
                   9076:        Make program that is used for building the
                   9077:        package.</p></td>
                   9078: </tr>
1.41      asau     9079: <tr class="question">
1.1       dsieger  9080: <td align="left" valign="top">
1.160   ! brook    9081: <a name="devfaq.cc"></a><a name="idp140445875787272"></a><p><b>24.3.</b></p>
1.1       dsieger  9082: </td>
                   9083: <td align="left" valign="top"><p>What is the difference between
                   9084:        <code class="varname">CC</code>, <code class="varname">PKG_CC</code> and
                   9085:        <code class="varname">PKGSRC_COMPILER</code>?</p></td>
                   9086: </tr>
                   9087: <tr class="answer">
                   9088: <td align="left" valign="top"></td>
                   9089: <td align="left" valign="top"><p><code class="varname">CC</code> is the path to the real C
                   9090:        compiler, which can be configured by the pkgsrc user.
                   9091:        <code class="varname">PKG_CC</code> is the path to the compiler wrapper.
                   9092:        <code class="varname">PKGSRC_COMPILER</code> is <span class="emphasis"><em>not</em></span> a
                   9093:        path to a compiler, but the type of compiler that should be
                   9094:        used. See <code class="filename">mk/compiler.mk</code> for more
                   9095:        information about the latter variable.</p></td>
                   9096: </tr>
1.41      asau     9097: <tr class="question">
1.1       dsieger  9098: <td align="left" valign="top">
1.160   ! brook    9099: <a name="devfaq.bl3flags"></a><a name="idp140445875792152"></a><p><b>24.4.</b></p>
1.1       dsieger  9100: </td>
                   9101: <td align="left" valign="top"><p>What is the difference between
                   9102:        <code class="varname">BUILDLINK_LDFLAGS</code>,
                   9103:        <code class="varname">BUILDLINK_LDADD</code> and
                   9104:        <code class="varname">BUILDLINK_LIBS</code>?</p></td>
                   9105: </tr>
                   9106: <tr class="answer">
                   9107: <td align="left" valign="top"></td>
                   9108: <td align="left" valign="top"><p>[FIXME]</p></td>
                   9109: </tr>
1.41      asau     9110: <tr class="question">
1.1       dsieger  9111: <td align="left" valign="top">
1.160   ! brook    9112: <a name="devfaq.bl3prefix"></a><a name="idp140445875794776"></a><p><b>24.5.</b></p>
1.1       dsieger  9113: </td>
1.10      hubertf  9114: <td align="left" valign="top"><p>Why does <span class="command"><strong>make show-var
1.1       dsieger  9115:        VARNAME=BUILDLINK_PREFIX.<em class="replaceable"><code>foo</code></em></strong></span>
                   9116:        say it's empty?</p></td>
                   9117: </tr>
                   9118: <tr class="answer">
                   9119: <td align="left" valign="top"></td>
                   9120: <td align="left" valign="top"><p>For optimization reasons, some variables are only
1.23      wiz      9121:        available in the <span class="quote">&#8220;<span class="quote">wrapper</span>&#8221;</span> phase and later. To
                   9122:        <span class="quote">&#8220;<span class="quote">simulate</span>&#8221;</span> the wrapper phase, append
1.10      hubertf  9123:        <span class="command"><strong>PKG_PHASE=wrapper</strong></span> to the above
1.1       dsieger  9124:        command.</p></td>
                   9125: </tr>
1.41      asau     9126: <tr class="question">
1.1       dsieger  9127: <td align="left" valign="top">
1.160   ! brook    9128: <a name="devfaq.master_sites"></a><a name="idp140445875798648"></a><p><b>24.6.</b></p>
1.1       dsieger  9129: </td>
                   9130: <td align="left" valign="top"><p>What does
1.108     rillig   9131:        <code class="code">${MASTER_SITE_SOURCEFORGE:=package/}</code> mean? I
                   9132:        don't understand the <code class="code">:=</code> inside
1.1       dsieger  9133:        it.</p></td>
                   9134: </tr>
                   9135: <tr class="answer">
                   9136: <td align="left" valign="top"></td>
1.108     rillig   9137: <td align="left" valign="top"><p>The <code class="code">:=</code> is not really an
                   9138:        assignment operator, although it looks like it.
1.1       dsieger  9139:        Instead, it is a degenerate form of
1.108     rillig   9140:        <code class="code">${LIST:<em class="replaceable"><code>old_string</code></em>=<em class="replaceable"><code>new_string</code></em>}</code>,
1.157     leot     9141:        which is documented in the <a class="citerefentry" href="http://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   9142:        commonly used in the form <code class="code">${SRCS:.c=.o}</code>. In the
1.1       dsieger  9143:        case of <code class="varname">MASTER_SITE_*</code>,
                   9144:        <em class="replaceable"><code>old_string</code></em> is the empty string and
                   9145:        <em class="replaceable"><code>new_string</code></em> is
1.108     rillig   9146:        <code class="code">package/</code>. That's where the
                   9147:        <code class="code">:</code> and the <code class="code">=</code> fall
1.1       dsieger  9148:        together.</p></td>
                   9149: </tr>
1.41      asau     9150: <tr class="question">
1.1       dsieger  9151: <td align="left" valign="top">
1.160   ! brook    9152: <a name="devfaq.mailinglists"></a><a name="idp140445875806360"></a><p><b>24.7.</b></p>
1.1       dsieger  9153: </td>
                   9154: <td align="left" valign="top"><p>Which mailing lists are there for package
                   9155:        developers?</p></td>
                   9156: </tr>
                   9157: <tr class="answer">
                   9158: <td align="left" valign="top"></td>
1.41      asau     9159: <td align="left" valign="top"><div class="variablelist"><dl class="variablelist">
1.10      hubertf  9160: <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  9161: <dd><p>This is a list for technical discussions related
                   9162:        to pkgsrc development, e.g. soliciting feedback for changes to
                   9163:        pkgsrc infrastructure, proposed new features, questions related
                   9164:        to porting pkgsrc to a new platform, advice for maintaining a
                   9165:        package, patches that affect many packages, help requests moved
                   9166:        from pkgsrc-users when an infrastructure bug is found,
                   9167:        etc.</p></dd>
1.10      hubertf  9168: <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  9169: <dd><p>All bug reports in category "pkg" sent with
1.157     leot     9170:        <a class="citerefentry" href="http://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  9171:        directly; use one of the other mailing
                   9172:        lists.</p></dd>
                   9173: </dl></div></td>
                   9174: </tr>
1.41      asau     9175: <tr class="question">
1.1       dsieger  9176: <td align="left" valign="top">
1.160   ! brook    9177: <a name="devfaq.documentation"></a><a name="idp140445875811320"></a><p><b>24.8.</b></p>
1.1       dsieger  9178: </td>
                   9179: <td align="left" valign="top"><p>Where is the pkgsrc
                   9180:        documentation?</p></td>
                   9181: </tr>
                   9182: <tr class="answer">
                   9183: <td align="left" valign="top"></td>
                   9184: <td align="left" valign="top">
                   9185: <p>There are many places where you can find
                   9186:        documentation about pkgsrc:</p>
1.41      asau     9187: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      9188: <li class="listitem"><p>The pkgsrc guide (this document) is a collection
1.1       dsieger  9189:        of chapters that explain large parts of pkgsrc, but some
                   9190:        chapters tend to be outdated. Which ones they are is hard to
                   9191:        say.</p></li>
1.23      wiz      9192: <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  9193:        about certain features, announcements of new parts of the pkgsrc
                   9194:        infrastructure and sometimes even announcements that a certain
                   9195:        feature has been marked as obsolete. The benefit here is that
                   9196:        each message has a date appended to it.</p></li>
1.23      wiz      9197: <li class="listitem"><p>Many of the files in the
1.1       dsieger  9198:        <code class="filename">mk/</code> directory start with a comment that
                   9199:        describes the purpose of the file and how it can be used by the
                   9200:        pkgsrc user and package authors. An easy way to find this
1.10      hubertf  9201:        documentation is to run <span class="command"><strong>bmake
1.1       dsieger  9202:        help</strong></span>.</p></li>
1.23      wiz      9203: <li class="listitem"><p>The CVS log messages are a rich source of
1.1       dsieger  9204:        information, but they tend to be highly abbreviated, especially
                   9205:        for actions that occur often. Some contain a detailed
                   9206:        description of what has changed, but they are geared towards the
                   9207:        other pkgsrc developers, not towards an average pkgsrc user.
                   9208:        They also only document <span class="emphasis"><em>changes</em></span>, so if you
                   9209:        don't know what has been before, these messages may not be worth
                   9210:        too much to you.</p></li>
1.23      wiz      9211: <li class="listitem"><p>Some parts of pkgsrc are only <span class="quote">&#8220;<span class="quote">implicitly
                   9212:        documented</span>&#8221;</span>, that is the documentation exists only in the
1.1       dsieger  9213:        mind of the developer who wrote the code. To get this
1.10      hubertf  9214:        information, use the <span class="command"><strong>cvs annotate</strong></span> command
1.1       dsieger  9215:        to see who has written it and ask on the
                   9216:        <code class="literal">tech-pkg</code> mailing list, so that others can
                   9217:        find your questions later (see above). To be sure that the
                   9218:        developer in charge reads the mail, you may CC him or
                   9219:        her.</p></li>
                   9220: </ul></div>
                   9221: </td>
                   9222: </tr>
1.41      asau     9223: <tr class="question">
1.1       dsieger  9224: <td align="left" valign="top">
1.160   ! brook    9225: <a name="devfaq.too-much-time"></a><a name="idp140445875820168"></a><p><b>24.9.</b></p>
1.1       dsieger  9226: </td>
                   9227: <td align="left" valign="top"><p>I have a little time to kill.  What shall I
                   9228: do?</p></td>
                   9229: </tr>
                   9230: <tr class="answer">
                   9231: <td align="left" valign="top"></td>
                   9232: <td align="left" valign="top">
                   9233: <p>This is not really an FAQ yet, but here's the answer
                   9234: anyway.</p>
1.41      asau     9235: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      9236: <li class="listitem"><p>Run <span class="command"><strong>pkg_chk -N</strong></span> (from the
1.137     leot     9237:     <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  9238:     will tell you about newer versions of installed packages that are
                   9239:     available, but not yet updated in pkgsrc.</p></li>
1.23      wiz      9240: <li class="listitem"><p>Browse <code class="filename">pkgsrc/doc/TODO</code>
1.14      jmcneill 9241:     &mdash; it contains a list of suggested new packages and a list of
1.1       dsieger  9242:     cleanups and enhancements for pkgsrc that would be nice to
                   9243:     have.</p></li>
1.23      wiz      9244: <li class="listitem"><p>Review packages for which review was requested on
1.71      wiz      9245:     the <a class="ulink" href="http://www.NetBSD.org/mailinglists/index.html#tech-pkg" target="_top">tech-pkg</a>
1.1       dsieger  9246:     mailing list.</p></li>
                   9247: </ul></div>
                   9248: </td>
                   9249: </tr>
                   9250: </tbody>
                   9251: </table>
                   9252: </div>
                   9253: </div>
1.41      asau     9254: <div class="chapter">
1.1       dsieger  9255: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   9256: <a name="gnome"></a>Chapter 25. GNOME packaging and porting</h2></div></div></div>
1.1       dsieger  9257: <div class="toc">
                   9258: <p><b>Table of Contents</b></p>
1.100     leot     9259: <dl class="toc">
1.154     rillig   9260: <dt><span class="sect1"><a href="#meta-packages">25.1. Meta packages</a></span></dt>
                   9261: <dt><span class="sect1"><a href="#new-package">25.2. Packaging a GNOME application</a></span></dt>
                   9262: <dt><span class="sect1"><a href="#full-update">25.3. Updating GNOME to a newer version</a></span></dt>
                   9263: <dt><span class="sect1"><a href="#patching">25.4. Patching guidelines</a></span></dt>
1.1       dsieger  9264: </dl>
                   9265: </div>
1.10      hubertf  9266: <p>Quoting <a class="ulink" href="http://www.gnome.org/" target="_top">GNOME's web
1.1       dsieger  9267: site</a>:</p>
                   9268: <div class="blockquote"><blockquote class="blockquote"><p>The GNOME project provides two things: The GNOME desktop
                   9269:   environment, an intuitive and attractive desktop for users, and the
                   9270:   GNOME development platform, an extensive framework for building
                   9271:   applications that integrate into the rest of the desktop.</p></blockquote></div>
                   9272: <p>pkgsrc provides a seamless way to automatically build and install
                   9273: a complete GNOME environment <span class="emphasis"><em>under many different
                   9274: platforms</em></span>.  We can say with confidence that pkgsrc is one of
                   9275: the most advanced build and packaging systems for GNOME due to its
                   9276: included technologies buildlink3, the wrappers and tools framework and
                   9277: automatic configuration file management.  Lots of efforts are put into
                   9278: achieving a completely clean deinstallation of installed software
                   9279: components.</p>
1.10      hubertf  9280: <p>Given that pkgsrc is <a class="ulink" href="http://www.NetBSD.org/" target="_top">NetBSD</a>'s official packaging system,
1.1       dsieger  9281: the above also means that great efforts are put into making GNOME work
1.10      hubertf  9282: under this operating system.  Recently, <a class="ulink" href="http://www.dragonflybsd.org/" target="_top">DragonFly BSD</a> also adopted
1.1       dsieger  9283: pkgsrc as its preferred packaging system, contributing lots of
                   9284: portability fixes to make GNOME build and install under it.</p>
                   9285: <p>This chapter is aimed at pkgsrc developers and other people
                   9286: interested in helping our GNOME porting and packaging efforts.  It
                   9287: provides instructions on how to manage the existing packages and some
                   9288: important information regarding their internals.</p>
1.41      asau     9289: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  9290: <h3 class="title">We need your help!</h3>
                   9291: <p>Should you have some spare cycles to devote to NetBSD, pkgsrc
                   9292:   and GNOME and are willing to learn new exciting stuff, please jump
1.10      hubertf  9293:   straight to the <a class="ulink" href="http://www.NetBSD.org/contrib/projects.html#gnome" target="_top">pending
1.1       dsieger  9294:   work</a> list!  There is still a long way to go to get a
                   9295:   fully-functional GNOME desktop under NetBSD and we need your help to
                   9296:   achieve it!</p>
                   9297: </div>
1.41      asau     9298: <div class="sect1">
1.1       dsieger  9299: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   9300: <a name="meta-packages"></a>25.1. Meta packages</h2></div></div></div>
1.1       dsieger  9301: <p>pkgsrc includes three GNOME-related meta packages:</p>
1.41      asau     9302: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.137     leot     9303: <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  9304:     the core GNOME desktop environment.  It only includes the necessary
                   9305:     bits to get it to boot correctly, although it may lack important
                   9306:     functionality for daily operation.  The idea behind this package is
                   9307:     to let end users build their own configurations on top of this one,
                   9308:     first installing this meta package to achieve a functional setup and
                   9309:     then adding individual applications.</p></li>
1.137     leot     9310: <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  9311:     complete installation of the GNOME platform and desktop as defined
                   9312:     by the GNOME project; this is based on the components distributed in
                   9313:     the <code class="filename">platform/x.y/x.y.z/sources</code> and
                   9314:     <code class="filename">desktop/x.y/x.y.z/sources</code> directories of the
                   9315:     official FTP server.  Developer-only tools found in those
                   9316:     directories are not installed unless required by some other
                   9317:     component to work properly.  Similarly, packages from the bindings
                   9318:     set (<code class="filename">bindings/x.y/x.y.z/sources</code>) are not pulled
                   9319:     in unless required as a dependency for an end-user component.  This
1.137     leot     9320:     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>
                   9321: <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  9322:     Installs all the tools required to build a GNOME component when
                   9323:     fetched from the CVS repository.  These are required to let the
1.10      hubertf  9324:     <span class="command"><strong>autogen.sh</strong></span> scripts work appropriately.</p></li>
1.1       dsieger  9325: </ul></div>
                   9326: <p>In all these packages, the <code class="varname">DEPENDS</code> lines are
                   9327: sorted in a way that eases updates: a package may depend on other
                   9328: packages listed before it but not on any listed after it.  It is very
                   9329: important to keep this order to ease updates so... <span class="emphasis"><em>do not
                   9330: change it to alphabetical sorting!</em></span></p>
                   9331: </div>
1.41      asau     9332: <div class="sect1">
1.1       dsieger  9333: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   9334: <a name="new-package"></a>25.2. Packaging a GNOME application</h2></div></div></div>
1.1       dsieger  9335: <p>Almost all GNOME applications are written in C and use a common
                   9336: set of tools as their build system.  Things get different with the new
                   9337: bindings to other languages (such as Python), but the following will
                   9338: give you a general idea on the minimum required tools:</p>
1.41      asau     9339: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      9340: <li class="listitem">
1.1       dsieger  9341: <p>Almost all GNOME applications use the GNU Autotools as their
                   9342:     build system.  As a general rule you will need to tell this to your
                   9343:     package:</p>
                   9344: <pre class="programlisting">
                   9345: GNU_CONFIGURE=yes
                   9346: USE_LIBTOOL=yes
                   9347: USE_TOOLS+=gmake
                   9348: </pre>
                   9349: </li>
1.23      wiz      9350: <li class="listitem">
1.1       dsieger  9351: <p>If the package uses pkg-config to detect dependencies, add this
                   9352:     tool to the list of required utilities:</p>
1.111     sevan    9353: <pre class="programlisting">
                   9354: USE_TOOLS+=pkg-config
                   9355: </pre>
1.137     leot     9356: <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  9357:     the end of the build process to ensure that you did not miss to
                   9358:     specify any dependency in your package and that the version
                   9359:     requirements are all correct.</p>
                   9360: </li>
1.23      wiz      9361: <li class="listitem"><p>If the package uses intltool, be sure to add
1.1       dsieger  9362:     <code class="literal">intltool</code> to the <code class="varname">USE_TOOLS</code>
                   9363:     to handle dependencies and to force the package to use the latest
                   9364:     available version.</p></li>
1.23      wiz      9365: <li class="listitem">
1.1       dsieger  9366: <p>If the package uses gtk-doc (a documentation generation
                   9367:     utility), do <span class="emphasis"><em>not</em></span> add a dependency on it.  The
                   9368:     tool is rather big and the distfile should come with pregenerated
                   9369:     documentation anyway; if it does not, it is a bug that you ought to
                   9370:     report.  For such packages you should disable gtk-doc (unless it is
                   9371:     the default):</p>
1.111     sevan    9372: <pre class="programlisting">
                   9373: CONFIGURE_ARGS+=--disable-gtk-doc
                   9374: </pre>
1.1       dsieger  9375: <p>The default location of installed HTML files
                   9376:     (<code class="filename">share/gtk-doc/&lt;package-name&gt;</code>) is correct
                   9377:     and should not be changed unless the package insists on installing
                   9378:     them somewhere else.  Otherwise programs as
1.10      hubertf  9379:     <span class="command"><strong>devhelp</strong></span> will not be able to open them.  You can
1.1       dsieger  9380:     do that with an entry similar to:</p>
1.111     sevan    9381: <pre class="programlisting">
                   9382: CONFIGURE_ARGS+=--with-html-dir=${PREFIX}/share/gtk-doc/...
                   9383: </pre>
1.1       dsieger  9384: </li>
                   9385: </ul></div>
                   9386: <p>GNOME uses multiple <span class="emphasis"><em>shared</em></span> directories and
                   9387: files under the installation prefix to maintain databases.  In this
                   9388: context, shared means that those exact same directories and files are
                   9389: used among several different packages, leading to conflicts in the
                   9390: <code class="filename">PLIST</code>.  pkgsrc currently includes functionality to
                   9391: handle the most common cases, so you have to forget about using
                   9392: <code class="literal">@unexec ${RMDIR}</code> lines in your file lists and
                   9393: omitting shared files from them.  If you find yourself doing those,
                   9394: <span class="emphasis"><em>your package is most likely incorrect</em></span>.</p>
                   9395: <p>The following table lists the common situations that result in
                   9396: using shared directories or files.  For each of them, the appropriate
                   9397: solution is given.  After applying the solution be sure to
                   9398: <span class="emphasis"><em>regenerate the package's file list</em></span> with
1.10      hubertf  9399: <span class="command"><strong>make print-PLIST</strong></span> and ensure it is correct.</p>
1.1       dsieger  9400: <div class="table">
1.154     rillig   9401: <a name="plist-handling"></a><p class="title"><b>Table 25.1. PLIST handling for GNOME packages</b></p>
1.106     tnn      9402: <div class="table-contents"><table class="table" summary="PLIST handling for GNOME packages" border="1">
1.1       dsieger  9403: <colgroup>
                   9404: <col>
                   9405: <col>
                   9406: </colgroup>
                   9407: <thead><tr>
                   9408: <th>If the package...</th>
                   9409: <th>Then...</th>
                   9410: </tr></thead>
                   9411: <tbody>
                   9412: <tr>
                   9413: <td>Installs OMF files under <code class="filename">share/omf</code>.</td>
1.154     rillig   9414: <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  9415: </tr>
                   9416: <tr>
                   9417: <td>Installs icons under the
                   9418:         <code class="filename">share/icons/hicolor</code> hierarchy or updates
                   9419:         <code class="filename">share/icons/hicolor/icon-theme.cache</code>.</td>
1.154     rillig   9420: <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  9421: </tr>
                   9422: <tr>
                   9423: <td>Installs files under
                   9424:         <code class="filename">share/mime/packages</code>.</td>
1.154     rillig   9425: <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  9426: </tr>
                   9427: <tr>
                   9428: <td>Installs <code class="filename">.desktop</code> files under
                   9429:         <code class="filename">share/applications</code> and these include MIME
                   9430:         information.</td>
1.154     rillig   9431: <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  9432: </tr>
                   9433: </tbody>
                   9434: </table></div>
                   9435: </div>
                   9436: <br class="table-break">
                   9437: </div>
1.41      asau     9438: <div class="sect1">
1.1       dsieger  9439: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   9440: <a name="full-update"></a>25.3. Updating GNOME to a newer version</h2></div></div></div>
1.1       dsieger  9441: <p>When seeing GNOME as a whole, there are two kinds of
                   9442: updates:</p>
1.41      asau     9443: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  9444: <dt><span class="term">Major update</span></dt>
                   9445: <dd>
                   9446: <p>Given that there is still a very long way for GNOME 3 (if it
                   9447:       ever appears), we consider a major update one that goes from a
                   9448:       <code class="literal">2.X</code> version to a <code class="literal">2.Y</code> one,
                   9449:       where <code class="literal">Y</code> is even and greater than
                   9450:       <code class="literal">X</code>.  These are hard to achieve because they
                   9451:       introduce lots of changes in the components' code and almost all
                   9452:       GNOME distfiles are updated to newer versions.  Some of them can
                   9453:       even break API and ABI compatibility with the previous major
                   9454:       version series.  As a result, the update needs to be done all at
                   9455:       once to minimize breakage.</p>
                   9456: <p>A major update typically consists of around 80 package
                   9457:       updates and the addition of some new ones.</p>
                   9458: </dd>
                   9459: <dt><span class="term">Minor update</span></dt>
                   9460: <dd>
                   9461: <p>We consider a minor update one that goes from a
                   9462:       <code class="literal">2.A.X</code> version to a <code class="literal">2.A.Y</code>
                   9463:       one where <code class="literal">Y</code> is greater than
                   9464:       <code class="literal">X</code>.  These are easy to achieve because they do
                   9465:       not update all GNOME components, can be done in an incremental way
                   9466:       and do not break API nor ABI compatibility.</p>
                   9467: <p>A minor update typically consists of around 50 package
                   9468:       updates, although the numbers here may vary a lot.</p>
                   9469: </dd>
                   9470: </dl></div>
                   9471: <p>In order to update the GNOME components in pkgsrc to a new stable
                   9472: release (either major or minor), the following steps should be
                   9473: followed:</p>
1.23      wiz      9474: <div class="orderedlist"><ol class="orderedlist" type="1">
                   9475: <li class="listitem">
1.1       dsieger  9476: <p>Get a list of all the tarballs that form the new release by
                   9477:     using the following commands.  These will leave the full list of the
1.18      snj      9478:     components' distfiles into the <code class="filename">list.txt</code>
1.1       dsieger  9479:     file:</p>
                   9480: <pre class="screen"><code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
                   9481:     ftp -V ftp://ftp.gnome.org/pub/gnome/platform/x.y/x.y.z/sources/ | \
                   9482:     awk '{ print $9 }' &gt;list.txt</code></strong>
                   9483: <code class="prompt">%</code> <strong class="userinput"><code>echo ls "*.tar.bz2" | \
                   9484:     ftp -V ftp://ftp.gnome.org/pub/gnome/desktop/x.y/x.y.z/sources/ | \
                   9485:     awk '{ print $9 }' &gt;&gt;list.txt</code></strong></pre>
                   9486: </li>
1.23      wiz      9487: <li class="listitem"><p>Open each meta package's <code class="filename">Makefile</code> and
1.1       dsieger  9488:     bump their version to the release you are updating them to.  The
                   9489:     three meta packages should be always consistent with versioning.
                   9490:     Obviously remove any <code class="varname">PKGREVISION</code>s that might be
                   9491:     in them.</p></li>
1.23      wiz      9492: <li class="listitem">
1.1       dsieger  9493: <p>For each meta package, update all its
                   9494:     <code class="varname">DEPENDS</code> lines to match the latest versions as
                   9495:     shown by the above commands.  Do <span class="emphasis"><em>not</em></span> list any
                   9496:     newer version (even if found in the FTP) because the meta packages
                   9497:     are supposed to list the exact versions that form a specific GNOME
                   9498:     release.  Exceptions are permitted here if a newer version solves a
                   9499:     serious issue in the overall desktop experience; these typically
                   9500:     come in the form of a revision bump in pkgsrc, not in newer versions
                   9501:     from the developers.</p>
                   9502: <p>Packages not listed in the <code class="filename">list.txt</code> file
                   9503:     should be updated to the latest version available (if found in
                   9504:     pkgsrc).  This is the case, for example, of the dependencies on the
1.137     leot     9505:     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  9506: </li>
1.23      wiz      9507: <li class="listitem">
1.1       dsieger  9508: <p>Generate a patch from the modified meta packages and extract the
                   9509:     list of "new" lines.  This will provide you an outline on what
                   9510:     packages need to be updated in pkgsrc and in what order:</p>
                   9511: <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>
                   9512: </li>
1.23      wiz      9513: <li class="listitem"><p>For major desktop updates it is recommended to zap all your
1.1       dsieger  9514:     installed packages and start over from scratch at this point.</p></li>
1.23      wiz      9515: <li class="listitem"><p>Now comes the longest step by far: iterate over the contents
1.1       dsieger  9516:     of <code class="filename">todo.txt</code> and update the packages listed in
                   9517:     it in order.  For major desktop updates none of these should be
                   9518:     committed until the entire set is completed because there are chances
                   9519:     of breaking not-yet-updated packages.</p></li>
1.23      wiz      9520: <li class="listitem"><p>Once the packages are up to date and working, commit them to
1.1       dsieger  9521:     the tree one by one with appropriate log messages.  At the end,
                   9522:     commit the three meta package updates and all the corresponding
                   9523:     changes to the <code class="filename">doc/CHANGES-&lt;YEAR&gt;</code> and
                   9524:     <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>
                   9525: </ol></div>
                   9526: </div>
1.41      asau     9527: <div class="sect1">
1.1       dsieger  9528: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   9529: <a name="patching"></a>25.4. Patching guidelines</h2></div></div></div>
1.1       dsieger  9530: <p>GNOME is a very big component in pkgsrc which approaches 100
                   9531: packages.  Please, it is very important that you always, always,
                   9532: <span class="strong"><strong>always</strong></span> feed back any portability
1.154     rillig   9533: 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  9534: their attention on portability issues and to ensure that future versions
                   9535: can be built out-of-the box on NetBSD.  The less custom patches in
                   9536: pkgsrc, the easier further updates are.  Those developers in charge of
                   9537: issuing major GNOME updates will be grateful if you do that.</p>
1.10      hubertf  9538: <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  9539: Bugzilla</a>.  Not all components use these to track bugs, but most
                   9540: of them do.  Do not be short on your reports: always provide detailed
                   9541: explanations of the current failure, how it can be improved to achieve
                   9542: maximum portability and, if at all possible, provide a patch against CVS
                   9543: head.  The more verbose you are, the higher chances of your patch being
                   9544: accepted.</p>
                   9545: <p>Also, please avoid using preprocessor magic to fix portability
                   9546: issues.  While the FreeBSD GNOME people are doing a great job in porting
                   9547: GNOME to their operating system, the official GNOME sources are now
                   9548: plagued by conditionals that check for <code class="varname">__FreeBSD__</code>
                   9549: and similar macros.  This hurts portability.  Please see our patching
1.154     rillig   9550: 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  9551: details.</p>
                   9552: </div>
                   9553: </div>
                   9554: </div>
1.41      asau     9555: <div class="part">
1.1       dsieger  9556: <div class="titlepage"><div><div><h1 class="title">
                   9557: <a name="infrastructure"></a>Part III. The pkgsrc infrastructure internals</h1></div></div></div>
1.41      asau     9558: <div class="partintro">
1.1       dsieger  9559: <div></div>
                   9560: <p>This part of the guide deals with everything
                   9561:        from the infrastructure that is behind the interfaces described
                   9562:        in the developer's guide. A casual package maintainer should not
                   9563:        need anything from this part.</p>
                   9564: <div class="toc">
                   9565: <p><b>Table of Contents</b></p>
1.100     leot     9566: <dl class="toc">
1.154     rillig   9567: <dt><span class="chapter"><a href="#infr.design">26. Design of the pkgsrc infrastructure</a></span></dt>
1.1       dsieger  9568: <dd><dl>
1.154     rillig   9569: <dt><span class="sect1"><a href="#infr.vardef">26.1. The meaning of variable definitions</a></span></dt>
                   9570: <dt><span class="sect1"><a href="#infr.vardef.problems">26.2. Avoiding problems before they arise</a></span></dt>
                   9571: <dt><span class="sect1"><a href="#infr.var">26.3. Variable evaluation</a></span></dt>
1.1       dsieger  9572: <dd><dl>
1.154     rillig   9573: <dt><span class="sect2"><a href="#infr.var.load">26.3.1. At load time</a></span></dt>
                   9574: <dt><span class="sect2"><a href="#infr.var.run">26.3.2. At runtime</a></span></dt>
1.1       dsieger  9575: </dl></dd>
1.154     rillig   9576: <dt><span class="sect1"><a href="#infr.varspec">26.4. How can variables be specified?</a></span></dt>
                   9577: <dt><span class="sect1"><a href="#infr.design.intf">26.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1       dsieger  9578: <dd><dl>
1.154     rillig   9579: <dt><span class="sect2"><a href="#infr.design.intf.proc">26.5.1. Procedures with parameters</a></span></dt>
                   9580: <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  9581: </dl></dd>
1.154     rillig   9582: <dt><span class="sect1"><a href="#infr.order">26.6. The order in which files are loaded</a></span></dt>
1.1       dsieger  9583: <dd><dl>
1.154     rillig   9584: <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>
                   9585: <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  9586: </dl></dd>
                   9587: </dl></dd>
1.154     rillig   9588: <dt><span class="chapter"><a href="#regression">27. Regression tests</a></span></dt>
1.1       dsieger  9589: <dd><dl>
1.154     rillig   9590: <dt><span class="sect1"><a href="#regression.run">27.1. Running the regression tests</a></span></dt>
                   9591: <dt><span class="sect1"><a href="#regression.new">27.2. Adding a new regression test</a></span></dt>
1.1       dsieger  9592: <dd><dl>
1.154     rillig   9593: <dt><span class="sect2"><a href="#regression.fun.override">27.2.1. Overridable functions</a></span></dt>
                   9594: <dt><span class="sect2"><a href="#regression.fun.helper">27.2.2. Helper functions</a></span></dt>
1.1       dsieger  9595: </dl></dd>
                   9596: </dl></dd>
1.154     rillig   9597: <dt><span class="chapter"><a href="#porting">28. Porting pkgsrc</a></span></dt>
                   9598: <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  9599: </dl>
                   9600: </div>
                   9601: </div>
1.41      asau     9602: <div class="chapter">
1.1       dsieger  9603: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   9604: <a name="infr.design"></a>Chapter 26. Design of the pkgsrc infrastructure</h2></div></div></div>
1.1       dsieger  9605: <div class="toc">
                   9606: <p><b>Table of Contents</b></p>
1.100     leot     9607: <dl class="toc">
1.154     rillig   9608: <dt><span class="sect1"><a href="#infr.vardef">26.1. The meaning of variable definitions</a></span></dt>
                   9609: <dt><span class="sect1"><a href="#infr.vardef.problems">26.2. Avoiding problems before they arise</a></span></dt>
                   9610: <dt><span class="sect1"><a href="#infr.var">26.3. Variable evaluation</a></span></dt>
1.1       dsieger  9611: <dd><dl>
1.154     rillig   9612: <dt><span class="sect2"><a href="#infr.var.load">26.3.1. At load time</a></span></dt>
                   9613: <dt><span class="sect2"><a href="#infr.var.run">26.3.2. At runtime</a></span></dt>
1.1       dsieger  9614: </dl></dd>
1.154     rillig   9615: <dt><span class="sect1"><a href="#infr.varspec">26.4. How can variables be specified?</a></span></dt>
                   9616: <dt><span class="sect1"><a href="#infr.design.intf">26.5. Designing interfaces for Makefile fragments</a></span></dt>
1.1       dsieger  9617: <dd><dl>
1.154     rillig   9618: <dt><span class="sect2"><a href="#infr.design.intf.proc">26.5.1. Procedures with parameters</a></span></dt>
                   9619: <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  9620: </dl></dd>
1.154     rillig   9621: <dt><span class="sect1"><a href="#infr.order">26.6. The order in which files are loaded</a></span></dt>
1.1       dsieger  9622: <dd><dl>
1.154     rillig   9623: <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>
                   9624: <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  9625: </dl></dd>
                   9626: </dl>
                   9627: </div>
                   9628: <p>The pkgsrc infrastructure consists of many small Makefile
                   9629:        fragments. Each such fragment needs a properly specified
                   9630:        interface. This chapter explains how such an interface looks
                   9631:        like.</p>
1.41      asau     9632: <div class="sect1">
1.1       dsieger  9633: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   9634: <a name="infr.vardef"></a>26.1. The meaning of variable definitions</h2></div></div></div>
1.1       dsieger  9635: <p>Whenever a variable is defined in the pkgsrc
                   9636:        infrastructure, the location and the way of definition provide
                   9637:        much information about the intended use of that variable.
                   9638:        Additionally, more documentation may be found in a header
                   9639:        comment or in this pkgsrc guide.</p>
                   9640: <p>A special file is
                   9641:        <code class="filename">mk/defaults/mk.conf</code>, which lists all
                   9642:        variables that are intended to be user-defined. They are either
                   9643:        defined using the <code class="literal">?=</code> operator or they are
                   9644:        left undefined because defining them to anything would
1.23      wiz      9645:        effectively mean <span class="quote">&#8220;<span class="quote">yes</span>&#8221;</span>. All these variables may be
1.1       dsieger  9646:        overridden by the pkgsrc user in the <code class="varname">MAKECONF</code>
                   9647:        file.</p>
                   9648: <p>Outside this file, the following conventions apply:
                   9649:        Variables that are defined using the <code class="literal">?=</code>
                   9650:        operator may be overridden by a package.</p>
                   9651: <p>Variables that are defined using the <code class="literal">=</code>
                   9652:        operator may be used read-only at run-time.</p>
                   9653: <p>Variables whose name starts with an underscore must not be
                   9654:        accessed outside the pkgsrc infrastructure at all. They may
                   9655:        change without further notice.</p>
1.41      asau     9656: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  9657: <h3 class="title">Note</h3>
                   9658: <p>These conventions are currently not applied
                   9659:        consistently to the complete pkgsrc
                   9660:        infrastructure.</p>
                   9661: </div>
                   9662: </div>
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.problems"></a>26.2. Avoiding problems before they arise</h2></div></div></div>
1.1       dsieger  9666: <p>All variables that contain lists of things should default
                   9667:        to being empty. Two examples that do not follow this rule are
                   9668:        <code class="varname">USE_LANGUAGES</code> and
                   9669:        <code class="varname">DISTFILES</code>. These variables cannot simply be
                   9670:        modified using the <code class="literal">+=</code> operator in package
                   9671:        <code class="filename">Makefile</code>s (or other files included by
                   9672:        them), since there is no guarantee whether the variable is
                   9673:        already set or not, and what its value is. In the case of
1.23      wiz      9674:        <code class="varname">DISTFILES</code>, the packages <span class="quote">&#8220;<span class="quote">know</span>&#8221;</span>
1.1       dsieger  9675:        the default value and just define it as in the following
                   9676:        example.</p>
                   9677: <pre class="programlisting">
                   9678: DISTFILES=      ${DISTNAME}${EXTRACT_SUFX} additional-files.tar.gz
                   9679: </pre>
                   9680: <p>Because of the selection of this default value, the same
                   9681:        value appears in many package Makefiles. Similarly for
                   9682:        <code class="varname">USE_LANGUAGES</code>, but in this case the default
1.23      wiz      9683:        value (<span class="quote">&#8220;<span class="quote"><code class="literal">c</code></span>&#8221;</span>) is so short that it
1.1       dsieger  9684:        doesn't stand out. Nevertheless it is mentioned in many
                   9685:        files.</p>
                   9686: </div>
1.41      asau     9687: <div class="sect1">
1.1       dsieger  9688: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   9689: <a name="infr.var"></a>26.3. Variable evaluation</h2></div></div></div>
1.41      asau     9690: <div class="sect2">
1.1       dsieger  9691: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   9692: <a name="infr.var.load"></a>26.3.1. At load time</h3></div></div></div>
1.1       dsieger  9693: <p>Variable evaluation takes place either at load time or at
                   9694:        runtime, depending on the context in which they occur. The
                   9695:        contexts where variables are evaluated at load time are:</p>
1.41      asau     9696: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      9697: <li class="listitem"><p>The right hand side of the <code class="literal">:=</code>
1.1       dsieger  9698:        and <code class="literal">!=</code> operators,</p></li>
1.23      wiz      9699: <li class="listitem"><p>Make directives like <code class="literal">.if</code> or
1.1       dsieger  9700:        <code class="literal">.for</code>,</p></li>
1.23      wiz      9701: <li class="listitem"><p>Dependency lines.</p></li>
1.1       dsieger  9702: </ul></div>
                   9703: <p>A special exception are references to the iteration
                   9704:        variables of <code class="literal">.for</code> loops, which are expanded
                   9705:        inline, no matter in which context they appear.</p>
                   9706: <p>As the values of variables may change during load time,
                   9707:        care must be taken not to evaluate them by accident. Typical
                   9708:        examples for variables that should not be evaluated at load time
                   9709:        are <code class="varname">DEPENDS</code> and
                   9710:        <code class="varname">CONFIGURE_ARGS</code>. To make the effect more
                   9711:        clear, here is an example:</p>
                   9712: <pre class="programlisting">
                   9713: CONFIGURE_ARGS=         # none
                   9714: CFLAGS=                 -O
                   9715: CONFIGURE_ARGS+=        CFLAGS=${CFLAGS:Q}
                   9716: 
                   9717: CONFIGURE_ARGS:=        ${CONFIGURE_ARGS}
                   9718: 
                   9719: CFLAGS+=                -Wall
1.111     sevan    9720: </pre>
1.1       dsieger  9721: <p>This code shows how the use of the <code class="literal">:=</code>
                   9722:        operator can quickly lead to unexpected results. The first
                   9723:        paragraph is fairly common code. The second paragraph evaluates
                   9724:        the <code class="varname">CONFIGURE_ARGS</code> variable, which results in
                   9725:        <code class="literal">CFLAGS=-O</code>. In the third paragraph, the
                   9726:        <code class="literal">-Wall</code> is appended to the
                   9727:        <code class="varname">CFLAGS</code>, but this addition will not appear in
                   9728:        <code class="varname">CONFIGURE_ARGS</code>. In actual code, the three
                   9729:        paragraphs from above typically occur in completely unrelated
                   9730:        files.</p>
                   9731: </div>
1.41      asau     9732: <div class="sect2">
1.1       dsieger  9733: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   9734: <a name="infr.var.run"></a>26.3.2. At runtime</h3></div></div></div>
1.1       dsieger  9735: <p>After all the files have been loaded, the values of the
                   9736:        variables cannot be changed anymore. Variables that are used in
                   9737:        the shell commands are expanded at this point.</p>
                   9738: </div>
                   9739: </div>
1.41      asau     9740: <div class="sect1">
1.1       dsieger  9741: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   9742: <a name="infr.varspec"></a>26.4. How can variables be specified?</h2></div></div></div>
1.1       dsieger  9743: <p>There are many ways in which the definition and use of a
1.108     rillig   9744:        variable can be restricted in order to detect bugs and violations
                   9745:        of the (mostly unwritten) policies. A package can be checked with
                   9746:        <code class="literal">pkglint -Wall</code> to see whether it meets these
                   9747:        rules.</p>
1.1       dsieger  9748: </div>
1.41      asau     9749: <div class="sect1">
1.1       dsieger  9750: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   9751: <a name="infr.design.intf"></a>26.5. Designing interfaces for Makefile fragments</h2></div></div></div>
1.1       dsieger  9752: <p>Most of the <code class="filename">.mk</code> files fall into one
                   9753:        of the following classes. Cases where a file falls into more
                   9754:        than one class should be avoided as it often leads to subtle
                   9755:        bugs.</p>
1.41      asau     9756: <div class="sect2">
1.1       dsieger  9757: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   9758: <a name="infr.design.intf.proc"></a>26.5.1. Procedures with parameters</h3></div></div></div>
1.1       dsieger  9759: <p>In a traditional imperative programming language some of
                   9760:        the <code class="filename">.mk</code> files could be described as
1.14      jmcneill 9761:        procedures. They take some input parameters and&mdash;after
                   9762:        inclusion&mdash;provide a result in output parameters. Since all
1.1       dsieger  9763:        variables in <code class="filename">Makefile</code>s have global scope
                   9764:        care must be taken not to use parameter names that have already
                   9765:        another meaning. For example, <code class="varname">PKGNAME</code> is a
                   9766:        bad choice for a parameter name.</p>
                   9767: <p>Procedures are completely evaluated at preprocessing time.
                   9768:        That is, when calling a procedure all input parameters must be
                   9769:        completely resolvable. For example,
                   9770:        <code class="varname">CONFIGURE_ARGS</code> should never be an input
                   9771:        parameter since it is very likely that further text will be
                   9772:        added after calling the procedure, which would effectively apply
                   9773:        the procedure to only a part of the variable. Also, references
1.108     rillig   9774:        to other variables will be modified after calling the
1.1       dsieger  9775:        procedure.</p>
                   9776: <p>A procedure can declare its output parameters either as
                   9777:        suitable for use in preprocessing directives or as only
                   9778:        available at runtime. The latter alternative is for variables
                   9779:        that contain references to other runtime variables.</p>
                   9780: <p>Procedures shall be written such that it is possible to
                   9781:        call the procedure more than once. That is, the file must not
                   9782:        contain multiple-inclusion guards.</p>
                   9783: <p>Examples for procedures are
                   9784:        <code class="filename">mk/bsd.options.mk</code> and
                   9785:        <code class="filename">mk/buildlink3/bsd.builtin.mk</code>. To express
                   9786:        that the parameters are evaluated at load time, they should be
                   9787:        assigned using the <code class="literal">:=</code> operator, which should
                   9788:        be used only for this purpose.</p>
                   9789: </div>
1.41      asau     9790: <div class="sect2">
1.1       dsieger  9791: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   9792: <a name="infr.design.intf.action"></a>26.5.2. Actions taken on behalf of parameters</h3></div></div></div>
1.1       dsieger  9793: <p>Action files take some input parameters and may define
                   9794:        runtime variables. They shall not define loadtime variables.
                   9795:        There are action files that are included implicitly by the
                   9796:        pkgsrc infrastructure, while other must be included
                   9797:        explicitly.</p>
                   9798: <p>An example for action files is
                   9799:        <code class="filename">mk/subst.mk</code>.</p>
                   9800: </div>
                   9801: </div>
1.41      asau     9802: <div class="sect1">
1.1       dsieger  9803: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   9804: <a name="infr.order"></a>26.6. The order in which files are loaded</h2></div></div></div>
1.1       dsieger  9805: <p>Package <code class="filename">Makefile</code>s usually consist of
                   9806:        a set of variable definitions, and include the file
                   9807:        <code class="filename">../../mk/bsd.pkg.mk</code> in the very last line.
                   9808:        Before that, they may also include various other
                   9809:        <code class="filename">*.mk</code> files if they need to query the
                   9810:        availability of certain features like the type of compiler or
                   9811:        the X11 implementation. Due to the heavy use of preprocessor
                   9812:        directives like <code class="literal">.if</code> and
                   9813:        <code class="literal">.for</code>, the order in which the files are loaded
                   9814:        matters.</p>
                   9815: <p>This section describes at which point the various files
                   9816:        are loaded and gives reasons for that order.</p>
1.41      asau     9817: <div class="sect2">
1.1       dsieger  9818: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   9819: <a name="infr.order.prefs"></a>26.6.1. The order in <code class="filename">bsd.prefs.mk</code>
1.1       dsieger  9820: </h3></div></div></div>
                   9821: <p>The very first action in <code class="filename">bsd.prefs.mk</code>
                   9822:        is to define some essential variables like
                   9823:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code> and
                   9824:        <code class="varname">MACHINE_ARCH</code>.</p>
                   9825: <p>Then, the user settings are loaded from the file specified
1.10      hubertf  9826:        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   9827:        After that, those variables
1.1       dsieger  9828:        that have not been overridden by the user are loaded from
                   9829:        <code class="filename">mk/defaults/mk.conf</code>.</p>
                   9830: <p>After the user settings, the system settings and platform
                   9831:        settings are loaded, which may override the user
                   9832:        settings.</p>
                   9833: <p>Then, the tool definitions are loaded. The tool wrappers
                   9834:        are not yet in effect. This only happens when building a
                   9835:        package, so the proper variables must be used instead of the
                   9836:        direct tool names.</p>
                   9837: <p>As the last steps, some essential variables from the
                   9838:        wrapper and the package system flavor are loaded, as well as the
                   9839:        variables that have been cached in earlier phases of a package
                   9840:        build.</p>
                   9841: </div>
1.41      asau     9842: <div class="sect2">
1.1       dsieger  9843: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   9844: <a name="infr.order.pkg"></a>26.6.2. The order in <code class="filename">bsd.pkg.mk</code>
1.1       dsieger  9845: </h3></div></div></div>
                   9846: <p>First, <code class="filename">bsd.prefs.mk</code> is loaded.</p>
                   9847: <p>Then, the various <code class="filename">*-vars.mk</code> files are
                   9848:        loaded, which fill default values for those variables that have
                   9849:        not been defined by the package. These variables may later
                   9850:        be used even in unrelated files.</p>
                   9851: <p>Then, the file <code class="filename">bsd.pkg.error.mk</code>
                   9852:        provides the target <code class="literal">error-check</code> that is added
                   9853:        as a special dependency to all other targets that use
                   9854:        <code class="varname">DELAYED_ERROR_MSG</code> or
                   9855:        <code class="varname">DELAYED_WARNING_MSG</code>.</p>
                   9856: <p>Then, the package-specific hacks from
                   9857:        <code class="filename">hacks.mk</code> are included.</p>
                   9858: <p>Then, various other files follow. Most of them don't have
                   9859:        any dependencies on what they need to have included before or
                   9860:        after them, though some do.</p>
                   9861: <p>The code to check <code class="varname">PKG_FAIL_REASON</code> and
                   9862:        <code class="varname">PKG_SKIP_REASON</code> is then executed, which
                   9863:        restricts the use of these variables to all the files that have
                   9864:        been included before. Appearances in later files will be
                   9865:        silently ignored.</p>
                   9866: <p>Then, the files for the main targets are included, in the
                   9867:        order of later execution, though the actual order should not
                   9868:        matter.</p>
                   9869: <p>At last, some more files are included that don't set any
                   9870:        interesting variables but rather just define make targets to be
                   9871:        executed.</p>
                   9872: </div>
                   9873: </div>
                   9874: </div>
1.41      asau     9875: <div class="chapter">
1.1       dsieger  9876: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   9877: <a name="regression"></a>Chapter 27. Regression tests</h2></div></div></div>
1.1       dsieger  9878: <div class="toc">
                   9879: <p><b>Table of Contents</b></p>
1.100     leot     9880: <dl class="toc">
1.154     rillig   9881: <dt><span class="sect1"><a href="#regression.run">27.1. Running the regression tests</a></span></dt>
                   9882: <dt><span class="sect1"><a href="#regression.new">27.2. Adding a new regression test</a></span></dt>
1.1       dsieger  9883: <dd><dl>
1.154     rillig   9884: <dt><span class="sect2"><a href="#regression.fun.override">27.2.1. Overridable functions</a></span></dt>
                   9885: <dt><span class="sect2"><a href="#regression.fun.helper">27.2.2. Helper functions</a></span></dt>
1.1       dsieger  9886: </dl></dd>
                   9887: </dl>
                   9888: </div>
                   9889: <p>The pkgsrc infrastructure consists of a large codebase,
                   9890:        and there are many corners where every little bit of a file is
                   9891:        well thought out, making pkgsrc likely to fail as soon as
                   9892:        anything is changed near those parts. To prevent most changes
                   9893:        from breaking anything, a suite of regression tests should go
                   9894:        along with every important part of the pkgsrc infrastructure.
                   9895:        This chapter describes how regression tests work in pkgsrc and
                   9896:        how you can add new tests.</p>
1.41      asau     9897: <div class="sect1">
1.1       dsieger  9898: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   9899: <a name="regression.run"></a>27.1. Running the regression tests</h2></div></div></div>
1.137     leot     9900: <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  9901:        provides the <span class="command"><strong>pkg_regress</strong></span> command. Then you
1.1       dsieger  9902:        can simply run that command, which will run all tests in the
                   9903:        <code class="filename">regress</code> category.</p>
                   9904: </div>
1.41      asau     9905: <div class="sect1">
1.1       dsieger  9906: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   9907: <a name="regression.new"></a>27.2. Adding a new regression test</h2></div></div></div>
1.1       dsieger  9908: <p>Every directory in the <code class="filename">regress</code>
                   9909:        category that contains a file called <code class="filename">spec</code>
                   9910:        is considered a regression test. This file is a shell program
1.10      hubertf  9911:        that is included by the <span class="command"><strong>pkg_regress</strong></span> command.
1.1       dsieger  9912:        The following functions can be overridden to suit your
                   9913:        needs.</p>
1.41      asau     9914: <div class="sect2">
1.1       dsieger  9915: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   9916: <a name="regression.fun.override"></a>27.2.1. Overridable functions</h3></div></div></div>
1.108     rillig   9917: <p>These functions do not take any parameters. Although they
                   9918:        are called in <span class="quote">&#8220;<span class="quote">set -e</span>&#8221;</span> mode, they don't stop at the
                   9919:        first failing command. See <a class="ulink" href="http://stackoverflow.com/q/4072984" target="_top">this StackOverflow
                   9920:        question</a> for details.</p>
1.41      asau     9921: <div class="variablelist"><dl class="variablelist">
1.108     rillig   9922: <dt><span class="term"><code class="varname">do_setup</code></span></dt>
1.1       dsieger  9923: <dd><p>This function prepares the environment for the
                   9924:        test. By default it does nothing.</p></dd>
1.108     rillig   9925: <dt><span class="term"><code class="varname">do_test</code></span></dt>
                   9926: <dd>
                   9927: <p>This function runs the actual test. By default,
1.1       dsieger  9928:        it calls <code class="varname">TEST_MAKE</code> with the arguments
                   9929:        <code class="varname">MAKEARGS_TEST</code> and writes its output including
                   9930:        error messages into the file
1.108     rillig   9931:        <code class="varname">TEST_OUTFILE</code>.</p>
                   9932: <p>When defining this function, make sure that all output that
                   9933:        needs to be checked is written to the correct output file.
                   9934:        Example:</p>
                   9935: <pre class="programlisting">
                   9936: do_test() {
1.112     rillig   9937:         echo "Example output"
1.108     rillig   9938: } 1&gt;$TEST_OUTFILE 2&gt;&amp;1
                   9939: </pre>
                   9940: </dd>
                   9941: <dt><span class="term"><code class="varname">check_result</code></span></dt>
                   9942: <dd>
                   9943: <p>This function is run after the test and is
1.1       dsieger  9944:        typically used to compare the actual output from the one that is
                   9945:        expected. It can make use of the various helper functions from
1.108     rillig   9946:        the next section. Example:</p>
                   9947: <pre class="programlisting">
                   9948: check_result() {
1.112     rillig   9949:         exit_status 0
                   9950:         output_require "Example"
                   9951:         output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
                   9952:         output_prohibit "no such file or directory"
1.108     rillig   9953: }
                   9954: </pre>
                   9955: </dd>
                   9956: <dt><span class="term"><code class="varname">do_cleanup</code></span></dt>
1.1       dsieger  9957: <dd><p>This function cleans everything up after the
                   9958:        test has been run. By default it does nothing.</p></dd>
                   9959: </dl></div>
                   9960: </div>
1.41      asau     9961: <div class="sect2">
1.1       dsieger  9962: <div class="titlepage"><div><div><h3 class="title">
1.154     rillig   9963: <a name="regression.fun.helper"></a>27.2.2. Helper functions</h3></div></div></div>
1.41      asau     9964: <div class="variablelist"><dl class="variablelist">
1.108     rillig   9965: <dt><span class="term"><code class="varname">exit_status expected</code></span></dt>
1.1       dsieger  9966: <dd><p>This function compares the exitcode of the
1.108     rillig   9967:        <span class="command"><strong>do_test</strong></span> function with its first parameter.
1.1       dsieger  9968:        If they differ, the test will fail.</p></dd>
1.108     rillig   9969: <dt><span class="term"><code class="varname">output_require regex...</code></span></dt>
                   9970: <dd>
                   9971: <p>This function checks for each of its parameters
                   9972:        if the output from <span class="command"><strong>do_test</strong></span> matches the
1.1       dsieger  9973:        extended regular expression. If it does not, the test will
1.108     rillig   9974:        fail. Example:</p>
                   9975: <pre class="programlisting">
                   9976: output_require "looks fine"
                   9977: output_require "^[[:alpha:]+[[:space:]][[:alpha:]]{6}$"
                   9978: </pre>
                   9979: </dd>
1.1       dsieger  9980: <dt><span class="term"><code class="varname">output_prohibit(regex...)</code></span></dt>
                   9981: <dd><p>This function checks for each of its parameters
1.10      hubertf  9982:        if the output from <span class="command"><strong>do_test()</strong></span> does
1.1       dsieger  9983:        <span class="emphasis"><em>not</em></span> match the extended regular expression.
                   9984:        If any of the regular expressions matches, the test will
                   9985:        fail.</p></dd>
                   9986: </dl></div>
                   9987: </div>
                   9988: </div>
                   9989: </div>
1.41      asau     9990: <div class="chapter">
1.1       dsieger  9991: <div class="titlepage"><div><div><h2 class="title">
1.154     rillig   9992: <a name="porting"></a>Chapter 28. Porting pkgsrc</h2></div></div></div>
1.1       dsieger  9993: <div class="toc">
                   9994: <p><b>Table of Contents</b></p>
1.154     rillig   9995: <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  9996: </div>
                   9997: <p>The pkgsrc system has already been ported to many
                   9998:        operating systems, hardware architectures and compilers. This
                   9999:        chapter explains the necessary steps to make pkgsrc even more
                   10000:        portable.</p>
1.41      asau     10001: <div class="sect1">
1.1       dsieger  10002: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   10003: <a name="porting.opsys"></a>28.1. Porting pkgsrc to a new operating system</h2></div></div></div>
1.1       dsieger  10004: <p>To port pkgsrc to a new operating system (called
                   10005:        <code class="literal">MyOS</code> in this example), you need to touch the
                   10006:        following files:</p>
1.41      asau     10007: <div class="variablelist"><dl class="variablelist">
1.1       dsieger  10008: <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>
                   10009: <dd><p>This file contains some basic definitions, for
                   10010:        example the name of the C
                   10011:        compiler.</p></dd>
                   10012: <dt><span class="term"><code class="filename">mk/bsd.prefs.mk</code></span></dt>
                   10013: <dd><p>Insert code that defines the variables
                   10014:        <code class="varname">OPSYS</code>, <code class="varname">OS_VERSION</code>,
                   10015:        <code class="varname">LOWER_OS_VERSION</code>,
                   10016:        <code class="varname">LOWER_VENDOR</code>,
                   10017:        <code class="varname">MACHINE_ARCH</code>, <code class="varname">OBJECT_FMT</code>,
                   10018:        <code class="varname">APPEND_ELF</code>, and the other variables that
                   10019:        appear in this file.</p></dd>
                   10020: <dt><span class="term"><code class="filename">mk/platform/<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
                   10021: <dd><p>This file contains the platform-specific
                   10022:        definitions that are used by pkgsrc. Start by copying one of the
                   10023:        other files and edit it to your
                   10024:        needs.</p></dd>
                   10025: <dt><span class="term"><code class="filename">mk/tools/tools.<em class="replaceable"><code>MyOS</code></em>.mk</code></span></dt>
                   10026: <dd><p>This file defines the paths to all the tools
                   10027:        that are needed by one or the other package in pkgsrc, as well
                   10028:        as by pkgsrc itself. Find out where these tools are on your
                   10029:        platform and add them.</p></dd>
                   10030: </dl></div>
                   10031: <p>Now, you should be able to build some basic packages, like
1.137     leot     10032:        <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  10033: </div>
                   10034: </div>
                   10035: </div>
1.41      asau     10036: <div class="appendix">
                   10037: <div class="titlepage"><div><div><h1 class="title">
                   10038: <a name="examples"></a>Appendix A. A simple example package: bison</h1></div></div></div>
1.1       dsieger  10039: <div class="toc">
                   10040: <p><b>Table of Contents</b></p>
1.100     leot     10041: <dl class="toc">
1.1       dsieger  10042: <dt><span class="sect1"><a href="#example-files">A.1. files</a></span></dt>
                   10043: <dd><dl>
                   10044: <dt><span class="sect2"><a href="#example-Makefile">A.1.1. Makefile</a></span></dt>
                   10045: <dt><span class="sect2"><a href="#example-descr">A.1.2. DESCR</a></span></dt>
                   10046: <dt><span class="sect2"><a href="#example-plist">A.1.3. PLIST</a></span></dt>
1.23      wiz      10047: <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  10048: </dl></dd>
                   10049: <dt><span class="sect1"><a href="#steps-for-b-i-p">A.2. Steps for building, installing, packaging</a></span></dt>
                   10050: </dl>
                   10051: </div>
                   10052: <p>We checked to find a piece of software that wasn't in the packages
                   10053:     collection, and picked GNU bison. Quite why someone would want to have
1.10      hubertf  10054:     <span class="command"><strong>bison</strong></span> when Berkeley <span class="command"><strong>yacc</strong></span> is already
1.1       dsieger  10055:     present in the tree is beyond us, but it's useful for the purposes of
                   10056:     this exercise.</p>
1.41      asau     10057: <div class="sect1">
1.1       dsieger  10058: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10059: <a name="example-files"></a>A.1. files</h2></div></div></div>
1.41      asau     10060: <div class="sect2">
1.1       dsieger  10061: <div class="titlepage"><div><div><h3 class="title">
                   10062: <a name="example-Makefile"></a>A.1.1. Makefile</h3></div></div></div>
                   10063: <pre class="programlisting">
                   10064: # $NetBSD$
                   10065: #
                   10066: 
                   10067: DISTNAME=       bison-1.25
                   10068: CATEGORIES=     devel
                   10069: MASTER_SITES=   ${MASTER_SITE_GNU}
                   10070: 
1.29      dholland 10071: MAINTAINER=     pkgsrc-users@NetBSD.org
1.1       dsieger  10072: HOMEPAGE=       http://www.gnu.org/software/bison/bison.html
                   10073: COMMENT=        GNU yacc clone
                   10074: 
                   10075: GNU_CONFIGURE=  yes
1.46      wiz      10076: INFO_FILES=     yes
1.1       dsieger  10077: 
                   10078: .include "../../mk/bsd.pkg.mk"
                   10079: </pre>
                   10080: </div>
1.41      asau     10081: <div class="sect2">
1.1       dsieger  10082: <div class="titlepage"><div><div><h3 class="title">
                   10083: <a name="example-descr"></a>A.1.2. DESCR</h3></div></div></div>
                   10084: <pre class="programlisting">
                   10085: GNU version of yacc.  Can make re-entrant parsers, and numerous other
1.157     leot     10086: improvements.  Why you would want this when Berkeley <a class="citerefentry" href="http://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  10087: of the NetBSD source tree is beyond me.
                   10088: </pre>
                   10089: </div>
1.41      asau     10090: <div class="sect2">
1.1       dsieger  10091: <div class="titlepage"><div><div><h3 class="title">
                   10092: <a name="example-plist"></a>A.1.3. PLIST</h3></div></div></div>
                   10093: <pre class="programlisting">
                   10094: @comment $NetBSD$
                   10095: bin/bison
                   10096: man/man1/bison.1.gz
                   10097: share/bison.simple
                   10098: share/bison.hairy
                   10099: </pre>
                   10100: </div>
1.41      asau     10101: <div class="sect2">
1.1       dsieger  10102: <div class="titlepage"><div><div><h3 class="title">
1.10      hubertf  10103: <a name="checking-package-with-pkglint"></a>A.1.4. Checking a package with <span class="command"><strong>pkglint</strong></span>
1.1       dsieger  10104: </h3></div></div></div>
                   10105: <p>The NetBSD package system comes with
1.137     leot     10106:         <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  10107:        which helps to check the contents of these
                   10108:        files. After installation it is quite easy to use, just change to the
                   10109:        directory of the package you wish to examine and execute
1.10      hubertf  10110:        <span class="command"><strong>pkglint</strong></span>:</p>
1.1       dsieger  10111: <pre class="screen"><code class="prompt">$</code> <strong class="userinput"><code>pkglint</code></strong>
                   10112: looks fine.</pre>
                   10113: <p>Depending on the supplied command line arguments (see pkglint(1)),
1.10      hubertf  10114:        more checks will be performed. Use e.g. <span class="command"><strong>pkglint -Call
1.1       dsieger  10115:        -Wall</strong></span> for a very thorough check.</p>
                   10116: </div>
                   10117: </div>
1.41      asau     10118: <div class="sect1">
1.1       dsieger  10119: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10120: <a name="steps-for-b-i-p"></a>A.2. Steps for building, installing, packaging</h2></div></div></div>
                   10121: <p>Create the directory where the package lives,
                   10122:       plus any auxiliary directories:</p>
                   10123: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>cd /usr/pkgsrc/lang</code></strong>
                   10124: <code class="prompt">#</code> <strong class="userinput"><code>mkdir bison</code></strong>
                   10125: <code class="prompt">#</code> <strong class="userinput"><code>cd bison</code></strong>
                   10126: <code class="prompt">#</code> <strong class="userinput"><code>mkdir patches</code></strong></pre>
                   10127: <p>Create <code class="filename">Makefile</code>, <code class="filename">DESCR</code> and
1.154     rillig   10128:       <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  10129:       then continue with fetching the distfile:</p>
                   10130: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make fetch</code></strong>
                   10131: &gt;&gt; bison-1.25.tar.gz doesn't seem to exist on this system.
                   10132: &gt;&gt; Attempting to fetch from ftp://prep.ai.mit.edu/pub/gnu//.
                   10133: Requesting ftp://prep.ai.mit.edu/pub/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   10134: ftp: Error retrieving file: 500 Internal error
                   10135: 
                   10136: &gt;&gt; Attempting to fetch from ftp://wuarchive.wustl.edu/systems/gnu//.
                   10137: Requesting ftp://wuarchive.wustl.edu/systems/gnu//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   10138: ftp: Error retrieving file: 500 Internal error
                   10139: 
                   10140: &gt;&gt; Attempting to fetch from ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//.
                   10141: Requesting ftp://ftp.freebsd.org/pub/FreeBSD/distfiles//bison-1.25.tar.gz (via ftp://orpheus.amdahl.com:80/)
                   10142: Successfully retrieved file.</pre>
                   10143: <p>Generate the checksum of the distfile into
                   10144:       <code class="filename">distinfo</code>:</p>
                   10145: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make makedistinfo</code></strong></pre>
                   10146: <p>Now compile:</p>
                   10147: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
                   10148: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10149: ===&gt;  Extracting for bison-1.25
                   10150: ===&gt;  Patching for bison-1.25
                   10151: ===&gt;   Ignoring empty patch directory
                   10152: ===&gt;  Configuring for bison-1.25
                   10153: creating cache ./config.cache
                   10154: checking for gcc... cc
                   10155: checking whether we are using GNU C... yes
                   10156: checking for a BSD compatible install... /usr/bin/install -c -o bin -g bin
                   10157: checking how to run the C preprocessor... cc -E
                   10158: checking for minix/config.h... no
                   10159: checking for POSIXized ISC... no
                   10160: checking whether cross-compiling... no
                   10161: checking for ANSI C header files... yes
                   10162: checking for string.h... yes
                   10163: checking for stdlib.h... yes
                   10164: checking for memory.h... yes
                   10165: checking for working const... yes
                   10166: checking for working alloca.h... no
                   10167: checking for alloca... yes
                   10168: checking for strerror... yes
                   10169: updating cache ./config.cache
                   10170: creating ./config.status
                   10171: creating Makefile
                   10172: ===&gt;  Building for bison-1.25
                   10173: 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
                   10174: 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
                   10175: 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
                   10176: 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
                   10177: 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
                   10178: 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
                   10179: 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
                   10180: 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
                   10181: 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
                   10182: 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
                   10183: 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
                   10184: 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
                   10185: 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
                   10186: 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
                   10187: 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
                   10188: 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
                   10189: 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
                   10190: 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
                   10191: 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
                   10192: 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
                   10193: 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
                   10194: 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
                   10195: ./files.c:240: warning: mktemp() possibly used unsafely, consider using mkstemp()
                   10196: rm -f bison.s1
                   10197: sed -e "/^#line/ s|bison|/usr/pkg/share/bison|" &lt; ./bison.simple &gt; bison.s1</pre>
                   10198: <p>Everything seems OK, so install the files:</p>
                   10199: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   10200: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10201: ===&gt;  Installing for bison-1.25
                   10202: sh ./mkinstalldirs /usr/pkg/bin /usr/pkg/share  /usr/pkg/info /usr/pkg/man/man1
                   10203: rm -f /usr/pkg/bin/bison
                   10204: cd /usr/pkg/share; rm -f bison.simple bison.hairy
                   10205: rm -f /usr/pkg/man/man1/bison.1 /usr/pkg/info/bison.info*
                   10206: install -c  -o bin -g bin -m 555 bison /usr/pkg/bin/bison
                   10207: /usr/bin/install -c -o bin -g bin -m 644 bison.s1 /usr/pkg/share/bison.simple
                   10208: /usr/bin/install -c -o bin -g bin -m 644 ./bison.hairy /usr/pkg/share/bison.hairy
                   10209: cd .; for f in bison.info*;  do /usr/bin/install -c -o bin -g bin -m 644 $f /usr/pkg/info/$f; done
                   10210: /usr/bin/install -c -o bin -g bin -m 644 ./bison.1 /usr/pkg/man/man1/bison.1
                   10211: ===&gt;  Registering installation for bison-1.25</pre>
                   10212: <p>You can now use bison, and also - if you decide so - remove it with
1.10      hubertf  10213:       <span class="command"><strong>pkg_delete bison</strong></span>. Should you decide that you want a
1.1       dsieger  10214:       binary package, do this now:</p>
                   10215: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
                   10216: &gt;&gt; Checksum OK for bison-1.25.tar.gz.
                   10217: ===&gt;  Building package for bison-1.25
                   10218: Creating package bison-1.25.tgz
                   10219: Registering depends:.
                   10220: Creating gzip'd tar ball in '/u/pkgsrc/lang/bison/bison-1.25.tgz'</pre>
                   10221: <p>Now that you don't need the source and object files
                   10222:       any more, clean up:</p>
                   10223: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make clean</code></strong>
                   10224: ===&gt;  Cleaning for bison-1.25</pre>
                   10225: </div>
                   10226: </div>
1.41      asau     10227: <div class="appendix">
                   10228: <div class="titlepage"><div><div><h1 class="title">
                   10229: <a name="logs"></a>Appendix B. Build logs</h1></div></div></div>
1.1       dsieger  10230: <div class="toc">
                   10231: <p><b>Table of Contents</b></p>
1.100     leot     10232: <dl class="toc">
1.1       dsieger  10233: <dt><span class="sect1"><a href="#logs.building">B.1. Building figlet</a></span></dt>
                   10234: <dt><span class="sect1"><a href="#logs.package">B.2. Packaging figlet</a></span></dt>
                   10235: </dl>
                   10236: </div>
1.41      asau     10237: <div class="sect1">
1.1       dsieger  10238: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10239: <a name="logs.building"></a>B.1. Building figlet</h2></div></div></div>
                   10240: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make</code></strong>
                   10241: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10242: =&gt; figlet221.tar.gz doesn't seem to exist on this system.
                   10243: =&gt; Attempting to fetch figlet221.tar.gz from ftp://ftp.figlet.org/pub/figlet/program/unix/.
                   10244: =&gt; [172219 bytes]
                   10245: Connected to ftp.plig.net.
                   10246: 220 ftp.plig.org NcFTPd Server (licensed copy) ready.
                   10247: 331 Guest login ok, send your complete e-mail address as password.
                   10248: 230-You are user #5 of 500 simultaneous users allowed.
                   10249: 230-
                   10250: 230-  ___ _             _ _
                   10251: 230- |  _| |_ ___   ___| |_|___   ___ ___ ___
                   10252: 230- |  _|  _| . |_| . | | | . |_| . |  _| . |
                   10253: 230- |_| |_| |  _|_|  _|_|_|_  |_|___|_| |_  |
                   10254: 230-         |_|   |_|     |___|         |___|
                   10255: 230-
                   10256: 230-** Welcome to ftp.plig.org **
                   10257: 230-
                   10258: 230-Please note that all transfers from this FTP site are logged. If you
                   10259: 230-do not like this, please disconnect now.
                   10260: 230-
1.18      snj      10261: 230-This archive is available via
1.1       dsieger  10262: 230-
                   10263: 230-HTTP:  http://ftp.plig.org/
                   10264: 230-FTP:   ftp://ftp.plig.org/     (max 500 connections)
                   10265: 230-RSYNC: rsync://ftp.plig.org/   (max  30 connections)
                   10266: 230-
                   10267: 230-Please email comments, bug reports and requests for packages to be
                   10268: 230-mirrored to ftp-admin@plig.org.
                   10269: 230-
                   10270: 230-
                   10271: 230 Logged in anonymously.
                   10272: Remote system type is UNIX.
                   10273: Using binary mode to transfer files.
                   10274: 200 Type okay.
                   10275: 250 "/pub" is new cwd.
                   10276: 250-"/pub/figlet" is new cwd.
                   10277: 250-
                   10278: 250-Welcome to the figlet archive at ftp.figlet.org
                   10279: 250-
                   10280: 250-   ftp://ftp.figlet.org/pub/figlet/
                   10281: 250-
                   10282: 250-The official FIGlet web page is:
                   10283: 250-   http://www.figlet.org/
                   10284: 250-
                   10285: 250-If you have questions, please mailto:info@figlet.org. If you want to
                   10286: 250-contribute a font or something else, you can email us.
                   10287: 250
                   10288: 250 "/pub/figlet/program" is new cwd.
                   10289: 250 "/pub/figlet/program/unix" is new cwd.
                   10290: local: figlet221.tar.gz remote: figlet221.tar.gz
                   10291: 502 Unimplemented command.
                   10292: 227 Entering Passive Mode (195,40,6,41,246,104)
                   10293: 150 Data connection accepted from 84.128.86.72:65131; transfer starting for figlet221.tar.gz (172219 bytes).
                   10294: 38% |**************                       | 65800      64.16 KB/s    00:01 ETA
                   10295: 226 Transfer completed.
                   10296: 172219 bytes received in 00:02 (75.99 KB/s)
                   10297: 221 Goodbye.
                   10298: =&gt; Checksum OK for figlet221.tar.gz.
                   10299: ===&gt; Extracting for figlet-2.2.1nb2
                   10300: ===&gt; Required installed package ccache-[0-9]*: ccache-2.3nb1 found
                   10301: ===&gt; Patching for figlet-2.2.1nb2
                   10302: ===&gt; Applying pkgsrc patches for figlet-2.2.1nb2
                   10303: ===&gt; Overriding tools for figlet-2.2.1nb2
                   10304: ===&gt; Creating toolchain wrappers for figlet-2.2.1nb2
                   10305: ===&gt; Configuring for figlet-2.2.1nb2
                   10306: ===&gt; Building for figlet-2.2.1nb2
                   10307: gcc -O2 -DDEFAULTFONTDIR=\"/usr/pkg/share/figlet\"  -DDEFAULTFONTFILE=\"standard.flf\"  figlet.c zipio.c crc.c inflate.c -o figlet
                   10308: chmod a+x figlet
                   10309: gcc -O2 -o chkfont chkfont.c
                   10310: =&gt; Unwrapping files-to-be-installed.
                   10311: <code class="prompt">#</code>
                   10312: <code class="prompt">#</code> <strong class="userinput"><code>make install</code></strong>
                   10313: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10314: ===&gt; Installing for figlet-2.2.1nb2
                   10315: install -d -o root -g wheel -m 755 /usr/pkg/bin
                   10316: install -d -o root -g wheel -m 755 /usr/pkg/man/man6
                   10317: mkdir -p /usr/pkg/share/figlet
                   10318: cp figlet /usr/pkg/bin
                   10319: cp chkfont /usr/pkg/bin
                   10320: chmod 555 figlist showfigfonts
                   10321: cp figlist /usr/pkg/bin
                   10322: cp showfigfonts /usr/pkg/bin
                   10323: cp fonts/*.flf /usr/pkg/share/figlet
                   10324: cp fonts/*.flc /usr/pkg/share/figlet
                   10325: cp figlet.6 /usr/pkg/man/man6
                   10326: ===&gt; Registering installation for figlet-2.2.1nb2
                   10327: <code class="prompt">#</code></pre>
                   10328: </div>
1.41      asau     10329: <div class="sect1">
1.1       dsieger  10330: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
                   10331: <a name="logs.package"></a>B.2. Packaging figlet</h2></div></div></div>
                   10332: <pre class="screen"><code class="prompt">#</code> <strong class="userinput"><code>make package</code></strong>
                   10333: ===&gt; Checking for vulnerabilities in figlet-2.2.1nb2
                   10334: ===&gt; Packaging figlet-2.2.1nb2
                   10335: ===&gt; Building binary package for figlet-2.2.1nb2
                   10336: Creating package /home/cvs/pkgsrc/packages/i386/All/figlet-2.2.1nb2.tgz
                   10337: Using SrcDir value of /usr/pkg
                   10338: Registering depends:.
                   10339: <code class="prompt">#</code></pre>
                   10340: </div>
                   10341: </div>
1.41      asau     10342: <div class="appendix">
                   10343: <div class="titlepage"><div><div><h1 class="title">
                   10344: <a name="ftp-layout"></a>Appendix C. Directory layout of the pkgsrc FTP server</h1></div></div></div>
1.1       dsieger  10345: <div class="toc">
                   10346: <p><b>Table of Contents</b></p>
1.100     leot     10347: <dl class="toc">
1.23      wiz      10348: <dt><span class="sect1"><a href="#ftp-distfiles">C.1. <code class="filename">distfiles</code>: The distributed source files</a></span></dt>
                   10349: <dt><span class="sect1"><a href="#ftp-misc">C.2. <code class="filename">misc</code>: Miscellaneous things</a></span></dt>
                   10350: <dt><span class="sect1"><a href="#ftp-packages">C.3. <code class="filename">packages</code>: Binary packages</a></span></dt>
                   10351: <dt><span class="sect1"><a href="#ftp-reports">C.4. <code class="filename">reports</code>: Bulk build reports</a></span></dt>
                   10352: <dt><span class="sect1"><a href="#ftp-source">C.5. <code class="filename">current</code>,
1.148     leot     10353: <code class="filename">stable</code>,
1.23      wiz      10354: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1       dsieger  10355: source packages</a></span></dt>
                   10356: </dl>
                   10357: </div>
                   10358: <p>As in other big projects, the directory layout of pkgsrc
                   10359:        is quite complex for newbies. This chapter explains where you
                   10360:        find things on the FTP server. The base directory on
1.10      hubertf  10361:        <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  10362:        On other servers it may be different, but inside this directory,
                   10363:        everything should look the same, no matter on which server you
                   10364:        are. This directory contains some subdirectories, which are
                   10365:        explained below.</p>
1.41      asau     10366: <div class="sect1">
1.1       dsieger  10367: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22      jakllsch 10368: <a name="ftp-distfiles"></a>C.1. <code class="filename">distfiles</code>: The distributed source files</h2></div></div></div>
1.1       dsieger  10369: <p>The directory <code class="filename">distfiles</code> contains lots
                   10370:        of archive files from all pkgsrc packages, which are mirrored
                   10371:        here. The subdirectories are called after their package names
                   10372:        and are used when the distributed files have names that don't
                   10373:        explicitly contain a version number or are otherwise too generic
                   10374:        (for example <code class="filename">release.tar.gz</code>).</p>
                   10375: </div>
1.41      asau     10376: <div class="sect1">
1.1       dsieger  10377: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22      jakllsch 10378: <a name="ftp-misc"></a>C.2. <code class="filename">misc</code>: Miscellaneous things</h2></div></div></div>
1.1       dsieger  10379: <p>This directory contains things that individual pkgsrc
                   10380:        developers find worth publishing.</p>
                   10381: </div>
1.41      asau     10382: <div class="sect1">
1.1       dsieger  10383: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22      jakllsch 10384: <a name="ftp-packages"></a>C.3. <code class="filename">packages</code>: Binary packages</h2></div></div></div>
1.3       rillig   10385: <p>This directory contains binary packages for the various
                   10386:        platforms that are supported by pkgsrc.
                   10387:        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     10388: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      10389: <li class="listitem"><p><code class="varname">OPSYS</code> is the name of the
1.9       rillig   10390:        operating system for which the packages have been built. The
1.10      hubertf  10391:        name is taken from the output of the <span class="command"><strong>uname</strong></span>
1.9       rillig   10392:        command, so it may differ from the one you are used to
                   10393:        hear.</p></li>
1.23      wiz      10394: <li class="listitem"><p><code class="varname">ARCH</code> is the hardware
1.8       rillig   10395:        architecture of the platform for which the packages have been
1.10      hubertf  10396:        built. It also includes the <code class="varname">ABI</code> (Application
                   10397:        Binary Interface) for platforms that have several of
                   10398:        them.</p></li>
1.23      wiz      10399: <li class="listitem"><p><code class="varname">OSVERSION</code> is the version of
1.8       rillig   10400:        the operating system. For version numbers that change often (for
                   10401:        example NetBSD-current), the often-changing part should be
                   10402:        replaced with an <code class="literal">x</code>, for example
                   10403:        <code class="literal">4.99.x</code>.</p></li>
1.23      wiz      10404: <li class="listitem"><p><code class="varname">TAG</code> is either
1.22      jakllsch 10405:        <code class="literal">20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
1.8       rillig   10406:        for a stable branch, or <code class="literal">head</code> for packages
                   10407:        built from the HEAD branch. The latter should only be used when
                   10408:        the packages are updated on a regular basis. Otherwise the date
                   10409:        from checking out pkgsrc should be appended, for example
                   10410:        <code class="literal">head_20071015</code>.</p></li>
1.3       rillig   10411: </ul></div>
                   10412: <p>The rationale for exactly this scheme is that the pkgsrc users looking for binary packages
                   10413:        can quickly click through the directories on the
                   10414:        server and find the best binary packages for their machines. Since they
                   10415:        usually know the operating system and the hardware architecture, OPSYS
                   10416:        and ARCH are placed first. After these choices, they can select the
                   10417:        best combination of OSVERSION and TAG together, since it is usually the
                   10418:        case that packages stay compatible between different version of the
                   10419:        operating system.</p>
                   10420: <p>In each of these directories, there is a
                   10421:        whole binary packages collection for a specific platform. It has a directory called
1.1       dsieger  10422:        <code class="filename">All</code> which contains all binary packages.
                   10423:        Besides that, there are various category directories that
                   10424:        contain symbolic links to the real binary packages.</p>
                   10425: </div>
1.41      asau     10426: <div class="sect1">
1.1       dsieger  10427: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22      jakllsch 10428: <a name="ftp-reports"></a>C.4. <code class="filename">reports</code>: Bulk build reports</h2></div></div></div>
1.8       rillig   10429: <p>Here are the reports from bulk builds, for those who want
                   10430:        to fix packages that didn't build on some of the platforms. The
1.23      wiz      10431:        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   10432: </div>
1.41      asau     10433: <div class="sect1">
1.8       rillig   10434: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.22      jakllsch 10435: <a name="ftp-source"></a>C.5. <code class="filename">current</code>,
1.148     leot     10436: <code class="filename">stable</code>,
1.22      jakllsch 10437: <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>:
1.1       dsieger  10438: source packages</h2></div></div></div>
1.23      wiz      10439: <p>These directories contain the <span class="quote">&#8220;<span class="quote">real</span>&#8221;</span> pkgsrc,
1.1       dsieger  10440:        that is the files that define how to create binary packages from
                   10441:        source archives.</p>
1.149     leot     10442: <p>Each of the <code class="filename">current</code>,
                   10443:        <code class="filename">stable</code> and
                   10444:        <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
                   10445:        directories share the same structure.  They each contain a
                   10446:        <code class="filename">pkgsrc</code> directory and
                   10447:        <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> file.</p>
1.1       dsieger  10448: <p>The directory <code class="filename">pkgsrc</code> contains a
                   10449:        snapshot of the CVS repository, which is updated regularly. The
1.149     leot     10450:        file <code class="filename">pkgsrc.tar.{bz,gz,xz}</code> contains the same
                   10451:        as the directory, ready to be downloaded as a whole.</p>
                   10452: <p>The <code class="filename">current</code> directory contains files
                   10453:        related to the HEAD branch of the CVS repository.
                   10454:        In this directory there is an additional file called
                   10455:        <code class="filename">pkgsrc-readmes.tar.{bz,gz,xz}</code> that contains
                   10456:        all pkgsrc <code class="filename">README</code>s with information about
                   10457:        categories and packages.
                   10458:        </p>
                   10459: <p>The <code class="filename">stable</code> directory is a symlink to
                   10460:        the latest 
                   10461:        <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
                   10462:        </p>
                   10463: <p>The
                   10464:        <code class="filename">pkgsrc-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>.
                   10465:        directories contain files related to the 
                   10466:        <code class="filename">-20<em class="replaceable"><code>xx</code></em>Q<em class="replaceable"><code>y</code></em></code>
                   10467:        stable branch of the CVS repository. In these directories there is
                   10468:        an additional file called
                   10469:        <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  10470:        which contains the state of pkgsrc when it was branched.</p>
                   10471: </div>
                   10472: </div>
1.41      asau     10473: <div class="appendix">
                   10474: <div class="titlepage"><div><div><h1 class="title">
1.154     rillig   10475: <a name="help-topics"></a>Appendix D. Help topics</h1></div></div></div>
                   10476: <p>
                   10477:        The following list contains all help topics that are available
                   10478:        when running <span class="command"><strong>bmake help topic=:index</strong></span>.
                   10479: </p>
1.156     leot     10480: <table border="0" summary="Simple list" class="simplelist">
                   10481: <tr>
                   10482: <td>#!</td>
                   10483: <td>-lintl</td>
                   10484: </tr>
                   10485: <tr>
                   10486: <td>64bit</td>
                   10487: <td>ABI</td>
                   10488: </tr>
                   10489: <tr>
                   10490: <td>ACCEPTABLE_LICENSES</td>
                   10491: <td>ACROREAD_FONTPATH</td>
                   10492: </tr>
                   10493: <tr>
                   10494: <td>ADDITIONAL</td>
                   10495: <td>AFAIK</td>
                   10496: </tr>
                   10497: <tr>
                   10498: <td>AIX</td>
                   10499: <td>ALLOW_VULNERABLE_PACKAGES</td>
                   10500: </tr>
                   10501: <tr>
                   10502: <td>ALL_ENV</td>
1.160   ! brook    10503: <td>ALTERNATIVES_SRC</td>
1.159     rillig   10504: </tr>
                   10505: <tr>
                   10506: <td>AMANDA_TMP</td>
1.160   ! brook    10507: <td>AMANDA_USER</td>
1.156     leot     10508: </tr>
                   10509: <tr>
1.159     rillig   10510: <td>AMANDA_VAR</td>
1.160   ! brook    10511: <td>APACHE_GROUP</td>
1.156     leot     10512: </tr>
                   10513: <tr>
1.159     rillig   10514: <td>APACHE_MODULE_NAME</td>
1.160   ! brook    10515: <td>APACHE_MODULE_SRC</td>
1.156     leot     10516: </tr>
                   10517: <tr>
1.159     rillig   10518: <td>APACHE_MODULE_SRCDIR</td>
1.160   ! brook    10519: <td>APACHE_PKG_PREFIX</td>
1.156     leot     10520: </tr>
                   10521: <tr>
1.159     rillig   10522: <td>APACHE_SUEXEC_CONFIGURE_ARGS</td>
1.160   ! brook    10523: <td>APACHE_SUEXEC_DOCROOT</td>
1.156     leot     10524: </tr>
                   10525: <tr>
1.159     rillig   10526: <td>APACHE_USER</td>
1.160   ! brook    10527: <td>APPEND_ABI</td>
1.156     leot     10528: </tr>
                   10529: <tr>
1.159     rillig   10530: <td>APPEND_ELF</td>
1.160   ! brook    10531: <td>ARLA_CACHE</td>
1.156     leot     10532: </tr>
                   10533: <tr>
1.159     rillig   10534: <td>AUDIT_PACKAGES_FLAGS</td>
1.160   ! brook    10535: <td>AUTOCONF_REQD</td>
1.156     leot     10536: </tr>
                   10537: <tr>
1.159     rillig   10538: <td>AUTOMAKE_OVERRIDE</td>
1.160   ! brook    10539: <td>AUTOMAKE_REQD</td>
1.156     leot     10540: </tr>
                   10541: <tr>
1.159     rillig   10542: <td>AUTO_MKDIRS</td>
1.160   ! brook    10543: <td>BDB185_DEFAULT</td>
1.156     leot     10544: </tr>
                   10545: <tr>
1.159     rillig   10546: <td>BDBBASE</td>
1.160   ! brook    10547: <td>BDB_ACCEPTED</td>
1.156     leot     10548: </tr>
                   10549: <tr>
1.159     rillig   10550: <td>BDB_DEFAULT</td>
1.160   ! brook    10551: <td>BDB_LIBS</td>
1.156     leot     10552: </tr>
                   10553: <tr>
1.159     rillig   10554: <td>BDB_TYPE</td>
1.160   ! brook    10555: <td>BIND_DIR</td>
1.156     leot     10556: </tr>
                   10557: <tr>
1.159     rillig   10558: <td>BIND_GROUP</td>
1.160   ! brook    10559: <td>BIND_USER</td>
1.156     leot     10560: </tr>
                   10561: <tr>
1.159     rillig   10562: <td>BINPKG_SITES</td>
1.160   ! brook    10563: <td>BIN_INSTALL_FLAGS</td>
1.156     leot     10564: </tr>
                   10565: <tr>
1.159     rillig   10566: <td>BISON_PKGDATADIR</td>
1.156     leot     10567: <td>BOOTSTRAP_DEPENDS</td>
                   10568: </tr>
                   10569: <tr>
                   10570: <td>BOOTSTRAP_SETUPTOOLS</td>
                   10571: <td>BROKEN</td>
                   10572: </tr>
                   10573: <tr>
                   10574: <td>BROKEN_EXCEPT_ON_PLATFORM</td>
                   10575: <td>BROKEN_ON_PLATFORM</td>
                   10576: </tr>
                   10577: <tr>
                   10578: <td>BSDSRCDIR</td>
                   10579: <td>BSDXSRCDIR</td>
                   10580: </tr>
                   10581: <tr>
                   10582: <td>BSD_MAKE_ENV</td>
                   10583: <td>BUILDLINK_AUTO_DIRS</td>
                   10584: </tr>
                   10585: <tr>
                   10586: <td>BUILDLINK_AUTO_VARS</td>
                   10587: <td>BUILDLINK_CFLAGS</td>
                   10588: </tr>
                   10589: <tr>
                   10590: <td>BUILDLINK_CONTENTS_FILTER</td>
                   10591: <td>BUILDLINK_CPPFLAGS</td>
                   10592: </tr>
                   10593: <tr>
                   10594: <td>BUILDLINK_DEPMETHOD</td>
                   10595: <td>BUILDLINK_FILES</td>
                   10596: </tr>
                   10597: <tr>
                   10598: <td>BUILDLINK_FILES_CMD</td>
                   10599: <td>BUILDLINK_FNAME_TRANSFORM</td>
                   10600: </tr>
                   10601: <tr>
                   10602: <td>BUILDLINK_LDFLAGS</td>
                   10603: <td>BUILDLINK_LIBS</td>
                   10604: </tr>
                   10605: <tr>
                   10606: <td>BUILDLINK_OPSYS_SUPPORT_PTHREAD</td>
                   10607: <td>BUILDLINK_PKGNAME</td>
                   10608: </tr>
                   10609: <tr>
                   10610: <td>BUILDLINK_PREFIX</td>
                   10611: <td>BUILDLINK_RPATHDIRS</td>
                   10612: </tr>
                   10613: <tr>
                   10614: <td>BUILDLINK_TREE</td>
                   10615: <td>BUILD_DEFS</td>
                   10616: </tr>
                   10617: <tr>
                   10618: <td>BUILD_DEFS_EFFECTS</td>
                   10619: <td>BUILD_DEPENDS</td>
                   10620: </tr>
                   10621: <tr>
                   10622: <td>BUILD_DIRS</td>
                   10623: <td>BUILD_ENV_SHELL</td>
                   10624: </tr>
                   10625: <tr>
                   10626: <td>BUILD_MAKE_CMD</td>
                   10627: <td>BUILD_MAKE_FLAGS</td>
                   10628: </tr>
                   10629: <tr>
                   10630: <td>BUILD_TARGET</td>
                   10631: <td>BUILTIN_FIND_FILES</td>
                   10632: </tr>
                   10633: <tr>
                   10634: <td>BUILTIN_FIND_FILES_VAR</td>
                   10635: <td>BUILTIN_FIND_GREP</td>
                   10636: </tr>
                   10637: <tr>
                   10638: <td>BUILTIN_FIND_HEADERS</td>
                   10639: <td>BUILTIN_FIND_HEADERS_VAR</td>
                   10640: </tr>
                   10641: <tr>
                   10642: <td>BUILTIN_PKG</td>
                   10643: <td>BUILTIN_TEST_CURSES_DEFINES</td>
                   10644: </tr>
                   10645: <tr>
                   10646: <td>BUILTIN_TEST_CURSES_FUNCS</td>
                   10647: <td>BUILTIN_VERSION_SCRIPT</td>
                   10648: </tr>
                   10649: <tr>
                   10650: <td>BUILTIN_X11_TYPE</td>
                   10651: <td>BUILTIN_X11_VERSION</td>
                   10652: </tr>
                   10653: <tr>
                   10654: <td>CACTI_GROUP</td>
                   10655: <td>CACTI_USER</td>
                   10656: </tr>
                   10657: <tr>
                   10658: <td>CANNA_GROUP</td>
                   10659: <td>CANNA_USER</td>
                   10660: </tr>
                   10661: <tr>
                   10662: <td>CAT</td>
                   10663: <td>CCACHE_BASE</td>
                   10664: </tr>
                   10665: <tr>
                   10666: <td>CCACHE_DIR</td>
                   10667: <td>CCACHE_LOGFILE</td>
                   10668: </tr>
                   10669: <tr>
                   10670: <td>CC_VERSION</td>
                   10671: <td>CC_VERSION_STRING</td>
                   10672: </tr>
                   10673: <tr>
                   10674: <td>CDRECORD_CONF</td>
                   10675: <td>CDROM_PKG_URL_DIR</td>
                   10676: </tr>
                   10677: <tr>
                   10678: <td>CDROM_PKG_URL_HOST</td>
1.160   ! brook    10679: <td>CHECK_FAKEHOME</td>
1.159     rillig   10680: </tr>
                   10681: <tr>
                   10682: <td>CHECK_FILES</td>
1.160   ! brook    10683: <td>CHECK_FILES_SKIP</td>
1.156     leot     10684: </tr>
                   10685: <tr>
1.159     rillig   10686: <td>CHECK_FILES_STRICT</td>
1.160   ! brook    10687: <td>CHECK_HEADERS</td>
1.156     leot     10688: </tr>
                   10689: <tr>
1.159     rillig   10690: <td>CHECK_HEADERS_SKIP</td>
1.160   ! brook    10691: <td>CHECK_INTERPRETER</td>
1.156     leot     10692: </tr>
                   10693: <tr>
1.159     rillig   10694: <td>CHECK_INTERPRETER_SKIP</td>
1.160   ! brook    10695: <td>CHECK_PERMS</td>
1.156     leot     10696: </tr>
                   10697: <tr>
1.159     rillig   10698: <td>CHECK_PERMS_AUTOFIX</td>
1.160   ! brook    10699: <td>CHECK_PERMS_SKIP</td>
1.156     leot     10700: </tr>
                   10701: <tr>
1.159     rillig   10702: <td>CHECK_PORTABILITY</td>
1.160   ! brook    10703: <td>CHECK_PORTABILITY_SKIP</td>
1.156     leot     10704: </tr>
                   10705: <tr>
1.159     rillig   10706: <td>CHECK_RELRO</td>
1.160   ! brook    10707: <td>CHECK_RELRO_SKIP</td>
1.156     leot     10708: </tr>
                   10709: <tr>
1.159     rillig   10710: <td>CHECK_RELRO_SUPPORTED</td>
1.160   ! brook    10711: <td>CHECK_SHLIBS</td>
1.156     leot     10712: </tr>
                   10713: <tr>
1.159     rillig   10714: <td>CHECK_SHLIBS_BLACKLIST</td>
1.160   ! brook    10715: <td>CHECK_SHLIBS_SKIP</td>
1.156     leot     10716: </tr>
                   10717: <tr>
1.159     rillig   10718: <td>CHECK_SHLIBS_SUPPORTED</td>
1.160   ! brook    10719: <td>CHECK_SSP</td>
1.156     leot     10720: </tr>
                   10721: <tr>
1.159     rillig   10722: <td>CHECK_SSP_SKIP</td>
1.160   ! brook    10723: <td>CHECK_SSP_SUPPORTED</td>
1.156     leot     10724: </tr>
                   10725: <tr>
1.159     rillig   10726: <td>CHECK_STRIPPED</td>
1.160   ! brook    10727: <td>CHECK_STRIPPED_SKIP</td>
1.156     leot     10728: </tr>
                   10729: <tr>
1.159     rillig   10730: <td>CHECK_WRKREF</td>
1.160   ! brook    10731: <td>CHECK_WRKREF_EXTRA_DIRS</td>
1.156     leot     10732: </tr>
                   10733: <tr>
1.159     rillig   10734: <td>CHECK_WRKREF_SKIP</td>
1.160   ! brook    10735: <td>CLAMAV_DBDIR</td>
1.156     leot     10736: </tr>
                   10737: <tr>
1.159     rillig   10738: <td>CLAMAV_GROUP</td>
1.160   ! brook    10739: <td>CLAMAV_USER</td>
1.156     leot     10740: </tr>
                   10741: <tr>
1.159     rillig   10742: <td>CLANGBASE</td>
1.160   ! brook    10743: <td>CLEANDEPENDS</td>
1.156     leot     10744: </tr>
                   10745: <tr>
1.159     rillig   10746: <td>CMAKE_DEPENDENCIES_REWRITE</td>
1.160   ! brook    10747: <td>CMAKE_INSTALL_PREFIX</td>
1.156     leot     10748: </tr>
                   10749: <tr>
1.159     rillig   10750: <td>CMAKE_MODULE_PATH_OVERRIDE</td>
1.160   ! brook    10751: <td>CMAKE_PKGSRC_BUILD_FLAGS</td>
1.156     leot     10752: </tr>
                   10753: <tr>
1.159     rillig   10754: <td>CMAKE_PREFIX_PATH</td>
1.156     leot     10755: <td>CMAKE_USE_GNU_INSTALL_DIRS</td>
                   10756: </tr>
                   10757: <tr>
                   10758: <td>COMPILER_RPATH_FLAG</td>
                   10759: <td>COMPILER_USE_SYMLINKS</td>
                   10760: </tr>
                   10761: <tr>
                   10762: <td>CONFIGURE_ARGS</td>
                   10763: <td>CONFIGURE_DIRS</td>
                   10764: </tr>
                   10765: <tr>
                   10766: <td>CONFIGURE_ENV</td>
                   10767: <td>CONFIGURE_HAS_INFODIR</td>
                   10768: </tr>
                   10769: <tr>
                   10770: <td>CONFIGURE_HAS_MANDIR</td>
                   10771: <td>CONFIGURE_SCRIPT</td>
                   10772: </tr>
                   10773: <tr>
                   10774: <td>CONFIG_SHELL</td>
                   10775: <td>CONFIG_SHELL_FLAGS</td>
                   10776: </tr>
                   10777: <tr>
                   10778: <td>CONF_FILES</td>
                   10779: <td>CONF_FILES_MODE</td>
                   10780: </tr>
                   10781: <tr>
                   10782: <td>CONF_FILES_PERMS</td>
                   10783: <td>CONSERVER_DEFAULTHOST</td>
                   10784: </tr>
                   10785: <tr>
                   10786: <td>CONSERVER_DEFAULTPORT</td>
                   10787: <td>CP</td>
                   10788: </tr>
                   10789: <tr>
                   10790: <td>CPP</td>
                   10791: <td>CPP_PRECOMP_FLAGS</td>
                   10792: </tr>
                   10793: <tr>
                   10794: <td>CREATE_WRKDIR_SYMLINK</td>
                   10795: <td>CROSSBASE</td>
                   10796: </tr>
                   10797: <tr>
                   10798: <td>CTFCONVERT</td>
                   10799: <td>CTF_FILES_SKIP</td>
                   10800: </tr>
                   10801: <tr>
                   10802: <td>CTF_SUPPORTED</td>
                   10803: <td>CTYPE</td>
                   10804: </tr>
                   10805: <tr>
                   10806: <td>CUPS_GROUP</td>
                   10807: <td>CUPS_SYSTEM_GROUPS</td>
                   10808: </tr>
                   10809: <tr>
                   10810: <td>CUPS_USER</td>
                   10811: <td>CURSES_DEFAULT</td>
                   10812: </tr>
                   10813: <tr>
                   10814: <td>CURSES_TYPE</td>
1.160   ! brook    10815: <td>CXX</td>
1.159     rillig   10816: </tr>
                   10817: <tr>
                   10818: <td>CYRUS_GROUP</td>
1.160   ! brook    10819: <td>CYRUS_IDLE</td>
1.156     leot     10820: </tr>
                   10821: <tr>
1.159     rillig   10822: <td>CYRUS_USER</td>
1.160   ! brook    10823: <td>DAEMONTOOLS_GROUP</td>
1.156     leot     10824: </tr>
                   10825: <tr>
1.159     rillig   10826: <td>DAEMONTOOLS_LOG_USER</td>
1.160   ! brook    10827: <td>DBUS_GROUP</td>
1.156     leot     10828: </tr>
                   10829: <tr>
1.159     rillig   10830: <td>DBUS_USER</td>
1.160   ! brook    10831: <td>DEFANG_GROUP</td>
1.156     leot     10832: </tr>
                   10833: <tr>
1.159     rillig   10834: <td>DEFANG_USER</td>
1.160   ! brook    10835: <td>DEFAULT_ACCEPTABLE_LICENSES</td>
1.156     leot     10836: </tr>
                   10837: <tr>
1.159     rillig   10838: <td>DEFAULT_DISTFILES</td>
1.160   ! brook    10839: <td>DEFAULT_IRC_SERVER</td>
1.156     leot     10840: </tr>
                   10841: <tr>
1.159     rillig   10842: <td>DEFAULT_SERIAL_DEVICE</td>
1.160   ! brook    10843: <td>DEF_UMASK</td>
1.156     leot     10844: </tr>
                   10845: <tr>
1.159     rillig   10846: <td>DEINSTALLDEPENDS</td>
1.160   ! brook    10847: <td>DEINSTALL_SRC</td>
1.156     leot     10848: </tr>
                   10849: <tr>
1.159     rillig   10850: <td>DEINSTALL_TEMPLATES</td>
1.160   ! brook    10851: <td>DELAYED_ERROR_MSG</td>
1.156     leot     10852: </tr>
                   10853: <tr>
1.159     rillig   10854: <td>DELAYED_WARNING_MSG</td>
1.160   ! brook    10855: <td>DEPENDS</td>
1.156     leot     10856: </tr>
                   10857: <tr>
1.159     rillig   10858: <td>DEPENDS_TARGET</td>
1.160   ! brook    10859: <td>DEPENDS_TYPE</td>
1.156     leot     10860: </tr>
                   10861: <tr>
1.159     rillig   10862: <td>DESTDIR</td>
1.160   ! brook    10863: <td>DESTDIR_VARNAME</td>
1.156     leot     10864: </tr>
                   10865: <tr>
1.159     rillig   10866: <td>DIALER_GROUP</td>
1.160   ! brook    10867: <td>DIGEST_REQD</td>
1.156     leot     10868: </tr>
                   10869: <tr>
1.159     rillig   10870: <td>DISTDIR</td>
1.160   ! brook    10871: <td>DISTFILES</td>
1.156     leot     10872: </tr>
                   10873: <tr>
1.159     rillig   10874: <td>DISTINFO_FILE</td>
1.160   ! brook    10875: <td>DISTNAME</td>
1.156     leot     10876: </tr>
                   10877: <tr>
1.159     rillig   10878: <td>DIST_PATH</td>
1.160   ! brook    10879: <td>DIST_SUBDIR</td>
1.156     leot     10880: </tr>
                   10881: <tr>
1.159     rillig   10882: <td>DJBDNS_AXFR_USER</td>
1.160   ! brook    10883: <td>DJBDNS_CACHE_USER</td>
1.156     leot     10884: </tr>
                   10885: <tr>
1.159     rillig   10886: <td>DJBDNS_DJBDNS_GROUP</td>
1.160   ! brook    10887: <td>DJBDNS_LOG_USER</td>
1.156     leot     10888: </tr>
                   10889: <tr>
1.159     rillig   10890: <td>DJBDNS_RBL_USER</td>
1.160   ! brook    10891: <td>DJBDNS_TINY_USER</td>
1.156     leot     10892: </tr>
                   10893: <tr>
1.159     rillig   10894: <td>DLOPEN_REQUIRE_PTHREADS</td>
1.160   ! brook    10895: <td>DL_AUTO_VARS</td>
1.156     leot     10896: </tr>
                   10897: <tr>
1.159     rillig   10898: <td>DL_CFLAGS</td>
1.160   ! brook    10899: <td>DL_LDFLAGS</td>
1.156     leot     10900: </tr>
                   10901: <tr>
1.159     rillig   10902: <td>DL_LIBS</td>
1.160   ! brook    10903: <td>DNS</td>
1.156     leot     10904: </tr>
                   10905: <tr>
1.159     rillig   10906: <td>DOWNLOADED_DISTFILE</td>
1.160   ! brook    10907: <td>DT_LAYOUT</td>
1.156     leot     10908: </tr>
                   10909: <tr>
1.159     rillig   10910: <td>DYNAMIC_SITES_CMD</td>
1.160   ! brook    10911: <td>DYNAMIC_SITES_SCRIPT</td>
1.156     leot     10912: </tr>
                   10913: <tr>
1.159     rillig   10914: <td>ECHO</td>
1.160   ! brook    10915: <td>ECHO_N</td>
1.156     leot     10916: </tr>
                   10917: <tr>
1.159     rillig   10918: <td>ELK_GUI</td>
1.160   ! brook    10919: <td>EMACS_TYPE</td>
1.156     leot     10920: </tr>
                   10921: <tr>
1.159     rillig   10922: <td>EMULDIR</td>
1.160   ! brook    10923: <td>EMULSUBDIR</td>
1.156     leot     10924: </tr>
                   10925: <tr>
1.159     rillig   10926: <td>EMULSUBDIRSLASH</td>
1.160   ! brook    10927: <td>EMUL_ARCH</td>
1.156     leot     10928: </tr>
                   10929: <tr>
1.159     rillig   10930: <td>EMUL_DISTRO</td>
1.160   ! brook    10931: <td>EMUL_EXEC_FMT</td>
1.156     leot     10932: </tr>
                   10933: <tr>
1.159     rillig   10934: <td>EMUL_IS_NATIVE</td>
1.160   ! brook    10935: <td>EMUL_MODULES</td>
1.156     leot     10936: </tr>
                   10937: <tr>
1.159     rillig   10938: <td>EMUL_OPSYS</td>
1.160   ! brook    10939: <td>EMUL_PKG_FMT</td>
1.156     leot     10940: </tr>
                   10941: <tr>
1.159     rillig   10942: <td>EMUL_PLATFORM</td>
1.160   ! brook    10943: <td>EMUL_PLATFORMS</td>
1.156     leot     10944: </tr>
                   10945: <tr>
1.159     rillig   10946: <td>EMUL_PREFER</td>
1.160   ! brook    10947: <td>EMUL_REQD</td>
1.156     leot     10948: </tr>
                   10949: <tr>
1.159     rillig   10950: <td>EMUL_TYPE</td>
1.160   ! brook    10951: <td>ERROR_MSG</td>
1.156     leot     10952: </tr>
                   10953: <tr>
1.159     rillig   10954: <td>EXIM_GROUP</td>
1.160   ! brook    10955: <td>EXIM_USER</td>
1.156     leot     10956: </tr>
                   10957: <tr>
1.159     rillig   10958: <td>EXPORT_SYMBOLS_LDFLAGS</td>
1.160   ! brook    10959: <td>EXTRACTOR</td>
1.156     leot     10960: </tr>
                   10961: <tr>
1.159     rillig   10962: <td>EXTRACT_CMD</td>
1.160   ! brook    10963: <td>EXTRACT_CMD_DEFAULT</td>
1.156     leot     10964: </tr>
                   10965: <tr>
1.159     rillig   10966: <td>EXTRACT_DIR</td>
1.160   ! brook    10967: <td>EXTRACT_ELEMENTS</td>
1.156     leot     10968: </tr>
                   10969: <tr>
1.159     rillig   10970: <td>EXTRACT_ENV</td>
1.160   ! brook    10971: <td>EXTRACT_ONLY</td>
1.156     leot     10972: </tr>
                   10973: <tr>
1.159     rillig   10974: <td>EXTRACT_OPTS</td>
1.160   ! brook    10975: <td>EXTRACT_SUFX</td>
1.156     leot     10976: </tr>
                   10977: <tr>
1.159     rillig   10978: <td>EXTRACT_USING</td>
1.160   ! brook    10979: <td>FAILOVER_FETCH</td>
1.156     leot     10980: </tr>
                   10981: <tr>
1.159     rillig   10982: <td>FAIL_MSG</td>
1.160   ! brook    10983: <td>FAKE_NCURSES</td>
1.156     leot     10984: </tr>
                   10985: <tr>
1.159     rillig   10986: <td>FAM</td>
1.160   ! brook    10987: <td>FAM_ACCEPTED</td>
1.156     leot     10988: </tr>
                   10989: <tr>
1.159     rillig   10990: <td>FAM_DEFAULT</td>
1.160   ! brook    10991: <td>FAM_SERVER</td>
1.156     leot     10992: </tr>
                   10993: <tr>
1.159     rillig   10994: <td>FCPATH</td>
1.160   ! brook    10995: <td>FEATURE_CPPFLAGS</td>
1.156     leot     10996: </tr>
                   10997: <tr>
1.159     rillig   10998: <td>FEATURE_LDFLAGS</td>
1.160   ! brook    10999: <td>FEATURE_LIBS</td>
1.156     leot     11000: </tr>
                   11001: <tr>
1.159     rillig   11002: <td>FETCH_AFTER_ARGS</td>
1.160   ! brook    11003: <td>FETCH_BEFORE_ARGS</td>
1.156     leot     11004: </tr>
                   11005: <tr>
1.159     rillig   11006: <td>FETCH_CMD</td>
1.160   ! brook    11007: <td>FETCH_OUTPUT_ARGS</td>
1.156     leot     11008: </tr>
                   11009: <tr>
1.159     rillig   11010: <td>FETCH_PROXY</td>
1.160   ! brook    11011: <td>FETCH_RESUME_ARGS</td>
1.156     leot     11012: </tr>
                   11013: <tr>
1.159     rillig   11014: <td>FETCH_USING</td>
1.160   ! brook    11015: <td>FILES_SUBST</td>
1.156     leot     11016: </tr>
                   11017: <tr>
1.159     rillig   11018: <td>FILES_SUBST_SED</td>
1.160   ! brook    11019: <td>FIX_SYSTEM_HEADERS</td>
1.156     leot     11020: </tr>
                   11021: <tr>
1.159     rillig   11022: <td>FLUXBOX_USE_GNOME</td>
1.160   ! brook    11023: <td>FLUXBOX_USE_KDE</td>
1.156     leot     11024: </tr>
                   11025: <tr>
1.159     rillig   11026: <td>FLUXBOX_USE_XFT</td>
1.156     leot     11027: <td>FLUXBOX_USE_XINERAMA</td>
                   11028: </tr>
                   11029: <tr>
                   11030: <td>FONTS_DIRS</td>
                   11031: <td>FONTS_VERBOSE</td>
                   11032: </tr>
                   11033: <tr>
                   11034: <td>FOO_HACKS_MK</td>
                   11035: <td>FOX_USE_XUNICODE</td>
                   11036: </tr>
                   11037: <tr>
                   11038: <td>FREEWNN_GROUP</td>
                   11039: <td>FREEWNN_USER</td>
                   11040: </tr>
                   11041: <tr>
                   11042: <td>FTP_PKG_URL_DIR</td>
                   11043: <td>FTP_PKG_URL_HOST</td>
                   11044: </tr>
                   11045: <tr>
                   11046: <td>GAMEDATAMODE</td>
                   11047: <td>GAMEDATA_PERMS</td>
                   11048: </tr>
                   11049: <tr>
                   11050: <td>GAMEDIRMODE</td>
                   11051: <td>GAMEDIR_PERMS</td>
                   11052: </tr>
                   11053: <tr>
                   11054: <td>GAMEGRP</td>
                   11055: <td>GAMEMODE</td>
                   11056: </tr>
                   11057: <tr>
                   11058: <td>GAMEOWN</td>
                   11059: <td>GAMES_GROUP</td>
                   11060: </tr>
                   11061: <tr>
                   11062: <td>GAMES_USER</td>
                   11063: <td>GCC</td>
                   11064: </tr>
                   11065: <tr>
                   11066: <td>GCCBASE</td>
                   11067: <td>GCC_REQD</td>
                   11068: </tr>
                   11069: <tr>
                   11070: <td>GCC_VERSION_SUFFIX</td>
                   11071: <td>GEM_BUILD</td>
                   11072: </tr>
                   11073: <tr>
                   11074: <td>GEM_CLEANBUILD</td>
                   11075: <td>GEM_CLEANBUILD_EXTENSIONS</td>
                   11076: </tr>
                   11077: <tr>
                   11078: <td>GEM_DOCDIR</td>
                   11079: <td>GEM_EXTSDIR</td>
                   11080: </tr>
                   11081: <tr>
                   11082: <td>GEM_HOME</td>
                   11083: <td>GEM_LIBDIR</td>
                   11084: </tr>
                   11085: <tr>
                   11086: <td>GEM_NAME</td>
                   11087: <td>GEM_PATH</td>
                   11088: </tr>
                   11089: <tr>
                   11090: <td>GEM_SPECFILE</td>
                   11091: <td>GENERATE_PLIST</td>
                   11092: </tr>
                   11093: <tr>
                   11094: <td>GHOSTSCRIPT_REQD</td>
                   11095: <td>GITHUB_PROJECT</td>
                   11096: </tr>
                   11097: <tr>
                   11098: <td>GITHUB_RELEASE</td>
                   11099: <td>GITHUB_TAG</td>
                   11100: </tr>
                   11101: <tr>
                   11102: <td>GITHUB_TYPE</td>
1.160   ! brook    11103: <td>GNU</td>
1.159     rillig   11104: </tr>
                   11105: <tr>
                   11106: <td>GNU_CONFIGURE</td>
1.160   ! brook    11107: <td>GNU_CONFIGURE_INFODIR</td>
1.156     leot     11108: </tr>
                   11109: <tr>
1.159     rillig   11110: <td>GNU_CONFIGURE_MANDIR</td>
1.160   ! brook    11111: <td>GNU_CONFIGURE_STRICT</td>
1.156     leot     11112: </tr>
                   11113: <tr>
1.159     rillig   11114: <td>GODEP_REDIRECTS</td>
1.160   ! brook    11115: <td>GO_BUILD_PATTERN</td>
1.156     leot     11116: </tr>
                   11117: <tr>
1.159     rillig   11118: <td>GO_DEPS</td>
1.160   ! brook    11119: <td>GO_DIST_BASE</td>
1.156     leot     11120: </tr>
                   11121: <tr>
1.159     rillig   11122: <td>GO_SRCPATH</td>
1.160   ! brook    11123: <td>GROUP_SPECIFIC_PKGS</td>
1.156     leot     11124: </tr>
                   11125: <tr>
1.159     rillig   11126: <td>GRUB_NETWORK_CARDS</td>
1.160   ! brook    11127: <td>GRUB_PRESET_COMMAND</td>
1.156     leot     11128: </tr>
                   11129: <tr>
1.159     rillig   11130: <td>GRUB_SCAN_ARGS</td>
1.160   ! brook    11131: <td>GZIP</td>
1.156     leot     11132: </tr>
                   11133: <tr>
1.159     rillig   11134: <td>HASKELL_COMPILER</td>
1.160   ! brook    11135: <td>HASKELL_ENABLE_HADDOCK_DOCUMENTATION</td>
1.156     leot     11136: </tr>
                   11137: <tr>
1.159     rillig   11138: <td>HASKELL_ENABLE_LIBRARY_PROFILING</td>
1.160   ! brook    11139: <td>HASKELL_ENABLE_SHARED_LIBRARY</td>
1.156     leot     11140: </tr>
                   11141: <tr>
1.159     rillig   11142: <td>HAS_CONFIGURE</td>
1.156     leot     11143: <td>HEADER_TEMPLATES</td>
                   11144: </tr>
                   11145: <tr>
                   11146: <td>HOST_PKGTOOLS_ARGS</td>
                   11147: <td>HOST_SPECIFIC_PKGS</td>
                   11148: </tr>
                   11149: <tr>
                   11150: <td>HOWL_GROUP</td>
                   11151: <td>HOWL_USER</td>
                   11152: </tr>
                   11153: <tr>
                   11154: <td>ICCBASE</td>
                   11155: <td>ICECAST_CHROOTDIR</td>
                   11156: </tr>
                   11157: <tr>
                   11158: <td>ICON_THEMES</td>
                   11159: <td>IDOBASE</td>
                   11160: </tr>
                   11161: <tr>
                   11162: <td>IGNORE_CCACHE</td>
                   11163: <td>IGNORE_INFO_DIRS</td>
                   11164: </tr>
                   11165: <tr>
                   11166: <td>IGNORE_INTERACTIVE_FETCH</td>
                   11167: <td>IMAKE</td>
                   11168: </tr>
                   11169: <tr>
                   11170: <td>IMAKEOPTS</td>
                   11171: <td>IMAKE_MAKE</td>
                   11172: </tr>
                   11173: <tr>
                   11174: <td>IMAKE_MANINSTALL</td>
                   11175: <td>IMAP_UW_CCLIENT_MBOX_FMT</td>
                   11176: </tr>
                   11177: <tr>
                   11178: <td>IMDICTDIR</td>
                   11179: <td>INCOMPAT_CURSES</td>
                   11180: </tr>
                   11181: <tr>
                   11182: <td>INFO_DIR</td>
                   11183: <td>INFO_FILES</td>
                   11184: </tr>
                   11185: <tr>
                   11186: <td>INFO_FILES_VERBOSE</td>
                   11187: <td>INFO_MSG</td>
                   11188: </tr>
                   11189: <tr>
                   11190: <td>INIT_SYSTEM</td>
                   11191: <td>INN_DATA_DIR</td>
                   11192: </tr>
                   11193: <tr>
                   11194: <td>INN_GROUP</td>
                   11195: <td>INN_USER</td>
                   11196: </tr>
                   11197: <tr>
                   11198: <td>INSTALLATION_DIRS</td>
                   11199: <td>INSTALLATION_DIRS_FROM_PLIST</td>
                   11200: </tr>
                   11201: <tr>
                   11202: <td>INSTALL_ENV</td>
                   11203: <td>INSTALL_SH_OVERRIDE</td>
                   11204: </tr>
                   11205: <tr>
                   11206: <td>INSTALL_SRC</td>
                   11207: <td>INSTALL_TEMPLATES</td>
                   11208: </tr>
                   11209: <tr>
                   11210: <td>INSTALL_UNSTRIPPED</td>
                   11211: <td>IRCD_HYBRID_IRC_GROUP</td>
                   11212: </tr>
                   11213: <tr>
                   11214: <td>IRCD_HYBRID_IRC_USER</td>
                   11215: <td>IRCD_HYBRID_MAXCONN</td>
                   11216: </tr>
                   11217: <tr>
                   11218: <td>IRCD_HYBRID_NICLEN</td>
                   11219: <td>IRCD_HYBRID_SYSLOG_EVENTS</td>
                   11220: </tr>
                   11221: <tr>
                   11222: <td>IRCD_HYBRID_SYSLOG_FACILITY</td>
                   11223: <td>IRCD_HYBRID_TOPICLEN</td>
                   11224: </tr>
                   11225: <tr>
                   11226: <td>IRIX</td>
                   11227: <td>IRRD_USE_PGP</td>
                   11228: </tr>
                   11229: <tr>
                   11230: <td>JABBERD_GROUP</td>
                   11231: <td>JABBERD_LOGDIR</td>
                   11232: </tr>
                   11233: <tr>
                   11234: <td>JABBERD_PIDDIR</td>
                   11235: <td>JABBERD_SPOOLDIR</td>
                   11236: </tr>
                   11237: <tr>
                   11238: <td>JABBERD_USER</td>
                   11239: <td>JAKARTA_HOME</td>
                   11240: </tr>
                   11241: <tr>
                   11242: <td>JAVA_BINPREFIX</td>
                   11243: <td>JAVA_CLASSPATH</td>
                   11244: </tr>
                   11245: <tr>
                   11246: <td>JAVA_HOME</td>
                   11247: <td>JAVA_LD_LIBRARY_PATH</td>
                   11248: </tr>
                   11249: <tr>
                   11250: <td>JAVA_NAME</td>
                   11251: <td>JAVA_UNLIMIT</td>
                   11252: </tr>
                   11253: <tr>
                   11254: <td>JAVA_WRAPPERS</td>
                   11255: <td>JPEG_ACCEPTED</td>
                   11256: </tr>
                   11257: <tr>
                   11258: <td>JPEG_DEFAULT</td>
                   11259: <td>KERBEROS</td>
                   11260: </tr>
                   11261: <tr>
                   11262: <td>KERMIT_SUID_UUCP</td>
                   11263: <td>KJS_USE_PCRE</td>
                   11264: </tr>
                   11265: <tr>
                   11266: <td>KNEWS_DOMAIN_FILE</td>
                   11267: <td>KNEWS_DOMAIN_NAME</td>
                   11268: </tr>
                   11269: <tr>
                   11270: <td>KRB5_ACCEPTED</td>
                   11271: <td>KRB5_DEFAULT</td>
                   11272: </tr>
                   11273: <tr>
                   11274: <td>LANGUAGES</td>
1.160   ! brook    11275: <td>LATEX2HTML_ICONPATH</td>
1.156     leot     11276: </tr>
                   11277: <tr>
                   11278: <td>LDCONFIG_ADD_CMD</td>
1.160   ! brook    11279: <td>LDCONFIG_REMOVE_CMD</td>
1.156     leot     11280: </tr>
                   11281: <tr>
                   11282: <td>LEAFNODE_DATA_DIR</td>
1.160   ! brook    11283: <td>LEAFNODE_GROUP</td>
1.156     leot     11284: </tr>
                   11285: <tr>
                   11286: <td>LEAFNODE_USER</td>
1.160   ! brook    11287: <td>LIBDVDCSS_HOMEPAGE</td>
1.156     leot     11288: </tr>
                   11289: <tr>
                   11290: <td>LIBDVDCSS_MASTER_SITES</td>
1.160   ! brook    11291: <td>LIBRSVG_TYPE</td>
1.157     leot     11292: </tr>
                   11293: <tr>
1.156     leot     11294: <td>LIBTOOL</td>
1.160   ! brook    11295: <td>LIBTOOLIZE_PLIST</td>
1.156     leot     11296: </tr>
                   11297: <tr>
                   11298: <td>LIBTOOL_M4_OVERRIDE</td>
1.160   ! brook    11299: <td>LIBUSB_TYPE</td>
1.156     leot     11300: </tr>
                   11301: <tr>
                   11302: <td>LICENSE</td>
1.160   ! brook    11303: <td>LINKER_RPATH_FLAG</td>
1.156     leot     11304: </tr>
                   11305: <tr>
                   11306: <td>LINK_RPATH_FLAG</td>
1.159     rillig   11307: <td>LINUX_LOCALES</td>
1.156     leot     11308: </tr>
                   11309: <tr>
1.157     leot     11310: <td>LOCALBASE</td>
1.158     brook    11311: <td>LOCALBASE_LOCKTYPE</td>
1.156     leot     11312: </tr>
                   11313: <tr>
1.157     leot     11314: <td>LOCALPATCHES</td>
1.158     brook    11315: <td>LOVE_DATA</td>
1.156     leot     11316: </tr>
                   11317: <tr>
1.157     leot     11318: <td>LOVE_GAME</td>
1.158     brook    11319: <td>LOVE_VERSION</td>
1.156     leot     11320: </tr>
                   11321: <tr>
1.157     leot     11322: <td>LP64PLATFORMS</td>
1.158     brook    11323: <td>MACHINE_PLATFORM</td>
1.156     leot     11324: </tr>
                   11325: <tr>
1.157     leot     11326: <td>MAILAGENT_DOMAIN</td>
1.158     brook    11327: <td>MAILAGENT_EMAIL</td>
1.156     leot     11328: </tr>
                   11329: <tr>
1.157     leot     11330: <td>MAILAGENT_FQDN</td>
1.158     brook    11331: <td>MAILAGENT_ORGANIZATION</td>
1.156     leot     11332: </tr>
                   11333: <tr>
1.157     leot     11334: <td>MAJORDOMO_HOMEDIR</td>
1.160   ! brook    11335: <td>MAKEINFO_ARGS</td>
1.159     rillig   11336: </tr>
                   11337: <tr>
                   11338: <td>MAKE_DIRS</td>
1.160   ! brook    11339: <td>MAKE_DIRS_PERMS</td>
1.156     leot     11340: </tr>
                   11341: <tr>
1.159     rillig   11342: <td>MAKE_ENV</td>
1.160   ! brook    11343: <td>MAKE_FILE</td>
1.156     leot     11344: </tr>
                   11345: <tr>
1.159     rillig   11346: <td>MAKE_FLAGS</td>
1.160   ! brook    11347: <td>MAKE_JOBS</td>
1.156     leot     11348: </tr>
                   11349: <tr>
1.159     rillig   11350: <td>MAKE_JOBS_SAFE</td>
1.160   ! brook    11351: <td>MAKE_PROGRAM</td>
1.156     leot     11352: </tr>
                   11353: <tr>
1.159     rillig   11354: <td>MANINSTALL</td>
1.160   ! brook    11355: <td>MANZ</td>
1.156     leot     11356: </tr>
                   11357: <tr>
1.159     rillig   11358: <td>MASTER_SITES</td>
1.160   ! brook    11359: <td>MASTER_SITE_BACKUP</td>
1.156     leot     11360: </tr>
                   11361: <tr>
1.159     rillig   11362: <td>MASTER_SITE_CYGWIN</td>
1.160   ! brook    11363: <td>MASTER_SITE_GNOME</td>
1.156     leot     11364: </tr>
                   11365: <tr>
1.159     rillig   11366: <td>MASTER_SITE_GNU</td>
1.160   ! brook    11367: <td>MASTER_SITE_LOCAL</td>
1.156     leot     11368: </tr>
                   11369: <tr>
1.159     rillig   11370: <td>MASTER_SITE_MOZILLA</td>
1.160   ! brook    11371: <td>MASTER_SITE_OPENOFFICE</td>
1.156     leot     11372: </tr>
                   11373: <tr>
1.159     rillig   11374: <td>MASTER_SITE_OVERRIDE</td>
1.160   ! brook    11375: <td>MASTER_SITE_PERL_CPAN</td>
1.156     leot     11376: </tr>
                   11377: <tr>
1.159     rillig   11378: <td>MASTER_SITE_SUNSITE</td>
1.160   ! brook    11379: <td>MASTER_SITE_SUSE</td>
1.156     leot     11380: </tr>
                   11381: <tr>
1.159     rillig   11382: <td>MASTER_SITE_TEX_CTAN</td>
1.160   ! brook    11383: <td>MASTER_SITE_XCONTRIB</td>
1.156     leot     11384: </tr>
                   11385: <tr>
1.159     rillig   11386: <td>MASTER_SITE_XEMACS</td>
1.160   ! brook    11387: <td>MASTER_SORT</td>
1.156     leot     11388: </tr>
                   11389: <tr>
1.159     rillig   11390: <td>MASTER_SORT_RANDOM</td>
1.160   ! brook    11391: <td>MASTER_SORT_REGEX</td>
1.156     leot     11392: </tr>
                   11393: <tr>
1.159     rillig   11394: <td>MECAB_CHARSET</td>
1.160   ! brook    11395: <td>MEDIATOMB_GROUP</td>
1.156     leot     11396: </tr>
                   11397: <tr>
1.159     rillig   11398: <td>MEDIATOMB_USER</td>
1.160   ! brook    11399: <td>MIPSPROBASE</td>
1.156     leot     11400: </tr>
                   11401: <tr>
1.159     rillig   11402: <td>MIREDO_GROUP</td>
1.160   ! brook    11403: <td>MIREDO_USER</td>
1.156     leot     11404: </tr>
                   11405: <tr>
1.159     rillig   11406: <td>MISSING_FEATURES</td>
1.160   ! brook    11407: <td>MKDIR</td>
1.156     leot     11408: </tr>
                   11409: <tr>
1.159     rillig   11410: <td>MLDONKEY_GROUP</td>
1.160   ! brook    11411: <td>MLDONKEY_HOME</td>
1.156     leot     11412: </tr>
                   11413: <tr>
1.159     rillig   11414: <td>MLDONKEY_USER</td>
1.160   ! brook    11415: <td>MONOTONE_GROUP</td>
1.156     leot     11416: </tr>
                   11417: <tr>
1.159     rillig   11418: <td>MONOTONE_USER</td>
1.160   ! brook    11419: <td>MOTIFBASE</td>
1.156     leot     11420: </tr>
                   11421: <tr>
1.159     rillig   11422: <td>MOTIF_TYPE</td>
1.160   ! brook    11423: <td>MOTIF_TYPE_DEFAULT</td>
1.156     leot     11424: </tr>
                   11425: <tr>
1.159     rillig   11426: <td>MPI_TYPE</td>
1.160   ! brook    11427: <td>MSGFMT_STRIP_MSGCTXT</td>
1.156     leot     11428: </tr>
                   11429: <tr>
1.159     rillig   11430: <td>MSGFMT_STRIP_MSGID_PLURAL</td>
1.160   ! brook    11431: <td>MTOOLS_ENABLE_FLOPPYD</td>
1.156     leot     11432: </tr>
                   11433: <tr>
1.159     rillig   11434: <td>MUST</td>
1.160   ! brook    11435: <td>MV</td>
1.156     leot     11436: </tr>
                   11437: <tr>
1.159     rillig   11438: <td>MYSQL_CHARSET</td>
1.160   ! brook    11439: <td>MYSQL_DATADIR</td>
1.156     leot     11440: </tr>
                   11441: <tr>
1.159     rillig   11442: <td>MYSQL_EXTRA_CHARSET</td>
1.160   ! brook    11443: <td>MYSQL_GROUP</td>
1.156     leot     11444: </tr>
                   11445: <tr>
1.159     rillig   11446: <td>MYSQL_PKGSRCDIR</td>
1.160   ! brook    11447: <td>MYSQL_USER</td>
1.156     leot     11448: </tr>
                   11449: <tr>
1.159     rillig   11450: <td>MYSQL_VERSIONS_ACCEPTED</td>
1.160   ! brook    11451: <td>MYSQL_VERSION_DEFAULT</td>
1.156     leot     11452: </tr>
                   11453: <tr>
1.159     rillig   11454: <td>NAGIOSCMD_GROUP</td>
1.160   ! brook    11455: <td>NAGIOSDIR</td>
1.156     leot     11456: </tr>
                   11457: <tr>
1.159     rillig   11458: <td>NAGIOS_GROUP</td>
1.160   ! brook    11459: <td>NAGIOS_USER</td>
1.156     leot     11460: </tr>
                   11461: <tr>
1.159     rillig   11462: <td>NATIVE_APPEND_ABI</td>
1.160   ! brook    11463: <td>NATIVE_APPEND_ELF</td>
1.156     leot     11464: </tr>
                   11465: <tr>
1.159     rillig   11466: <td>NATIVE_EXEC_FMT</td>
1.160   ! brook    11467: <td>NATIVE_MACHINE_PLATFORM</td>
1.156     leot     11468: </tr>
                   11469: <tr>
1.159     rillig   11470: <td>NATIVE_OBJECT_FMT</td>
1.160   ! brook    11471: <td>NBPAX_PROGRAM_PREFIX</td>
1.156     leot     11472: </tr>
                   11473: <tr>
1.159     rillig   11474: <td>NETBSD_LOGIN_NAME</td>
1.160   ! brook    11475: <td>NMH_EDITOR</td>
1.156     leot     11476: </tr>
                   11477: <tr>
1.159     rillig   11478: <td>NMH_MTA</td>
1.160   ! brook    11479: <td>NMH_PAGER</td>
1.156     leot     11480: </tr>
                   11481: <tr>
1.159     rillig   11482: <td>NOLOGIN</td>
1.160   ! brook    11483: <td>NONZERO_FILESIZE_P</td>
1.156     leot     11484: </tr>
                   11485: <tr>
1.159     rillig   11486: <td>NOTE</td>
1.160   ! brook    11487: <td>NOT_FOR_PLATFORM</td>
1.156     leot     11488: </tr>
                   11489: <tr>
1.159     rillig   11490: <td>NOT_PAX_ASLR_SAFE</td>
1.160   ! brook    11491: <td>NOT_PAX_MPROTECT_SAFE</td>
1.156     leot     11492: </tr>
                   11493: <tr>
1.159     rillig   11494: <td>NO_BUILD</td>
1.160   ! brook    11495: <td>NO_CHECKSUM</td>
1.156     leot     11496: </tr>
                   11497: <tr>
1.159     rillig   11498: <td>NO_CONFIGURE</td>
1.160   ! brook    11499: <td>NO_SKIP</td>
1.156     leot     11500: </tr>
                   11501: <tr>
1.159     rillig   11502: <td>NS_PREFERRED</td>
1.160   ! brook    11503: <td>NULLMAILER_GROUP</td>
1.156     leot     11504: </tr>
                   11505: <tr>
1.159     rillig   11506: <td>NULLMAILER_USER</td>
1.160   ! brook    11507: <td>OASIS</td>
1.156     leot     11508: </tr>
                   11509: <tr>
1.159     rillig   11510: <td>OASIS_BUILD_ARGS</td>
1.160   ! brook    11511: <td>OBJHOSTNAME</td>
1.156     leot     11512: </tr>
                   11513: <tr>
1.159     rillig   11514: <td>OBJMACHINE</td>
1.160   ! brook    11515: <td>OCAML_FINDLIB_DIRS</td>
1.156     leot     11516: </tr>
                   11517: <tr>
1.159     rillig   11518: <td>OCAML_FINDLIB_REGISTER</td>
1.160   ! brook    11519: <td>OCAML_FINDLIB_REGISTER_VERBOSE</td>
1.156     leot     11520: </tr>
                   11521: <tr>
1.159     rillig   11522: <td>OCAML_SITELIBDIR</td>
1.160   ! brook    11523: <td>OCAML_TOPKG_DOCDIR</td>
1.156     leot     11524: </tr>
                   11525: <tr>
1.159     rillig   11526: <td>OCAML_USE_DUNE</td>
1.160   ! brook    11527: <td>OCAML_USE_FINDLIB</td>
1.156     leot     11528: </tr>
                   11529: <tr>
1.159     rillig   11530: <td>OCAML_USE_JBUILDER</td>
1.160   ! brook    11531: <td>OCAML_USE_OASIS</td>
1.156     leot     11532: </tr>
                   11533: <tr>
1.159     rillig   11534: <td>OCAML_USE_OASIS_DYNRUN</td>
1.160   ! brook    11535: <td>OCAML_USE_OPAM</td>
1.156     leot     11536: </tr>
                   11537: <tr>
1.159     rillig   11538: <td>OCAML_USE_OPT_COMPILER</td>
1.160   ! brook    11539: <td>OCAML_USE_TOPKG</td>
1.156     leot     11540: </tr>
                   11541: <tr>
1.159     rillig   11542: <td>OMF</td>
1.160   ! brook    11543: <td>ONLY_FOR_COMPILER</td>
1.156     leot     11544: </tr>
                   11545: <tr>
1.159     rillig   11546: <td>ONLY_FOR_PLATFORM</td>
1.160   ! brook    11547: <td>OPENSSH_CHROOT</td>
1.156     leot     11548: </tr>
                   11549: <tr>
1.159     rillig   11550: <td>OPENSSH_GROUP</td>
1.160   ! brook    11551: <td>OPENSSH_USER</td>
1.156     leot     11552: </tr>
                   11553: <tr>
1.159     rillig   11554: <td>OPSYS</td>
1.160   ! brook    11555: <td>OPSYS_EMULDIR</td>
1.156     leot     11556: </tr>
                   11557: <tr>
1.159     rillig   11558: <td>OSS_TYPE</td>
1.160   ! brook    11559: <td>OSX</td>
1.156     leot     11560: </tr>
                   11561: <tr>
1.159     rillig   11562: <td>OSX_TOLERATE_SDK_SKEW</td>
1.160   ! brook    11563: <td>OS_VARIANT</td>
1.159     rillig   11564: </tr>
                   11565: <tr>
                   11566: <td>OS_VERSION</td>
1.160   ! brook    11567: <td>OTF_FONTS_DIR</td>
1.156     leot     11568: </tr>
                   11569: <tr>
1.159     rillig   11570: <td>OVERRIDE_DIRDEPTH</td>
1.160   ! brook    11571: <td>OVERRIDE_GEMSPEC</td>
1.156     leot     11572: </tr>
                   11573: <tr>
1.159     rillig   11574: <td>OVERRIDE_GNU_CONFIG_SCRIPTS</td>
1.158     brook    11575: <td>OWN_DIRS</td>
1.156     leot     11576: </tr>
                   11577: <tr>
1.157     leot     11578: <td>OWN_DIRS_PERMS</td>
1.158     brook    11579: <td>P4GROUP</td>
1.156     leot     11580: </tr>
                   11581: <tr>
1.157     leot     11582: <td>P4PORT</td>
1.158     brook    11583: <td>P4ROOT</td>
1.156     leot     11584: </tr>
                   11585: <tr>
1.157     leot     11586: <td>P4USER</td>
1.158     brook    11587: <td>PACKAGES</td>
1.156     leot     11588: </tr>
                   11589: <tr>
1.157     leot     11590: <td>PALMOS_DEFAULT_SDK</td>
1.158     brook    11591: <td>PAMBASE</td>
1.156     leot     11592: </tr>
                   11593: <tr>
1.157     leot     11594: <td>PAM_DEFAULT</td>
1.158     brook    11595: <td>PAPERSIZE</td>
1.156     leot     11596: </tr>
                   11597: <tr>
1.157     leot     11598: <td>PASSIVE_FETCH</td>
1.158     brook    11599: <td>PATCHDIR</td>
1.156     leot     11600: </tr>
                   11601: <tr>
1.157     leot     11602: <td>PATCHFILES</td>
1.158     brook    11603: <td>PATCH_ARGS</td>
1.156     leot     11604: </tr>
                   11605: <tr>
1.157     leot     11606: <td>PATCH_DEBUG</td>
1.158     brook    11607: <td>PATCH_DIST_ARGS</td>
1.156     leot     11608: </tr>
                   11609: <tr>
1.157     leot     11610: <td>PATCH_DIST_CAT</td>
1.158     brook    11611: <td>PATCH_DIST_STRIP</td>
1.156     leot     11612: </tr>
                   11613: <tr>
1.157     leot     11614: <td>PATCH_FUZZ_FACTOR</td>
1.158     brook    11615: <td>PATCH_STRIP</td>
1.156     leot     11616: </tr>
                   11617: <tr>
1.157     leot     11618: <td>PATH</td>
1.156     leot     11619: <td>PCCBASE</td>
                   11620: </tr>
                   11621: <tr>
1.157     leot     11622: <td>PEAR_CMD</td>
1.158     brook    11623: <td>PEAR_LIB</td>
1.156     leot     11624: </tr>
                   11625: <tr>
1.157     leot     11626: <td>PEAR_PACKAGE_XML</td>
1.158     brook    11627: <td>PERL5</td>
1.156     leot     11628: </tr>
                   11629: <tr>
1.157     leot     11630: <td>PERL5_CONFIGURE</td>
1.158     brook    11631: <td>PERL5_CONFIGURE_DIRS</td>
1.156     leot     11632: </tr>
                   11633: <tr>
1.157     leot     11634: <td>PERL5_LDFLAGS</td>
1.158     brook    11635: <td>PERL5_LICENSE</td>
1.156     leot     11636: </tr>
                   11637: <tr>
1.157     leot     11638: <td>PERL5_MODULE_TYPE</td>
1.158     brook    11639: <td>PERL5_PACKLIST</td>
1.156     leot     11640: </tr>
                   11641: <tr>
1.157     leot     11642: <td>PERL5_PACKLIST_DIR</td>
1.158     brook    11643: <td>PERL5_PERLBASE</td>
1.156     leot     11644: </tr>
                   11645: <tr>
1.157     leot     11646: <td>PERL5_SITEBASE</td>
1.158     brook    11647: <td>PERL5_USE_PACKLIST</td>
1.156     leot     11648: </tr>
                   11649: <tr>
1.157     leot     11650: <td>PERL5_VENDORBASE</td>
1.158     brook    11651: <td>PFCTL</td>
1.156     leot     11652: </tr>
                   11653: <tr>
1.157     leot     11654: <td>PFVAR_H</td>
1.158     brook    11655: <td>PF_VERSION</td>
1.156     leot     11656: </tr>
                   11657: <tr>
1.157     leot     11658: <td>PGGROUP</td>
1.158     brook    11659: <td>PGHOME</td>
1.156     leot     11660: </tr>
                   11661: <tr>
1.157     leot     11662: <td>PGPKGSRCDIR</td>
1.158     brook    11663: <td>PGSQL_TYPE</td>
1.156     leot     11664: </tr>
                   11665: <tr>
1.157     leot     11666: <td>PGSQL_VERSIONS_ACCEPTED</td>
1.158     brook    11667: <td>PGSQL_VERSION_DEFAULT</td>
1.156     leot     11668: </tr>
                   11669: <tr>
1.157     leot     11670: <td>PGUSER</td>
1.158     brook    11671: <td>PG_LIB_EXT</td>
1.156     leot     11672: </tr>
                   11673: <tr>
1.157     leot     11674: <td>PHP</td>
1.158     brook    11675: <td>PHPCOMMON_MK</td>
1.156     leot     11676: </tr>
                   11677: <tr>
1.157     leot     11678: <td>PHPPKGSRCDIR</td>
1.158     brook    11679: <td>PHP_BASE_VERS</td>
1.156     leot     11680: </tr>
                   11681: <tr>
1.157     leot     11682: <td>PHP_CHECK_INSTALLED</td>
1.158     brook    11683: <td>PHP_EXTENSION_DIR</td>
1.156     leot     11684: </tr>
                   11685: <tr>
1.157     leot     11686: <td>PHP_INITIAL_TEENY</td>
1.158     brook    11687: <td>PHP_PKG_PREFIX</td>
1.156     leot     11688: </tr>
                   11689: <tr>
1.157     leot     11690: <td>PHP_VERSION</td>
1.158     brook    11691: <td>PHP_VERSIONS_ACCEPTED</td>
1.156     leot     11692: </tr>
                   11693: <tr>
1.157     leot     11694: <td>PHP_VERSIONS_INCOMPATIBLE</td>
1.158     brook    11695: <td>PHP_VERSION_DEFAULT</td>
1.156     leot     11696: </tr>
                   11697: <tr>
1.157     leot     11698: <td>PHP_VERSION_REQD</td>
1.158     brook    11699: <td>PILRC_USE_GTK</td>
1.156     leot     11700: </tr>
                   11701: <tr>
1.157     leot     11702: <td>PKGCONFIG_BASE</td>
1.158     brook    11703: <td>PKGCONFIG_FILE</td>
1.156     leot     11704: </tr>
                   11705: <tr>
1.157     leot     11706: <td>PKGCONFIG_OVERRIDE</td>
1.158     brook    11707: <td>PKGCONFIG_OVERRIDE_STAGE</td>
1.156     leot     11708: </tr>
                   11709: <tr>
1.157     leot     11710: <td>PKGDIR</td>
1.158     brook    11711: <td>PKGGNUDIR</td>
1.156     leot     11712: </tr>
                   11713: <tr>
1.157     leot     11714: <td>PKGINFODIR</td>
1.158     brook    11715: <td>PKGLOCALEDIR</td>
1.156     leot     11716: </tr>
                   11717: <tr>
1.157     leot     11718: <td>PKGMANDIR</td>
1.158     brook    11719: <td>PKGNAME</td>
1.156     leot     11720: </tr>
                   11721: <tr>
1.157     leot     11722: <td>PKGNAME_REQD</td>
1.158     brook    11723: <td>PKGPATH</td>
1.156     leot     11724: </tr>
                   11725: <tr>
1.157     leot     11726: <td>PKGREVISION</td>
1.160   ! brook    11727: <td>PKGSRC_CHANGES</td>
1.159     rillig   11728: </tr>
                   11729: <tr>
                   11730: <td>PKGSRC_COMPILER</td>
1.160   ! brook    11731: <td>PKGSRC_KEEP_BIN_PKGS</td>
1.156     leot     11732: </tr>
                   11733: <tr>
1.159     rillig   11734: <td>PKGSRC_LOCKTYPE</td>
1.160   ! brook    11735: <td>PKGSRC_MAKE_ENV</td>
1.156     leot     11736: </tr>
                   11737: <tr>
1.159     rillig   11738: <td>PKGSRC_MESSAGE_RECIPIENTS</td>
1.160   ! brook    11739: <td>PKGSRC_MKPIE</td>
1.156     leot     11740: </tr>
                   11741: <tr>
1.159     rillig   11742: <td>PKGSRC_MKREPRO</td>
1.160   ! brook    11743: <td>PKGSRC_RUN_TEST</td>
1.156     leot     11744: </tr>
                   11745: <tr>
1.159     rillig   11746: <td>PKGSRC_SETENV</td>
1.160   ! brook    11747: <td>PKGSRC_SLEEPSECS</td>
1.156     leot     11748: </tr>
                   11749: <tr>
1.159     rillig   11750: <td>PKGSRC_TODO</td>
1.160   ! brook    11751: <td>PKGSRC_USE_CTF</td>
1.156     leot     11752: </tr>
                   11753: <tr>
1.159     rillig   11754: <td>PKGSRC_USE_FORTIFY</td>
1.160   ! brook    11755: <td>PKGSRC_USE_RELRO</td>
1.156     leot     11756: </tr>
                   11757: <tr>
1.159     rillig   11758: <td>PKGSRC_USE_SSP</td>
1.160   ! brook    11759: <td>PKGSRC_USE_STACK_CHECK</td>
1.156     leot     11760: </tr>
                   11761: <tr>
1.159     rillig   11762: <td>PKGTASKS_DATAFILE</td>
1.160   ! brook    11763: <td>PKGTOOLS_ARGS</td>
1.156     leot     11764: </tr>
                   11765: <tr>
1.159     rillig   11766: <td>PKGTOOLS_ENV</td>
1.160   ! brook    11767: <td>PKG_ALTERNATIVES</td>
1.156     leot     11768: </tr>
                   11769: <tr>
1.159     rillig   11770: <td>PKG_APACHE</td>
1.160   ! brook    11771: <td>PKG_APACHE_ACCEPTED</td>
1.156     leot     11772: </tr>
                   11773: <tr>
1.159     rillig   11774: <td>PKG_APACHE_DEFAULT</td>
1.160   ! brook    11775: <td>PKG_BEST_EXISTS</td>
1.156     leot     11776: </tr>
                   11777: <tr>
1.159     rillig   11778: <td>PKG_BUILD_OPTIONS</td>
1.160   ! brook    11779: <td>PKG_COMPRESSION</td>
1.156     leot     11780: </tr>
                   11781: <tr>
1.159     rillig   11782: <td>PKG_CONFIG</td>
1.160   ! brook    11783: <td>PKG_CONFIG_PERMS</td>
1.156     leot     11784: </tr>
                   11785: <tr>
1.159     rillig   11786: <td>PKG_CREATE_USERGROUP</td>
1.160   ! brook    11787: <td>PKG_DB_TMPDIR</td>
1.156     leot     11788: </tr>
                   11789: <tr>
1.159     rillig   11790: <td>PKG_DEBUG_LEVEL</td>
1.160   ! brook    11791: <td>PKG_DEFAULT_OPTIONS</td>
1.156     leot     11792: </tr>
                   11793: <tr>
1.159     rillig   11794: <td>PKG_DESTDIR_SUPPORT</td>
1.160   ! brook    11795: <td>PKG_DEVELOPER</td>
1.156     leot     11796: </tr>
                   11797: <tr>
1.159     rillig   11798: <td>PKG_DISABLED_OPTIONS</td>
1.160   ! brook    11799: <td>PKG_FATAL_ERRORS</td>
1.156     leot     11800: </tr>
                   11801: <tr>
1.159     rillig   11802: <td>PKG_FC</td>
1.160   ! brook    11803: <td>PKG_FILELIST_CMD</td>
1.156     leot     11804: </tr>
                   11805: <tr>
1.159     rillig   11806: <td>PKG_GECOS</td>
1.160   ! brook    11807: <td>PKG_GID</td>
1.156     leot     11808: </tr>
                   11809: <tr>
1.159     rillig   11810: <td>PKG_GROUPS</td>
1.160   ! brook    11811: <td>PKG_GROUPS_VARS</td>
1.156     leot     11812: </tr>
                   11813: <tr>
1.159     rillig   11814: <td>PKG_HOME</td>
1.160   ! brook    11815: <td>PKG_INIT_SCRIPTS</td>
1.156     leot     11816: </tr>
                   11817: <tr>
1.159     rillig   11818: <td>PKG_JAVA_HOME</td>
1.160   ! brook    11819: <td>PKG_JVM</td>
1.156     leot     11820: </tr>
                   11821: <tr>
1.159     rillig   11822: <td>PKG_JVMS_ACCEPTED</td>
1.160   ! brook    11823: <td>PKG_JVM_DEFAULT</td>
1.156     leot     11824: </tr>
                   11825: <tr>
1.159     rillig   11826: <td>PKG_LEGACY_OPTIONS</td>
1.160   ! brook    11827: <td>PKG_LIBTOOL</td>
1.156     leot     11828: </tr>
                   11829: <tr>
1.159     rillig   11830: <td>PKG_OPTIONS</td>
1.160   ! brook    11831: <td>PKG_OPTIONS_DEPRECATED_WARNINGS</td>
1.156     leot     11832: </tr>
                   11833: <tr>
1.159     rillig   11834: <td>PKG_OPTIONS_LEGACY_OPTS</td>
1.160   ! brook    11835: <td>PKG_OPTIONS_LEGACY_VARS</td>
1.156     leot     11836: </tr>
                   11837: <tr>
1.159     rillig   11838: <td>PKG_OPTIONS_NONEMPTY_SETS</td>
1.160   ! brook    11839: <td>PKG_OPTIONS_OPTIONAL_GROUPS</td>
1.156     leot     11840: </tr>
                   11841: <tr>
1.159     rillig   11842: <td>PKG_OPTIONS_REQUIRED_GROUPS</td>
1.160   ! brook    11843: <td>PKG_OPTIONS_VAR</td>
1.156     leot     11844: </tr>
                   11845: <tr>
1.159     rillig   11846: <td>PKG_PHP</td>
1.160   ! brook    11847: <td>PKG_PHP_MAJOR_VERS</td>
1.156     leot     11848: </tr>
                   11849: <tr>
1.159     rillig   11850: <td>PKG_PHP_VERSION</td>
1.160   ! brook    11851: <td>PKG_RCD_SCRIPTS</td>
1.156     leot     11852: </tr>
                   11853: <tr>
1.159     rillig   11854: <td>PKG_REFCOUNT_DBDIR</td>
1.160   ! brook    11855: <td>PKG_REGISTER_SHELLS</td>
1.156     leot     11856: </tr>
                   11857: <tr>
1.159     rillig   11858: <td>PKG_RESUME_TRANSFERS</td>
1.160   ! brook    11859: <td>PKG_SHELL</td>
1.156     leot     11860: </tr>
                   11861: <tr>
1.159     rillig   11862: <td>PKG_SUGGESTED_OPTIONS</td>
1.160   ! brook    11863: <td>PKG_SUPPORTED_OPTIONS</td>
1.156     leot     11864: </tr>
                   11865: <tr>
1.159     rillig   11866: <td>PKG_SYSCONFBASE</td>
1.160   ! brook    11867: <td>PKG_SYSCONFBASEDIR</td>
1.156     leot     11868: </tr>
                   11869: <tr>
1.159     rillig   11870: <td>PKG_SYSCONFDIR</td>
1.160   ! brook    11871: <td>PKG_SYSCONFDIR_PERMS</td>
1.156     leot     11872: </tr>
                   11873: <tr>
1.159     rillig   11874: <td>PKG_SYSCONFSUBDIR</td>
1.160   ! brook    11875: <td>PKG_SYSCONFVAR</td>
1.156     leot     11876: </tr>
                   11877: <tr>
1.159     rillig   11878: <td>PKG_TOOLS_BIN</td>
1.160   ! brook    11879: <td>PKG_UID</td>
1.156     leot     11880: </tr>
                   11881: <tr>
1.159     rillig   11882: <td>PKG_UPDATE_FONTS_DB</td>
1.160   ! brook    11883: <td>PKG_USERS</td>
1.156     leot     11884: </tr>
                   11885: <tr>
1.159     rillig   11886: <td>PKG_USERS_VARS</td>
1.160   ! brook    11887: <td>PKG_VERBOSE</td>
1.156     leot     11888: </tr>
                   11889: <tr>
1.159     rillig   11890: <td>PLIST</td>
1.160   ! brook    11891: <td>PLIST_AWK</td>
1.156     leot     11892: </tr>
                   11893: <tr>
1.159     rillig   11894: <td>PLIST_AWK_ENV</td>
1.160   ! brook    11895: <td>PLIST_SRC</td>
1.156     leot     11896: </tr>
                   11897: <tr>
1.159     rillig   11898: <td>PLIST_SUBST</td>
1.160   ! brook    11899: <td>PLIST_TYPE</td>
1.156     leot     11900: </tr>
                   11901: <tr>
1.159     rillig   11902: <td>PLIST_VARS</td>
1.160   ! brook    11903: <td>POPTOP_USE_MPPE</td>
1.156     leot     11904: </tr>
                   11905: <tr>
1.159     rillig   11906: <td>POST_FETCH_HOOK</td>
1.160   ! brook    11907: <td>PREFER</td>
1.156     leot     11908: </tr>
                   11909: <tr>
1.159     rillig   11910: <td>PREFER_NATIVE</td>
1.160   ! brook    11911: <td>PREFER_NATIVE_PTHREADS</td>
1.156     leot     11912: </tr>
                   11913: <tr>
1.159     rillig   11914: <td>PREFER_PKGSRC</td>
1.160   ! brook    11915: <td>PREFIX</td>
1.156     leot     11916: </tr>
                   11917: <tr>
1.159     rillig   11918: <td>PREPEND_PATH</td>
1.160   ! brook    11919: <td>PRE_ROOT_CMD</td>
1.156     leot     11920: </tr>
                   11921: <tr>
1.159     rillig   11922: <td>PRIVILEGED_STAGES</td>
1.160   ! brook    11923: <td>PS</td>
1.156     leot     11924: </tr>
                   11925: <tr>
1.159     rillig   11926: <td>PTHREAD_AUTO_VARS</td>
1.160   ! brook    11927: <td>PTHREAD_CFLAGS</td>
1.156     leot     11928: </tr>
                   11929: <tr>
1.159     rillig   11930: <td>PTHREAD_LDFLAGS</td>
1.160   ! brook    11931: <td>PTHREAD_LIBS</td>
1.156     leot     11932: </tr>
                   11933: <tr>
1.159     rillig   11934: <td>PTHREAD_OPTS</td>
1.160   ! brook    11935: <td>PTHREAD_TYPE</td>
1.156     leot     11936: </tr>
                   11937: <tr>
1.159     rillig   11938: <td>PVM_SSH</td>
1.160   ! brook    11939: <td>PYPKGPREFIX</td>
1.156     leot     11940: </tr>
                   11941: <tr>
1.159     rillig   11942: <td>PYTHON_FOR_BUILD_ONLY</td>
1.160   ! brook    11943: <td>PYTHON_SELF_CONFLICT</td>
1.156     leot     11944: </tr>
                   11945: <tr>
1.159     rillig   11946: <td>PYTHON_VERSIONED_DEPENDENCIES</td>
1.160   ! brook    11947: <td>PYTHON_VERSIONS_ACCEPTED</td>
1.156     leot     11948: </tr>
                   11949: <tr>
1.159     rillig   11950: <td>PYTHON_VERSIONS_INCOMPATIBLE</td>
1.160   ! brook    11951: <td>PYTHON_VERSION_DEFAULT</td>
1.156     leot     11952: </tr>
                   11953: <tr>
1.159     rillig   11954: <td>PYTHON_VERSION_REQD</td>
1.160   ! brook    11955: <td>PYVERSSUFFIX</td>
1.156     leot     11956: </tr>
                   11957: <tr>
1.159     rillig   11958: <td>PY_NO_EGG</td>
1.160   ! brook    11959: <td>QMAILDIR</td>
1.156     leot     11960: </tr>
                   11961: <tr>
1.159     rillig   11962: <td>QMAIL_ALIAS_USER</td>
1.160   ! brook    11963: <td>QMAIL_DAEMON_USER</td>
1.156     leot     11964: </tr>
                   11965: <tr>
1.159     rillig   11966: <td>QMAIL_LOG_USER</td>
1.160   ! brook    11967: <td>QMAIL_NOFILES_GROUP</td>
1.156     leot     11968: </tr>
                   11969: <tr>
1.159     rillig   11970: <td>QMAIL_PASSWD_USER</td>
1.160   ! brook    11971: <td>QMAIL_QMAIL_GROUP</td>
1.156     leot     11972: </tr>
                   11973: <tr>
1.159     rillig   11974: <td>QMAIL_QUEUE_DIR</td>
1.160   ! brook    11975: <td>QMAIL_QUEUE_EXTRA</td>
1.156     leot     11976: </tr>
                   11977: <tr>
1.159     rillig   11978: <td>QMAIL_QUEUE_USER</td>
1.160   ! brook    11979: <td>QMAIL_REMOTE_USER</td>
1.156     leot     11980: </tr>
                   11981: <tr>
1.159     rillig   11982: <td>QMAIL_ROOT_USER</td>
1.160   ! brook    11983: <td>QMAIL_SEND_USER</td>
1.156     leot     11984: </tr>
                   11985: <tr>
1.159     rillig   11986: <td>QPOPPER_FAC</td>
1.160   ! brook    11987: <td>QPOPPER_SPOOL_DIR</td>
1.156     leot     11988: </tr>
                   11989: <tr>
1.159     rillig   11990: <td>QPOPPER_USER</td>
1.160   ! brook    11991: <td>RAKE_NAME</td>
1.156     leot     11992: </tr>
                   11993: <tr>
1.159     rillig   11994: <td>RASMOL_DEPTH</td>
1.160   ! brook    11995: <td>RCD_SCRIPTS</td>
1.159     rillig   11996: </tr>
                   11997: <tr>
                   11998: <td>RCD_SCRIPTS_DIR</td>
1.160   ! brook    11999: <td>RCD_SCRIPTS_EXAMPLEDIR</td>
1.156     leot     12000: </tr>
                   12001: <tr>
1.159     rillig   12002: <td>RCD_SCRIPTS_MODE</td>
1.160   ! brook    12003: <td>RCD_SCRIPTS_SHELL</td>
1.156     leot     12004: </tr>
                   12005: <tr>
1.159     rillig   12006: <td>RCD_SCRIPT_SRC</td>
1.157     leot     12007: <td>RDOC</td>
1.156     leot     12008: </tr>
                   12009: <tr>
                   12010: <td>READLINE_DEFAULT</td>
1.157     leot     12011: <td>READLINE_TYPE</td>
1.156     leot     12012: </tr>
                   12013: <tr>
                   12014: <td>REAL_ROOT_GROUP</td>
1.157     leot     12015: <td>REAL_ROOT_USER</td>
1.156     leot     12016: </tr>
                   12017: <tr>
                   12018: <td>RECURSIVE_MAKE</td>
1.157     leot     12019: <td>RELAY_CTRL_DIR</td>
1.156     leot     12020: </tr>
                   12021: <tr>
                   12022: <td>REPLACE_AWK</td>
1.157     leot     12023: <td>REPLACE_BASH</td>
1.156     leot     12024: </tr>
                   12025: <tr>
                   12026: <td>REPLACE_CSH</td>
1.157     leot     12027: <td>REPLACE_KSH</td>
1.156     leot     12028: </tr>
                   12029: <tr>
                   12030: <td>REPLACE_PERL</td>
1.157     leot     12031: <td>REPLACE_PERL6</td>
1.156     leot     12032: </tr>
                   12033: <tr>
                   12034: <td>REPLACE_PYTHON</td>
1.157     leot     12035: <td>REPLACE_RUBY</td>
1.156     leot     12036: </tr>
                   12037: <tr>
                   12038: <td>REPLACE_RUBY_DIRS</td>
1.157     leot     12039: <td>REPLACE_RUBY_PAT</td>
1.156     leot     12040: </tr>
                   12041: <tr>
                   12042: <td>REPLACE_SH</td>
1.157     leot     12043: <td>REPLACE_TEXLUA</td>
1.156     leot     12044: </tr>
                   12045: <tr>
                   12046: <td>REQD_DIRS</td>
1.157     leot     12047: <td>REQD_DIRS_PERMS</td>
1.156     leot     12048: </tr>
                   12049: <tr>
                   12050: <td>REQD_FILES</td>
1.157     leot     12051: <td>REQD_FILES_MODE</td>
1.156     leot     12052: </tr>
                   12053: <tr>
                   12054: <td>REQD_FILES_PERMS</td>
1.157     leot     12055: <td>RESOLV_AUTO_VARS</td>
1.156     leot     12056: </tr>
                   12057: <tr>
                   12058: <td>RESOLV_LDFLAGS</td>
1.157     leot     12059: <td>RESOLV_LIBS</td>
1.156     leot     12060: </tr>
                   12061: <tr>
                   12062: <td>RM</td>
1.157     leot     12063: <td>ROOT_CMD</td>
1.156     leot     12064: </tr>
                   12065: <tr>
                   12066: <td>ROOT_GROUP</td>
1.157     leot     12067: <td>ROOT_USER</td>
1.156     leot     12068: </tr>
                   12069: <tr>
                   12070: <td>RPCGEN</td>
1.157     leot     12071: <td>RPM</td>
1.156     leot     12072: </tr>
                   12073: <tr>
                   12074: <td>RPM2PKG_PLIST</td>
1.157     leot     12075: <td>RPM2PKG_PREFIX</td>
1.156     leot     12076: </tr>
                   12077: <tr>
                   12078: <td>RPM2PKG_STAGE</td>
1.157     leot     12079: <td>RPM2PKG_STRIP</td>
1.156     leot     12080: </tr>
                   12081: <tr>
                   12082: <td>RPM2PKG_SUBPREFIX</td>
1.157     leot     12083: <td>RPMFILES</td>
1.156     leot     12084: </tr>
                   12085: <tr>
                   12086: <td>RPMIGNOREPATH</td>
1.157     leot     12087: <td>RPM_DB_PREFIX</td>
1.156     leot     12088: </tr>
                   12089: <tr>
                   12090: <td>RSSH_CVS_PATH</td>
1.157     leot     12091: <td>RSSH_RDIST_PATH</td>
1.156     leot     12092: </tr>
                   12093: <tr>
                   12094: <td>RSSH_RSYNC_PATH</td>
1.157     leot     12095: <td>RSSH_SCP_PATH</td>
1.156     leot     12096: </tr>
                   12097: <tr>
                   12098: <td>RSSH_SFTP_SERVER_PATH</td>
1.157     leot     12099: <td>RUBY</td>
1.156     leot     12100: </tr>
                   12101: <tr>
                   12102: <td>RUBYGEM</td>
1.157     leot     12103: <td>RUBYGEM_NAME</td>
1.156     leot     12104: </tr>
                   12105: <tr>
                   12106: <td>RUBYGEM_OPTIONS</td>
1.157     leot     12107: <td>RUBY_ABI_VERSION</td>
1.156     leot     12108: </tr>
                   12109: <tr>
                   12110: <td>RUBY_ARCH</td>
1.157     leot     12111: <td>RUBY_ARCHINC</td>
1.156     leot     12112: </tr>
                   12113: <tr>
                   12114: <td>RUBY_ARCHLIB</td>
1.157     leot     12115: <td>RUBY_BASE</td>
1.156     leot     12116: </tr>
                   12117: <tr>
                   12118: <td>RUBY_BASERIDIR</td>
1.157     leot     12119: <td>RUBY_BUILD_RDOC</td>
1.156     leot     12120: </tr>
                   12121: <tr>
                   12122: <td>RUBY_BUILD_RI</td>
1.157     leot     12123: <td>RUBY_DLEXT</td>
1.156     leot     12124: </tr>
                   12125: <tr>
                   12126: <td>RUBY_DOC</td>
1.157     leot     12127: <td>RUBY_DYNAMIC_DIRS</td>
1.156     leot     12128: </tr>
                   12129: <tr>
                   12130: <td>RUBY_EG</td>
1.157     leot     12131: <td>RUBY_ENCODING_ARG</td>
1.156     leot     12132: </tr>
                   12133: <tr>
                   12134: <td>RUBY_EXTCONF</td>
1.157     leot     12135: <td>RUBY_EXTCONF_CHECK</td>
1.156     leot     12136: </tr>
                   12137: <tr>
                   12138: <td>RUBY_EXTCONF_DEBUG</td>
1.157     leot     12139: <td>RUBY_EXTCONF_MAKEFILE</td>
1.156     leot     12140: </tr>
                   12141: <tr>
                   12142: <td>RUBY_GEM_BASE</td>
1.157     leot     12143: <td>RUBY_INC</td>
1.156     leot     12144: </tr>
                   12145: <tr>
                   12146: <td>RUBY_LIB</td>
1.157     leot     12147: <td>RUBY_LIB_BASE</td>
1.156     leot     12148: </tr>
                   12149: <tr>
                   12150: <td>RUBY_NAME</td>
1.157     leot     12151: <td>RUBY_NOVERSION</td>
1.156     leot     12152: </tr>
                   12153: <tr>
                   12154: <td>RUBY_PKGPREFIX</td>
1.157     leot     12155: <td>RUBY_RAILS</td>
1.156     leot     12156: </tr>
                   12157: <tr>
                   12158: <td>RUBY_RAILS42_VERSION</td>
1.157     leot     12159: <td>RUBY_RAILS51_VERSION</td>
1.156     leot     12160: </tr>
                   12161: <tr>
                   12162: <td>RUBY_RAILS52_VERSION</td>
1.157     leot     12163: <td>RUBY_RAILS_ACCEPTED</td>
1.156     leot     12164: </tr>
                   12165: <tr>
                   12166: <td>RUBY_RAILS_DEFAULT</td>
1.157     leot     12167: <td>RUBY_RAILS_REQD</td>
1.156     leot     12168: </tr>
                   12169: <tr>
                   12170: <td>RUBY_RAILS_STRICT_DEP</td>
1.157     leot     12171: <td>RUBY_RIDIR</td>
1.156     leot     12172: </tr>
                   12173: <tr>
                   12174: <td>RUBY_SETUP</td>
1.157     leot     12175: <td>RUBY_SHLIB</td>
1.156     leot     12176: </tr>
                   12177: <tr>
                   12178: <td>RUBY_SHLIBALIAS</td>
1.157     leot     12179: <td>RUBY_SHLIBVER</td>
1.156     leot     12180: </tr>
                   12181: <tr>
                   12182: <td>RUBY_SIMPLE_INSTALL</td>
1.157     leot     12183: <td>RUBY_SITEARCHLIB</td>
1.156     leot     12184: </tr>
                   12185: <tr>
                   12186: <td>RUBY_SITELIB</td>
1.157     leot     12187: <td>RUBY_SITELIB_BASE</td>
1.156     leot     12188: </tr>
                   12189: <tr>
                   12190: <td>RUBY_SITERIDIR</td>
1.157     leot     12191: <td>RUBY_SLEXT</td>
1.156     leot     12192: </tr>
                   12193: <tr>
                   12194: <td>RUBY_SRCDIR</td>
1.157     leot     12195: <td>RUBY_STATICLIB</td>
1.156     leot     12196: </tr>
                   12197: <tr>
                   12198: <td>RUBY_SUFFIX</td>
1.157     leot     12199: <td>RUBY_SYSRIDIR</td>
1.156     leot     12200: </tr>
                   12201: <tr>
                   12202: <td>RUBY_USE_PTHREAD</td>
1.157     leot     12203: <td>RUBY_VENDORARCHLIB</td>
1.156     leot     12204: </tr>
                   12205: <tr>
                   12206: <td>RUBY_VENDORLIB</td>
1.157     leot     12207: <td>RUBY_VENDORLIB_BASE</td>
1.156     leot     12208: </tr>
                   12209: <tr>
                   12210: <td>RUBY_VER</td>
1.157     leot     12211: <td>RUBY_VERSION</td>
1.156     leot     12212: </tr>
                   12213: <tr>
                   12214: <td>RUBY_VERSIONS_ACCEPTED</td>
1.157     leot     12215: <td>RUBY_VERSION_DEFAULT</td>
1.156     leot     12216: </tr>
                   12217: <tr>
                   12218: <td>RUBY_VERSION_REQD</td>
1.157     leot     12219: <td>RUBY_VER_DIR</td>
1.156     leot     12220: </tr>
                   12221: <tr>
                   12222: <td>RUN</td>
1.157     leot     12223: <td>RUN_LDCONFIG</td>
1.156     leot     12224: </tr>
                   12225: <tr>
                   12226: <td>SAWFISH_THEMES</td>
1.157     leot     12227: <td>SCO</td>
1.156     leot     12228: </tr>
                   12229: <tr>
                   12230: <td>SCREWS_GROUP</td>
1.157     leot     12231: <td>SCREWS_USER</td>
1.156     leot     12232: </tr>
                   12233: <tr>
                   12234: <td>SCRIPTS_ENV</td>
1.157     leot     12235: <td>SCROLLKEEPER_DATADIR</td>
1.156     leot     12236: </tr>
                   12237: <tr>
                   12238: <td>SCROLLKEEPER_REBUILDDB</td>
1.157     leot     12239: <td>SCROLLKEEPER_UPDATEDB</td>
1.156     leot     12240: </tr>
                   12241: <tr>
                   12242: <td>SDIST_PAWD</td>
1.157     leot     12243: <td>SERIAL_DEVICES</td>
1.156     leot     12244: </tr>
                   12245: <tr>
                   12246: <td>SETGIDGAME</td>
1.157     leot     12247: <td>SETGID_GAMES_PERMS</td>
1.156     leot     12248: </tr>
                   12249: <tr>
                   12250: <td>SETUID_ROOT_PERMS</td>
1.157     leot     12251: <td>SH</td>
1.156     leot     12252: </tr>
                   12253: <tr>
                   12254: <td>SHLIB</td>
1.160   ! brook    12255: <td>SIGN_PACKAGES</td>
1.159     rillig   12256: </tr>
                   12257: <tr>
                   12258: <td>SILC_CLIENT_WITH_PERL</td>
1.160   ! brook    12259: <td>SITE_SPECIFIC_PKGS</td>
1.156     leot     12260: </tr>
                   12261: <tr>
1.159     rillig   12262: <td>SKIP_DEPENDS</td>
1.160   ! brook    12263: <td>SKIP_PORTABILITY_CHECK</td>
1.156     leot     12264: </tr>
                   12265: <tr>
1.159     rillig   12266: <td>SMF_INSTANCES</td>
1.160   ! brook    12267: <td>SMF_MANIFEST</td>
1.156     leot     12268: </tr>
                   12269: <tr>
1.159     rillig   12270: <td>SMF_METHODS</td>
1.160   ! brook    12271: <td>SMF_METHOD_SHELL</td>
1.156     leot     12272: </tr>
                   12273: <tr>
1.159     rillig   12274: <td>SMF_METHOD_SRC</td>
1.160   ! brook    12275: <td>SMF_NAME</td>
1.156     leot     12276: </tr>
                   12277: <tr>
1.159     rillig   12278: <td>SMF_PREFIX</td>
1.160   ! brook    12279: <td>SMF_SRCDIR</td>
1.156     leot     12280: </tr>
                   12281: <tr>
1.159     rillig   12282: <td>SNIPROXY_GROUP</td>
1.160   ! brook    12283: <td>SNIPROXY_USER</td>
1.156     leot     12284: </tr>
                   12285: <tr>
1.159     rillig   12286: <td>SOURCE_BUFFSIZE</td>
1.160   ! brook    12287: <td>SPECIAL_PERMS</td>
1.156     leot     12288: </tr>
                   12289: <tr>
1.159     rillig   12290: <td>SPECIFIC_PKGS</td>
1.160   ! brook    12291: <td>SSH_SUID</td>
1.156     leot     12292: </tr>
                   12293: <tr>
1.159     rillig   12294: <td>SSYNC_PAWD</td>
1.160   ! brook    12295: <td>STEP_MSG</td>
1.156     leot     12296: </tr>
                   12297: <tr>
1.159     rillig   12298: <td>STRIP</td>
1.160   ! brook    12299: <td>STRIP_DBG</td>
1.156     leot     12300: </tr>
                   12301: <tr>
1.159     rillig   12302: <td>STRIP_DEBUG</td>
1.160   ! brook    12303: <td>STRIP_DEBUG_SUPPORTED</td>
1.156     leot     12304: </tr>
                   12305: <tr>
1.159     rillig   12306: <td>STRIP_FILES_SKIP</td>
1.160   ! brook    12307: <td>SU</td>
1.156     leot     12308: </tr>
                   12309: <tr>
1.159     rillig   12310: <td>SUBDIR</td>
1.160   ! brook    12311: <td>SUBST_CLASSES</td>
1.156     leot     12312: </tr>
                   12313: <tr>
1.159     rillig   12314: <td>SUBST_FILES</td>
1.160   ! brook    12315: <td>SUBST_FILTER_CMD</td>
1.156     leot     12316: </tr>
                   12317: <tr>
1.159     rillig   12318: <td>SUBST_MESSAGE</td>
1.160   ! brook    12319: <td>SUBST_SED</td>
1.156     leot     12320: </tr>
                   12321: <tr>
1.159     rillig   12322: <td>SUBST_SHOW_DIFF</td>
1.160   ! brook    12323: <td>SUBST_SKIP_TEXT_CHECK</td>
1.156     leot     12324: </tr>
                   12325: <tr>
1.159     rillig   12326: <td>SUBST_STAGE</td>
1.160   ! brook    12327: <td>SUBST_VARS</td>
1.156     leot     12328: </tr>
                   12329: <tr>
1.159     rillig   12330: <td>SUNWSPROBASE</td>
1.160   ! brook    12331: <td>SUSE_PREFER</td>
1.156     leot     12332: </tr>
                   12333: <tr>
1.159     rillig   12334: <td>SU_CMD</td>
1.160   ! brook    12335: <td>TERMCAP_TYPE</td>
1.159     rillig   12336: </tr>
                   12337: <tr>
                   12338: <td>TERMINFO_DEFAULT</td>
1.160   ! brook    12339: <td>TERMINFO_TYPE</td>
1.156     leot     12340: </tr>
                   12341: <tr>
1.159     rillig   12342: <td>TEST</td>
1.160   ! brook    12343: <td>TEST_DEPENDS</td>
1.156     leot     12344: </tr>
                   12345: <tr>
1.159     rillig   12346: <td>TEST_DIRS</td>
1.160   ! brook    12347: <td>TEST_ENV</td>
1.156     leot     12348: </tr>
                   12349: <tr>
1.159     rillig   12350: <td>TEST_MAKE_CMD</td>
1.160   ! brook    12351: <td>TEST_MAKE_FLAGS</td>
1.156     leot     12352: </tr>
                   12353: <tr>
1.159     rillig   12354: <td>TEST_TARGET</td>
1.160   ! brook    12355: <td>TEXLIVE_IGNORE_PATTERNS</td>
1.156     leot     12356: </tr>
                   12357: <tr>
1.159     rillig   12358: <td>TEXLIVE_REV</td>
1.160   ! brook    12359: <td>TEXMFSITE</td>
1.156     leot     12360: </tr>
                   12361: <tr>
1.159     rillig   12362: <td>TEX_FORMATS</td>
1.160   ! brook    12363: <td>TEX_HYPHEN_DAT</td>
1.156     leot     12364: </tr>
                   12365: <tr>
1.159     rillig   12366: <td>TEX_HYPHEN_DEF</td>
1.160   ! brook    12367: <td>TEX_TEXMF_DIRS</td>
1.156     leot     12368: </tr>
                   12369: <tr>
1.159     rillig   12370: <td>THTTPD_LOG_FACILITY</td>
1.160   ! brook    12371: <td>TO</td>
1.156     leot     12372: </tr>
                   12373: <tr>
1.159     rillig   12374: <td>TOOLS_ALIASES</td>
1.160   ! brook    12375: <td>TOOLS_ARGS</td>
1.156     leot     12376: </tr>
                   12377: <tr>
1.159     rillig   12378: <td>TOOLS_BROKEN</td>
1.160   ! brook    12379: <td>TOOLS_CMD</td>
1.156     leot     12380: </tr>
                   12381: <tr>
1.159     rillig   12382: <td>TOOLS_CREATE</td>
1.160   ! brook    12383: <td>TOOLS_DIR</td>
1.156     leot     12384: </tr>
                   12385: <tr>
1.159     rillig   12386: <td>TOOLS_FAIL</td>
1.160   ! brook    12387: <td>TOOLS_GNU_MISSING</td>
1.156     leot     12388: </tr>
                   12389: <tr>
1.159     rillig   12390: <td>TOOLS_LDCONFIG</td>
1.160   ! brook    12391: <td>TOOLS_NOOP</td>
1.156     leot     12392: </tr>
                   12393: <tr>
1.159     rillig   12394: <td>TOOLS_PATH</td>
1.160   ! brook    12395: <td>TOOLS_SCRIPT</td>
1.156     leot     12396: </tr>
                   12397: <tr>
1.159     rillig   12398: <td>TOOL_DEPENDS</td>
1.157     leot     12399: <td>TTF_FONTS_DIR</td>
1.156     leot     12400: </tr>
                   12401: <tr>
                   12402: <td>TYPE</td>
1.157     leot     12403: <td>UAC_REQD_EXECS</td>
1.156     leot     12404: </tr>
                   12405: <tr>
                   12406: <td>UCSPI_SSL_GROUP</td>
1.157     leot     12407: <td>UCSPI_SSL_USER</td>
1.156     leot     12408: </tr>
                   12409: <tr>
                   12410: <td>UNLIMIT_RESOURCES</td>
1.157     leot     12411: <td>UNPRIVILEGED</td>
1.156     leot     12412: </tr>
                   12413: <tr>
                   12414: <td>UNPRIVILEGED_GROUP</td>
1.157     leot     12415: <td>UNPRIVILEGED_GROUPS</td>
1.156     leot     12416: </tr>
                   12417: <tr>
                   12418: <td>UNPRIVILEGED_USER</td>
1.157     leot     12419: <td>UNWRAP_FILES</td>
1.156     leot     12420: </tr>
                   12421: <tr>
                   12422: <td>UNWRAP_PATTERNS</td>
1.157     leot     12423: <td>UPDATE_GEMSPEC</td>
1.156     leot     12424: </tr>
                   12425: <tr>
                   12426: <td>UPDATE_TARGET</td>
1.157     leot     12427: <td>URI</td>
1.156     leot     12428: </tr>
                   12429: <tr>
                   12430: <td>USA</td>
1.157     leot     12431: <td>USERGROUP_PHASE</td>
1.156     leot     12432: </tr>
                   12433: <tr>
                   12434: <td>USERPPP_GROUP</td>
1.157     leot     12435: <td>USER_SPECIFIC_PKGS</td>
1.156     leot     12436: </tr>
                   12437: <tr>
                   12438: <td>USE_ABI_DEPENDS</td>
1.157     leot     12439: <td>USE_APR</td>
1.156     leot     12440: </tr>
                   12441: <tr>
                   12442: <td>USE_BSD_MAKEFILE</td>
1.157     leot     12443: <td>USE_BUILTIN</td>
1.156     leot     12444: </tr>
                   12445: <tr>
                   12446: <td>USE_CROSS_COMPILE</td>
1.157     leot     12447: <td>USE_CURSES</td>
1.156     leot     12448: </tr>
                   12449: <tr>
                   12450: <td>USE_CWRAPPERS</td>
1.157     leot     12451: <td>USE_DB185</td>
1.156     leot     12452: </tr>
                   12453: <tr>
                   12454: <td>USE_FEATURES</td>
1.157     leot     12455: <td>USE_GAMESGROUP</td>
1.156     leot     12456: </tr>
                   12457: <tr>
                   12458: <td>USE_GCC_RUNTIME</td>
1.157     leot     12459: <td>USE_IMAKE</td>
1.156     leot     12460: </tr>
                   12461: <tr>
                   12462: <td>USE_JAVA</td>
1.157     leot     12463: <td>USE_JAVA2</td>
1.156     leot     12464: </tr>
                   12465: <tr>
                   12466: <td>USE_LANGUAGES</td>
1.157     leot     12467: <td>USE_LIBTOOL</td>
1.156     leot     12468: </tr>
                   12469: <tr>
                   12470: <td>USE_NATIVE_GCC</td>
1.157     leot     12471: <td>USE_NETBSD_REPO</td>
1.156     leot     12472: </tr>
                   12473: <tr>
                   12474: <td>USE_PKGSRC_GCC</td>
1.157     leot     12475: <td>USE_PKGSRC_GCC_RUNTIME</td>
1.156     leot     12476: </tr>
                   12477: <tr>
                   12478: <td>USE_PKGTASKS</td>
1.157     leot     12479: <td>USE_RUBY_EXTCONF</td>
1.156     leot     12480: </tr>
                   12481: <tr>
                   12482: <td>USE_RUBY_INSTALL</td>
1.157     leot     12483: <td>USE_RUBY_SETUP</td>
1.156     leot     12484: </tr>
                   12485: <tr>
                   12486: <td>USE_RUBY_SETUP_PKG</td>
1.157     leot     12487: <td>USE_TOOLS</td>
1.156     leot     12488: </tr>
                   12489: <tr>
                   12490: <td>UUCP_GROUP</td>
1.157     leot     12491: <td>UUCP_USER</td>
1.156     leot     12492: </tr>
                   12493: <tr>
                   12494: <td>VARBASE</td>
1.157     leot     12495: <td>VARNAME</td>
1.156     leot     12496: </tr>
                   12497: <tr>
                   12498: <td>VIM_EXTRA_OPTS</td>
1.157     leot     12499: <td>WARNING_MSG</td>
1.156     leot     12500: </tr>
                   12501: <tr>
                   12502: <td>WCALC_CGIDIR</td>
1.157     leot     12503: <td>WCALC_CGIPATH</td>
1.156     leot     12504: </tr>
                   12505: <tr>
                   12506: <td>WCALC_HTMLDIR</td>
1.157     leot     12507: <td>WCALC_HTMLPATH</td>
1.156     leot     12508: </tr>
                   12509: <tr>
                   12510: <td>WDM_MANAGERS</td>
1.157     leot     12511: <td>WRAPPER_REORDER_CMDS</td>
1.156     leot     12512: </tr>
                   12513: <tr>
                   12514: <td>WRKDIR</td>
1.157     leot     12515: <td>WRKDIR_BASENAME</td>
1.156     leot     12516: </tr>
                   12517: <tr>
                   12518: <td>WRKDIR_LOCKTYPE</td>
1.157     leot     12519: <td>WRKLOG</td>
1.156     leot     12520: </tr>
                   12521: <tr>
                   12522: <td>WRKOBJDIR</td>
1.157     leot     12523: <td>WRKSRC</td>
1.156     leot     12524: </tr>
                   12525: <tr>
                   12526: <td>WXGTK_ACCEPTED</td>
1.157     leot     12527: <td>WXGTK_DEFAULT</td>
1.156     leot     12528: </tr>
                   12529: <tr>
                   12530: <td>X10_PORT</td>
1.157     leot     12531: <td>X11</td>
1.156     leot     12532: </tr>
                   12533: <tr>
                   12534: <td>X11BASE</td>
1.157     leot     12535: <td>X11_PKGSRCDIR</td>
1.156     leot     12536: </tr>
                   12537: <tr>
                   12538: <td>X11_TYPE</td>
1.157     leot     12539: <td>X509_CERTIFICATE</td>
1.156     leot     12540: </tr>
                   12541: <tr>
                   12542: <td>X509_KEY</td>
1.157     leot     12543: <td>XAW_TYPE</td>
1.156     leot     12544: </tr>
                   12545: <tr>
                   12546: <td>XLOCK_DEFAULT_MODE</td>
1.157     leot     12547: <td>XMKMF_FLAGS</td>
1.156     leot     12548: </tr>
                   12549: <tr>
                   12550: <td>XXX</td>
1.160   ! brook    12551: <td>YES</td>
1.159     rillig   12552: </tr>
                   12553: <tr>
                   12554: <td>ZERO_FILESIZE_P</td>
1.160   ! brook    12555: <td>ZSH_STATIC</td>
1.156     leot     12556: </tr>
                   12557: <tr>
1.159     rillig   12558: <td>__stdc__</td>
1.160   ! brook    12559: <td>_vargroups</td>
1.156     leot     12560: </tr>
                   12561: <tr>
1.159     rillig   12562: <td>add</td>
1.160   ! brook    12563: <td>all</td>
1.156     leot     12564: </tr>
                   12565: <tr>
1.159     rillig   12566: <td>alternatives</td>
1.160   ! brook    12567: <td>aslr</td>
1.156     leot     12568: </tr>
                   12569: <tr>
1.159     rillig   12570: <td>asprintf</td>
1.158     brook    12571: <td>autoconf</td>
1.156     leot     12572: </tr>
                   12573: <tr>
1.157     leot     12574: <td>automake</td>
1.158     brook    12575: <td>autoreconf</td>
1.156     leot     12576: </tr>
                   12577: <tr>
1.157     leot     12578: <td>awk</td>
1.158     brook    12579: <td>bash</td>
1.156     leot     12580: </tr>
                   12581: <tr>
1.157     leot     12582: <td>big-endian</td>
1.158     brook    12583: <td>bin-install</td>
1.156     leot     12584: </tr>
                   12585: <tr>
1.157     leot     12586: <td>binpkg-list</td>
1.160   ! brook    12587: <td>bootstrap-depends</td>
1.159     rillig   12588: </tr>
                   12589: <tr>
                   12590: <td>broken</td>
1.160   ! brook    12591: <td>broken_on_platform</td>
1.156     leot     12592: </tr>
                   12593: <tr>
1.159     rillig   12594: <td>build</td>
1.160   ! brook    12595: <td>build-env</td>
1.156     leot     12596: </tr>
                   12597: <tr>
1.159     rillig   12598: <td>buildlink-directories</td>
1.160   ! brook    12599: <td>buildlink-oss-soundcard-h</td>
1.156     leot     12600: </tr>
                   12601: <tr>
1.159     rillig   12602: <td>c</td>
1.160   ! brook    12603: <td>c++</td>
1.156     leot     12604: </tr>
                   12605: <tr>
1.159     rillig   12606: <td>ccache</td>
1.160   ! brook    12607: <td>cce</td>
1.156     leot     12608: </tr>
                   12609: <tr>
1.159     rillig   12610: <td>cdefs</td>
1.160   ! brook    12611: <td>changes</td>
1.156     leot     12612: </tr>
                   12613: <tr>
1.159     rillig   12614: <td>changes-entry</td>
1.160   ! brook    12615: <td>changes-entry-noupdate</td>
1.156     leot     12616: </tr>
                   12617: <tr>
1.159     rillig   12618: <td>check</td>
1.160   ! brook    12619: <td>check-clean</td>
1.156     leot     12620: </tr>
                   12621: <tr>
1.159     rillig   12622: <td>check-files</td>
1.160   ! brook    12623: <td>check-files-clean</td>
1.156     leot     12624: </tr>
                   12625: <tr>
1.159     rillig   12626: <td>check-vulnerable</td>
1.160   ! brook    12627: <td>checksum</td>
1.156     leot     12628: </tr>
                   12629: <tr>
1.159     rillig   12630: <td>checksum-phase</td>
1.160   ! brook    12631: <td>clean</td>
1.156     leot     12632: </tr>
                   12633: <tr>
1.159     rillig   12634: <td>clean-depends</td>
1.160   ! brook    12635: <td>cleandir</td>
1.156     leot     12636: </tr>
                   12637: <tr>
1.159     rillig   12638: <td>commit</td>
1.160   ! brook    12639: <td>commit-changes-entry</td>
1.156     leot     12640: </tr>
                   12641: <tr>
1.159     rillig   12642: <td>compact</td>
1.160   ! brook    12643: <td>compiler</td>
1.156     leot     12644: </tr>
                   12645: <tr>
1.159     rillig   12646: <td>conf</td>
1.160   ! brook    12647: <td>config.guess</td>
1.156     leot     12648: </tr>
                   12649: <tr>
1.159     rillig   12650: <td>config.sub</td>
1.160   ! brook    12651: <td>configuration</td>
1.156     leot     12652: </tr>
                   12653: <tr>
1.159     rillig   12654: <td>configure</td>
1.160   ! brook    12655: <td>configure-help</td>
1.156     leot     12656: </tr>
                   12657: <tr>
1.159     rillig   12658: <td>configure_args</td>
1.160   ! brook    12659: <td>cputime</td>
1.156     leot     12660: </tr>
                   12661: <tr>
1.159     rillig   12662: <td>create-usergroup</td>
1.160   ! brook    12663: <td>csh</td>
1.156     leot     12664: </tr>
                   12665: <tr>
1.159     rillig   12666: <td>ctf</td>
1.157     leot     12667: <td>debug</td>
1.156     leot     12668: </tr>
                   12669: <tr>
                   12670: <td>declaration</td>
1.157     leot     12671: <td>declare</td>
1.156     leot     12672: </tr>
                   12673: <tr>
                   12674: <td>defined</td>
1.157     leot     12675: <td>depend</td>
1.156     leot     12676: </tr>
                   12677: <tr>
                   12678: <td>dependencies</td>
1.157     leot     12679: <td>depends</td>
1.156     leot     12680: </tr>
                   12681: <tr>
                   12682: <td>depends-checksum</td>
1.157     leot     12683: <td>depends-fetch</td>
1.156     leot     12684: </tr>
                   12685: <tr>
                   12686: <td>deps</td>
1.157     leot     12687: <td>describe</td>
1.156     leot     12688: </tr>
                   12689: <tr>
                   12690: <td>destdir</td>
1.157     leot     12691: <td>distclean</td>
1.156     leot     12692: </tr>
                   12693: <tr>
                   12694: <td>distinfo</td>
1.157     leot     12695: <td>dl</td>
1.156     leot     12696: </tr>
                   12697: <tr>
                   12698: <td>dlopen</td>
1.157     leot     12699: <td>do-build</td>
1.156     leot     12700: </tr>
                   12701: <tr>
                   12702: <td>do-buildlink</td>
1.157     leot     12703: <td>do-clean</td>
1.156     leot     12704: </tr>
                   12705: <tr>
                   12706: <td>do-configure-post-hook</td>
1.157     leot     12707: <td>do-extract</td>
1.156     leot     12708: </tr>
                   12709: <tr>
                   12710: <td>do-fetch</td>
1.160   ! brook    12711: <td>emul</td>
1.159     rillig   12712: </tr>
                   12713: <tr>
                   12714: <td>emulation</td>
1.160   ! brook    12715: <td>emulator</td>
1.156     leot     12716: </tr>
                   12717: <tr>
1.159     rillig   12718: <td>endian</td>
1.160   ! brook    12719: <td>enomem</td>
1.156     leot     12720: </tr>
                   12721: <tr>
1.159     rillig   12722: <td>err</td>
1.160   ! brook    12723: <td>errx</td>
1.156     leot     12724: </tr>
                   12725: <tr>
1.159     rillig   12726: <td>etc</td>
1.160   ! brook    12727: <td>feature</td>
1.156     leot     12728: </tr>
                   12729: <tr>
1.159     rillig   12730: <td>features</td>
1.160   ! brook    12731: <td>fetch</td>
1.156     leot     12732: </tr>
                   12733: <tr>
1.159     rillig   12734: <td>fetch-list</td>
1.160   ! brook    12735: <td>follows</td>
1.156     leot     12736: </tr>
                   12737: <tr>
1.159     rillig   12738: <td>forbids</td>
1.160   ! brook    12739: <td>form</td>
1.156     leot     12740: </tr>
                   12741: <tr>
1.159     rillig   12742: <td>format</td>
1.160   ! brook    12743: <td>fortify</td>
1.156     leot     12744: </tr>
                   12745: <tr>
1.159     rillig   12746: <td>fortify_source</td>
1.157     leot     12747: <td>friend</td>
1.156     leot     12748: </tr>
                   12749: <tr>
                   12750: <td>from</td>
1.157     leot     12751: <td>fts</td>
1.156     leot     12752: </tr>
                   12753: <tr>
                   12754: <td>fts_close</td>
1.157     leot     12755: <td>fts_open</td>
1.156     leot     12756: </tr>
                   12757: <tr>
                   12758: <td>fts_read</td>
1.157     leot     12759: <td>fts_set</td>
1.156     leot     12760: </tr>
                   12761: <tr>
                   12762: <td>full</td>
1.157     leot     12763: <td>gcc</td>
1.156     leot     12764: </tr>
                   12765: <tr>
                   12766: <td>getopt_long</td>
1.157     leot     12767: <td>getprogname</td>
1.156     leot     12768: </tr>
                   12769: <tr>
                   12770: <td>gettext</td>
1.160   ! brook    12771: <td>github</td>
1.159     rillig   12772: </tr>
                   12773: <tr>
                   12774: <td>glob</td>
1.160   ! brook    12775: <td>gnu</td>
1.156     leot     12776: </tr>
                   12777: <tr>
1.159     rillig   12778: <td>gnu_configure_strict</td>
1.160   ! brook    12779: <td>go</td>
1.156     leot     12780: </tr>
                   12781: <tr>
1.159     rillig   12782: <td>go-deps</td>
1.160   ! brook    12783: <td>golang</td>
1.156     leot     12784: </tr>
                   12785: <tr>
1.159     rillig   12786: <td>guess-license</td>
1.160   ! brook    12787: <td>hashbang</td>
1.156     leot     12788: </tr>
                   12789: <tr>
1.159     rillig   12790: <td>heimdal</td>
1.156     leot     12791: <td>help</td>
                   12792: </tr>
                   12793: <tr>
                   12794: <td>imake</td>
1.157     leot     12795: <td>increment</td>
1.156     leot     12796: </tr>
                   12797: <tr>
                   12798: <td>interp</td>
1.157     leot     12799: <td>interpreter</td>
1.156     leot     12800: </tr>
                   12801: <tr>
                   12802: <td>intl</td>
1.157     leot     12803: <td>iso</td>
1.156     leot     12804: </tr>
                   12805: <tr>
                   12806: <td>kerberos</td>
1.157     leot     12807: <td>krb</td>
1.156     leot     12808: </tr>
                   12809: <tr>
                   12810: <td>krb5</td>
1.157     leot     12811: <td>ksh</td>
1.156     leot     12812: </tr>
                   12813: <tr>
                   12814: <td>latex</td>
1.160   ! brook    12815: <td>libnbcompat</td>
1.159     rillig   12816: </tr>
                   12817: <tr>
                   12818: <td>libs</td>
1.160   ! brook    12819: <td>libtool</td>
1.156     leot     12820: </tr>
                   12821: <tr>
1.159     rillig   12822: <td>licence</td>
1.160   ! brook    12823: <td>license</td>
1.156     leot     12824: </tr>
                   12825: <tr>
1.159     rillig   12826: <td>lintl</td>
1.160   ! brook    12827: <td>little-endian</td>
1.156     leot     12828: </tr>
                   12829: <tr>
1.159     rillig   12830: <td>lock</td>
1.160   ! brook    12831: <td>locking</td>
1.156     leot     12832: </tr>
                   12833: <tr>
1.159     rillig   12834: <td>lvalue</td>
1.160   ! brook    12835: <td>make</td>
1.156     leot     12836: </tr>
                   12837: <tr>
1.159     rillig   12838: <td>makesum</td>
1.157     leot     12839: <td>memory</td>
1.156     leot     12840: </tr>
                   12841: <tr>
1.157     leot     12842: <td>meta</td>
1.158     brook    12843: <td>meta-package</td>
1.156     leot     12844: </tr>
                   12845: <tr>
1.157     leot     12846: <td>meta_package</td>
1.158     brook    12847: <td>mit-krb5</td>
1.156     leot     12848: </tr>
                   12849: <tr>
1.157     leot     12850: <td>mk.conf</td>
1.160   ! brook    12851: <td>mount</td>
1.159     rillig   12852: </tr>
                   12853: <tr>
                   12854: <td>mprotect</td>
1.160   ! brook    12855: <td>mremap</td>
1.156     leot     12856: </tr>
                   12857: <tr>
1.159     rillig   12858: <td>nb</td>
1.160   ! brook    12859: <td>nbcompat</td>
1.156     leot     12860: </tr>
                   12861: <tr>
1.159     rillig   12862: <td>no</td>
1.160   ! brook    12863: <td>obstack</td>
1.156     leot     12864: </tr>
                   12865: <tr>
1.159     rillig   12866: <td>obstack_ptr_grow</td>
1.160   ! brook    12867: <td>occurs</td>
1.156     leot     12868: </tr>
                   12869: <tr>
1.159     rillig   12870: <td>only</td>
1.158     brook    12871: <td>options</td>
1.156     leot     12872: </tr>
                   12873: <tr>
1.157     leot     12874: <td>options.mk</td>
1.158     brook    12875: <td>order</td>
1.156     leot     12876: </tr>
                   12877: <tr>
1.157     leot     12878: <td>override</td>
1.158     brook    12879: <td>override-intltool</td>
1.156     leot     12880: </tr>
                   12881: <tr>
1.157     leot     12882: <td>override-message-intltool</td>
1.158     brook    12883: <td>package</td>
1.156     leot     12884: </tr>
                   12885: <tr>
1.157     leot     12886: <td>parallel</td>
1.158     brook    12887: <td>partial</td>
1.156     leot     12888: </tr>
                   12889: <tr>
1.157     leot     12890: <td>path</td>
1.158     brook    12891: <td>pax</td>
1.156     leot     12892: </tr>
                   12893: <tr>
1.157     leot     12894: <td>paxctl</td>
1.158     brook    12895: <td>pbulk-index</td>
1.156     leot     12896: </tr>
                   12897: <tr>
1.157     leot     12898: <td>pc</td>
1.158     brook    12899: <td>perl</td>
1.156     leot     12900: </tr>
                   12901: <tr>
1.157     leot     12902: <td>perl5</td>
1.158     brook    12903: <td>perms</td>
1.156     leot     12904: </tr>
                   12905: <tr>
1.157     leot     12906: <td>php</td>
1.158     brook    12907: <td>pkg-build-options</td>
1.156     leot     12908: </tr>
                   12909: <tr>
1.157     leot     12910: <td>pkg-config</td>
1.158     brook    12911: <td>pkg_build_options</td>
1.156     leot     12912: </tr>
                   12913: <tr>
1.157     leot     12914: <td>platform</td>
1.158     brook    12915: <td>plist</td>
1.156     leot     12916: </tr>
                   12917: <tr>
1.157     leot     12918: <td>post-extract</td>
1.158     brook    12919: <td>post-fetch</td>
1.156     leot     12920: </tr>
                   12921: <tr>
1.157     leot     12922: <td>post-wrapper</td>
1.158     brook    12923: <td>pre-configure</td>
1.156     leot     12924: </tr>
                   12925: <tr>
1.157     leot     12926: <td>pre-extract</td>
1.158     brook    12927: <td>pre-fetch</td>
1.156     leot     12928: </tr>
                   12929: <tr>
1.157     leot     12930: <td>print-go-deps</td>
1.158     brook    12931: <td>print-plist</td>
1.156     leot     12932: </tr>
                   12933: <tr>
1.157     leot     12934: <td>print-summary-data</td>
1.158     brook    12935: <td>privileged-install-hook</td>
1.156     leot     12936: </tr>
                   12937: <tr>
1.157     leot     12938: <td>pypi</td>
1.158     brook    12939: <td>python</td>
1.156     leot     12940: </tr>
                   12941: <tr>
1.157     leot     12942: <td>readme-all</td>
1.158     brook    12943: <td>regcomp</td>
1.156     leot     12944: </tr>
                   12945: <tr>
1.157     leot     12946: <td>relro</td>
1.158     brook    12947: <td>rename</td>
1.156     leot     12948: </tr>
                   12949: <tr>
1.157     leot     12950: <td>reorder</td>
1.158     brook    12951: <td>replace</td>
1.156     leot     12952: </tr>
                   12953: <tr>
1.157     leot     12954: <td>replace_interpreter</td>
1.158     brook    12955: <td>reproducible</td>
1.156     leot     12956: </tr>
                   12957: <tr>
1.157     leot     12958: <td>resolv</td>
1.158     brook    12959: <td>root</td>
1.156     leot     12960: </tr>
                   12961: <tr>
1.157     leot     12962: <td>ruby</td>
1.158     brook    12963: <td>setenv</td>
1.156     leot     12964: </tr>
                   12965: <tr>
1.157     leot     12966: <td>setgid</td>
1.158     brook    12967: <td>setprogname</td>
1.156     leot     12968: </tr>
                   12969: <tr>
1.157     leot     12970: <td>setuid</td>
1.158     brook    12971: <td>sh</td>
1.156     leot     12972: </tr>
                   12973: <tr>
1.157     leot     12974: <td>show</td>
1.158     brook    12975: <td>show-all</td>
1.156     leot     12976: </tr>
                   12977: <tr>
1.157     leot     12978: <td>show-build-defs</td>
1.158     brook    12979: <td>show-depends</td>
1.156     leot     12980: </tr>
                   12981: <tr>
1.157     leot     12982: <td>show-deps</td>
1.158     brook    12983: <td>show-distfiles</td>
1.156     leot     12984: </tr>
                   12985: <tr>
1.157     leot     12986: <td>show-downlevel</td>
1.158     brook    12987: <td>show-subdir-var</td>
1.156     leot     12988: </tr>
                   12989: <tr>
1.157     leot     12990: <td>show-tools</td>
1.158     brook    12991: <td>show-var</td>
1.156     leot     12992: </tr>
                   12993: <tr>
1.157     leot     12994: <td>show-vars</td>
1.158     brook    12995: <td>snprintf</td>
1.156     leot     12996: </tr>
                   12997: <tr>
1.157     leot     12998: <td>ssp</td>
1.158     brook    12999: <td>st_mode</td>
1.156     leot     13000: </tr>
                   13001: <tr>
1.157     leot     13002: <td>stage-install</td>
1.158     brook    13003: <td>strip</td>
1.156     leot     13004: </tr>
                   13005: <tr>
1.158     brook    13006: <td>strnlen</td>
1.157     leot     13007: <td>strong</td>
1.156     leot     13008: </tr>
                   13009: <tr>
                   13010: <td>subst</td>
1.160   ! brook    13011: <td>sun</td>
1.159     rillig   13012: </tr>
                   13013: <tr>
                   13014: <td>sunpro</td>
1.156     leot     13015: <td>sunwspro</td>
                   13016: </tr>
                   13017: <tr>
                   13018: <td>test</td>
1.157     leot     13019: <td>tex</td>
1.156     leot     13020: </tr>
                   13021: <tr>
                   13022: <td>texlive</td>
1.157     leot     13023: <td>tmp</td>
1.156     leot     13024: </tr>
                   13025: <tr>
                   13026: <td>tool</td>
1.157     leot     13027: <td>tools</td>
1.156     leot     13028: </tr>
                   13029: <tr>
                   13030: <td>tools-libtool-m4-override</td>
1.157     leot     13031: <td>type</td>
1.156     leot     13032: </tr>
                   13033: <tr>
                   13034: <td>ulimit</td>
1.157     leot     13035: <td>undefined</td>
1.156     leot     13036: </tr>
                   13037: <tr>
                   13038: <td>undo-replace</td>
1.157     leot     13039: <td>unlimit</td>
1.156     leot     13040: </tr>
                   13041: <tr>
                   13042: <td>unprivileged</td>
1.157     leot     13043: <td>unprivileged-install-hook</td>
1.156     leot     13044: </tr>
                   13045: <tr>
                   13046: <td>unstripped</td>
1.157     leot     13047: <td>update</td>
1.156     leot     13048: </tr>
                   13049: <tr>
                   13050: <td>upload</td>
1.157     leot     13051: <td>upload-distfiles</td>
1.156     leot     13052: </tr>
                   13053: <tr>
                   13054: <td>usage</td>
1.157     leot     13055: <td>use_tools</td>
1.156     leot     13056: </tr>
                   13057: <tr>
                   13058: <td>user</td>
1.157     leot     13059: <td>utimes</td>
1.156     leot     13060: </tr>
                   13061: <tr>
                   13062: <td>vasprintf</td>
1.157     leot     13063: <td>verbose</td>
1.156     leot     13064: </tr>
                   13065: <tr>
                   13066: <td>vsnprintf</td>
1.157     leot     13067: <td>warn</td>
1.156     leot     13068: </tr>
                   13069: <tr>
                   13070: <td>warning</td>
1.157     leot     13071: <td>warnings</td>
1.156     leot     13072: </tr>
                   13073: <tr>
                   13074: <td>warnx</td>
1.157     leot     13075: <td>weak</td>
1.156     leot     13076: </tr>
                   13077: <tr>
                   13078: <td>work</td>
1.157     leot     13079: <td>wrapper</td>
1.156     leot     13080: </tr>
                   13081: <tr>
                   13082: <td>yes</td>
1.157     leot     13083: <td> </td>
1.156     leot     13084: </tr>
                   13085: </table>
1.154     rillig   13086: </div>
                   13087: <div class="appendix">
                   13088: <div class="titlepage"><div><div><h1 class="title">
                   13089: <a name="editing"></a>Appendix E. Editing guidelines for the pkgsrc guide</h1></div></div></div>
1.1       dsieger  13090: <div class="toc">
                   13091: <p><b>Table of Contents</b></p>
1.100     leot     13092: <dl class="toc">
1.154     rillig   13093: <dt><span class="sect1"><a href="#targets">E.1. Make targets</a></span></dt>
                   13094: <dt><span class="sect1"><a href="#procedure">E.2. Procedure</a></span></dt>
1.1       dsieger  13095: </dl>
                   13096: </div>
                   13097: <p>This section contains information on editing the pkgsrc
                   13098:        guide itself.</p>
1.41      asau     13099: <div class="sect1">
1.1       dsieger  13100: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   13101: <a name="targets"></a>E.1. Make targets</h2></div></div></div>
1.1       dsieger  13102: <p>The pkgsrc guide's source code is stored in
                   13103:        <code class="filename">pkgsrc/doc/guide/files</code>, and several files
                   13104:        are created from it:</p>
1.41      asau     13105: <div class="itemizedlist"><ul class="itemizedlist" style="list-style-type: disc; ">
1.23      wiz      13106: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.txt</code></p></li>
                   13107: <li class="listitem"><p><code class="filename">pkgsrc/doc/pkgsrc.html</code></p></li>
                   13108: <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>
                   13109: <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  13110:        The PDF version of the pkgsrc guide.</p></li>
1.23      wiz      13111: <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  13112:        PostScript version of the pkgsrc guide.</p></li>
                   13113: </ul></div>
                   13114: </div>
1.41      asau     13115: <div class="sect1">
1.1       dsieger  13116: <div class="titlepage"><div><div><h2 class="title" style="clear: both">
1.154     rillig   13117: <a name="procedure"></a>E.2. Procedure</h2></div></div></div>
1.1       dsieger  13118: <p>The procedure to edit the pkgsrc guide is:</p>
1.23      wiz      13119: <div class="procedure"><ol class="procedure" type="1">
1.41      asau     13120: <li class="step"><p>Make sure you have the packages needed to
1.1       dsieger  13121:        regenerate the pkgsrc guide (and other XML-based NetBSD
1.45      obache   13122:        documentation) installed. These are automatically installed when
1.137     leot     13123:        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     13124: <li class="step"><p>Run <span class="command"><strong>cd doc/guide</strong></span> to get to the
1.1       dsieger  13125:        right directory. All further steps will take place
                   13126:        here.</p></li>
1.41      asau     13127: <li class="step"><p>Edit the XML file(s) in
1.1       dsieger  13128:        <code class="filename">files/</code>.</p></li>
1.41      asau     13129: <li class="step"><p>Run <span class="command"><strong>bmake</strong></span> to check the pkgsrc
1.1       dsieger  13130:        guide for valid XML and to build the final output files. If you
                   13131:        get any errors at this stage, you can just edit the files, as
                   13132:        there are only symbolic links in the working directory, pointing
                   13133:        to the files in <code class="filename">files/</code>.</p></li>
1.41      asau     13134: <li class="step"><p><span class="command"><strong>(cd files &amp;&amp; cvs
1.1       dsieger  13135:        commit)</strong></span></p></li>
1.41      asau     13136: <li class="step"><p>Run <span class="command"><strong>bmake clean &amp;&amp; bmake</strong></span> to
1.1       dsieger  13137:        regenerate the output files with the proper RCS
                   13138:        Ids.</p></li>
1.41      asau     13139: <li class="step">
1.10      hubertf  13140: <p>Run <span class="command"><strong>bmake regen</strong></span> to install and
1.1       dsieger  13141:        commit the files in both <code class="filename">pkgsrc/doc</code> and
                   13142:        <code class="filename">htdocs</code>.</p>
1.41      asau     13143: <div class="note" style="margin-left: 0.5in; margin-right: 0.5in;">
1.1       dsieger  13144: <h3 class="title">Note</h3>
                   13145: <p>If you have added, removed or renamed some chapters,
1.10      hubertf  13146:        you need to synchronize them using <span class="command"><strong>cvs add</strong></span> or
                   13147:        <span class="command"><strong>cvs delete</strong></span> in the htdocs
1.1       dsieger  13148:        directory.</p>
                   13149: </div>
                   13150: </li>
                   13151: </ol></div>
                   13152: </div>
                   13153: </div>
                   13154: </div></body>
                   13155: </html>

CVSweb <webmaster@jp.NetBSD.org>